Ссылка формата разметки детской площадки

Добавьте, что богатые комментарии к Вашим детским площадкам с помощью синтаксиса разметки на основе знакомых соглашений форматирования Скидки с цены для заголовков, маркированных списков, соединяются и т.д.

Редактирование комментариев

Редактирование комментирует в необработанном режиме редактирования для детской площадки. Режимы изменения для предварительного просмотра изменений путем выбора Editor> Show Rendered Markup. Переключитесь назад на необработанный режим редактирования путем выбора Editor> Show Raw Markup.

Синтаксис комментария разметки

Следующие заполнители используются всюду по определениям синтаксиса для элементов, следующих за разделителем.

<valid marked up text>

Любой допустимый повышенный в цене текст.

<optional comment>

Строка раньше комментировала разметку. Когда детская площадка находится в режиме обогащенного текста, строка не выведена на экран.

<string>

Строка символов. Для встроенных элементов первые и последние символы не должны быть пробелами.

<integer>

Любое допустимое целое число.

<blank line>

Пустая строка.

Разделители разметки

Элементы разметки в детских площадках разграничены или на линию за линией основание или в блоке.

Однострочный разделитель

Добавьте одну строку разметки к документу с помощью однострочного разделителя. Многократные непрерывные строки разделителей обрабатываются как единственный богатый комментарий. Должно быть точно одно пространство между однострочным разделителем и первым символом текста.

//: <valid marked up text>

Пример

//: This is a line of text that will appear as a rich comment in a playground.
 
//: These two lines of single delimiter text
//: show up as one rich comment block in the playground
../Art/PGR_single_line_eg.shot/Resources/shot_2x.png

Блочный разделитель

Включите многократные строки разметки с помощью блочного разделителя.

/*: <optional comment>

<valid marked up text>

<valid marked up text>

*/

Пример

/*: A comment that is not displayed in rich text view
# The First Heading Shown
The first content line displayed in this block of rich text.
*/
../Art/PGR_block_delim_eg.shot/Resources/shot_2x.png

Блочные элементы

Блочные элементы управляют форматированием одной или более строк комментариев детской площадки.

Заголовки

Используйте знак номера (#) указать до трех уровней заголовка. Должно быть по крайней мере одно пространство между знаком номера и строкой заголовка.

Заголовок 1

# <string>

Заголовок 2

## <string>

Заголовок 3

### <string>

Альтернатива

Подчеркните возглавляющую строку для уровня один и два заголовка. Число символов в заголовке и в строке подчеркивания должно быть тем же.

Заголовок 1

<string>

=<repeat for character count of heading string>

Подчеркните, что текст заголовка с равняется знаку (=).

Число (=) символы в соответствии с текстом заголовка должны совпасть с числом символов текста заголовка.

Заголовок 2

<string>

-<repeat for character count of heading string>

Подчеркните текст заголовка с помощью дефисов (-).

Число (-) символы в соответствии с текстом заголовка должны совпасть с числом символов текста заголовка.

Примеры

Создайте уровень два заголовка с помощью знака номера.

//: ## This is a Heading 2
../Art/PGR_heading_eg_1.shot/Resources/shot_2x.png

Создайте уровень, один заголовок с помощью равняется знаку. Обратите внимание на то, что число знаков «равно» совпадает с числом символов в возглавляющей строке.

//: This is a Heading 1
//: ===================
../Art/PGR_heading_eg_2.shot/Resources/shot_2x.png

Списки

Добавьте маркируемые и пронумерованные списки с помощью языка разметки детской площадки.

Маркированные списки

Используйте звездочку (*) для каждого маркированного элемента. Должно быть точно одно пространство между звездочкой и строкой элемента.

* <string>

Пример

/*: A bulleted list of 2 items
* Item 1
* Item 2
*/
../Art/PGR_bullet_list_eg.shot/Resources/shot_2x.png
Пронумерованные списки

Каждый элемент в пронумерованном списке запускается с одних или более пробелов, целое число, сопровождаемое периодом (.), и затем требуемый текст. Должно быть точно одно пространство между периодом и строкой элемента.

Число пробелов перед целым числом указывает уровень элемента в списке. Все первые элементы уровня запускаются с одного пространства. Добавьте четыре пробелов для каждого дополнительного уровня максимум к трех уровней.

Целое число, используемое на первой строке уровня списка, используется в качестве начального значения индекса в представлении обогащенного текста.

Пронумерованный уровень 1 списка

<integer>. <string>

Пронумерованный уровень 2 списка

    <integer>. <string>

4 пробелов

Пронумерованный уровень 3 списка

        <integer>. <string>

8 пробелов

Примеры

/*: A numbered list with 2 levels
1. Cat
2. Dog
    1. Golden Retriever
3. Llama
*/
../Art/PGR_numbered_list_eg_1.shot/Resources/shot_2x.png
/*: Start the numbering of the rich text list at "4"
4. Fish
5. Lizard
*/

Второй пример выше запусков нумерация списка в 4 как показано:

../Art/PGR_numbered_list_eg_2.shot/Resources/shot_2x.png

Блок цитирования

Запустите каждую строку блока цитирования с большим - чем знак ([>]). Должно быть точно одно пространство между большим - чем знак и строкой элемента.

> <string>

Пример

/*: A block quote of the first four lines from a great prologue
> Oh for a Muse of fire, that would ascend
> The brightest heaven of invention,
> A kingdom for a stage, princes to act
> And monarchs to behold the swelling scene!
*/
../Art/PGR_block_quote_eg.shot/Resources/shot_2x.png

Блок кода

Запустите каждую строку блока кода по крайней мере с четырьмя пробелами.

<string>

Пример

/*: How not to write a loop in Swift
    while true {
        println("When will this stop?")
    }
*/
../Art/PGR_code_block_eg.shot/Resources/shot_2x.png

Встроенные элементы

Встроенные элементы формата элементов в блочных элементах. Можно использовать встроенные элементы для добавления акцента, изображений или ссылок к другим ресурсам.

Акцент

Добавьте акцент при помощи звездочки (*) или подчеркивание (_) в запуске и конце строки. Не смешивайте звездочки и подчеркивания для того же элемента.

*<string>*

Альтернатива

_<string>_

Пример

//: This line has a word with *emphasis*
 
//: This line uses _emphasis for the last six words_
../Art/PGR_emphasis_eg.shot/Resources/shot_2x.png

Сильный

Добавьте сильное форматирование с двумя звездочками (**) или два подчеркивания (__) в запуске и конце строки. Не смешивайте звездочки и подчеркивания для того же элемента.

**<string>**

Альтернатива

__<string>__

Пример

//: A **strong * (asterisk)** is on this line
 
//: __A strong line__
../Art/PGR_strong_eg.shot/Resources/shot_2x.png

Код

Текст формата как код при помощи обратной галочки (`) вначале и конец строки.

`<string>`

Пример

//: Show Swift elements such as `for` and `let` as monspaced code font
../Art/PGR_code_eg.shot/Resources/shot_2x.png

Изображение

Включайте изображения от сети или из Вашего проекта детской площадки.

![<alt text>](<URL> "<image title for hover>")

<alt text>

Если изображение не загружается, текст вывел на экран. Также используемый для доступности.

<URL>

Адрес изображения. Это может быть веб-URL или путем к файлу в проекте детской площадки.

<image title for hover>

Когда указатель нависает над изображением, текст вывел на экран. Также используемый для доступности.

Примеры

Ссылка к изображению в сети с текстом парения.

//: ![Icon for a playground](http://devimages.apple.com.edgekey.net/swift/images/playgrounds.png "An image I seesawed")
../Art/PGR_image_web_eg.shot/Resources/shot_2x.png

Ссылка к ресурсу детской площадки без текста парения.

//: ![Anyone for tennis?](tennis.jpg)
../Art/PGR_image_resource_eg.shot/Resources/shot_2x.png

Ссылка

Включайте ссылки к веб-ресурсам.

[<text to display>](<http URL>)

<text to display>

Текст выведен на экран в комментарии детской площадки.

<http URL>

Адрес для веб-страницы для открытия, когда щелкают по ссылке в комментарии.

Пример

/*: Include a link to the Swift page in the text
See more about Swift by [following this link.](http://developer.apple.com/swift/)
*/
../Art/PGR_link_eg.shot/Resources/shot_2x.png

Прочие условия

Горизонтальное правило

Используйте четыре или больше дефиса (-) окруженный пустыми строками для добавления горизонтального правила.

<blank line>

----

<blank line>

Пример

/*: A block of markup code showing a single horizontal line
 
----
 
*/
../Art/PGR_horizontal_rule_eg.shot/Resources/shot_2x.png

Escape наклонной черты влево

Выведите на экран специальные символы путем выхода из них с наклонной чертой влево (\). Необходимо использовать наклонную черту влево для отображения специального символа в следующих случаях.

  • Разделитель является первым специальным символом строки разметки.

  • Разделитель является первым специальным символом блочного элемента.

    Период является специальным символом для пронумерованного списка.

  • Встроенный разделитель в запуске или конце строки символов.

Вы не должны выходить из специальных символов в блоке кода, или обратная галочка разграничила код.

Для списка специальных символов посмотрите Символы Синтаксиса Комментария

\<special character>

Пример

//: Show the *middle asterisk\* with emphasis*
../Art/PGR_backslash_eg.shot/Resources/shot_2x.png

Прокомментируйте сводку синтаксиса

Следующая таблица суммирует каждый оператор синтаксиса комментария.

Элемент

Синтаксис

Единственный разделитель строки комментария

//: <valid marked up text>

Блочный разделитель комментария

/*: <optional comment>

<valid marked up text>

*/

Заголовок 1

# <string>

 

Альтернатива

<string>

=<repeat for character count of heading>

Заголовок 2

## <string>

 

Альтернатива

<string>

-<repeat for character count of heading>

Заголовок 3

### <string>

Маркированный список

* <string>

Пронумерованный уровень 1 списка

<integer>. <string>

Пронумерованный уровень 2 списка

    <integer>. <string>

4 пробелов

Пронумерованный уровень 3 списка

        <integer>. <string>

8 пробелов

Блок цитирования

> <string>

Блочная строка кода

    <code>

По крайней мере 4 пробелов

Акцент

*<string>*

 

Альтернатива

_<string>_

Сильный

**<string>**

 

Альтернатива

__<string>__

Код

`<string>`

Изображение

![<alt text>](<URL> "<image title for hover>"

Ссылка

[<text to display>](<http URL>)

Горизонтальное правило

<blank line>

----

<blank line>

Escape наклонной черты влево

\<special character>

Символы синтаксиса комментария

Комментарий детской площадки использует много символов в качестве разделителей элемента. В следующей таблице перечислены каждый специальный символ и для чего это используется.

Символ

Имя персонажа

Элементы синтаксиса

!

Восклицательный знак

Изображение

#

Знак номера

Заголовки

(

Открывающая скобка

Изображение

Ссылка

)

Близкая круглая скобка

Изображение

Ссылка

*

Звездочка

Блочный разделитель

Маркированные списки

Сильный

Акцент

-

Дефис

Заголовки

Горизонтальное правило

/

Наклонная черта вправо

Однострочный разделитель

Блочный разделитель

:

Двоеточие

Однострочный разделитель

Блочный разделитель

=

Равняется знаку

Заголовки

>

Больше - чем

Блок цитирования

[

Открытая квадратная скобка

Изображение

Ссылка

]

Близкая квадратная скобка

Изображение

Ссылка

\

Наклонная черта влево

Escape наклонной черты влево

_

Подчеркивание

Акцент

Сильный

`

Одинарная левая кавычка (также названный серьезным диакритическим знаком)

Код

<number>.

Период, которому предшествует целое число

Пронумерованные списки