Sozi document format
Version 12.x
"sozi" namespace
| Prefix | URI |
|---|---|
| sozi | http://sozi.baierouge.fr |
Animation script (<script> element)
A <script> element contains the Javascript code needed to play the presentation. In Inkscape, this element is automatically added and updated by the “Sozi” extension.
| Attribut | Value |
|---|---|
| id | “sozi-script” |
| sozi:version | The version number of the Sozi script installed in this document |
Frame definition (<sozi:frame> element)
A frame is defined by a <sozi:frame> element with the following attributes:
| Attribute | Value |
|---|---|
| id | The unique identifier of the current frame |
| sozi:refid | The value of the “id” attribute of the graphical element that delimits this frame |
| sozi:title | The title of this frame |
| sozi:sequence | The index of this frame in the presentation order |
| sozi:hide | “true” or “false” to hide/show the delimiting element during the presentation |
| sozi:clip | “true” or “false” to clip the frame to the boundaries of the delimiting element |
| sozi:timeout-enable | “true” or “false” to enable/disable moving to the next frame automatically after the specified duration (see sozi:timeout-ms) |
| sozi:timeout-ms | How many milliseconds to wait before moving to the next frame automatically (when sozi:timeout-enable is “true”) |
| sozi:transition-duration-ms | The duration of the transition before the current frame, in milliseconds |
| sozi:transition-zoom-percent | The zoom effect to use during the transition before the current frame, as a percentage |
| sozi:transition-profile | The speed profile to use during the transition before the current frame (see below) |
Optionally, a <sozi:frame> element may contain <sozi:layer> elements.
Using layers (<sozi:layer> element)
The <sozi:layer> element is a child of element <sozi:frame>. It supports the following attributes:
| Attribut | Value |
|---|---|
| sozi:group | The value of the “id” attribute of the group element (<svg:g>) used as a layer |
| sozi:refid | The value of the “id” attribute of the graphical element that delimits this frame for the current layer |
| sozi:hide | “true” or “false” to hide/show the delimiting element during the presentation |
| sozi:clip | “true” or “false” to clip the layer to the boundaries of the delimiting element |
| sozi:transition-zoom-percent | The zoom effect to use during the transition before the current frame, as a percentage |
| sozi:transition-profile | The speed profile to use during the transition before the current frame (see below) |
These attributes are optional. Missing attributes are inherited from the parent <sozi:frame> element.
Speed profiles
Speed profiles usable in the “sozi:transition-profile” attribute are listed below. “strong” variants correspond to stronger accelerations.
| Name | Effect |
|---|---|
| “linear” | Constant speed |
| “accelerate”, “strong-accelerate” | Accelerate |
| “decelerate”, “strong-decelerate” | Decelerate |
| “accelerate-decelerate”, “strong-accelerate-decelerate” | Acceleration followed by deceleration |
| “decelerate-accelerate”, “strong-decelerate-accelerate” | Deceleration followed by acceleration |
Video and audio (<sozi:video> and <sozi:audio> elements)
A <sozi:video> or <sozi:audio> element must be placed as a direct child of an <svg:rect> element.
For videos, the <svg:rect> element must have the following attributes:
| Attribute | Value |
|---|---|
| svg:width | The width of the rectangle, must be equal to the width of the video, in pixels |
| svg:height | The height of the rectangle, must be equal to the height of the video, in pixels |
The <svg:rect> element will act as a container for the video to be displayed. Geometrical transformations applied to the rectangle will also affect the video.
An <svg:rect> element can contain several <sozi:video> elements, or several <sozi:audio> elements pointing to alternative media files in different formats.
Attributes for the <sozi:video> and <sozi:audio> elements:
| Attribute | Value |
|---|---|
| sozi:type | The MIME type of the media |
| sozi:src | The URL of the media |
| sozi:start-frame | The id of the frame where the media should start automatically. If missing, playback will start only on user request. |
| sozi:stop-frame | The id of the frame where the media should stop automatically. |
Version 10.x (obsolete)
The following definitions are no longer supported in Sozi 11.01 and later versions. The Inkscape extension automatically upgrades older documents to the new format.
Frame definition
A frame is defined by the following attributes when they are attached to a graphical element of the SVG document.
| Attribute | Value |
|---|---|
| class | ”…, sozi-frame, …” |
| sozi:title | The title of this frame |
| sozi:sequence | The index of this frame in the presentation order |
| sozi:hide | “true” or “false” to hide/show the delimiting element during the presentation |
| sozi:clip | “true” or “false” to clip the frame to the boundaries of the delimiting element |
| sozi:timeout-enable | “true” or “false” to enable/disable moving to the next frame automatically after the specified duration (see sozi:timeout-ms) |
| sozi:timeout-ms | How many milliseconds to wait before moving to the next frame automatically (when sozi:timeout-enable is “true”) |
| sozi:transition-duration-ms | The duration of the transition before the current frame, in milliseconds |
| sozi:transition-zoom-percent | The zoom effect to use during the transition before the current frame, as a percentage |
| sozi:transition-profile | The speed profile to use during the transition before the current frame (see below) |
