Ordering of Content in Playgrounds

Playground pages in rendered documentation mode show the rendered markup interspersed with other content.

Figure 3-3 shows two screenshots of the same playground. The raw markup is on the left and the rendered documentation is on the right. The red boxes show each of the markup delimiters and their corresponding rendered output. For example, the top box in each view of the page page shows the first block of markup that includes a first level heading, a numbered list, and an image. The next box shows a heading, a line of text, and then a line of text with a bolded word. The final box shows a single line comment that is a link to the next playground page.

The Swift content appears interspersed with the markup content. For example, the constant definition for myPageShortTitle is the first item below the first box in each view of the page.

Figure 3-3Order of rendered markup

Ordering of Content in Quick Help

Quick Help groups the markup into different sections. The rendered content in each section appears in the same order as the unrendered markup.

For example, the the following markup generates the Quick Help shown in Figure 3-4.

Figure 3-4Quick Help sections

The markup in lines 2-4 and line 8 generates the Description section. The order of rendered elements in the section is the same as the order in the markup. The text from line 1 is shown at the top of the description, the important callout from line 4 is shown next, and then the text from line 8.

Line 6 generates the content in the Parameters section, even though it comes before the markup used for the final line of the description. Similarly, Line 5 generates the Returns section which comes after the parameters section.

For more information on using markup to generate Quick Help, see Formatting Quick Help.