RapiDoc 1.0 Handbuch


Inhalt



1 Vorwort

2 Installation 3 Benutzung

4 Sprachumfang 5 Rechtliches

6 Kontakt

1 Vorwort

RapiDoc ist ein Programmpaket, das die Erstellung von PDF-Dokumenten stark vereinfacht. Die Dokumente werden in der RapiDoc Dokumentenbeschreibungssprache geschrieben. Ein Compiler übersetzt diese in ein speziell optimiertes HTML-Dokument, welches mittels HTMLDOC ins PDF-Format konvertiert wird.
Der Compiler selbst ist in REBOL geschrieben, einer Interpretersprache, die für mehr als 40 Plattformen verfügbar ist. HTMLDOC ist ein HTML->PDF-Konverter, der auch für viele Plattformen verfügbar ist. Der RapiDoc-Compiler übersetzt die RapiDoc-Dokumente in HTML-Code, der für die Eingabe in HTMLDOC optimiert ist.
Auch wenn RapiDoc bei weitem nicht die Möglichkeiten bietet wie Tex oder HTML selbst, so ist es doch ein Werkzeug, mit dem sich schnell und ohne große Einarbeitungszeit eine Vielzahl von Dokumenten erzeugen lassen. Dieses Dokument ist selbst in RapiDoc verfaßt und vermittelt einen guten Eindruck, was damit machbar ist.
RapiDoc bietet:
Was fehlt ?

2 Installation

Benötigt werden zwei externe Programmpakete:

2.1 Rebol

Benötigt wird der Rebol/View Interpreter.ab Version 1.2 Da für einige Plattformen (Windows CE, Elate) lediglich Rebol/Core existiert, kann ich bei Bedarf eine angepaßte Version erstellen.
Hinweis für MorphOS User: Die AmigaOS Version sollte eigentlich auch unter MorphOS funktionieren.
Download unter
http://www.rebol.com

2.2 HTMLDOC

Getestet wurde mit Version 1.8.19. Ältere Versionen sollten eigentlich auch gehen.
HTMLDOC für
kann direkt unter
http://www.easysw.com/htmldoc/htmldoc.html
heruntergeladen werden
Die Portierungen für
gibt es unter
http://fr3dy.meanmachine.ch
Die Bezugsadressen für andere Plattformen (MacOS,BeOS,QNX...) sind mir leider nicht bekannt.

3 Benutzung

Aufruf: 
 rebol rapidoc.r Eingabedatei

Eingabedatei ist der Pfad (Syntax wie unter dem verwendeten Betriebssystem üblich) des RapiDoc Dokuments.
Eine Datei eingabedatei.htm wird generiert.
Dann kann man mittels htmldoc dieses in ein strukturiertes HTML-, PostScript- oder PDF DoKument konvertieren.

4 Sprachumfang

4.1 Titel

Jedes Dokument beginnt mit einer Zeile, die es als RapiDoc Dokument identifiziert. 
 %RapiDoc%

Optional kann dahinter der Titel des Dokuments angegeben werden: 
 %RapiDoc% RapiDoc - eine Einführung und mehr...

4.2 Überschriften

Überschriften sind von besonderer Bedeutung, da sie auch die logische Struktur eines Dokuments festlegen. Es gibt 6 verschiedene Hierarchiestufen. Diese müssen sauber ineinander geschachtelt sein. Es dürfen keine Hierarchieebenen übersprungen werden.
Um diese Struktur zu erhalten: 
 Kapitel1
   Abschnitt1.1
     Unterabschnitt1.1.1
     Unterabschnitt1.1.2
   Abschnitt1.2
 Kapitel2
   Abschnitt2.1
 Kapitel3

ist folgender Code notwendig: 
 111 Kapitel1


 222 Abschnitt1.1


 333 Unterabschnitt1.1.1


 333 Unterabschnitt1.1.2


 222 Abschnitt1.2


 111 Kapitel2


 222 Abschnitt2.1


 111 Kapitel3

4.3 Absätze

Grundsätzlich wird Text als Fließtext behandelt. Zeilenumbrüche werden ignoriert. Möchte man einen neuen Absatz beginnen, so fügt man einfach eine Leerzeile im Text ein: 
 Dies ist der Text vom ersten Absatz.


 Und hier folgt der zweite Absatz.

ergibt:
Dies ist der Text vom ersten Absatz.
Und hier folgt der zweite Absatz.

4.4 Manueller Seitenumbruch

Grundsätzlich wird bei jedem Kapitel (Überschrift 1.Ordnung) eine neue Seite begonnen. Man kann aber auch jederzeit einen zusätzlichen Seitenumbruch erzwingen. 
 Hier steht etwas Text.


 ---


 Dieser Text steht auf einer neuen Seite

4.5 Aufzählungen

Aufzählungen beginnen und enden mit jeweils einer Leerzeile. Zwischen den einzelnen Punkten dürfen keine Leerzeichen stehen !
Aufzählungen können nicht geschachtelt werden.

4.5.1 ohne Numerierung

 * Punkt Eins
 * Punkt Zwei
 * Punkt Drei

ergibt:

4.5.2 mit Numerierung

 # Punkt Eins
 # Punkt Zwei
 # Punkt Drei

ergibt:
  1. Punkt Eins
  2. Punkt Zwei
  3. Punkt Drei

4.6 Quellcode-Passagen

Dabei handelt es sich um Text, der in einer nonproportionalen Schrift dargestellt wird. Sämtliche Leerzeichen und Zeilenumbrüche werden unverändert in die Ausgabe mit übernommen.
Um solche Passagen zu erzeugen, einfach die Textzeilen mit einem Leerzeichen beginnen.
Sämtliche Quelltextdarstellungen in diesem Dokument wurden auf diese Art und Weise erstellt.

4.7 Kommentare

Kommentare sind Textzeilen, die nicht in die Ausgabe mit übernommen werden. 
 Zeile 1


 !!! Dies ist ein Kommentar


 Zeile 2

ergibt:
Zeile 1
Zeile 2

4.8 URL-Verweise

Um einen Verweis auf eine externe Quelle anzugeben, muß man eine Zeile mit :// beginnen, gefolgt vom eigentlichen URL der Quelle und einem Text für die Beschriftung des Verweises. 
 :// http://www.holzammer.net Meine private Homepage

ergibt:
Meine private Homepage

4.9 Grafiken

Grafiken werden immer in Form eines eigenen Absatzes eingebunden. Textumfluß ist nicht möglich !
Diese können linksbündig, zentriert oder rechtsbündig angeordnet werden. 
 linksbündig:


 %<example.jpg


 zentriert:


 %| example.jpg


 rechtsbündig:


 %> ./example.jpg

ergibt:
linksbündig:


zentriert:


rechtsbündig:


Pfadangaben für Grafiken können sowohl in Form von URLs als auch lokalen Pfadangaben (Unix-Syntax) angegeben werden. Bei lokalen Pfadangaben sollte man auf absolute Pfade möglichst verzichten !
Als Grafikformate kommen in Betracht:

5 Rechtliches

© 2001-2002 Jean Holzammer
Dieses Programm ist Freeware.
Man darf es kostenlos benutzen, sowohl für private als auch kommerzielle Zwecke, mit folgenden Ausnahmen:
  • Öffentliche Institutionen von Staaten , die Menschenrechte nicht achten, z.B. Staaten, die die Todesstrafe vollziehen
  • Militärische Zwecke
  • Kriminelle Zwecke
    • Das Software-Paket darf nur vollständig und unverändert weitergegeben werden.
    Wenn die Verteilung kommerziell erfolgt, darf man nicht mehr als 1 EUR per Diskette bzw. 5 EUR per CD/DVD verlangen.
    Andernfalls benötigt man meine explizite Erlaubnis !
    Erlaubnis wird hiermit ausdrücklich erteilt für Aminet CD-ROMs und Aminet Set CD-ROMs.
    Die Benutzung dieses Programm erfolgt auf eigene Gefahr ! Es wird keinerlei Haftung übernommen !

    6 Kontakt

    Fragen beantworte ich gern. Und für Anregungen bin ich immer dankbar.
    So kann man mich erreichen:
    Name:
    Jean Holzammer
    E-Mail:
    Development@Holzammer.net
    WWW:
    www.Holzammer.net