Формат документа Ruby - Ruby Document format

RD (Ruby Document) - это облегченный язык разметки для записи Рубин связанных документов, которые могут быть встроены в исходный код Ruby.

RD - это традиционный формат. В современном Ruby разработчики обычно пишут документы в RDoc вместо RD.

Использовать

Первоначально большая часть документации в мире Ruby, в том числе для самого Ruby, была написана на RD. Затем, в 2002 году, большая часть его была преобразована в формат RDoc. Хотя японская версия Справочное руководство по Ruby по-прежнему остается в формате RD.

RD предназначен для написания от руки и легко читается в исходном виде. Однако большинство конечных пользователей испытывают его после преобразования в HTML или страницы руководства.

RD может быть встроен в код Ruby, а чистые файлы RD обычно имеют расширение .rd.

Образец документа RD

Этот документ является синтаксически правильным RD, который также пытается следовать основным соглашениям об именах разделов.

ИсточникHTML результат
= begin = NAMERD sample - Образец RD-документа = SYNOPSIS здесь. is_a? (Piece :: Of :: Code) print << "END" Этот блок с отступом не будет сканироваться на предмет кодов форматирования или директив, а интервалы будут сохранены. КОНЕЦ = ОПИСАНИЕ Вот обычный текст. Он включает текст, который ((* выделен *)), ((% keyboard%)), (({code})) - отформатирован, ((| переменная часть |)), ((: проиндексировано :)) и ( ('как есть')) ((- сноска -)). == Пример списка * Это маркированный список. * Вот еще один элемент. * Вложенный элемент списка. == Упорядоченный список (1) Это первый элемент (2) второй * Вложенный неупорядоченный список. (3) третий (1) Вложенный упорядоченный список (2) его второй элемент = end = begin html Рисунок 1. 
 Вот встроенный HTML. В этот блок я могу включать изображения, применять  стили  или делать что-нибудь еще, что я могу делать с HTML. Процессоры RD, которые не выводят HTML, полностью его игнорируют. 
 = end = begin = COPYRIGHTCopyright 2005 J. Random Hacker . Разрешается копировать, распространять и / или изменять этот документ в соответствии с условиями лицензии GNU Free Documentation License версии 1.2 или любой более поздней версии, опубликованной Free Software Foundation; без неизменяемых разделов, без текста на лицевой обложке и без текстов на задней обложке. = конец

ИМЯ

Образец RD - образец документа RD

ОБЗОР

here.is_a? (Piece :: Of :: Code) print << "END" Этот блок с отступом не будет сканироваться на предмет кодов форматирования или директив, а интервалы будут сохранены.END

ОПИСАНИЕ

Вот нормальный текст. Он включает текст, которыйподчеркнул, клавиатура, код-форматированный, переменная часть, проиндексировано и как есть*1.

Примерный список

  • Это маркированный список.
  • Вот еще один предмет.
    • Вложенный элемент списка.

Упорядоченный список

  1. Это первый предмет
  2. второй
  • Вложенный неупорядоченный список.
  1. start = 3
  2. в третьих
  1. Вложенный упорядоченный список
  2. его второй пункт


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


АВТОРСКИЕ ПРАВА

Авторские права 2005 J. Random Hacker . Разрешается копировать, распространять и / или изменять этот документ в соответствии с условиями лицензии GNU Free Documentation License версии 1.2 или любой более поздней версии, опубликованной Free Software Foundation; без неизменяемых разделов, без текстов на лицевой обложке и без текстов на задней обложке.

Смотрите также

внешняя ссылка

  • RDtool - Платформа для перевода документа RD в другие форматы.
  • rd-draft.rd - полное описание языка разметки RD (в формате RD)
  • rd-draft.html - полное описание языка разметки RD (преобразовано в HTML)