MakeDoc

MakeDoc är ett lättviktigt märkningsspråk skapat 2000 av Carl Sassenrath för att skapa dokumentation och webbsidor med enkla textnoteringar. Språket används flitigt i REBOL -communityt för dokumentation, webbplatser och wikis.

Översikt

MakeDoc designades ursprungligen för att tillåta författare att skapa formaterad dokumentation utan behov av ordbehandlingsprogram. Alla vanliga textredigerare, inklusive webbinmatningsformulär kan användas för inmatning, och utdata kan vara HTML , PDF eller vanlig text.

Ett ytterligare mål med MakeDoc var att själva textinmatningsformatet skulle vara läsbart – rent med märkningsnoteringar som vanligtvis finns i de SGML -baserade märkningsspråken som HTML och XML . Detta gjordes för att möjliggöra distribution av dokumentation för mjukvarupaket, där sådana dokument ofta visas (eller till och med skapas) i enbart textkommandoskal.

Grundformat

Formatet för MakeDoc är avsett för inmatning och redigering från alla textredigerare, inklusive de som ofta används i skalmiljöer, som vi och Emacs .

Titlar, rubriker och stycken

Dokumentets titel Valfri pannplåt som författarens namn, datum etc. === Primära rubriker Detta är ett exempelstycke. All denna text kommer att finnas kvar i samma stycke tills en tom rad nås. Detta är ett separat stycke. --- Underrubrik Text fortsätter härifrån...

Kommandorader

Punkter, numeriska listor, definitioner och andra speciella dokumentformat noteras genom att en rad börjar med ett specialtecken.

Till exempel:

*Punktpost *Another #Numred item #Another numbered item

Andra kommandorader börjar med en lika (=) följt av själva kommandot.

Till exempel, för att inkludera en bild:

=bild nyc.jpg

Många andra kommandon tillhandahålls också. Se referenslänkarna nedan.

Specialkommandon

Språket tillåter också utvärdering (exekvering) av kodsektioner för att producera resultat till exempel eller utdatabilder. Detta gör det möjligt att exakt generera kodsektioner som innehåller korrekta resultat.

Till exempel, om kommandot:

=vy

följer ett kodexempel kommer processorn automatiskt att generera en bild av vilken kod som helst som visas i dess fönster.

Bearbetar språket

MakeDoc-språket bearbetas med ett gratis skript under en öppen BSD-licens . Dess källkod är skriven på REBOL-språket och är bara cirka 17KB.

Processorn är uppdelad i en textinmatningsskanner och en utgångsgenerator. Skannerutgången är i REBOL-blockformat och kan matas in i en av flera utgångsformaterare.

Utdatageneratorn för HTML ingår i det vanliga MakeDoc-skriptet. Utdatageneratorer för PDF är separata.

Se även

• Lättviktigt märkningsspråk
• MakeDoc Pro (gratis tillägg till MakeDoc)