PageRenderTime 236ms CodeModel.GetById 178ms app.highlight 16ms RepoModel.GetById 1ms app.codeStats 2ms

/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 files are truncated, but you can click here to view the full file

  1Txt2tags Benutzerhandbuch
  2Aurelio, %%mtime(%c)
  3άbersetzung von Andreas Deininger
  4
  5%!target: html
  6%!options: --toc --toc-level 2 --css-sugar 
  7
  8%%!options: -o ../../../web/userguide/userguide.html
  9
 10% TRANSLATOR:
 11% - Don't worry about the PDF cover page
 12% - Don't worry about PDF at all, translate and check on HTML
 13% - Don't worry about the images
 14
 15% TRANSLATOR uncomment the next line
 16%%!options: -o benutzerhandbuch.html
 17
 18% TRANSLATOR uncomment the next line to use images on the same folder
 19%!preproc: IMGPATH img-lowres
 20
 21% TRANSLATOR:
 22% You can take new screenshots and make new images for the program
 23% interface and "first conversion" section. Remember to send them
 24% to the author!
 25
 26
 27%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 28%%% activate those lines when converting to HTML for PDF generation
 29%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 30%%% htmldoc does TOC
 31%!options(html): --no-toc --no-css-sugar -o userguide-pdf.html
 32%%% mask the 'nopdf' marks so they will not be removed
 33%!preproc(html): ^%nopdf  %yespdf
 34%%% removing first header, htmldoc ignores all until next <H1> (cool!)
 35%!postproc(html): '<H1>Txt2tags Benutzerhandbuch</H1>'  ''
 36%%% imagens are in the same dir
 37%!preproc: IMGPATH .
 38%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 39
 40% normalizing common text
 41%!preproc: CONFAREA	Konfigurationsbereich
 42%!preproc: HEADAREA	Kopfbereich
 43%!preproc: BODYAREA	Textbereich
 44%!preproc: MARKPROP	**Eigenschaften:**
 45%!preproc: MARKCONT	**Enthδlt:**
 46%!preproc: MARKDESC	**Beschreibung:**
 47%!preproc: MARKSYN	**Syntax:**
 48%!preproc: MARKDET	**Details:**
 49%!preproc: NOMARKS	Markierungen werden NICHT ausgewertet
 50%!preproc: NOMACRO	Makros werden NICHT ausgewertet
 51
 52%!preproc: URLMARKUP	http://txt2tags.org/markup.html
 53
 54% activate the areas disabled on the PDF version
 55%!preproc(html): ^%nopdf  ''
 56
 57% remove separator lines and strong lines
 58%!preproc(html): '^ *--------*'  ''
 59%!preproc(html): '^ *========*'  ''
 60
 61% highlight NEW topic on TOC
 62%%!postproc(html): '(<LI>.*Makros beherrschen lernen</A>)$' '\1 <b>[NEU!]</b>'
 63
 64%%% Little clean up for less large tables
 65%!postproc: /pessoal/sourceforge.net ''
 66
 67% border for all images
 68%!postproc: '(<IMG [^>]*BORDER)="0"'    '\1="1"'
 69
 70
 71%%% Embedded CSS code (ugly not?)
 72%
 73%!postproc(html): ^<HEAD>$ '<HEAD>\n<STYLE TYPE="text/css">\n@#@'
 74%!postproc(html): (@#@)$ 'body {background-color:#ddeeff; color:black;   \n\1'
 75%!postproc(html): (@#@)$ '      margin:3em; text-align:justify;}         \n\1'
 76%!postproc(html): (@#@)$ '#header {text-align:center;}                   \n\1'
 77%!postproc(html): (@#@)$ '.toc {border:1px solid black;padding:9px;\n\1'
 78%!postproc(html): (@#@)$ '            background-color:white;}           \n\1'
 79%!postproc(html): (@#@)$ '.toc li{list-style-type: none;}                \n\1'
 80%!postproc(html): (@#@)$ 'a {text-decoration:none;}\na:hover {color:red;}\n\1'
 81%!postproc(html): (@#@)$ 'a:visited {color:purple;}\ndl {margin:1em;}    \n\1'
 82%!postproc(html): (@#@)$ '#body h1 {text-align:center; color:white;      \n\1'
 83%!postproc(html): (@#@)$ '          background-color:blue; padding:8px;} \n\1'
 84%!postproc(html): (@#@)$ 'h2 {padding-top:20px;}\nhr {border-style:none;}\n\1'
 85%!postproc(html): (@#@)$ 'code {background-color:lightblue;}             \n\1'
 86%!postproc(html): (@#@)$ 'blockquote {border:1px solid black;padding:9px;\n\1'
 87%!postproc(html): (@#@)$ '            background-color:white;}           \n\1'
 88%!postproc(html): (@#@)$ 'table {border-style:solid; border-color:black;}\n\1'
 89%!postproc(html): (@#@)$ 'th {background-color:lightblue; padding:.5em;} \n\1'
 90%!postproc(html): (@#@)$ 'td {border-style:none; background-color:white;}\n\1'
 91%!postproc(html): (@#@)$ 'pre {border-style:solid; border-width:1px 1px; \n\1'
 92%!postproc(html): (@#@)$ '     background-color:lightblue; padding:8px;  \n\1'
 93%!postproc(html): (@#@)$ '     border-color:black;}                      \n\1'
 94%!postproc(html):  @#@$  </STYLE>
 95
 96% 26/Nov/2003: revised by anamimts
 97% 26/Jun/2004: updated to v2, new embedded CSS 
 98% 17/Jul/2004: revised by anamimts
 99% 01/Nov/2004: updated to v2.0 and 2.1, new chapters, PDF version
100
101% TODO Mastering Options [option-help], [option-css-sugar], ...
102
103========================================================================
104
105%nopdf	"Hallo! Hier kommt das txt2tags Benutzerhandbuch. Sie finden hier alle
106%nopdf	Informationen zum Textkonvertierunsgwerkzeug txt2tags. Die neuste
107%nopdf	Version ist stets erhδltlich bei http://txt2tags.org/userguide/. 
108%nopdf	Fόr ergδnzende Informationen besuchen sie bitte 
109%nopdf	[die txt2tags Webseite http://txt2tags.org]. Viel Spaί!"
110%nopdf  
111%nopdf	[Download PDF-Version http://txt2tags.org/userguide/benutzerhandbuch.pdf]
112
113========================================================================
114
115%nopdf%**Dieses Benutzerhandbuch enthδlt:**
116
117%%toc
118
119========================================================================
120
121= Teil I - Einfόhrung in txt2tags =[Einfuehrung]
122
123== Die ersten Fragen, die sich ihnen stellen ==[Erste-Fragen]
124
125Dieses Kapitel bietet einen άberblick όber txt2tags, in dem das Programm, dessen Zweck und dessen Mφglichkeiten vorgestellt werden
126
127------------------------------------------------------------------------
128
129=== Worum handelt es sich? ===
130
131Txt2tags ist ein Werkzeug zur Textformatierung und -konvertierung.
132
133Txt2tags konvertiert ein ASCII-Text Datei mit einigen wenigen Auszeichnungen zu jedem der unterstόtzten Ausgabeformate:
134
135- HTML Dokument
136- XHTML Dokument
137- SGML Dokument
138- LaTeX Dokument
139- UNIX man page
140- Magic Point Prδsentation
141- MoinMoin Seite
142- PageMaker 6.0 Dokument
143- ASCII-Text (keine Auszeichnungen)
144
145
146------------------------------------------------------------------------
147
148=== Wieso sollte ich txt2tags benutzen? ===
149
150txt2tags kann fόr sie sehr nόtzlich sein, wenn sie:
151- Dokumente in verschiedenen Formaten verφffentlichen mόssen
152- fόr das Update von Dokumenten in verschiedenen Formaten verantwortlich sind
153- technische Dokumentationen oder Handbόcher verfassen mόssen
154- nicht wissen, wie sie ein Dokument in einem bestimmten Format schreiben sollen
155- keinen speziellen Editor fόr ein bestimmtes Format besitzen
156- mit einem einfachen Texteditor ihre Dokumente aktualisieren wollen
157
158
159Die hauptsδchliche Motivation hinter all dem ist:
160- Sparen sie Zeit, schreiben sie **Inhalte** und vergessen Sie die **Formatierung**
161
162
163------------------------------------------------------------------------
164
165=== Was zeichnet txt2tags gegenόber δhnlichen Werkzeugen aus? ===
166
167Txt2tags wird sehr geradlinig erweitert, basierend auf grundlegenden Konzepten.
168Das sind die wichtigsten Merkmale:
169
170| //Quellcode gut lesbar// | Txt2tags Auszeichnungen sind sehr einfach und in natόrlicher Weise gehalten.
171| //Erzeugtes Dokument lesbar// | Ebenso wie der Quellcode ist auch das erzeugte Dokument gut lesbar, mit Einrόckungen und kurzen Zeilenlδngen.
172| //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.
173| //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".
174| //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.
175| //Einfach zu erlernen// | Aufgrund der einfachen Auszeichnungen und da der Quellcode lesbar ist, weist txt2tags eine flache, benutzerfreundliche Lernkurve auf.
176| //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.
177| //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.
178| //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.
179| //Skripting// | άber den mδchtigen Kommandozeilen-Modus kφnnen erfahrene Benutzer bestimmte Aufgaben **automatisieren** sowie konvertierte Dateien **nachtrδglich verδndern**.
180| //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.
181| //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.
182
183
184------------------------------------------------------------------------
185
186=== Muss ich fόr das Programm bezahlen? ===
187
188                || Definitiv NEIN! |
189
190Es ist frei, GPL, Open Source, Public Domain,
191//<setzen sie hier ihr Lieblings-Schlagwort ein>//.
192
193Sie 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.
194
195------------------------------------------------------------------------
196
197
198== Unterstόtzte Auszeichnungsstrukturen ==[Strukturen]
199
200Nachfolgend eine Aufzδhlung aller von txt2tags unterstόtzten Strukturen.
201
202- Kopfbereich (Titel des Dokuments, Name des Autors, Datum)
203- Abschnittstitel (nummeriert oder nicht nummeriert)
204- Absδtze
205- Schriftarten
206  - fett
207  - kursiv
208  - unterstrichen
209- Schreibmaschinenschrift (fόr Originaltext)
210  - Originaltext innerhalb eines Absatzes
211  - einzelne Originaltext-Zeile
212  - Originaltext-Bereich (mehrere Zeilen umfassend)
213- Bereich fόr ein Zitat
214- Verknόpfungen
215  - URL/Internet Verknόpfungen
216  - E-Mail Verknόpfungen
217  - lokale Verknόpfungen
218  - benannte Verknόpfungen
219- Listen
220  - Aufzδhlungslisten
221  - nummerierte Listen
222  - Definitionslisten
223- horizontale Trennlinien
224- Bilder (ausgerichtet)
225- Tabellen (mit oder ohne Rahmen, ausgerichtet, όber mehrere Spalten hinweg)
226
227- Spezielle Auszeichnung fόr rohen Text (wird nicht geparst)
228- Spezielles Makro fόr das aktuelle Datum (mit flexibler Formatierung)
229- Kommentare (fόr Notizen, Aufgabenlisten, Fehlerbeschreibungen etc.)
230
231
232------------------------------------------------------------------------
233
234== Unterstόtzte Ausgabeformate ==[Zielformate]
235
236: **HTML**
237  Jeder weiί was HTML ist. (Hinweis: Internet)
238
239  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.
240
241  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.
242
243: **XHTML**
244  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.
245
246  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.
247
248: **SGML**
249  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).
250
251  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.
252
253: **LATEX**
254  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 ...
255
256  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.
257
258: **LOUT**
259  Δ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.
260
261  Txt2tags erzeugt gebrauchsfertige Lout Dateien, welche mittels des "lout"-Kommandos zu Postscript- oder PDF-Dateien konvertiert werden kφnnen.
262
263: **MAN**
264  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.
265
266  Es gibt andere Werkzeuge um man Dokumente zu erzeugen, aber txt2tags hat
267einen 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.
268
269: **MGP**
270  [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).
271
272  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.
273
274  **BONUS 1:** von txt2tags erzeugte .mgp Dateien nutzen XFree86 Type1
275  Schriftarten! Dies bedeutet, dass sie keine zusδtzlichen TrueType Schriftart-Dateien fόr ihre Prδsentation benφtigen.
276
277  **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!
278
279  Das Schlόsselprinzip: Konvertieren und benutzen. Keine aufwδndigen Anpassungen oder sonstigen Anforderungen sind vonnφten.
280
281: **MOIN**
282  Sie wissen nicht was [MoinMoin http://moin.sourceforge.net] ist?
283  Es ist ein [WikiWiki http://www.c2.com/cgi/wiki]!
284
285  Die Moin Syntax ist nicht sonderlich adrett, insbesondere da stδndig
286  ``{{{'''''Klammern und Hochzeichen'''''}}}``, hinzugefόgt werden mόssen. Auch hier bietet txt2tags mit seinen einfachen Auszeichnungen eine universelle Lφsung: ein Quelltext, vielerlei Zielformate.
287
288: **PM6**
289  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.
290
291  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.
292
293  Anmerkung des Autors:
294  //Mein gesamtes, in portugiesisch verfasstes [Buch όber regulδre Ausdrόcke http://guia-er.sf.net]//
295  //wurde im Editor VI geschrieben, mit txt2tags in das PageMaker-Format konvertiert und ging anschlieίend in//
296  //Druck.//
297
298: **TXT**
299  TXT ist Text. Der einzig wahre Formatierungs-Typ.
300
301  Obwohl die txt2tags Auszeichnungen sehr intuitiv und unauffδllig sind, kφnnen sie entfernt werden, indem die Quelldatei in reinen ASCII-Text konvertiert wird.
302
303  Titelzeilen sind dabei unterstrichen, und der Text ist mehr oder weniger der gleiche wie in der Quelltext-Datei.
304
305
306------------------------------------------------------------------------
307
308== άbersicht όber die je nach Zielformaten unterstόtzten Strukturen ==[unterstuetzte-Strukturen]
309
310  || Struktur           | html | xhtml | sgml | tex | lout | man | mgp | moin | pm6 | txt |
311  | Kopfzeile           |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  N   |  N  |  J  |
312  | Abschnittstitel     |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  J  |
313  | Absδtze             |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  J  |
314  | fett                |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  -  |
315  | kursiv              |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  -  |
316  | unterstrichen       |  J   |   J   |  -   |  J  |  J   |  -  |  J  |  J   |  J  |  -  |
317  | Schreibmaschine     |  J   |   J   |  J   |  J  |  J   |  -  |  J  |  J   |  J  |  -  |
318  | Originaltextzeile   |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  -  |
319  | Originaltextbereich |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  -  |
320  | Zitate              |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  J  |
321  | Internet Verknόpfungen     |  J   |   J   |  J   |  -  |  -   |  -  |  -  |  J  |  -  |  -  |
322  | E-Mail Verknόpfung  |  J   |   J   |  J   |  -  |  -   |  -  |  -  |  J   |  -  |  -  |
323  | lokale Verknόpfungen       |  J   |   J   |  J   |  N  |  N   |  -  |  -  |  J   |  -  |  -  |
324  | benannte Verknόpfungen     |  J   |   J   |  J   |  -  |  -   |  -  |  -  |  J   |  -  |  -  |
325  | Aufzδhlungslisten   |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  J  |
326  | Nummerierte Listen  |  J   |   J   |  J   |  J  |  J   |  J  |  J  |  J   |  J  |  J  |
327  | Definitionslisten   |  J   |   J   |  J   |  J  |  J   |  J  |  N  |  N   |  N  |  J  |
328  | Trennlinien         |  J   |   J   |  -   |  J  |  J   |  -  |  J  |  J   |  N  |  J  |
329  | Bilder              |  J   |   J   |  J   |  J  |  J   |  -  |  J  |  J   |  N  |  -  |
330  | Tabellen            |  J   |   J   |  J   |  J  |  N   |  J  |  N  |  J   |  N  |  N  |
331  || Extras             | html | xhtml | sgml | tex | lout | man | mgp | moin | pm6 | txt |
332  | Bilder ausrichten   |  J   |   J   |  N   |  N  |  J   |  -  |  J  |  N   |  N  |  -  |
333  | Tabellenzellen ausrichten |  J   |   J   |  J   |  J  |  N   |  J  |  N  |  J   |  N  |  N  |
334  | mehrspaltige Zellen |  J   |   J   |  N   |  N  |  N   |  N  |  N  |  N   |  N  |  N  |
335
336  ||      | Legende
337  | **J** | //Unterstόtzt//
338  | **N** | //Nicht unterstόtzt (eventuell in zukόnftigen Versionen)//
339  | **-** | //Nicht unterstόtzt (in diesem Zielformat nicht mφglich)//
340% | **?** | //Nicht unterstόtzt (Ungewiss, ob eine Realisierung mφglich ist)//
341
342------------------------------------------------------------------------
343
344== Die drei Benutzerschnittstellen: GUI, Web und die Kommandozeile ==[Schnittstellen]
345
346Da 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.
347
348Es existieren drei Benutzerschnittstellen fόr das Programm, jede davon mit mit ihren eigenen Mφglichkeiten und jeweils fόr einen anderen Zweck gedacht.
349
350- **GUI**: in Tk verfasst, eine Fensteroberflδche zum Anklicken fόr txt2tags .
351- **Web**: in PHP verfasst, gestattet es den Benutzers txt2tags in einem Webbrowser ablaufen zu lassen,wodurch die clientseitige Installation von txt2tags όberflόssig wird.
352- **Kommandozeile**: in Python verfasst, ist dies das Herzstόck des Programms. Alle Optionen sind όber die Optionsschalter der Kommandozeile konfigurierbar.
353
354
355------------------------------------------------------------------------
356
357=== Graphische Tk Schnittstelle ===[GUI]
358
359Seit Version 1.0 steht eine hόbsche graphische Oberflδche zur Verfόgung, welche unter Linux, Windows, Mac und anderen Systeme lauffδhig ist.
360
361Das 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.
362
363	**Hinweis:** Das Tkinter-Modul ist zwingend erforderlich. Da dieses jedoch bereits standardmδίig in der Python-Distribution enthalten ist, besitzen sie es eventuell schon.
364
365Die Schnittstelle ist ziemlich einfach und intuitiv:
366
367                     [IMGPATH/gui.png]  
368
369+ Sie lokaliseren die Quelldatei auf ihrem Datentrδger und deren Optionen werden geladen.
370
371+ Falls die Quelle dann noch leer sein sollte, mόssen sie eine auswδhlen.
372
373+ Zusδtzlich gibt es noch Optionen, die sie gegebenenfalls auswδhlen kφnnen, wobei jedoch keine dieser Optionen zwingend benφtigt wird.
374
375+ Zuletzt, drόcken Sie die Schaltflδche "Umwandlung starten!".
376
377
378Sehr 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.
379
380Die voreingestellten Farben der Schnittstelle kφnnen in der Datei ``~/.txt2tagsrc`` geδndert werden, zur Einstellung muss dabei der Parameter ``%!guicolors`` gesetzt werden. Ein Beispiel:
381
382```
383% nutze benutzerdefinierte Farben fόr die graphische Schnittstelle
384% (Hintergrund1, Vordergrund1, Hintergrund2, Vordergrund2)
385%!guicolors: blue white brown yellow
386```
387
388------------------------------------------------------------------------
389
390=== Webschnittstelle ===
391
392Die Webschnittstelle ist im Internet verfόgbar όber die Adresse
393http://txt2tags.org/online.php. Dort kφnnen sie dass Programm sofort austesten und nutzen, noch bevor sie es dann eventuell herunterladen.
394
395          [IMGPATH/web.png]  
396
397Sie 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.
398
399------------------------------------------------------------------------
400
401=== Kommandozeile als Schnittstelle ===[Kommandozeile]
402
403Fόr erfahrene Kommandozeilenbenutzer sollte die Ausgabe von --help genόgen:
404
405```
406Usage: txt2tags [OPTIONEN] [Quelldateiname.t2t ...]
407
408  -t, --target        Typ des Zieldokuments festlegen. Derzeit unterstόtzt:
409                      html, xhtml, sgml, tex, lout, man, mgp, moin, pm6, txt
410  -i, --infile=DATEI  DATEI als Quellcodedatei festlegen ('-' fόr STDIN)
411  -o, --outfile=DATEI DATEI as the Ausgabedatei festlegen ('-' fόr STDOUT)
412  -n, --enum-title    Titelzeilen fortlaufend nummerieren (1, 1.1, 1.1.1, etc)
413  -H, --no-headers    unterdrόcke Kopfzeile, Titel und Fuίzeile
414      --headers       Kopf-, Fuί- und Titelzeilen anzeigen (Voreinstellung: EIN)
415      --encoding      Zeichensatz des Zieldokuments (utf-8, iso-8859-1, etc)
416      --style=DATEI   DATEI zur Definition des Dokumentenstils benutzen (δhnlich HTML CSS)
417      --css-sugar     CSS-freundliche Auszeichnungen fόr HTML and XHTML-Zieldokumente einfόgen
418      --css-inside    CSS-Stilinformationen innerhalb des HTML/XHTML Kopfbereichs einfόgen
419      --mask-email    E-Mail-Adressen verbergen. x@y.z wird umgewandelt in <x (a) y z>
420      --toc           Inhaltsverzeichnis hinzufόgen
421      --toc-only      lediglich das Inhaltsverzeichnis ausgeben
422      --toc-level=N   maximale Nummerierungstiefe im Inhaltsverzeichnis einstellen
423      --rc            benutzerdefinierte Einstellungsdatei ~/.txt2tagsrc laden (Voreinstellung: EIN)
424      --gui           Aufruf der graphischen Tk-Schnittstelle
425  -q, --quiet         stiller Modus, jegliche Ausgaben werden unterdrόckt (auίer Fehlermeldungen)
426  -v, --verbose       Statusmeldungen wδhrend der Konvertierung ausgeben
427  -h, --help          diese Hilfeinformation anzeigen und Programm beenden
428  -V, --version       Programmversion anzeigen und Programm beenden
429      --dump-config   alle gefundenen Konfigurationsquellen ausgeben
430
431Abschalten von einzelnen Optionen:
432     --no-outfile, --no-infile, --no-style, --no-encoding, --no-headers
433     --no-toc, --no-toc-only, --no-mask-email, --no-enum-title, --no-rc
434     --no-css-sugar, --no-css-inside, --no-quiet
435
436Beispiel:
437     txt2tags -t html --toc meineDatei.t2t
438
439Per Voreinstellung wird die Ausgabe der Konvertierung in der Datei 'meineDatei.<target>' gespeichert.
440Benutzen sie --outfile um den Namen der Ausgabedatei festzulegen.
441Wird als Eingabedatei '-' angeben, liest das Programm von STDIN.
442Wird als Eingabedatei '-' angegeben, erfolgt die Ausgabe nach STDOUT.
443```
444
445==== Beispiele ====
446
447Vorausgesetzt, sie haben eine Quelldatei ``Datei.t2t``, los geht's mit der Konvertierung!.
448
449| **Konvertierung nach HTML**     | ``$ txt2tags -t html Datei.t2t``
450| **Das gleiche, mit Umleitung**  | ``$ txt2tags -t html -o - Datei.t2t > Datei.html``
451|  | .
452| **inkl. Inhaltsverzeichnis**    | ``$ txt2tags -t html --toc Datei.t2t``
453| **und die Titel nummeriert**    | ``$ txt2tags -t html --toc --enum-title Datei.t2t``
454|  | .
455| **kurze Inhaltsόbersicht**      | ``$ txt2tags --toc-only Datei.t2t``
456| **diese dann noch nummeriert?** | ``$ txt2tags --toc-only --enum-title Datei.t2t``
457|  | .
458| **Einzeiler gelesen von STDIN** | ``$ echo -e "\n**bold**" | txt2tags -t html --no-headers -``
459| **Test der E-Mail Maskierung**  | ``$ echo -e "\njohn.wayne@farwest.com" | txt2tags -t txt --mask-email --no-headers -``
460| **Nachbearbeitung mittels sed** | ``$ txt2tags -t html -o- Datei.t2t | sed "s/<BODY .*/<BODY BGCOLOR=green>/" > datei.html``
461
462: //Anmerkung//
463   Seit Version 1.6 kann mit Hilfe der ``%!preproc`` and ``%!postproc`` Konfigurationsfilter eine Vor- und Nachbearbeitung vorgenommen werden.
464
465
466========================================================================
467
468
469
470= Teil II - Ok, I mφchte das Programm. Wie geht's weiter? =[Installation]
471
472Laden sie das Programm einfach herunter und installieren sie es auf ihrem Rechner.
473
474== Herunterladen & Installieren von Python ==[download-python]
475
476Zunδchst mόssen sie den Python-Interpreter herunterladen und auf Ihrem System installieren. Sollte Python bereits installiert sein, όberspringen sie diesen Schritt.
477
478
479Python ist eine der tollsten Programmiersprachen die derzeit verfόgbar sind, und ist fόr
480Windows, 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).
481
482Falls 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.
483
484
485== Download von txt2tags ==[Download-txt2tags]
486
487Der offizielle Ort fόr die txt2tags-Distribution ist die Website des Programms, aufrufbar via http://txt2tags.org/src.
488
489Alle 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
490
491Besorgen sie sich stets die **neueste** Version (wobei die neuste Version stets auch die hφchste Versionsnummer aufweist).
492Die frόheren Versionen verbleiben lediglich zu Dokumentationszwecken auf der Seite.
493
494== Installation von txt2tags ==[Installation-txt2tags]
495
496Da es sich bei txt2tags um ein gewφhnliches Python-Skript handelt, muss txt2tags nicht gesondert installiert werden.
497
498Die 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.
499
500Die sicherste Art und Weise, txt2tags ablaufen zu lassen besteht darin, es όber den Python-Compiler aufzurufen:
501``` Eingabeprompt$ python txt2tags
502
503Wenn 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.
504
505: **UNIX/Linux**
506  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``)
507
508: **Windows**
509  Benennen sie das Skript txt2tags nach txt2tags.py um
510  (``ren txt2tags txt2tags.py``) und kopieren sie es in ein Verzeichnis, das Bestandteil ihrer Umgebungsvariable PATH ist
511  (``copy txt2tags.py C:\WINNT``)
512
513
514Falls sie die graphische Benutzerschnittstelle des Programms nutzen wollen, kφnnen sie fόr das Programm anschlieίend ein Symbol auf ihrem Desktop anlegen.
515
516=== Spezielle Pakete fόr Windows-Benutzer ===
517
518Fόr txt2tags sind auch zwei .EXE-Dateien verfόgbar, mit denen das Programm auf Windows-Rechnern mit nur wenigen Mausklicks installiert werden kann:
519
520- Das bloίe txt2tag-Skript fόr all diejenigen, die den Python-Interpreter bereits installiert haben
521  
522- Die 'Stand-alone'-Version, welche keinen Python-Interpreter benφtigt (eine abgespeckte Python-Installationsdatei ist in diese Version integriert)
523
524
525Besuchen Sie bitte die //txt2tags-Windows// Webseite um diese Pakete herunterzuladen:
526http://txt2tags-win.sf.net
527
528== Installation von Dateien zum Hervorheben der Programmsyntax fόr Texteditoren ==[Editor-syntax]
529
530Txt2tags wird mit sehr nόtzlichen Dateien zum Hervorheben der Programmsyntax ausgeliefert, solche Dateien sind dabei fόr die folgenden Texteditoren verfόgbar:
531
532- Vim (www.vim.org)
533- Emacs (www.emacs.org)
534- Nano (www.nano-editor.org)
535- Kate (http://kate.kde.org)
536
537
538ά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.
539
540           |  [IMGPATH/Kate.png]  |
541           |  Beispieldatei, geφffnet im Editor Kate 
542
543Fό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.
544
545========================================================================
546
547
548
549= Teil III - Verfassen und Konvertieren ihres ersten Dokuments =[Ihr-erstes-Dokument]
550
551== άberprόfung der Werkzeuge ==
552
553Um ihre erste Textumwandlung erfolgreich vornehmen zu kφnnen, brauchen sie drei Dinge: txt2tags, einen Texteditor und einen Webbrowser.
554
555+ Stellen Sie sicher, dass txt2tags auf ihrem Rechner installiert und funktionsfδhig ist.
556
557  - **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
558    /Pfad/zu/txt2tags" (falls Python nicht Bestandteil ihrer Umgebungsvariable PATH ist).
559
560  - **Graphische Schnittstelle:** Klicken sie auf das Programmsymbol um die graphische Benutzerschnittstelle zu starten.
561
562+ 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.
563
564+ 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.
565
566
567------------------------------------------------------------------------
568
569== Schreiben sie den Kopfbereich des Dokuments ==
570
571+ Wechseln sie zu ihrem Texteditor und tippen sie auf der ersten Zeile den Titel ihres Dokuments: //Mein erstes Dokument//
572+ Fόgen sie nun einen Untertitel hinzu, indem sie auf der zweiten Zeile den folgenden Text einfόgen:
573  //Ein Test von txt2tags//
574+ Anschlieίend kφnnen sie auf der dritten Zeile das Datum der Abfassung vermerken, wie etwa: //Freitag, 26. August 2005//
575
576Falls alles glatt gelaufen ist, sollten sie jetzt ein dreizeiliges Dokument mit folgendem Inhalt vor sich sehen:
577
578```
579Mein erstes Dokument
580Ein Test von txt2tags
581Freitag, 26. August 2005
582```
583
584Dies ist zwar nur ein kleiner Teil des gesamten Dokuments, wir kφnnen diesen Teil jedoch bereits konvertieren und anschlieίend die Ergebnisse όberprόfen.
585
586Speichern 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.
587
588
589------------------------------------------------------------------------
590
591== Die erste Umwandlung eines Dokuments - GUI Schnittstelle ==
592
593Falls sie txt2tags όber die Kommandozeilenschnittstelle bedienen wollen, όberspringen sie bitte diesen Schritt und befolgen sie die Anweisungen im nδchsten Abschnitt.
594
595Falls jedoch nach dem Aufruf von txt2tags die graphische Schnittstelle erscheint, folgen sie diesen Schritten:
596
597    [IMGPATH/erste-Konvertierung.png] 
598
599+ 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!).
600+ Zurόck am Ausgangsschirm wδhlen sie "HTML Seite" in der mit "Wδhlen Sie das Format des Zieldokuments" beschrifteten Auswahlbox.
601+ Klicken sie auf die Schaltflδche "Wandlung starten!".
602
603
604   [IMGPATH/erste-Konvertierung-fertig.png] 
605
606   Nun wird ein Fenster erscheinen, welches sie darόber informiert, dass die Datei erfolgreich konvertiert wurde.
607Beachten 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.
608
609------------------------------------------------------------------------
610
611== Die erste Umwandlung eines Dokuments - Kommandozeile ==
612
613Falls sie txt2tags όber die graphische Schnittstelle bedienen wollen, befolgen sie bitte nicht diesen Schritt sondern folgen sie den Anweisungen im vorherigen Abschnitt.
614
615Falls 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: 
616
617``` txt2tags  --target html  Test.txt
618
619Beachten 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.
620
621Nach vollendeter Konvertierung wird die resultierende Datei unter dem Namen ``Test.html`` abgespeichert, wobei das Programm die folgende Mitteilung ausgibt: 
622"//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!
623
624Hier folgt ein Beispiel dafόr, wie sich das Ganze am Bildschirm prδsentiert:
625
626```
627prompt$ txt2tags --target html Test.txt
628txt2tags erzeugte Test.html
629prompt$
630```
631
632------------------------------------------------------------------------
633
634== άberprόfung des Resultats ==
635
636Φffnen sie die Datei ``Test.html`` in einem Webbrowser um zu όberprόfen, ob alles korrekt dargestellt wird.
637
638   [IMGPATH/Ergebnis-erste-Konvertierung.png] 
639
640Da 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.
641
642  || Sie schreiben den Text, txt2tags erledigt den Rest ;) |
643
644Hinweis: Sie kφnnen auf von txt2tags erzeugte Dokumente auch CSS-Stylesheets anwenden, dadurch kann das Erscheinungsbild der Seite 100%-ig von ihnen festgelegt werden.
645
646------------------------------------------------------------------------
647
648== Verfassen des Dokuments ==
649
650Zurό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
651automatisch erkennt, sie mόssen sie gar nicht besonders auszeichnen.
652
653Und dann wieder: speichern sie ihr Dokument, wandeln es um und όberprόfen sie das Ergebnis. 
654Das 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.
655
656Vergleichen sie doch einfach die folgenden Inhalte der Quelldatei ``Test.txt``, welche in Klartext verfasst wurde, mit der bei der Konvertierung erzeugten HTML-Seite:
657
658```
659Mein erstes Dokument
660Ein Test von txt2tags
661Freitag, 26. August 2005
662
663Gut, probieren wir halt mal dieses sagenhafte txt2tags Werkzeug.
664Eigentlich weiί ich gar nicht was ich schreiben soll.
665
666Mmmmmm, I weiί was jetzt was ich tun werde:
667- Mich zuerst duschen
668- Dann eine Pizza essen
669- Mich schlafen legen
670```
671
672   [IMGPATH/Ergebnis-erste-Konvertierung-komplett.png] 
673
674
675Sie 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.
676
677Neben 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].
678
679=======================================================================
680
681
682= Teil IV - Die Konzepte von txt2tags beherrschen lernen =[Konzepte]
683
684== Die Bereiche eines .t2t Dokuments ==[Bereiche]
685
686Mit txt2tags ausgezeichnete Dateien sind in drei Bereiche aufgeteilt. Jeder Bereich hat einen anderen Zweck und besitzt seine eigenen Regeln. Es handelt sich dabei um:
687
688: //HEADAREA//
689  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)
690: //CONFAREA//
691  Dies ist der richtige Platz fόr im gesamten Dokument gόltige Einstellungen sowie fόr das Verhalten des Parsers beeinflussende Anweisungen. (optional)
692: //BODYAREA//
693  Dies ist der Platz fόr den Inhalt des Dokuments. (wird benφtigt)
694
695
696Wie 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.
697
698Die 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:
699
700```
701             _____________
702            |             |
703            | KOPFBEREICH |       1. Zunδchst der Kopfbereich
704            |             |
705            |   KONFIG    |       2. Anschlieίend die Einstellungen
706            |             |
707            |    TEXT     |       3. Und schlieίlich der Text des Dokuments,
708            |             |
709            |     ...     |          der sich bis zum Ende erstreckt
710            |     ...     |
711            |___________ _|
712
713```
714
715Hier bereits ein Kurzόberblick darόber, wie die einzelnen Bereiche definiert sind:
716
717 |  **Kopfbereich**  | Die ersten drei Zeilen der Datei, oder eine Leerzeile als erste Zeile falls kein Kopfbereich erforderlich ist.
718 |  **CONFAREA**   | Beginnt direkt im Anschluss an den Kopfbereich (zweite oder vierte Zeile) und endet mit Beginn des //Textkφrpers//.
719 |   **Textkφrper**    | Die erste gόltige Textzeile (keine Kommentar- oder Parameterzeile) nach dem //HEADAREA//.
720
721
722=== Komplettes Beispiel ===
723
724```
725Der Titel meines tollen Dokuments
726Dr. Andreas Deininger
727Letzte Aktualisierung: %%mtime(%c)
728
729%! Target  : html
730%! Style   : fancy.css
731%! Encoding: iso-8859-1
732%! Options : --toc --enum-title
733
734Hallo! Dies ist mein Test-Dokument.
735Es endet bereits hier.
736```
737
738------------------------------------------------------------------------
739
740== HEADAREA ==[Kopfbereich]
741
742Positionierung:
743- Eindeutig festgelegte Position: Die **ersten 3 Zeilen** der Datei. Nicht mehr und nicht weniger
744- 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.
745
746
747Der HEADAREA ist der einzige Bereich, dessen Position eindeutig anhand der Zeilennummern festgelegt ist: es handelt sich dabei um die ersten drei Zeilen der Quelldatei.
748
749Diese Zeilen kφnnen mit beliebigen Inhalten gefόllt werden, der Typ der Informationen ist nirgends statisch festgeschrieben.
750Dennoch wird sich fόr die meisten Dokumente ein Aufbau der HEADAREAs in der folgenden Art anbieten:
751
752   - //1. Zeile//: Titel des Dokuments
753   - //2. Zeile//: Name des Autors und/oder seine E-Mail-Adresse
754   - //3. Zeile//: Version des Dokuments und/oder Zeitpunkt der Abfassung (hierfόr bietet sich das ``%%date``-Makro an)
755
756
757Denken sie daran, dass die ersten drei Zeilen des Quelldokuments zugleich auch die
758ersten 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.
759
760
761==== Weniger (oder gar keine) Kopfzeilen ====
762
763Gelegentlich 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.
764
765Lassen 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.
766
767Der 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.
768
769Der 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.
770
771==== Auf den Punkt gebracht ====
772
773 || In Kurzform: "Kopfzeilen sind lediglich durch ihre __Position__ definiert, nicht όber ihren Inhalt" |
774
775Platzieren 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.
776
777------------------------------------------------------------------------
778
779== CONFAREA ==[config-area]
780
781Positionierung:
782- Beginnt direkt im Anschluss an den HEADAREA
783  - Beginnt auf der **vierten Zeile** der Datei falls ein **Kopfbereich** angegeben wurde
784  - Beginnt auf der **zweiten Zeile** der Datei falls **kein Kopfbereich** angegeben wurde
785- Endet mit dem Beginn des BODYAREAs
786  - Ein Leerzeile, eine Kommentarzeile oder eine Zeile in der keine Einstellung festgelegt wird beendet automatisch den CONFAREA
787
788
789Der 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.
790
791Der 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.
792
793Fόr weitergehende Informationen zu diesem Thema lesen sie bitte den Abschnitt [Einstellungen #Einstellungen-Ueberblick] .
794
795----------------------------------------------------------------
796
797== BODYAREA ==[body-area]
798
799Positionierung:
800- Beginnt mit der ersten gόltigen Textzeile innerhalb der Datei
801  - Zeilen innerhalb des Kopfbereichs, Zeilen welche Einstellungen enthalten sowie Kommentarzeilen sind **keine** gόltigen Textzeilen
802- Endet zugleich mit dem Ende der Datei (EOF)
803
804
805Jeglicher Text auίerhalb des Kopfbereichs und des CONFAREAs zδhlt zum BODYAREA.
806
807Der 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.
808
809Sie 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.
810
811----------------------------------------------------------------
812
813== Einstellungen ==[Einstellungen-Ueberblick]
814
815Einstellungen 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:
816
817 || %! Schlόsselwort : Wert |
818
819Liste aller gόltigen Schlόsselwφrter:
820
821 || Schlόsselwort  | Beschreibung |
822 |   Target        | Definiert das Zielformat in welches das Dokument beim Fehlen von Kommandozeilenoptionen konvertiert wird.
823 |  Options        | Definiert voreingestellt Optionen, welche bei der Konvertierung genutzt werden. Das Format ist dasselbe wie dasjenige von Kommandozeilenoptionen.
824 |   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.
825 |  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.
826 |   PreProc       | Eingabefilter. Definiert Regeln fόr das "Suchen und Ersetzen" welche auf das Quelldokument angewendet werden.
827 |  PostProc       | Ausgabefilter. Definiert Regeln fόr das "Suchen und Ersetzen" welche auf das bereits konvertierte Dokument angewendet werden.
828
829Beispiel:
830
831```
832%! Target  : html
833%! Options : --toc --toc-level 3
834%! Style   : fancy.css
835%! Encoding: iso-8859-1
836%! PreProc : "HPM"        "Hans-Peter Mόller"
837%! PostProc: '<BODY.*?>'  '<BODY bgcolor="yellow">'
838``…

Large files files are truncated, but you can click here to view the full file