|
|||
| Forrige < |
Innhold ^
|
Neste >
|
|
| Figur A.1: rd kildefil |
|
| Figur A.2: Utput fra kilden i figur A.1 |
 |
rdtool, en samling Ruby verktøy som kan konvertere
denne dokumentasjonen til forskjellige format.
rdtool søker gjennom en fil på jakt etter =begin og =end par
og tar tak i teksten den finner mellom alle parene. Verktøyet antar at teksten
er i RD-format og den blir deretter omformet ut fra et enkelt sett av regler:
= Toppnivå overskritf == Underoverskrift ... |
Dette er normal tekst * starten på et punkt går over flere linjer * og et annet punkt * nøsted punkt * nok et nøstet punkt * tredje punkt på topp-nivå |
(1) Et nummerert punkt * underpunkt i en punktliste * underpunkt (2) Andre nummererte punkt (9) Denne vil faktisk bli merket med '3.' |
: rødt når lyset er rødt, må du stoppe : gult det gule lyset betyr at noe skal til å endre seg. Enten: * gi masse gass eller * trå inn bremsen : grønn grønn betyr KJØR |
| Sekvens | Eksempel | Brukes til | ||||||
| ((*utheving*)) | utheving | Utheving (vanligvis kursiv) | ||||||
| (({programkode})) |
programkode
|
Programkode | ||||||
| ((|variabel|)) | variabel | Variabelnavn | ||||||
| ((%tast meg%)) |
tast meg
|
Innput fra tastatur | ||||||
| ((:indekseringsterm:)) | indekseringsterm | Noe som skal indekseres | ||||||
| ((<referanse>)) | referanse | Hypertekstreferanse | ||||||
| ((-fotnote-)) | tekst.4 | Fotnoter. En referanse plasseres i hvor fotnoten forekommer, og selve innholdsteksten til fotnoten befinner seg på bunnen av siden. | ||||||
| (('verb')) | verb | Verbatim tekst | ||||||
 |
||||||||
((<...>)) konstruksjonen.
= Synopsis
...
See ((<Return Codes>)) for details.
..
== Instance Methods
--- Tempfile.open( filename )
Opens the file...
== Return Codes
..
The method ((<Tempfile.open>)) raises an (({IOException}))...
|
rdtool forsøke å formatere
det som en ekstern hypertekstlenke.
Referansen ((<visningsdel|merkelapp>)) lager en lenke til
merkelapp med plasserer teksten ``visningsdel'' i det genererte dokumentet.
Dette blir brukt i beskrivelsesdelen av eksempelet i
figur A.1 på side 512
for å lage referanse til metodenavnene:
perspective, apart from the unusual ((<(({new}))|Tempfile.new>)),
...
|
Tempfile.new.
rdtool gjør visse antagelser om hvordan metodenavn formateres.
Klasse- eller modulmetoder bør skrives som Klasse.metode,
instansmetoder som Klasse#metode og klasse- eller modulkonstanter
som Klasse::Konstant.
--- Tempfile::IOWRITE Open the file write-only. ... --- Tempfile.new( filename ) Constructs a temporary file in the given directory. The file ... --- Tempfile#open Reopens ((|aTempfile|)) using mode ``r+'', which allows reading .. |
<<< filnavn |
.rd eller .rb
vil den bli behandlet som RD-dokumentasjon.
Dersom filnavnet ikke har noen endelse vil rdtool lete etter
en fil med en endelse som passer med typen dokumentasjon som generes
(.html for HTML-filer, .man for man-filer og så videre)
og interpolere den filens innhold i utputstrømmen.
Dermed vil en linje som:
<<< hode |
.rd). Disse filene behandles ved hjelp av
rd2-kommandoen for å lage passende utput.
rd2 [
opsjoner
] innputfil [ >utputfil ]
|
-r
format
|
Velg et utputformat.
-rrd/rd2html-lib.rb produserer HTML (og er standardvalget)
-rrd/rd2man-lib.rb produserer Unix man-sider. |
-o
navn
|
Setter stammen til utputfilnavnet. |
--help
|
Lister alle opsjonene. |
rdtool stadig utvikling.
Det er høyst sannsynlig at noen av detaljene vi har gitt her vil ha gått
ut på dato (eller være feil) innen du leser dette.
Inkludert i rdtool-distribusjonen er filen README.rd.
Vi foreslår at du gjør som filenavnet ber deg, slik at den kan gi deg
siste nytt innen produksjon av Ruby-dokumentasjon.
| Forrige < |
Innhold ^
|
Neste >
|