Ruby formát dokumentu - Ruby Document format
Tento článek obsahuje a seznam doporučení, související čtení nebo externí odkazy, ale její zdroje zůstávají nejasné, protože jí chybí vložené citace.Říjen 2009) (Zjistěte, jak a kdy odstranit tuto zprávu šablony) ( |
RD (Ruby Document) je a lehký značkovací jazyk pro psaní Rubín Související dokumenty. Může být vložen do zdrojového kódu Ruby.
RD je tradiční formát. V moderní Ruby mají vývojáři tendenci psát dokumenty RDoc místo RD.
Použití
Původně byla většina dokumentace ve světě Ruby, včetně samotné Ruby, napsána v RD. Poté v roce 2002 byla velká část převedena do formátu RDoc. I když, japonská verze Referenční příručka Ruby stále zůstává ve formátu RD.
RD je navržen tak, aby byl psán ručně a snadno čitelný v surové podobě. Většina koncových uživatelů to však po převodu na HTML nebo manuálové stránky.
RD lze vložit do Ruby kódu a příponu mají obvykle čisté soubory RD .rd
.
Ukázkový dokument RD
Tento dokument je syntakticky správný RD, který se pokouší dodržovat také hlavní konvence týkající se pojmenování oddílů.
Zdroj | Výsledek HTML |
---|---|
= begin = NAMERD sample - A sample RD document = SYNOPSIS here.is_a? (Piece :: Of :: Code) print << "END" Tento odsazený blok nebude prohledán kvůli formátovacím kódům nebo směrnicím a mezery budou zachovány. KONEC = POPIS Tady je normální text. Zahrnuje text, který je ((* zdůrazněn *)), ((% keyboard%)), (({code})) - formátovaný, ((| | variabilní část |)), ((: indexováno :)) a ( ('as-is')) ((- poznámka pod čarou -)). == Příklad seznamu * Toto je seznam s odrážkami. * Zde je další položka. * Vnořená položka seznamu. == Objednaný seznam (1) Toto je první položka (2) druhá * Vnořený neuspořádaný seznam. (3) třetí (1) Vnořený seřazený seznam (2) její druhá položka = konec = začátek html | NÁZEVUkázka RD - Ukázka dokumentu RD SYNOPSEhere.is_a? (Piece :: Of :: Code) print << "END" Tento odsazený blok nebude prohledán na formátovací kódy nebo směrnice a mezery budou zachovány.END POPISTady je normální text. Obsahuje text, který jezdůrazněno, klávesnice, Příklad seznamu
Objednaný seznam
AUTORSKÁ PRÁVACopyright 2005 J. Random Hacker |
Viz také
externí odkazy
- RDtool - Rámec pro překlad dokumentu RD do jiných formátů.
- rd-draft.rd - úplný popis značkovacího jazyka RD (ve formátu RD)
- rd-draft.html - úplný popis značkovacího jazyka RD (převedený do HTML)
Tento programovací jazyk související článek je a pahýl. Wikipedii můžete pomoci pomocí rozšiřovat to. |