# Document conventions

Applies to: All SVG to Slides documentation.

This library uses a small set of conventions for keys, interface names, versions and notes. Keys are given for Mac. The Windows key follows a fixed rule.

## Keys

Keys are printed in capitals and joined with a plus sign. Option+Shift+P means hold OPTION and SHIFT and press P. A phrase such as "Command-click" means hold the key and click.

Key combinations are given for Mac. On Windows, use the key in the second column. Point at any key combination in a topic to see the Windows form.

| Mac | Windows |
|---|---|
| Command | Ctrl |
| Option | Alt |
| Shift | Shift |
| Delete | Backspace |
| Command+Control+K | Ctrl+Alt+K |

The full list, with both columns, is in [Keyboard shortcuts](https://svgslid.es/docs/keyboard-shortcuts.md).

## Typography

| Convention | Used for |
|---|---|
| **Bold** | Names you see on screen: buttons, menus, panel titles. |
| *Italic* | A value you supply. |
| `Monospace` | File names, addresses, SVG code and text you type. |
| CAPITALS in a box | Keys. |

Spelling follows the product: colour, centre.

## Versions

Each topic opens with a box headed "The information in this topic applies to". If the box names version 1.3.0 only, the tool is not present in earlier versions. To find your version, see [Installing and updating](https://svgslid.es/docs/install.md#check-version).

## Procedures

A procedure starts with a line that begins "To", followed by numbered steps. Do the steps in order. A step that has a result says what you should see.

## Notes

| Label | Meaning |
|---|---|
| Note | Information that qualifies the text around it. |
| Tip | A faster or easier way. |
| Important | Something that affects the result if you miss it. |
| Caution | A step that loses work or cannot be reversed. |

## Figures

Screen pictures show the extension's own interface running over a sample deck, the Vacay.com pitch deck. Numbered yellow markers on a figure match the numbered list under it.

Figures labelled *Illustration* are frames from the release animations. They show the result on the slide and draw the toolbar in simplified form.

## Knowledge Base articles

Knowledge Base articles are numbered Q100101 and up. The first word of the title gives the kind of article.

| Prefix | Kind of article |
|---|---|
| PRB | A problem and its cause. The behaviour may be by design. |
| FIX | A problem that a later version corrects. |
| INFO | Background on how something behaves. |
| HOWTO | A procedure. |

## See also

- [Keyboard shortcuts](https://svgslid.es/docs/keyboard-shortcuts.md)
- [All articles](https://svgslid.es/docs/kb.md)
- [Glossary](https://svgslid.es/docs/glossary.md)
- [Index](https://svgslid.es/docs/a-z-index.md)

Source: https://svgslid.es/docs/conventions (SVG to Slides Documentation, Getting Started). Last reviewed November 20, 2026.
