Documentation Archive

Developer

Markup Formatting Reference

On This Page

Named Page

Open a named page in the playground.

Selecting a link that points to the same playground page as the one containing the link has no effect.

For example, in the screenshot Overview.playground is the first page and Adding Files.playground is the last page.

image: Art/MFR_pg_next_previous_2x.png

Works with:

  • ✓ Playgrounds

  •    Symbol documentation

Syntax

  • [link name](name of the playground document to open)

Replace spaces in the name of the playground page with the ASCII character code for space (%20).

Example: Simple Named Page Link

The markup below is for a named page link that opens a playground page called Adding Files.playground.

  1. //: [Adding Files](Adding%20Files)

The named page link is rendered as a link with the text "Adding Files" in rendered documentation, as shown in the screenshot.

image: Art/MFR_link_named_pg_2x.png

Example: Named Page Links in Context

You can use named page links to build a table of contents. Lines 4-6 below are links to different pages. Each link is an item in a numbered list.

  1. /*:
  2.  ### Table of Contents
  3. 1. [Designing Your Tutorial](Designing)
  4.  2. [Creating the Tutorial Project](Creating)
  5. 3. [Adding Files](Adding%20Files)
  6. */

In the screenshot below, line 4 of the markup renders as link to the file Designing.playground named "Designing Your Tutorial." Lines 5 and 6 render as list items two and three.

image: Art/MFR_link_named_pg_context_2x.png