Markup Functionality
Markup uses simple character-based delimiters to mark formatted text in playgrounds and in Quick Help for Swift symbols.
The different delimiters include functionality for:
Formatting a line of text such as a creating a heading
Formatting multiple lines of text such as creating a bulleted list
Formatting a span of characters such as adding emphasis to a string
Inserting links to web based content
Inserting assets such as images and videos
Inserting callouts such as examples in playgrounds and parameters in Quick Help.
Escaping special characters, including markup delimiters
Some of the delimiters are used for both rendered playground documentation and in Quick Help. Other delimiters are used with either playgrounds or with Quick Help. The documentation for each delimiter includes information on where it can be used. In addition, Table 2-1 gives an alphabetical overview of all the delimiters including a brief description.
For information on adding markup, see Using Markup.
Delimiter name |
Description |
Playground |
Quick Help |
---|---|---|---|
Adds an |
|
✓ |
|
Adds an |
|
✓ |
|
Adds an |
|
✓ |
|
The comment markers for opening and closing a block of markup. |
✓ |
✓ |
|
Adds a |
|
✓ |
|
Adds a bulleted list. |
✓ |
✓ |
|
Renders lines of text as a block of code. |
✓ |
✓ |
|
Renders a span of text in the font used for displaying code. |
✓ |
✓ |
|
Adds a |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a callout with custom text. |
✓ |
|
|
Adds a |
|
✓ |
|
Renders a span of text with emphasis. |
✓ |
✓ |
|
Disables any special behaviors for the following character. |
✓ |
✓ |
|
Adds an |
✓ |
|
|
Adds an |
✓ |
✓ |
|
Renders a line as a heading. |
✓ |
✓ |
|
Adds a horizontal rule. |
✓ |
✓ |
|
Shows an image from the web or from a playground project. |
✓ |
✓ |
|
Adds an |
✓ |
✓ |
|
Adds an |
|
✓ |
|
Adds a named reference to a URL that can be used in multiple places. |
✓ |
✓ |
|
Adds a link to a text-based resource. |
✓ |
✓ |
|
Adds a link to a named playground page. |
✓ |
|
|
Adds a link to the next playground page in the project. |
✓ |
|
|
Adds a |
✓ |
✓ |
|
Adds a numbered list. |
✓ |
✓ |
|
Adds a |
|
✓ |
|
Adds multiple |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a link to the previous page in a playground project. |
✓ |
|
|
Adds a |
|
✓ |
|
Adds the |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a |
|
✓ |
|
The comment marker used for a single line of markup. |
✓ |
✓ |
|
Renders a span of text in bold. |
✓ |
✓ |
|
Adds the |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a |
|
✓ |
|
Adds a live video player. |
✓ |
|
|
Adds a |
|
✓ |
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05