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

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

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

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

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

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

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

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

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

Источник

HTML-результат

=begin = NAME RD sample - A sample RD document = SYNOPSIS here.is_a?(Piece::Of::Code) print <<"END" This indented block will not be scanned for formatting codes or directives, and spacing will be preserved. END = DESCRIPTION Here's some normal text. It includes text that is ((*emphasized*)), ((%keyboard%)), (({code}))-formatted, ((|variable part|)), ((:indexed:)), and (('as-is'))((-footnote-)). == An Example List * This is a bulleted list. * Here's another item. * Nested list item. == An ordered List (1) This is the first item (2) second * Nested unordered list. (3) third (1) Nested ordered list (2) its second item =end =begin html <img src="Example.png" align="right" alt="Figure 1." /> <p> Here's some embedded HTML. In this block I can include images, apply <span style="color: green"> styles</span>, or do anything else I can do with HTML. RD processors that aren't outputting HTML will completely ignore it. </p> =end =begin = COPYRIGHT Copyright 2005 J. Random Hacker <[email protected]>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. =end

ИМЯ Образец РД — образец документа РД. СИНОПСИС here.is_a?(Piece::Of::Code) print <<"END" This indented block will not be scanned for formatting codes or directives, and spacing will be preserved. END ОПИСАНИЕ Вот нормальный текст. Он включает в себя текст, который подчеркнул , клавиатура , code-форматированная, переменная часть , индексированная и «как есть» *1 . Пример списка Это маркированный список. Вот еще один предмет. Вложенный элемент списка. Упорядоченный список Это первый предмет второй Вложенный неупорядоченный список. начало=3 третий Вложенный упорядоченный список его второй пункт Вот встроенный HTML. В этом блоке я могу включить изображения, применить стили или сделать что-нибудь еще, что я могу сделать с HTML. Процессоры RD, которые не выводят HTML полностью проигнорирует это. АВТОРСКОЕ ПРАВО Авторские права принадлежат J. Random Hacker, 2005 г. < [электронная почта защищена] >. Разрешается копировать, распространять и/или изменять этот документ в соответствии с условиями лицензии GNU Free Documentation License версии 1.2 или любой более поздней версии, опубликованной Фондом свободного программного обеспечения; без неизменяемых разделов, без текстов на передней обложке и без текстов на задней обложке.

См. также

• Уценка
• Обычная старая документация

Внешние ссылки

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