Glossary¶
Look up the terms that the guide and the API use in a specific sense.
File format¶
- document¶
A
.keyxfile as a whole, which is the presentation together with its presets, manifest, and resources. It’s a ZIP archive with these entries:main.jsonThe presentation, which is its slides and everything on them.
presets.jsonThe presets.
manifest.jsonThe manifest.
Data/The resources that the document keeps as files.
For more information, see Explore the files in a document.
People who use Keynote call the whole file a presentation. In this library, that file is a document. Its presentation is the part that holds the slides. A
KeyxDocumentholds a document in memory, and reads and writes its ZIP archive.- reader¶
A program that opens a document, such as Keynote. The format’s documentation and the API reference describe each value by what a reader does with it.
- property¶
A key-value pair in a JSON object, such as
"width": 1024in a size.- identifier¶
The name other JSON objects use to refer to one, such as a preset. It’s unique across the whole document. For more information, see Write unique object identifiers.
- preset¶
A reusable, named set of properties that JSON objects in
main.jsonadopt and inherit. A preset can hold any property of the object that adopts it, including a property that isn’t visual, such as whether a paragraph’s lines stay together. For more information, see Style objects with presets.- resource¶
Binary data that a JSON object references. The document keeps it as its own file or embeds it in the JSON. The bytes of an image or a movie are a resource. For more information, see Resource store and Store media as resources.
- manifest¶
The part of a document that declares its
package_version, which is the version of the format that the document uses. For more information, see Declare versions.- version¶
A number in major.minor form, such as
1.0, that the format uses for backward and forward compatibility. Each type has one, and a JSON object can declare which version of its type it follows. A document’s package version, which the manifest writes aspackage_version, is the version of the format as a whole. For more information, see Distinguish the two kinds of version.
Library¶
- model¶
A Pydantic model class that represents one type of JSON object in the format, such as
SlideorText. Its fields mirror that type’s properties.model_for()finds the model for atype_identifier.- union¶
A model for a property that holds exactly one of several values, such as a
CanvasObject, which holds a text box, a shape, or another object. Each possible value is an optional field, called a case, and you set exactly one. For more information, seeTaggedUnionModeland Recognize values that take one of several forms.
Keynote¶
Authoring from a theme shows how these work together, and Base slides on a theme and its layouts shows how a document stores them.
- theme¶
The predesigned look a presentation builds on. You choose it by name, such as
"White". It provides the presentation’s slide layouts and default styles.Presentation.themenames it, and can carry slide layouts that replace the theme’s own.- slide layout¶
One of a theme’s predesigned slides, which a slide builds on through
Slide.layout. It provides the slide’s placeholders and background. Also called a layout.- placeholder¶
An object that marks where content goes on a slide, such as the title or body text.