Skip to content

Commit baaad75

Browse files
committed
Add compatibility note to Readme.
1 parent c6e77c8 commit baaad75

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,23 @@ To do so:
7979
`keynote-parser` will automatically rescale the replacement image to fit all of the
8080
sizes of the target image.
8181

82+
### Compatibility
83+
84+
Note that between Keynote 10.2 and Keynote 11.2, a number of Protobuf definitions
85+
used by Keynote have changed names. `keynote-parser` does not yet support
86+
backwards compatibility: it can only read `.key` files as the
87+
currently-supported Keynote version would, and will write `.yaml` output with
88+
keys that match the current names of the keys. This means that **`.yaml` files
89+
generated with older versions of `keynote-parser` may not be readable by with
90+
v1.11.2.1 or higher of `keynote-parser`**.
91+
92+
Until this issue is fixed (_if_ it's ever fixed) - to properly read `.yaml` files
93+
created by older versions of `keynote-parser`:
94+
- use an older version of `keynote-parser` to read the file
95+
- write a `.key` (or `.iwa`) file with that older version
96+
- upgrade `keynote-parser`
97+
- read that resulting `.iwa` file in the newer version of `keynote-parser`
98+
8299
## Updates
83100

84101
As `keynote-parser` includes private Protobuf definitions extracted from a copy of Keynote,

0 commit comments

Comments
 (0)