/doc/German/userguide-de/userguide-de.t2t
http://txt2tags.googlecode.com/ · Unknown · 1863 lines · 1243 code · 620 blank · 0 comment · 0 complexity · 69056791580169b49ae3f04526d4a962 MD5 · raw file
Large files are truncated click here to view the full file
- Txt2tags Benutzerhandbuch
- Aurelio, %%mtime(%c)
- άbersetzung von Andreas Deininger
- %!target: html
- %!options: --toc --toc-level 2 --css-sugar
- %%!options: -o ../../../web/userguide/userguide.html
- % TRANSLATOR:
- % - Don't worry about the PDF cover page
- % - Don't worry about PDF at all, translate and check on HTML
- % - Don't worry about the images
- % TRANSLATOR uncomment the next line
- %%!options: -o benutzerhandbuch.html
- % TRANSLATOR uncomment the next line to use images on the same folder
- %!preproc: IMGPATH img-lowres
- % TRANSLATOR:
- % You can take new screenshots and make new images for the program
- % interface and "first conversion" section. Remember to send them
- % to the author!
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %%% activate those lines when converting to HTML for PDF generation
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- %%% htmldoc does TOC
- %!options(html): --no-toc --no-css-sugar -o userguide-pdf.html
- %%% mask the 'nopdf' marks so they will not be removed
- %!preproc(html): ^%nopdf %yespdf
- %%% removing first header, htmldoc ignores all until next <H1> (cool!)
- %!postproc(html): '<H1>Txt2tags Benutzerhandbuch</H1>' ''
- %%% imagens are in the same dir
- %!preproc: IMGPATH .
- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- % normalizing common text
- %!preproc: CONFAREA Konfigurationsbereich
- %!preproc: HEADAREA Kopfbereich
- %!preproc: BODYAREA Textbereich
- %!preproc: MARKPROP **Eigenschaften:**
- %!preproc: MARKCONT **Enthδlt:**
- %!preproc: MARKDESC **Beschreibung:**
- %!preproc: MARKSYN **Syntax:**
- %!preproc: MARKDET **Details:**
- %!preproc: NOMARKS Markierungen werden NICHT ausgewertet
- %!preproc: NOMACRO Makros werden NICHT ausgewertet
- %!preproc: URLMARKUP http://txt2tags.org/markup.html
- % activate the areas disabled on the PDF version
- %!preproc(html): ^%nopdf ''
- % remove separator lines and strong lines
- %!preproc(html): '^ *--------*' ''
- %!preproc(html): '^ *========*' ''
- % highlight NEW topic on TOC
- %%!postproc(html): '(<LI>.*Makros beherrschen lernen</A>)$' '\1 <b>[NEU!]</b>'
- %%% Little clean up for less large tables
- %!postproc: /pessoal/sourceforge.net ''
- % border for all images
- %!postproc: '(<IMG [^>]*BORDER)="0"' '\1="1"'
- %%% Embedded CSS code (ugly not?)
- %
- %!postproc(html): ^<HEAD>$ '<HEAD>\n<STYLE TYPE="text/css">\n@#@'
- %!postproc(html): (@#@)$ 'body {background-color:#ddeeff; color:black; \n\1'
- %!postproc(html): (@#@)$ ' margin:3em; text-align:justify;} \n\1'
- %!postproc(html): (@#@)$ '#header {text-align:center;} \n\1'
- %!postproc(html): (@#@)$ '.toc {border:1px solid black;padding:9px;\n\1'
- %!postproc(html): (@#@)$ ' background-color:white;} \n\1'
- %!postproc(html): (@#@)$ '.toc li{list-style-type: none;} \n\1'
- %!postproc(html): (@#@)$ 'a {text-decoration:none;}\na:hover {color:red;}\n\1'
- %!postproc(html): (@#@)$ 'a:visited {color:purple;}\ndl {margin:1em;} \n\1'
- %!postproc(html): (@#@)$ '#body h1 {text-align:center; color:white; \n\1'
- %!postproc(html): (@#@)$ ' background-color:blue; padding:8px;} \n\1'
- %!postproc(html): (@#@)$ 'h2 {padding-top:20px;}\nhr {border-style:none;}\n\1'
- %!postproc(html): (@#@)$ 'code {background-color:lightblue;} \n\1'
- %!postproc(html): (@#@)$ 'blockquote {border:1px solid black;padding:9px;\n\1'
- %!postproc(html): (@#@)$ ' background-color:white;} \n\1'
- %!postproc(html): (@#@)$ 'table {border-style:solid; border-color:black;}\n\1'
- %!postproc(html): (@#@)$ 'th {background-color:lightblue; padding:.5em;} \n\1'
- %!postproc(html): (@#@)$ 'td {border-style:none; background-color:white;}\n\1'
- %!postproc(html): (@#@)$ 'pre {border-style:solid; border-width:1px 1px; \n\1'
- %!postproc(html): (@#@)$ ' background-color:lightblue; padding:8px; \n\1'
- %!postproc(html): (@#@)$ ' border-color:black;} \n\1'
- %!postproc(html): @#@$ </STYLE>
- % 26/Nov/2003: revised by anamimts
- % 26/Jun/2004: updated to v2, new embedded CSS
- % 17/Jul/2004: revised by anamimts
- % 01/Nov/2004: updated to v2.0 and 2.1, new chapters, PDF version
- % TODO Mastering Options [option-help], [option-css-sugar], ...
- ========================================================================
- %nopdf "Hallo! Hier kommt das txt2tags Benutzerhandbuch. Sie finden hier alle
- %nopdf Informationen zum Textkonvertierunsgwerkzeug txt2tags. Die neuste
- %nopdf Version ist stets erhδltlich bei http://txt2tags.org/userguide/.
- %nopdf Fόr ergδnzende Informationen besuchen sie bitte
- %nopdf [die txt2tags Webseite http://txt2tags.org]. Viel Spaί!"
- %nopdf
- %nopdf [Download PDF-Version http://txt2tags.org/userguide/benutzerhandbuch.pdf]
- ========================================================================
- %nopdf%**Dieses Benutzerhandbuch enthδlt:**
- %%toc
- ========================================================================
- = Teil I - Einfόhrung in txt2tags =[Einfuehrung]
- == Die ersten Fragen, die sich ihnen stellen ==[Erste-Fragen]
- Dieses Kapitel bietet einen άberblick όber txt2tags, in dem das Programm, dessen Zweck und dessen Mφglichkeiten vorgestellt werden
- ------------------------------------------------------------------------
- === Worum handelt es sich? ===
- Txt2tags ist ein Werkzeug zur Textformatierung und -konvertierung.
- Txt2tags konvertiert ein ASCII-Text Datei mit einigen wenigen Auszeichnungen zu jedem der unterstόtzten Ausgabeformate:
- - HTML Dokument
- - XHTML Dokument
- - SGML Dokument
- - LaTeX Dokument
- - UNIX man page
- - Magic Point Prδsentation
- - MoinMoin Seite
- - PageMaker 6.0 Dokument
- - ASCII-Text (keine Auszeichnungen)
- ------------------------------------------------------------------------
- === Wieso sollte ich txt2tags benutzen? ===
- txt2tags kann fόr sie sehr nόtzlich sein, wenn sie:
- - Dokumente in verschiedenen Formaten verφffentlichen mόssen
- - fόr das Update von Dokumenten in verschiedenen Formaten verantwortlich sind
- - technische Dokumentationen oder Handbόcher verfassen mόssen
- - nicht wissen, wie sie ein Dokument in einem bestimmten Format schreiben sollen
- - keinen speziellen Editor fόr ein bestimmtes Format besitzen
- - mit einem einfachen Texteditor ihre Dokumente aktualisieren wollen
- Die hauptsδchliche Motivation hinter all dem ist:
- - Sparen sie Zeit, schreiben sie **Inhalte** und vergessen Sie die **Formatierung**
- ------------------------------------------------------------------------
- === Was zeichnet txt2tags gegenόber δhnlichen Werkzeugen aus? ===
- Txt2tags wird sehr geradlinig erweitert, basierend auf grundlegenden Konzepten.
- Das sind die wichtigsten Merkmale:
- | //Quellcode gut lesbar// | Txt2tags Auszeichnungen sind sehr einfach und in natόrlicher Weise gehalten.
- | //Erzeugtes Dokument lesbar// | Ebenso wie der Quellcode ist auch das erzeugte Dokument gut lesbar, mit Einrόckungen und kurzen Zeilenlδngen.
- | //Konsistente Auszeichnungen// | Txt2tags Auszeichnungen sind sehr spezifisch, sie eignen sich fόr alle Arten von Dokumenten und kφnnen dennoch nicht mit den eigentlichen Inhalten des Dokuments verwechselt werden.
- | //Konsistente Regeln// | Ebenso einfach wie die Auszeichnungen selbst sind auch die Regeln, wie die Auszeichnungen miteinander verknόpft sind, es gibt keine "Ausnahmen" oder "Spezialfδlle".
- | //Einfache Strukturen// | Alle unterstόtzten Formatierungen sind **einfach**, ohne zusδtzlich Optionen oder sonstige komplizierte Schalter. Eine Auszeichnung ist lediglich eine Auszeichnung, ohne jegliche Optionen.
- | //Einfach zu erlernen// | Aufgrund der einfachen Auszeichnungen und da der Quellcode lesbar ist, weist txt2tags eine flache, benutzerfreundliche Lernkurve auf.
- | //Hόbsche Beispiele// | Die **Bespieldateien**, welche in dem Paket enthalten sind, geben reale Beispiele fόr einfache und auch komplexe Dokumente, die fόr und mit txt2tags geschrieben wurden.
- | //Wertvolle Werkzeuge// | Die **Syntax-Dateien**, welche in dem Paket enthalten sind (fόr die Editoren vim, emacs, nano and kate), unterstόtzen sie beim Verfassen fehlerfreier Dokumente.
- | //Drei Benutzerschnittstellen// | Es existieren eine sehr benutzerfreundliche **grafische Tk-Oberflδche**, eine **Webschnittstelle**, um das Programm im Inter- oder Intranet zu nutzen und eine **Kommandozeilen Version** des Programms fόr fortgeschrittene Benutzer sowie fόr das Skripting.
- | //Skripting// | άber den mδchtigen Kommandozeilen-Modus kφnnen erfahrene Benutzer bestimmte Aufgaben **automatisieren** sowie konvertierte Dateien **nachtrδglich verδndern**.
- | //Download und Aufruf / mehrere Plattformen// | Txt2tags ist ein einfaches **Python Skript**. Es braucht nicht kompiliert zu werden und benφtigt keine zusδtzlichen Module. Insofern lδuft es problemlos auf *NIX, Linux, Windows und Macintosh Computern.
- | //Regelmδίige Updates// | Das Programm hat eine aktive Mailingliste, όber die Benutzer Korrekturen und Verbesserungen vorschlagen kφnnen. Der Autor selbst nutzt das Programm ausgiebig sowohl beruflich als auch privat, insofern wird die Entwicklung nicht kurzfristig eingestellt werden.
- ------------------------------------------------------------------------
- === Muss ich fόr das Programm bezahlen? ===
- || Definitiv NEIN! |
- Es ist frei, GPL, Open Source, Public Domain,
- //<setzen sie hier ihr Lieblings-Schlagwort ein>//.
- Sie kφnnen das Programm kopieren, benutzen, verδndern, verkaufen und es sogar als das ihrige verφffentlichen. Fragen des Copyrights und der Softwarelizenzierung sind fόr den Autor von nachrangiger Bedeutung.
- ------------------------------------------------------------------------
- == Unterstόtzte Auszeichnungsstrukturen ==[Strukturen]
- Nachfolgend eine Aufzδhlung aller von txt2tags unterstόtzten Strukturen.
- - Kopfbereich (Titel des Dokuments, Name des Autors, Datum)
- - Abschnittstitel (nummeriert oder nicht nummeriert)
- - Absδtze
- - Schriftarten
- - fett
- - kursiv
- - unterstrichen
- - Schreibmaschinenschrift (fόr Originaltext)
- - Originaltext innerhalb eines Absatzes
- - einzelne Originaltext-Zeile
- - Originaltext-Bereich (mehrere Zeilen umfassend)
- - Bereich fόr ein Zitat
- - Verknόpfungen
- - URL/Internet Verknόpfungen
- - E-Mail Verknόpfungen
- - lokale Verknόpfungen
- - benannte Verknόpfungen
- - Listen
- - Aufzδhlungslisten
- - nummerierte Listen
- - Definitionslisten
- - horizontale Trennlinien
- - Bilder (ausgerichtet)
- - Tabellen (mit oder ohne Rahmen, ausgerichtet, όber mehrere Spalten hinweg)
- - Spezielle Auszeichnung fόr rohen Text (wird nicht geparst)
- - Spezielles Makro fόr das aktuelle Datum (mit flexibler Formatierung)
- - Kommentare (fόr Notizen, Aufgabenlisten, Fehlerbeschreibungen etc.)
- ------------------------------------------------------------------------
- == Unterstόtzte Ausgabeformate ==[Zielformate]
- : **HTML**
- Jeder weiί was HTML ist. (Hinweis: Internet)
- Txt2tags erzeugt standardkonforme HTML Dokumente, die ansprechend aussehen und deren Quelltext gut lesbar ist. Es nutzt KEIN Javascript, keine Frames und auch keine sonstigen όberflόssigen Formatierungstechniken, die fόr einfache, technische orientierte Dokumente auch gar nicht gebraucht werden. Falls gewόnscht, kann allerdings eine getrennte CSS-Datei genutzt werden. Txt2tags erzeugt Code konform zum "//HTML 4.0 Transitional//"-Standard.
- Seit Version 2.0 ist der von txt2tags erzeugte HTML-Code 100% standardkonform, dies kann mit dem [W3C-Validator http://validator.w3.org/] όberprόft werden.
- : **XHTML**
- Dies ist die neue HTML-Generation mit einem strikteren Regelwerk, so mόssen etwa alle Tags, die geφffnet wurden, auch wieder geschlossen werden. Dadurch kann der Code einfacher geparst und verstanden werden. Von Aufgabenzweck her gesehen kann es grob generalisierend auch als HTML angesehen werden. Txt2tags erzeugt Code konform zum "//XHTML 1.0 Transitional//"-Standard.
- Seit Version 2.0 ist der von txt2tags erzeugte XHTML-Code 100% standardkonform, dies kann mit dem [W3C-Validator http://validator.w3.org/] όberprόft werden.
- : **SGML**
- Dies ist ein verbreitetes Dokumentenformat fόr welches mit den [sgmltools http://www.sgmltools.org] mδchtige Anwendungen zur Konvertierung bereitstehen. Aus einer SGML-Datei kφnnen HTML-, PDF-, Postscript-, info, LaTeX, Lyx, RTF- sowie XML-Dokumente erzeugt werden. Die sgml2*-Werkzeuge erzeugen dabei automatisch Inhaltsverzeichnisse und kφnnen einzelnen Abschnitte auf getrennten Seiten anordnen (sgml2html).
- Txt2tags erzeugt SGML Dateien die vom Systemtyp her linuxdoc Quellen gleichen, diese sind dafόr geeignet, unmittelbar mit sgml2* Werkzeugen konvertiert zu werden, hierfόr werden keine zusδtzlichen Katalogdateien benφtigt und auch sonst sind keine weiteren Anforderungen seitens des SGML-Standards vonnφten.
- : **LATEX**
- Dieses im akademischem Bereich bevorzugte Dokumentenformat ist leistungsfδhiger als sie es zu trδumen wagen. Komplette Bόcher, komplizierte Formeln und jeder noch so komplexe Text kann in LaTeX verfasst werden. Aber seien sie darauf gefasst sich ihre Haare auszuraufen, wenn sie versuchen, die Auszeichnungen per Hand zu schreiben ...
- Txt2tags erzeugt kompilierfδhige LaTeX Quelldateien und όbernimmt dabei all die komplexen Maskierungsaufgaben und die sonstigen Ausnahmen. Sie als Autor mόssen sich nur noch um den Text selbst kόmmern.
- : **LOUT**
- Δhnlich leistungsstark wie LaTeX, aber mit einer einfacheren Syntax, welche ein "@"-Zeichen anstelle des "\"-Zeichens verwendet und in den meisten Fδllen ohne das Setzen von Klammern auskommt. Der Ansatz "Alles ist ein Objekt" macht die Auszeichnung sehr viel weniger komplex.
- Txt2tags erzeugt gebrauchsfertige Lout Dateien, welche mittels des "lout"-Kommandos zu Postscript- oder PDF-Dateien konvertiert werden kφnnen.
- : **MAN**
- UNIX man pages blieben όber all die Jahre bestehen. Dokumentenformate kommen und gehen, man pages bleiben im Gegensatz dazu in Gebrauch, sie sind nicht zu verdrδngen.
- Es gibt andere Werkzeuge um man Dokumente zu erzeugen, aber txt2tags hat
- einen entscheidenden Vorteil: ein einziger Quelltext, vielerlei Zielformate. So kφnnen die Inhalte der man-page genau so gut in eine HTML-Seite, eine Magic Point- Prδsentation, etc. konvertiert werden.
- : **MGP**
- [Magic Point http://www.mew.org/mgp] ist ein sehr praktisches Prδsentationswerkzeug (δhnlich Microsoft PowerPoint), die einzelnen Folien werden dabei mittels einer Auszeichnungssprache definiert. Auf diese Weise kφnnen komplexe Prδsentationen in einem Editor erzeugt werden (etwa mittels vi/emacs/notepad).
- Txt2tags erzeugt gebrauchsfertige .mgp Dateien, in denen bereits alle notwendigen Kopfzeilen fόr Schriften und fόr das generelle Erscheinungsbild definiert sind, Unterstόtzung fόr Akzente nach ISO-8859 inbegriffen.
- **BONUS 1:** von txt2tags erzeugte .mgp Dateien nutzen XFree86 Type1
- Schriftarten! Dies bedeutet, dass sie keine zusδtzlichen TrueType Schriftart-Dateien fόr ihre Prδsentation benφtigen.
- **BONUS 2:** die Farbdefinitionen fόr die Schriftarten sind so gewδhlt, dass selbst auf Systemen, auf denen nur eine geringe Farbtiefe zur Verfόgung steht (gestartet mit ``startx -- -bpp 8``), die Prδsentation dennoch ansprechend aussieht!
- Das Schlόsselprinzip: Konvertieren und benutzen. Keine aufwδndigen Anpassungen oder sonstigen Anforderungen sind vonnφten.
- : **MOIN**
- Sie wissen nicht was [MoinMoin http://moin.sourceforge.net] ist?
- Es ist ein [WikiWiki http://www.c2.com/cgi/wiki]!
- Die Moin Syntax ist nicht sonderlich adrett, insbesondere da stδndig
- ``{{{'''''Klammern und Hochzeichen'''''}}}``, hinzugefόgt werden mόssen. Auch hier bietet txt2tags mit seinen einfachen Auszeichnungen eine universelle Lφsung: ein Quelltext, vielerlei Zielformate.
- : **PM6**
- I wette sie wussten das noch nicht, aber tatsδchlich hat Adobe PageMaker 6.0 eine eigene Auszeichnungssprache! Schriftarten und -stile, Farbtabellen und die meisten anderen, όber Mausklick auswδhlbaren Eigenschaften sind in dieser Auszeichnungssprache verfόgbar. Der Import eines solchen Texts erfolgt όber den Menόpunkt "Import tagged text". Ein Hinweis am Rande: es handelt sich um ein <HTML "δhnliches"> Auszeichnungsformat.
- Txt2tags erzeugt all diese Auszeichnungen und definiert zusδtzlich einen umfangreichen, funktionierenden Kopfbereich, in dem Absatzformate und -formatierungen gesetzt werden. Dies ist dabei der aufwδndigere Teil. **ACHTUNG:** Keine Zeilenumbrόche! Jeder Abschnitt muss eine einzelne Zeile umfassen.
- Anmerkung des Autors:
- //Mein gesamtes, in portugiesisch verfasstes [Buch όber regulδre Ausdrόcke http://guia-er.sf.net]//
- //wurde im Editor VI geschrieben, mit txt2tags in das PageMaker-Format konvertiert und ging anschlieίend in//
- //Druck.//
- : **TXT**
- TXT ist Text. Der einzig wahre Formatierungs-Typ.
- Obwohl die txt2tags Auszeichnungen sehr intuitiv und unauffδllig sind, kφnnen sie entfernt werden, indem die Quelldatei in reinen ASCII-Text konvertiert wird.
- Titelzeilen sind dabei unterstrichen, und der Text ist mehr oder weniger der gleiche wie in der Quelltext-Datei.
- ------------------------------------------------------------------------
- == άbersicht όber die je nach Zielformaten unterstόtzten Strukturen ==[unterstuetzte-Strukturen]
- || Struktur | html | xhtml | sgml | tex | lout | man | mgp | moin | pm6 | txt |
- | Kopfzeile | J | J | J | J | J | J | J | N | N | J |
- | Abschnittstitel | J | J | J | J | J | J | J | J | J | J |
- | Absδtze | J | J | J | J | J | J | J | J | J | J |
- | fett | J | J | J | J | J | J | J | J | J | - |
- | kursiv | J | J | J | J | J | J | J | J | J | - |
- | unterstrichen | J | J | - | J | J | - | J | J | J | - |
- | Schreibmaschine | J | J | J | J | J | - | J | J | J | - |
- | Originaltextzeile | J | J | J | J | J | J | J | J | J | - |
- | Originaltextbereich | J | J | J | J | J | J | J | J | J | - |
- | Zitate | J | J | J | J | J | J | J | J | J | J |
- | Internet Verknόpfungen | J | J | J | - | - | - | - | J | - | - |
- | E-Mail Verknόpfung | J | J | J | - | - | - | - | J | - | - |
- | lokale Verknόpfungen | J | J | J | N | N | - | - | J | - | - |
- | benannte Verknόpfungen | J | J | J | - | - | - | - | J | - | - |
- | Aufzδhlungslisten | J | J | J | J | J | J | J | J | J | J |
- | Nummerierte Listen | J | J | J | J | J | J | J | J | J | J |
- | Definitionslisten | J | J | J | J | J | J | N | N | N | J |
- | Trennlinien | J | J | - | J | J | - | J | J | N | J |
- | Bilder | J | J | J | J | J | - | J | J | N | - |
- | Tabellen | J | J | J | J | N | J | N | J | N | N |
- || Extras | html | xhtml | sgml | tex | lout | man | mgp | moin | pm6 | txt |
- | Bilder ausrichten | J | J | N | N | J | - | J | N | N | - |
- | Tabellenzellen ausrichten | J | J | J | J | N | J | N | J | N | N |
- | mehrspaltige Zellen | J | J | N | N | N | N | N | N | N | N |
- || | Legende
- | **J** | //Unterstόtzt//
- | **N** | //Nicht unterstόtzt (eventuell in zukόnftigen Versionen)//
- | **-** | //Nicht unterstόtzt (in diesem Zielformat nicht mφglich)//
- % | **?** | //Nicht unterstόtzt (Ungewiss, ob eine Realisierung mφglich ist)//
- ------------------------------------------------------------------------
- == Die drei Benutzerschnittstellen: GUI, Web und die Kommandozeile ==[Schnittstellen]
- Da die unterschiedlichen Nutzergruppen verschiedene Bedόrfnisse haben und in verschiedenen Umgebungen arbeiten, ist txt2tags sehr flexibel bezόglich der Art und Weise, wie es aufgerufen werden kann.
- Es existieren drei Benutzerschnittstellen fόr das Programm, jede davon mit mit ihren eigenen Mφglichkeiten und jeweils fόr einen anderen Zweck gedacht.
- - **GUI**: in Tk verfasst, eine Fensteroberflδche zum Anklicken fόr txt2tags .
- - **Web**: in PHP verfasst, gestattet es den Benutzers txt2tags in einem Webbrowser ablaufen zu lassen,wodurch die clientseitige Installation von txt2tags όberflόssig wird.
- - **Kommandozeile**: in Python verfasst, ist dies das Herzstόck des Programms. Alle Optionen sind όber die Optionsschalter der Kommandozeile konfigurierbar.
- ------------------------------------------------------------------------
- === Graphische Tk Schnittstelle ===[GUI]
- Seit Version 1.0 steht eine hόbsche graphische Oberflδche zur Verfόgung, welche unter Linux, Windows, Mac und anderen Systeme lauffδhig ist.
- Das Programm erkennt automatisch, ob ihr System zur Anzeige der graphischen Schnittstelle fδhig ist, und startet diese, falls der Aufruf ohne jegliches Argument erfolgt. Der Aufruf der graphischen Schnittstelle kann auch όber den Aufruf mit der ``--gui``-Option erzwungen werden. Falls irgendwelche Ressourcen fehlen sollten, teilt das Programm ihnen dies mit.
- **Hinweis:** Das Tkinter-Modul ist zwingend erforderlich. Da dieses jedoch bereits standardmδίig in der Python-Distribution enthalten ist, besitzen sie es eventuell schon.
- Die Schnittstelle ist ziemlich einfach und intuitiv:
- [IMGPATH/gui.png]
- + Sie lokaliseren die Quelldatei auf ihrem Datentrδger und deren Optionen werden geladen.
- + Falls die Quelle dann noch leer sein sollte, mόssen sie eine auswδhlen.
- + Zusδtzlich gibt es noch Optionen, die sie gegebenenfalls auswδhlen kφnnen, wobei jedoch keine dieser Optionen zwingend benφtigt wird.
- + Zuletzt, drόcken Sie die Schaltflδche "Umwandlung starten!".
- Sehr praktisch kann es sein, die Option "//Ausgabe an Bildschirm leiten//" auszuwδhlen. Hierdurch kφnnen sie den erzeugten Code in einem separatem Fenster όberprόfen, dabei wird zunδchst noch keine Datei gespeichert. Wenn der erzeugte Code dann ihren Vorstellungen entspricht, kφnnen sie diese Option wieder abwδhlen und die Datei wird gespeichert.
- Die voreingestellten Farben der Schnittstelle kφnnen in der Datei ``~/.txt2tagsrc`` geδndert werden, zur Einstellung muss dabei der Parameter ``%!guicolors`` gesetzt werden. Ein Beispiel:
- ```
- % nutze benutzerdefinierte Farben fόr die graphische Schnittstelle
- % (Hintergrund1, Vordergrund1, Hintergrund2, Vordergrund2)
- %!guicolors: blue white brown yellow
- ```
- ------------------------------------------------------------------------
- === Webschnittstelle ===
- Die Webschnittstelle ist im Internet verfόgbar όber die Adresse
- http://txt2tags.org/online.php. Dort kφnnen sie dass Programm sofort austesten und nutzen, noch bevor sie es dann eventuell herunterladen.
- [IMGPATH/web.png]
- Sie kφnnen die Webschnittstelle auch in ihrem Intranet zur Verfόgung stellen, dadurch brauchen sie dann txt2tags nicht lokal auf allen Rechnern in ihrem Intranet installieren.
- ------------------------------------------------------------------------
- === Kommandozeile als Schnittstelle ===[Kommandozeile]
- Fόr erfahrene Kommandozeilenbenutzer sollte die Ausgabe von --help genόgen:
- ```
- Usage: txt2tags [OPTIONEN] [Quelldateiname.t2t ...]
- -t, --target Typ des Zieldokuments festlegen. Derzeit unterstόtzt:
- html, xhtml, sgml, tex, lout, man, mgp, moin, pm6, txt
- -i, --infile=DATEI DATEI als Quellcodedatei festlegen ('-' fόr STDIN)
- -o, --outfile=DATEI DATEI as the Ausgabedatei festlegen ('-' fόr STDOUT)
- -n, --enum-title Titelzeilen fortlaufend nummerieren (1, 1.1, 1.1.1, etc)
- -H, --no-headers unterdrόcke Kopfzeile, Titel und Fuίzeile
- --headers Kopf-, Fuί- und Titelzeilen anzeigen (Voreinstellung: EIN)
- --encoding Zeichensatz des Zieldokuments (utf-8, iso-8859-1, etc)
- --style=DATEI DATEI zur Definition des Dokumentenstils benutzen (δhnlich HTML CSS)
- --css-sugar CSS-freundliche Auszeichnungen fόr HTML and XHTML-Zieldokumente einfόgen
- --css-inside CSS-Stilinformationen innerhalb des HTML/XHTML Kopfbereichs einfόgen
- --mask-email E-Mail-Adressen verbergen. x@y.z wird umgewandelt in <x (a) y z>
- --toc Inhaltsverzeichnis hinzufόgen
- --toc-only lediglich das Inhaltsverzeichnis ausgeben
- --toc-level=N maximale Nummerierungstiefe im Inhaltsverzeichnis einstellen
- --rc benutzerdefinierte Einstellungsdatei ~/.txt2tagsrc laden (Voreinstellung: EIN)
- --gui Aufruf der graphischen Tk-Schnittstelle
- -q, --quiet stiller Modus, jegliche Ausgaben werden unterdrόckt (auίer Fehlermeldungen)
- -v, --verbose Statusmeldungen wδhrend der Konvertierung ausgeben
- -h, --help diese Hilfeinformation anzeigen und Programm beenden
- -V, --version Programmversion anzeigen und Programm beenden
- --dump-config alle gefundenen Konfigurationsquellen ausgeben
- Abschalten von einzelnen Optionen:
- --no-outfile, --no-infile, --no-style, --no-encoding, --no-headers
- --no-toc, --no-toc-only, --no-mask-email, --no-enum-title, --no-rc
- --no-css-sugar, --no-css-inside, --no-quiet
- Beispiel:
- txt2tags -t html --toc meineDatei.t2t
- Per Voreinstellung wird die Ausgabe der Konvertierung in der Datei 'meineDatei.<target>' gespeichert.
- Benutzen sie --outfile um den Namen der Ausgabedatei festzulegen.
- Wird als Eingabedatei '-' angeben, liest das Programm von STDIN.
- Wird als Eingabedatei '-' angegeben, erfolgt die Ausgabe nach STDOUT.
- ```
- ==== Beispiele ====
- Vorausgesetzt, sie haben eine Quelldatei ``Datei.t2t``, los geht's mit der Konvertierung!.
- | **Konvertierung nach HTML** | ``$ txt2tags -t html Datei.t2t``
- | **Das gleiche, mit Umleitung** | ``$ txt2tags -t html -o - Datei.t2t > Datei.html``
- | | .
- | **inkl. Inhaltsverzeichnis** | ``$ txt2tags -t html --toc Datei.t2t``
- | **und die Titel nummeriert** | ``$ txt2tags -t html --toc --enum-title Datei.t2t``
- | | .
- | **kurze Inhaltsόbersicht** | ``$ txt2tags --toc-only Datei.t2t``
- | **diese dann noch nummeriert?** | ``$ txt2tags --toc-only --enum-title Datei.t2t``
- | | .
- | **Einzeiler gelesen von STDIN** | ``$ echo -e "\n**bold**" | txt2tags -t html --no-headers -``
- | **Test der E-Mail Maskierung** | ``$ echo -e "\njohn.wayne@farwest.com" | txt2tags -t txt --mask-email --no-headers -``
- | **Nachbearbeitung mittels sed** | ``$ txt2tags -t html -o- Datei.t2t | sed "s/<BODY .*/<BODY BGCOLOR=green>/" > datei.html``
- : //Anmerkung//
- Seit Version 1.6 kann mit Hilfe der ``%!preproc`` and ``%!postproc`` Konfigurationsfilter eine Vor- und Nachbearbeitung vorgenommen werden.
- ========================================================================
- = Teil II - Ok, I mφchte das Programm. Wie geht's weiter? =[Installation]
- Laden sie das Programm einfach herunter und installieren sie es auf ihrem Rechner.
- == Herunterladen & Installieren von Python ==[download-python]
- Zunδchst mόssen sie den Python-Interpreter herunterladen und auf Ihrem System installieren. Sollte Python bereits installiert sein, όberspringen sie diesen Schritt.
- Python ist eine der tollsten Programmiersprachen die derzeit verfόgbar sind, und ist fόr
- Windows, Linux, UNIX, Macintosh, und andere Systeme verfόgbar. Sie kφnnen es sich von der [Python Webseite http://www.python.org]. herunterladen. Auf derselben Seite finden sie auch Hinweise zur Installation. Txt2tags lδuft mit Python ab der Version 1.5 (oder neuer).
- Falls sie sich nicht sicher sind, ob auf ihrem System Python installiert ist, φffnen sie eine Konsole (tty, xterm, MSDOS) und geben sie am Kommandoprompt ``python`` ein. Falls Python nicht installiert sein sollte, wird sie ihre System darauf aufmerksam machen.
- == Download von txt2tags ==[Download-txt2tags]
- Der offizielle Ort fόr die txt2tags-Distribution ist die Website des Programms, aufrufbar via http://txt2tags.org/src.
- Alle zum Programm gehφrigen Dateien finden sich in einem tarball (.tgz Datei), die Dateien kφnnen mit den meisten gebrδuchlichen Pack-Programmen (einschlieίlich Winzip) aus dem tarball entpackt werden
- Besorgen sie sich stets die **neueste** Version (wobei die neuste Version stets auch die hφchste Versionsnummer aufweist).
- Die frόheren Versionen verbleiben lediglich zu Dokumentationszwecken auf der Seite.
- == Installation von txt2tags ==[Installation-txt2tags]
- Da es sich bei txt2tags um ein gewφhnliches Python-Skript handelt, muss txt2tags nicht gesondert installiert werden.
- Die einzige Datei, die sie brauchen, um das Programm zu nutzen ist, das txt2tags-Skript selbst. Bei allen anderen Dateien in der Download-Archivdatei handelt es sich entweder um Dokumentationsdateien, Werkzeuge oder Beispieldateien.
- Die sicherste Art und Weise, txt2tags ablaufen zu lassen besteht darin, es όber den Python-Compiler aufzurufen:
- ``` Eingabeprompt$ python txt2tags
- Wenn sie txt2tags auf ihrem Rechner als einzeln aufrufbares Programm "installieren" wollen, kopieren (oder verknόpfen) sie das txt2tags-Skript in ein Verzeichnis, welches in der Umgebungsvariable PATH enthalten ist und stellen sie sicher, dass ihr System weiί, mit welchem Programm ihre Datei aufzurufen ist.
- : **UNIX/Linux**
- Markieren sie das Skript als ausfόhrbar (``chmod a+x txt2tags``) und kopieren sie das Programm in ein Verzeichnis, das Bestandteil ihrer Umgebungsvariable PATH ist (``cp txt2tags /usr/local/bin``)
- : **Windows**
- Benennen sie das Skript txt2tags nach txt2tags.py um
- (``ren txt2tags txt2tags.py``) und kopieren sie es in ein Verzeichnis, das Bestandteil ihrer Umgebungsvariable PATH ist
- (``copy txt2tags.py C:\WINNT``)
- Falls sie die graphische Benutzerschnittstelle des Programms nutzen wollen, kφnnen sie fόr das Programm anschlieίend ein Symbol auf ihrem Desktop anlegen.
- === Spezielle Pakete fόr Windows-Benutzer ===
- Fόr txt2tags sind auch zwei .EXE-Dateien verfόgbar, mit denen das Programm auf Windows-Rechnern mit nur wenigen Mausklicks installiert werden kann:
- - Das bloίe txt2tag-Skript fόr all diejenigen, die den Python-Interpreter bereits installiert haben
-
- - Die 'Stand-alone'-Version, welche keinen Python-Interpreter benφtigt (eine abgespeckte Python-Installationsdatei ist in diese Version integriert)
- Besuchen Sie bitte die //txt2tags-Windows// Webseite um diese Pakete herunterzuladen:
- http://txt2tags-win.sf.net
- == Installation von Dateien zum Hervorheben der Programmsyntax fόr Texteditoren ==[Editor-syntax]
- Txt2tags wird mit sehr nόtzlichen Dateien zum Hervorheben der Programmsyntax ausgeliefert, solche Dateien sind dabei fόr die folgenden Texteditoren verfόgbar:
- - Vim (www.vim.org)
- - Emacs (www.emacs.org)
- - Nano (www.nano-editor.org)
- - Kate (http://kate.kde.org)
- άber diese Dateien zum Hervorheben der Programmsyntax wird der Editor όber alle txt2tags-Regeln und Auszeichnungen informiert, dies unterstόtzt den Benutzer dabei, fehlerfreie Dokumente zu verfassen. Da die Auszeichnungen farbig hervorgehoben werden, sehen sie unmittelbar, ob sie die Auszeichnungsmarken in ihren Texten korrekt eingesetzt haben.
- | [IMGPATH/Kate.png] |
- | Beispieldatei, geφffnet im Editor Kate
- Fόr jeden Editor erfolgt die Installation dieser Dateien zum Hervorheben der Programmsyntax unterschiedlich, lesen sie vor der Installation bitte die Kopfzeilen der jeweiligen Syntax-Datei sowie die Dokumentation zu ihrem Editor.
- ========================================================================
- = Teil III - Verfassen und Konvertieren ihres ersten Dokuments =[Ihr-erstes-Dokument]
- == άberprόfung der Werkzeuge ==
- Um ihre erste Textumwandlung erfolgreich vornehmen zu kφnnen, brauchen sie drei Dinge: txt2tags, einen Texteditor und einen Webbrowser.
- + Stellen Sie sicher, dass txt2tags auf ihrem Rechner installiert und funktionsfδhig ist.
- - **Kommandozeilenschnittstelle:** Rufen Sie "txt2tags" auf der Kommandozeile auf, und sie sollten eine Meldung erhalten, die eine "Fehlende Eingabedatei" anmahnt. Falls der Aufruf von txt2tags fehlschlδgt, versuchen sie "python /Pfad/zu/txt2tags" oder auch "/Pfad/zu/Python
- /Pfad/zu/txt2tags" (falls Python nicht Bestandteil ihrer Umgebungsvariable PATH ist).
- - **Graphische Schnittstelle:** Klicken sie auf das Programmsymbol um die graphische Benutzerschnittstelle zu starten.
- + Starten sie einen Texteditor mit dem sie gut vertraut sind. Hierbei kann **jeder** Texteditor genutzt werden, angefangen vom guten alten vi όber MS-Word bis hin zum Texteditor aus der OpenOffice-Suite. Erstellen sie ein neues, leeres Dokument, das sie dann als ihr erstes txt2tags-Dokument verfassen.
- + Starten Sie den von ihnen bevorzugten Webbrowser, sie brauchen ihn, um das Resultat der Konvertierung des von ihnen verfassten Dokuments in eine HTML-Seite zu όberprόfen.
- ------------------------------------------------------------------------
- == Schreiben sie den Kopfbereich des Dokuments ==
- + Wechseln sie zu ihrem Texteditor und tippen sie auf der ersten Zeile den Titel ihres Dokuments: //Mein erstes Dokument//
- + Fόgen sie nun einen Untertitel hinzu, indem sie auf der zweiten Zeile den folgenden Text einfόgen:
- //Ein Test von txt2tags//
- + Anschlieίend kφnnen sie auf der dritten Zeile das Datum der Abfassung vermerken, wie etwa: //Freitag, 26. August 2005//
- Falls alles glatt gelaufen ist, sollten sie jetzt ein dreizeiliges Dokument mit folgendem Inhalt vor sich sehen:
- ```
- Mein erstes Dokument
- Ein Test von txt2tags
- Freitag, 26. August 2005
- ```
- Dies ist zwar nur ein kleiner Teil des gesamten Dokuments, wir kφnnen diesen Teil jedoch bereits konvertieren und anschlieίend die Ergebnisse όberprόfen.
- Speichern sie dazu das Dokument unter dem Namen ``Test.txt``. Merken sie sich dabei, in welchen Ordner sie die Datei abspeichern, sie benφtigen diese Information in Kόrze wieder.
- ------------------------------------------------------------------------
- == Die erste Umwandlung eines Dokuments - GUI Schnittstelle ==
- Falls sie txt2tags όber die Kommandozeilenschnittstelle bedienen wollen, όberspringen sie bitte diesen Schritt und befolgen sie die Anweisungen im nδchsten Abschnitt.
- Falls jedoch nach dem Aufruf von txt2tags die graphische Schnittstelle erscheint, folgen sie diesen Schritten:
- [IMGPATH/erste-Konvertierung.png]
- + Klicken sie auf die mit "Blδttern" beschriftete Schaltflδche und wδhlen sie das Dokument ``Test.txt``, welches sie soeben erstellt und gespeichert haben (sicher haben sie sich den Ordner gemerkt, in dem sie das Dokument abgespeichert haben!).
- + Zurόck am Ausgangsschirm wδhlen sie "HTML Seite" in der mit "Wδhlen Sie das Format des Zieldokuments" beschrifteten Auswahlbox.
- + Klicken sie auf die Schaltflδche "Wandlung starten!".
- [IMGPATH/erste-Konvertierung-fertig.png]
- Nun wird ein Fenster erscheinen, welches sie darόber informiert, dass die Datei erfolgreich konvertiert wurde.
- Beachten sie dabei, dass die erzeugte HTML-Seite in demselben Ordner gespeichert wurde wie die fόr die Konvertierung benutzte Quelldatei, die Datei weist dabei die Endung "html" auf.
- ------------------------------------------------------------------------
- == Die erste Umwandlung eines Dokuments - Kommandozeile ==
- Falls sie txt2tags όber die graphische Schnittstelle bedienen wollen, befolgen sie bitte nicht diesen Schritt sondern folgen sie den Anweisungen im vorherigen Abschnitt.
- Falls sie jedoch txt2tags όber die Kommandozeile bedienen wollen, wechseln sie in den Ordner, in welchen sich das von ihnen erstellte Dokument abgespeichert haben und tippen dort das folgende Kommando ein:
- ``` txt2tags --target html Test.txt
- Beachten sie dabei bitte, dass Leerzeichen zwischen den einzelnen Bestandteilen des Kommandos, nicht aber innerhalb des Textpassage "--target" erlaubt sind, da es sich bei letzterer um eine Option handelt. Dieser Option folgt der Text "html", hierόber wird dem Programm mitgeteilt, in welches Format ihre Quelldatei konvertiert werden soll. Der letzte Bestandteil des Kommandos schlieίlich ist der Dateiname des Quelldokuments.
- Nach vollendeter Konvertierung wird die resultierende Datei unter dem Namen ``Test.html`` abgespeichert, wobei das Programm die folgende Mitteilung ausgibt:
- "//txt2tags erzeugte Test.html//". Sollte das nicht der Fall sein, erscheint eine entsprechende Meldung, der sie entnehmen kφnnen, welcher Fehler sich bei der Eingabe des Kommandos auf der Kommandozeile eingeschlichen hat. Lesen sie solche Meldungen sorgfδltig durch!
- Hier folgt ein Beispiel dafόr, wie sich das Ganze am Bildschirm prδsentiert:
- ```
- prompt$ txt2tags --target html Test.txt
- txt2tags erzeugte Test.html
- prompt$
- ```
- ------------------------------------------------------------------------
- == άberprόfung des Resultats ==
- Φffnen sie die Datei ``Test.html`` in einem Webbrowser um zu όberprόfen, ob alles korrekt dargestellt wird.
- [IMGPATH/Ergebnis-erste-Konvertierung.png]
- Da ist das Resultat! Sie haben lediglich 3 kurze Textzeilen eingeben, und txt2tags hat den Rest erledigt und dabei sowohl den HTML-Kopfbereich (inklusive Dateiinformationen) erstellt als auch die Ausrichtung, Grφίe, Erscheinungsbild und Abstδnde fόr den Text adδquat festgelegt. Wie sie sehen kφnnen, erscheint der Titel ihres Texts auch in der Titelzeile des Browsers.
- || Sie schreiben den Text, txt2tags erledigt den Rest ;) |
- Hinweis: Sie kφnnen auf von txt2tags erzeugte Dokumente auch CSS-Stylesheets anwenden, dadurch kann das Erscheinungsbild der Seite 100%-ig von ihnen festgelegt werden.
- ------------------------------------------------------------------------
- == Verfassen des Dokuments ==
- Zurόck im Texteditor ist nun der nδchste Schritt die Eingabe der eigentlichen Inhalte des Dokuments. Sie kφnnen hierbei in Klartext schreiben, so wie sie das normalerweise beim Verfassen von E-Mail-Nachrichten auch tun. Sie werden sehen, dass txt2tags Abschnitte und Aufzδhlungen
- automatisch erkennt, sie mόssen sie gar nicht besonders auszeichnen.
- Und dann wieder: speichern sie ihr Dokument, wandeln es um und όberprόfen sie das Ergebnis.
- Das ist der Entwicklungszyklus eines Dokuments in txt2tags. Sie konzentrieren sich ganz auf die Inhalte des Dokuments und sind mit ihrem Dokument schneller fertig als wenn sie ein mit Funktionen όberladenes Textverarbeitungsprogramm benutzt hδtten. Keine Mausklicks, keine Menόs, Fenster oder sonstige Ablenkungen.
- Vergleichen sie doch einfach die folgenden Inhalte der Quelldatei ``Test.txt``, welche in Klartext verfasst wurde, mit der bei der Konvertierung erzeugten HTML-Seite:
- ```
- Mein erstes Dokument
- Ein Test von txt2tags
- Freitag, 26. August 2005
- Gut, probieren wir halt mal dieses sagenhafte txt2tags Werkzeug.
- Eigentlich weiί ich gar nicht was ich schreiben soll.
- Mmmmmm, I weiί was jetzt was ich tun werde:
- - Mich zuerst duschen
- - Dann eine Pizza essen
- - Mich schlafen legen
- ```
- [IMGPATH/Ergebnis-erste-Konvertierung-komplett.png]
- Sie kφnnen eine ganze Homepage erstellen, ohne auch nur das geringste Wissen όber HTML zu besitzen! Sie brauchen keinerlei Auszeichnungsmarken einfόgen. Und der Clou, dieselbe Quelldatei kann auch in jedes andere der von txt2tags unterstόtzten Formate umgewandelt werden.
- Neben dem Klartext versteht txt2tags einige ganz einfache Auszeichnungsmarken, welche sie nutzen kφnnen, falls sie eine andere Textformatierung oder -struktur benφtigen, wie etwa Fett- oder Kursivschrift, Titel, Bilder, Tabellen und anderes mehr. Hier zwei einfache Beispiele: ``**zeichnet fettgedruckte Passagen aus**`` und ``== kann fόr Titel genutzt werden ==``. Die Auszeichnungen lernen sie am besten mittels der [Demonstration von txt2tags Auszeichnungen http://txt2tags.org/markup.html].
- =======================================================================
- = Teil IV - Die Konzepte von txt2tags beherrschen lernen =[Konzepte]
- == Die Bereiche eines .t2t Dokuments ==[Bereiche]
- Mit txt2tags ausgezeichnete Dateien sind in drei Bereiche aufgeteilt. Jeder Bereich hat einen anderen Zweck und besitzt seine eigenen Regeln. Es handelt sich dabei um:
- : //HEADAREA//
- Dies ist der Platz fόr den Titel des Dokuments, zusδtzlich kφnnen hier die Autoren, die Version und der Zeitpunkt der Abfassung des Dokuments angegeben werden. (optional)
- : //CONFAREA//
- Dies ist der richtige Platz fόr im gesamten Dokument gόltige Einstellungen sowie fόr das Verhalten des Parsers beeinflussende Anweisungen. (optional)
- : //BODYAREA//
- Dies ist der Platz fόr den Inhalt des Dokuments. (wird benφtigt)
- Wie man aus der obigen Aufzδhlung ersehen kann, sind die ersten beiden Bereiche nicht zwingend erforderlich, insofern ist der //BODYAREA// der einzige Bereich, fόr den Text eingegeben werden muss.
- Die Abgrenzung der einzelnen Bereiche untereinander erfolgt nach speziellen Regeln, die wir im Detail im nδchsten Kapitel kennenlernen werden. Zunδchst wollen wir uns erstmal mit einer graphischen Darstellung der einzelnen Bereiche eines Dokuments zufrieden geben:
- ```
- _____________
- | |
- | KOPFBEREICH | 1. Zunδchst der Kopfbereich
- | |
- | KONFIG | 2. Anschlieίend die Einstellungen
- | |
- | TEXT | 3. Und schlieίlich der Text des Dokuments,
- | |
- | ... | der sich bis zum Ende erstreckt
- | ... |
- |___________ _|
- ```
- Hier bereits ein Kurzόberblick darόber, wie die einzelnen Bereiche definiert sind:
- | **Kopfbereich** | Die ersten drei Zeilen der Datei, oder eine Leerzeile als erste Zeile falls kein Kopfbereich erforderlich ist.
- | **CONFAREA** | Beginnt direkt im Anschluss an den Kopfbereich (zweite oder vierte Zeile) und endet mit Beginn des //Textkφrpers//.
- | **Textkφrper** | Die erste gόltige Textzeile (keine Kommentar- oder Parameterzeile) nach dem //HEADAREA//.
- === Komplettes Beispiel ===
- ```
- Der Titel meines tollen Dokuments
- Dr. Andreas Deininger
- Letzte Aktualisierung: %%mtime(%c)
- %! Target : html
- %! Style : fancy.css
- %! Encoding: iso-8859-1
- %! Options : --toc --enum-title
- Hallo! Dies ist mein Test-Dokument.
- Es endet bereits hier.
- ```
- ------------------------------------------------------------------------
- == HEADAREA ==[Kopfbereich]
- Positionierung:
- - Eindeutig festgelegte Position: Die **ersten 3 Zeilen** der Datei. Nicht mehr und nicht weniger
- - Eindeutig festgelegte Position: Die **erste Zeile** der Datei falls es sich dabei um eine Leerzeile handelt. Dies bedeutet dann, dass auf den Kopfbereich verzichtet wird.
- Der HEADAREA ist der einzige Bereich, dessen Position eindeutig anhand der Zeilennummern festgelegt ist: es handelt sich dabei um die ersten drei Zeilen der Quelldatei.
- Diese Zeilen kφnnen mit beliebigen Inhalten gefόllt werden, der Typ der Informationen ist nirgends statisch festgeschrieben.
- Dennoch wird sich fόr die meisten Dokumente ein Aufbau der HEADAREAs in der folgenden Art anbieten:
- - //1. Zeile//: Titel des Dokuments
- - //2. Zeile//: Name des Autors und/oder seine E-Mail-Adresse
- - //3. Zeile//: Version des Dokuments und/oder Zeitpunkt der Abfassung (hierfόr bietet sich das ``%%date``-Makro an)
- Denken sie daran, dass die ersten drei Zeilen des Quelldokuments zugleich auch die
- ersten drei Zeilen des Zieldokuments darstellen, welche abgesetzt und gegenόber dem Textkφrper stark hervorgehoben dargestellt werden (z. B. durch die Schriftgrφίe, Fettschrift). Falls das Dokument einen seitenorientierten Aufbau besitzt, wird der Kopfbereich alleinstehend zentriert auf der ersten Seite des Dokuments wiedergegeben.
- ==== Weniger (oder gar keine) Kopfzeilen ====
- Gelegentlich wird der Fall auftreten, dass der Autor des Dokuments weniger als drei Zeilen fόr den Kopfbereich benφtigt, etwa wenn er lediglich den Titel des Dokuments und/oder das Datum der Abfassung angeben mφchte.
- Lassen sie in solch einem Fall die zweite und/oder dritte Zeile ihres Dokuments einfach leer (Leerzeile) und es wird entsprechend auch kein Text im Kopf des Zieldokuments angegeben werden. Denken sie jedoch daran, dass diese Leerzeilen, auch wenn sie keinen Inhalt tragen, dennoch als ein Teil des Kopfbereich zδhlen, so dass der der Textkφrper des Dokuments nach wie vor frόhestens **nach** der dritten Zeile beginnen kann.
- Der Titel (die erste Zeile) ist das einzige Element im Kopfbereich des Dokuments, das zwingend angegeben werden muss. Falls sie die erste Zeile des Dokuments leer lassen und damit den Titel quasi auslassen, teilen sie txt2tags mit, dass das Dokument **keinen Kopfbereich** besitzt. Dies bedeutet dann zugleich, dass der //BODYAREA// direkt anschlieίend beginnen kann, in diesem speziellen Fall also bereits auf der zweiten Zeile des Dokuments.
- Der Verzicht auf die Angabe von Kopfzeilen ist besonders dann nόtzlich, wenn sie dem Dokument nach der Konvertierung eine eigene, von ihnen angepasst gestaltete Titelseite hinzufόgen mφchten. Gewφhnlich wird die Kommandozeilenoption ``--no-headers`` fόr diese Art der angepassten Dokumentgestaltung verwendet.
- ==== Auf den Punkt gebracht ====
- || In Kurzform: "Kopfzeilen sind lediglich durch ihre __Position__ definiert, nicht όber ihren Inhalt" |
- Platzieren sie beliebigen Text auf der ersten Zeile ihres Dokuments, und er wird auch im konvertierten Dokument auf der ersten Zeile erscheinen. Dasselbe gilt auch fόr die auf der zweiten und der dritten Dokumentenzeile platzierten Kopfzeilen.
- ------------------------------------------------------------------------
- == CONFAREA ==[config-area]
- Positionierung:
- - Beginnt direkt im Anschluss an den HEADAREA
- - Beginnt auf der **vierten Zeile** der Datei falls ein **Kopfbereich** angegeben wurde
- - Beginnt auf der **zweiten Zeile** der Datei falls **kein Kopfbereich** angegeben wurde
- - Endet mit dem Beginn des BODYAREAs
- - Ein Leerzeile, eine Kommentarzeile oder eine Zeile in der keine Einstellung festgelegt wird beendet automatisch den CONFAREA
- Der CONFAREA ist optional. Ein gewφhnlicher Benutzer kann viele txt2tags-Dateien verfassen ohne dass er όberhaupt weiί, dass ein CONFAREA existiert, ein erfahrener Benutzer aber wird dessen Mδchtigkeit und die όber seine Nutzung gebotene Flexibilitδt zu schδtzen wissen.
- Der CONFAREA kann dazu genutzt werden, dokumentenspezifische Einstellungen zu speichern, so dass diese bei der Konvertierung des Dokuments nicht jedesmal όber die Kommandozeile explizit als Kommandozeilenoptionen mit angegeben werden mόssen. Auf diese Art und Weise kφnnen zum Beispiel das Zielformat fόr die Konvertierung sowie die Kodierung der Datei festgelegt werden.
- Fόr weitergehende Informationen zu diesem Thema lesen sie bitte den Abschnitt [Einstellungen #Einstellungen-Ueberblick] .
- ----------------------------------------------------------------
- == BODYAREA ==[body-area]
- Positionierung:
- - Beginnt mit der ersten gόltigen Textzeile innerhalb der Datei
- - Zeilen innerhalb des Kopfbereichs, Zeilen welche Einstellungen enthalten sowie Kommentarzeilen sind **keine** gόltigen Textzeilen
- - Endet zugleich mit dem Ende der Datei (EOF)
- Jeglicher Text auίerhalb des Kopfbereichs und des CONFAREAs zδhlt zum BODYAREA.
- Der Textkφrper enthδlt die Inhalte des Dokuments sowie alle Auszeichnungen und -strukturen, welche von txt2tags erkannt werden. Innerhalb des Textkφrpers kφnnen auch Kommentare, etwa fόr //Aufgabenlisten (TODOs)// oder fόr sonstige, nur fόr den Verfasser bestimmte Notizen niedergeschrieben werden.
- Sie kφnnen die Kommandozeilenoption ``--no-headers`` benutzen, um nur den Textkφrper des Dokuments zu konvertieren, der Kopfbereich wird dann unterdrόckt. Dies ist nόtzlich, wenn die Informationen des Kopfbereichs in einer separaten Datei hintergelegt sind, an diese Datei kann dann der konvertierte Textkφrper angehδngt werden.
- ----------------------------------------------------------------
- == Einstellungen ==[Einstellungen-Ueberblick]
- Einstellungen sind spezielle Konfigurationsangaben, όber welche das Ergebnis der Konvertierung beeinflusst werden kann. Solche Einstellungen mόssen im CONFAREA des Quelldokuments platziert werden. Ihre Syntax lautet:
- || %! Schlόsselwort : Wert |
- Liste aller gόltigen Schlόsselwφrter:
- || Schlόsselwort | Beschreibung |
- | Target | Definiert das Zielformat in welches das Dokument beim Fehlen von Kommandozeilenoptionen konvertiert wird.
- | Options | Definiert voreingestellt Optionen, welche bei der Konvertierung genutzt werden. Das Format ist dasselbe wie dasjenige von Kommandozeilenoptionen.
- | Style | Definiert das Aussehen des Dokuments. Damit kann einer HTML/XHTML-Datei eine CSS-Datei zugeordnet oder in einem LaTeX-Dokument ein Paket geladen werden.
- | Encoding | Definiert die Kodierung bzw. den Zeichensatz des Dokument. Findet immer dann Anwendung, wenn das Dokument Umlaute, mit Akzenten versehene Buchstaben oder andere nicht ASCII-Zeichen enthδlt.
- | PreProc | Eingabefilter. Definiert Regeln fόr das "Suchen und Ersetzen" welche auf das Quelldokument angewendet werden.
- | PostProc | Ausgabefilter. Definiert Regeln fόr das "Suchen und Ersetzen" welche auf das bereits konvertierte Dokument angewendet werden.
- Beispiel:
- ```
- %! Target : html
- %! Options : --toc --toc-level 3
- %! Style : fancy.css
- %! Encoding: iso-8859-1
- %! PreProc : "HPM" "Hans-Peter Mόller"
- %! PostProc: '<BODY.*?>' '<BODY bgcolor="yellow">'
- ``…