› wiki2xhtml-Dokumentation

Andere Sprache: en

Dies ist die Hauptdokumentation zu wiki2xhtml. Die Dokumentation ist wie oben zu sehen aufgebaut. Für die ersten Schritte ist es empfehlenswert, mit den Einstiegsseiten zu beginnen. Die Hauptdokumentation (aktuelle Seite) wird am besten zum Nachschlagen verwendet.

Um wiki2xhtml ausführen zu können, benötigst du die Java Runtime[1] Version 1.6 oder höher.

Sollte hier etwas fehlen oder unverständlich sein, melde es bitte im wiki2xhtml-Forum!

Letzte Änderungen

Neu seit wiki2xhtml 3.4


Neue Seiten erstellen

Ein Teil des GUI in wiki2xhtmlnbsp3.2
Ein Teil des GUI in wiki2xhtml 3.2

Im GUI kannst du die Dateien, die du parsen willst, sowie die weiteren benötigten Dateien mit den folgenden Buttons auswählen:

Icon «Öffnen» (Nur eine Datei kann ausgewählt werden, z. B. die header-Datei)
Icon «Mehrere Öffnen» (Um mehrere Dateien auszuwählen; Hier kannst du Shift oder Ctrl halten) oder
Icon «Ordner wählen» (Um einen Ordner zu wählen)

Top

Menu

Das Menu wird aus einer Datei gelesen, damit man es nicht bei jeder Seite manuell einfügen muss (und bei einer Änderung auch wieder überall ändern …). Jeder Eintrag steht auf einer neuen Zeile in Listenform. #!link_deactivate !link_strong Menu
* Links, links.html
** Hier, here.html
** Dort, http://granjow.net
 Hier kommt nach der Überschrift «Menu» ein Eintrag «Links» mit einem Untermenu, das zwei weitere Einträge enthält. Die erste, auch optionale, Zeile beschreibt, was mit Links auf die aktuelle Seite geschehen soll. Sie muss mit #! beginnen und kann folgende Befehle beinhalten:

Die oben genannten Einstellungen können auch explizit deaktiviert werden, indem man ihnen eine Null anhängt (link_strong0). Top

Fenstertitel

Es bestehen zwei Möglichkeiten, den Fenstertitel, der in der Menuleiste erscheint, zu ändern, und man kann diese beiden Möglichkeiten sogar kombinieren. Die erste ist für viele Seiten gedacht, denn da wird der Titel in die Konfigurationsdatei gespeichert und bei allen Seiten eingefügt. Die zweite Möglichkeit ist, den Titel irgendwo in der Quelldatei mit einem {{Title:…}} zu übergeben.

Wie bereits gesagt können die Fenstertitel kombiniert werden. Der «allgemeine» Fenstertitel, der mit der Datei übergeben wird, gilt für jede Seite, der andere ist seitenspezifisch und ersetzt den allgemeinen Fenstertitel. Indem du ein %s an der gewünschten Stelle im seitenspezifischen Titel einfügst, kannst du an dieser Stelle das Programm den allgmemeinen Fenstertitel einfügen lassen. Beispiel: Deine Seite kann auf sourceforge.net gefunden werden, also willst du in all deinen Fenstertiteln ein «– .::sourceforge.net» haben. Die aktuelle Seite ist über ein Spiel, sagen wir dem mal «Tetris». Nun willst du, dass im Titel «Tetris – .::sourceforge.net» steht. Dazu benötigst du in der Quelldatei (mit dem Inhalt der Seite) folgenden Code: [Inhalt]
{{Title:Tetris, %p %s}}
[Inhalt] In der Datei common.txt musst du nun die folgende Zeile, die den allgemeinen Titel enthält – welcher möglichst alle Zeichen enthalten sollte, die immer wieder vorkommen, also in diesem Beispiel auch das «–» – hinzufügen: {{DefaultTitle:– .::sourceforge.net}} Das %p wird, falls das Dokument Seitenumbrüche enthält, mit «Seite x von y» ersetzt. Top

Header

Der Header wird heute oft dazu verwendet, Benutzer wieder zurück auf die Startseite zu führen -- eine nützliche Hilfe! Der Link zurück zur Startseite kann mit {{Homelink:…}} (irgendwo im Text oder auch in der Konfigurationsdatei) gesetzt werden. Als Beispiel nach sf.net/projects/wiki2xhtml: $$ {{Homelink:http://sf.net/projects/wiki2xhtml}} $$ Klickt man nun auf den Header (meistens ein Bild), gelangt man hierhin zurück. Top

Der Footer, ein kurzes Stück Text am Ende der Seite, muss auch in eine separate Datei geschrieben werden. Er könnte folgendermassen ausschauen: <p>Diese Seite wurde erstellt mit <a href="http://sf.net/projects/wiki2xhtml">wiki2xhtml</a> %v.</p>
<p>Erstellungsdatum: %d</p> Das %v wird durch die aktuelle Versionsnummer des Programmes ersetzt, das %d mit dem aktuellen Datum und der Zeit. Vergiss die <p> nicht!

Du kannst einen Footer mit dem Argument -f DATEI oder --footer=DATEI hinzufügen: $ java -jar wiki2xhtml help.txt --footer=footer.txt $ java -jar wiki2xhtml help.txt -f footer.txt Top

Inhaltsverzeichnis

Mit {{TOC}} kann an einer beliebigen Stelle im Text ein Inhaltsverzeichnis eingefügt werden. Der Standardtitel kann durch eine alternative Überschrift ersetzt werden mit {{TOC|Überschrift}}. Top

Quellenangaben

Um im Text Fussnoten oder Quellenangaben einzufügen, kann der ref-Befehl verwendet werden. So steht die Erklärung/Quelle nicht störend mitten im Text. Sie können am Ende der Seite mit <references /> wieder eingefügt werden. Im Text sieht das zum Beispiel folgendermassen aus: Fussnoten<ref>Durch eine Fussnote können Anmerkungen oder Quellenangaben im Fliesstext ausgelagert werden.</ref> sind oft schwerer zu spielen, da die Füsse weniger beweglich sind als die Hände.
…
== Fussnoten ==
<references /> Das Resultat: «Fussnoten[2] sind oft schwerer zu spielen, da die Füsse weniger beweglich sind als die Hände.»

Tipp: Vor den Fussnoten werden keine Leerschläge gesetzt.

Top

Konfigurationsdatei

Um die Handhabung der verschiedenen Einstellungen (wie Autor und Sprache, Übersicht in der Quickref) etwas zu vereinfachen, können diese Einstellungen nun in einer einzigen Datei gesetzt werden.

Die Konfigurationsdatei (hier common.txt genannt; common steht für «gemeinsam») wird mit dem folgenden Argument übergeben: $ java -jar wiki2xhtml.jar -c common.txt Top

Seitengestaltung

Überschriften

Überschriften solltest du immer mit dem zweiten Level beginnen -- nebenbei, die erste Überschrift ist hier sowieso deaktiviert –, da das erste für die Überschrift über die gesamte Seite steht, also einen Seitentitel. Um eine Überschrift auf dem zweiten Level einzufügen, zum Beispiel «Guten Morgen», setzt du vor und nach den Text zwei Gleichheitszeichen (und für das dritte Level drei etc.). Die Überschrift muss auf einer separaten Linie stehen. Das sieht dann folgendermassen aus: == Guten Morgen == Der Seitentitel, also die erste Überschrift, kann mit {{H1:…}} gesetzt werden. Beispiel: {{H1:Fotografie ohne Kamera}} Top

Absätze

Absätze können mit einer neuen (leeren) Linie eingefügt werden. Er stand alleine im Raum den Arm ausgestreckt, als ob er etwas suchte. Dann&nbsp;&ndash; plötzlich wurde es dunkel um ihn!

Er konnte einfach nicht schlafen, wenn das Licht an ist. Top

Zeilenumbrüche

Zeilenumbrüche können mit zwei Backslashes gefolgt von einem Leerzeichen
\\ 
eingefügt werden. Top

Seitenumbrüche

Seitenumbrüche werden mit folgenden Zeilen eingefügt: \\//
---
//\\ Dieses Muster wurde gewählt, weil es im Text gut sichtbar ist.

Achtung: Nowiki-Tags werden nicht beachtet!

Formatierung

Um Text kursiv oder fett zu formatieren, umschliesse ihn mit entweder zwei oder drei Apostrophen. Benutze Fettschrift nicht zu oft, sie sollte nur verwendet werden, um ein Lemma hervorzuheben. Beispiel: Ein '''Lemma''' is etwas, um das es sich in einem Absatz oder sogar ganzen Text ''handelt.'' Top

Es gibt zwei Arten von Links: Absolute und relative. Der Unterschied: Ein absoluter oder externer Link führt gewöhnlicherweise zu einer Seite wie http://www.gimp.org. Ein relativer oder interner Link wird benutzt, um zusammengehörende Seiten untereinander zu verlinken, die oft auch im selben Verzeichnis liegen.

URLs wie http://sourceforge.net werden ohne weiteres erkannt und etwaige Punkte oder andere Satzzeichen entfernt. Wenn du einem Link einen anderen Namen geben willst, umschliesse ihn mit eckigen Klammern und füge die Beschreibung nach einem Leerzeichen an: [http://www.scribus.net Scribus] führt zu Scribus.

Relative Links zur Navigation innerhalb einer Seite werden mit zwei eckigen Klammern gekennzeichnet: [[doc.html]] etwa führt zur englischsprachigen Ausgabe dieser Seite: doc.html. Der Seitenname kann auch mit anderem Text ersetzt werden, indem man diesen Linktext mit einem Leerzeichen oder einem vertikalen Strich («|») vom Link trennt. Siehe auch «Zeichen escapen» für weitere Informationen.

Beispiele: http://www.gimp.org ist der Link zum «GNU Image Manipulation Program».
[http://www.gimp.org GIMP] ersetzt den Linknamen mit «GIMP».
[[help-de.txt Diese Datei]] ist die Quelle für dieses HTML-Dokument, das du gerade siehst.

Hinweise:

Anker

Es ist auch möglich, Anker innerhalb einer Seite zu verwenden. In HTML werden dazu Elementen, zum Beispiel einer Überschrift, eine einmalige ID vergeben, zu der man mit einem Link springen kann. Überschriften bekommen automatisch eine zugewiesen, es können aber auch innerhalb des Textes welche verwendet werden.

Überschriften haben die ID «h_» gefolgt von der Überschrift selber, in leicht abgeänderter Form. Einige Sonderzeichen wie Leerzeichen werden entfernt (Um genau zu sein: Es wird ein XML-Name verwendet, alle erlaubten Zeichen sind hier aufgelistet, in eindeutiger, aber etwas schwer verständlicher Form). Der einfachste Weg, um herauszufinden, wie die ID einer Überschrift lautet, ist, sie im Code-Fenster im GUI von wiki2xhtml einzufügen.

Du kannst auch einen eigenen «Anker», also eine Stelle, zu der gesprungen werden kann, im Text einfügen. Dies geschieht mit dem Kommando ~~eindeutiger Name~~. Der Name darf dabei nur ein Mal vorkommen. Danach kannst du (beliebig oft) an diese Stelle verlinken.

Um nun einen Link auf einen solchen Anker zu setzen, hängt man dem Ziel ein #, gefolgt vom Namen des Ankers, an. Falls sich das Ziel auf der selben Seite befindet, kann der Seitenname weggelassen werden. Folgende Beispiele linken auf die Galerie und auf die Überschrift «Tabellen»: ~~gallery~~
…
[[doc-de.html#gallery Galerie]] hat das selbe Ziel wie [[#gallery Galerie]]
[[#h_Tabellen Tabellen]] (Gross-/Kleinschreibung nicht vergessen!) Top

Bilder

Es ist einfach, Bilder einzufügen. Wenn du zum Beispiel ein Bild mit dem Namen «img.jpg» hast, füge deiner Seite den Code [[Image:img.jpg]] hinzu. Du kannst an Stelle von Image: auch Bild: verwenden. Eine Beschreibung kannst du nach einem Vertikalen Strich (Pipe-Zeichen) angeben. [[Image:img.jpg|thumb|Butterwort ''(Pinguicula)'']] Du kannst das Resultat oben an der Seite betrachten.

Für Bilder (auch in der Galerie) werden mit dem Argument thumb spezielle Seiten erzeugt. Wird zwei Mal von einer Seite aus zum selben Bild verlinkt, aber mit unterschiedlicher Beschreibung, wird die letzte Beschreibung verwendet. Wenn es von verschiedenen Seiten aus verlinkt wird, werden seperate Bildbeschreibungsseiten erstellt.

Den Bildern können auch Argumente übergeben werden.

Ausserdem:

Tipp: Der Link zum Thumbnail kann auch für ein Bild separat gesetzt werden; falls ein PDF-Dokument (buch.pdf) zum Beispiel ein spezielles Vorschaubild bekommen soll (cover.png), verwendet man statt thumb das Argument thumb=cover.png. Ansonsten sollte ein Standardpfad zu den Thumbnails gesetzt und einfach das Argument thumb verwendet werden.

Beispiele zum Einfügen von Bildern

Ohne Argumente

[[Image:ahorn-300.jpg]]

Das Bild wird direkt eingefügt, in Originalgrösse.


Beschriftet und mit neuer Grösse

[[Image:ahorn-300.jpg|Ahorn|150px]]

Das Bild bekommt die Bildunterschrift «Ahorn» und wird auf eine Breite von 150 Pixel gesetzt.

Ahorn
Ahorn


Vorschaubild (Thumbnail)

[[Image:ahorn-300.jpg|thumb=ahorn-thumb.jpg|Ein Ahornblatt|ld=Silber-Ahorn ''(Acer saccharinum)'']]

Das Vorschaubild ahorn-thumb.jpg wird verwendet. Als Bildtitel wird «Ein Ahornblatt» gesetzt, ausserdem eine ausführliche Beschreibung mit dem lateinischen Namen, die auf der verlinkten Bildseite verwendet wird.

Ein Ahornblatt
Ein Ahornblatt


Direkt verlinktes Vorschaubild

[[Image:ahorn-300.jpg|thumb|direct|thumb=ahorn-thumb.jpg|Silber-Ahorn]]

Die ausfürhliche Beschreibung wurde weggelassen, da durch die direkte Verlinkung keine Bildseite erstellt wird.

Silber-Ahorn
Silber-Ahorn

Top

Tipp: Du kannst mit {{DirImages:…}} ein Standardverzeichnis für die Bilder setzen. Um auf eine Datei zuzugreifen, die nicht in diesem Verzeichnis ist, kann ./ vor den Pfad geschrieben werden (. bedeutet das aktuelle Verzeichnis). Siehe Quickref für weitere Einstellungen.

Galerie

Du kannst deiner Seite mit dem gallery-Tag eine (oder mehrere) Galerie hinzufügen. Zwischen dem öffnenden und schliessenden Tag kannst du Bilder oder Reintext hinzufügen, wie du im Beispiel oben siehst. Mit dem Argument caption= kannst du eine Überschrift für die Galerie setzen. Beispielcode: <gallery caption="Meine Galerie">
Image:ferien.jpg
Ja, das waren gute Zeiten &hellip; schau dir mal den links an ;)
Image:meer.jpg|Mein Boot. Ich habe es&nbsp;&hellip; ähm, ausgeliehen.
<gallery> Top


Top

Listen

Listen können hier viel einfacher als mit HTML eingefügt werden: Für ein Element reicht ein * am Anfang der Zeile. Numerierte Listen können mit dem Zeichen # generiert werden. * Erstes Level
** Zweites Level

Definitionslisten sind eine andere Art von Listen. Hier werden sie zum Beispiel bei der FAQ verwendet.

«Defititionspunkte» können mit einem ; eingefügt werden.
Mit dem : am Anfang der Zeile kann der Punkt nun erklärt werden.

Den Listenpunkten können Argumente wie zum Beispiel CSS-Definitionen übergeben werden. Alles, was vor einem Pipe-Symbol («|») steht, wird als Argument betrachtet. Das Argument style="color: #f00;" färbt die Zeile zum Beispiel rot ein. * style="color: #f00;" | Dieser Listeneintrag ist rot gefärbt.

Top

Tabellen

Tabellen können Tabellenüberschrifte haben. Du kannst Tabellen entsprechend dem folgenden Beispiel einfügen: {|
!
! Windows
! Linux
|-
! Musik-Player
| [http://www.apple.com/itunes/ iTunes]
| [http://amarok.kde.org/ Amarok]
|-
! Fotos
| [http://picasa.google.com/ Picasa]
| [http://www.digikam.org/ digikam]
|} Die erste Zelle wird hier ausgelassen. Das Resultat wäre das Folgende:

Windows Linux
Musik-Player iTunes Amarok
Fotos Picasa digikam

Dies sind die Grundlagen. Um die Übersicht im Quellcode zu erhöhen, kannst du mehr als eine Zelle pro Linie einfügen, indem du die sie mit zwei vertikalen Linien trennst: | Zelle 1
| Zelle 2
ist das selbe wie
| Zelle 1 || Zelle 2

Du kannst auch Eigenschaften wie die Breite einer Zelle oder ihre Hintergrundfarbe festlegen. In diesem Fall musst du die Argumente mit einer vertikalen Linie und einem Leerschlag davor und danach von Inhalt trennen. {|
| style="width: 200px; border: 2px solid #000;" | 200 px breit
|}

200 px breit

Hinweis: Verwechsle Tabellen nicht mit Listen! Sie haben verschiedene Anwendungsbereiche. Top
Weitere Möglichkeiten

Farbiger Rahmen (border: 1px #98e5b3 solid;), links 10 Pixel breit (border-left-width: 10px;), rechts ein Zeichen Abstand (padding-right: 1em;):

style="border: 1px #98e5b3 solid; border-left-width: 10px; padding-right: 1em;" Zelle 2


Zwei Pixel Abstand zwischen den Zellen: cellspacing="2" als Argument für die ganze Tabelle

{| cellspacing="2" style="border: 1px solid;" Zelle 2


Einzelne Zeilen können separat formatiert werden, indem man die Argumente nach dem Zeichen für die neue Zeile (|-) anfügt.

Position der Argumente Wirkungsbereich
Argumente nach {| Ganze Tabelle
Argumente nach |- Formatierungen für eine Zeile
Argumente nach | einzelne Zelle

Der dazu benötigte Code: {| cellspacing="2" style="background-color: #fff0c8;"
! Position der Argumente !! Wirkungsbereich
|-
| | Argumente nach {| || Ganze Tabelle
|- style="color: #e9713c; background-color: #fff; font-weight: bold;"
| | Argumente nach |- || Formatierungen für eine Zeile
|-
| | Argumente nach | || style="font-style: italic;" | einzelne Zelle
|}

Tipp: Steht in einer Zelle ein |, wird der Inhalt davor als Argument interpretiert (und abgeschnitten). Setze ein |, mit Leerschlägen getrennt, an den Anfang des Zellinhaltes, um dieses Problem zu vermeiden (siehe auch oben).

Top

Beispiele, Zitate

Siehe auch: Zeichen «escapen»

Text kann mit weiteren Auszeichnungen versehen werden:

--text-- für entfernten Text,
++text++ für eingefügten Text,
$$code$$ für Quellcode,
@@cite@@ für Zitate
::samp:: für Beispiele
01kbd01 Für Tastatureingaben

Soll ein separater Absatz dafür verwendet werden (alle obigen Auszeichnungen ausser entfernter/eingefügter Text), müssen die jeweiligen Steuerzeichen auf neuen Linien stehen. Ein Beispiel für Quellcode: Leerzeichen werden so dargestellt, wie sie eingegeben wurden. Falls nicht, muss in der CSS-Datei folgender Abschnitt hinzugefügt werden: $$
code.block { white-space: pre; }
$$ Für Tastatureingaben: Vim bedienen lernen unter Debian:
01 $ apt-get install vim $ vimtutor
01 Zitate werden demnach so eingefügt: … Und er sprach:
@@ ZITAT
@@ Und es wurde ein Zitat. Ein Beispiel (Leerzeichen vor den beiden Doppelpunkten beachten! Sonst wird es als Liste interpretiert!): Der Gedankenstrich – genau der – kann unter Windows über die Tastenkombination 01Alt+015001 eingefügt werden. Top

Horizontale Linien

Du kannst horizontale Linien einfügen, solltest sie aber nur verwenden, wenn es wirklich nötig ist. Der Code: ---- Top

Vorlagen

Inhalt, der immer wieder vorkommt (wie hier der Button zum wechseln der Sprache), kann in einer Datei im selben Verzeichnis wie die Quelldateien gespeichert werden. Diese, in diesem Beispiel tplLang-de.txt, kann dann wie folgt eingebaut werden: {{:tplLang-de.txt}} Der Text von der Vorlagenseite läuft auch durch den Parser, Wikitext wird also erkannt. Ausserdem werden Parameter unterstützt. Falls Text Sonderzeichen wie vertikale Striche oder schliessende geschweifte Klammern beinhaltet, die falsch verstanden werden können (eta als Parameter-Trennzeichen), können diese mit <![CDATA[text]]> maskiert werden: {{:tplLang-de.txt|<![CDATA[ «}}» sind zwei schliessende geschweifte Klammern, «|» ist ein Pipe-Symbol.. ]]>}} Top

Tipps

Mein Programm macht nicht alles. Ein paar Dinge sind nur ein wenig HTML und CSS, aber andere kann das Programm nicht oder nur wenig beeinflussen, wie zum Beispiel richtige Typografie. Ich werde dir nun einen kleinen Überblick über die Möglichkeiten verschaffen, die du hast.

Bemerkung: In den Beispielen, die zeigen, wie man ein Quelldokument parst, werde ich als Beispiel die Datei help-de.txt verwenden. Ein Befehl ist mit einem $ am Zeilenanfang markiert. Das Grundkommando ist: $ java -jar wiki2xhtml.jar help-de.txt Dies würde die Datei doc-de.html erstellen, ohne menu und weitere Specials.

Es ist möglich, mehrere Dateien gleichzeitig zu kompilieren. Da der *-Operator jedoch noch nicht funktioniert, muss jede Datei von Hand eingegeben werden. Oder halt ein Skript schreiben ;) Top

Zeichen «escapen»

Wenn du etwa ein Beispiel für HTML-Code schreiben willst, kannst du im Quellcode nicht einfach ein <p> hinschreiben, da dies in HTML einen Absatz darstellt. Dazu gibt es gewisse Codes, die trotzdem solche Zeichen generieren können, aber nicht als HTML interpretiert weren. Die wichtigsten Codes sind:

Um zu verhindern, dass ganze Ausdrücke vom Programm nicht als Wikipedia-Syntax interpretiert werden, kannst du sie mit dem nowiki-Tag umschliessen. So kannst du zum Beispiel verhindert, dass ein Link (zum Beispiel www.google.com) auch verlinkt wird. Beispielcode: <nowiki>www.google.com</nowiki> Wie kann man diese Codes selber herausfinden? Ganz einfach: Sie werden zum Beispiel in OpenOffice.org in der Zeichentabelle (Einfügen > Sonderzeichen) angezeigt. Für die geschweifte Klammer «{» steht hier zum Beispiel «U+007B (123)». Die Zahl in Klammern kann nun mit &#ZAHL; eingefügt werden. Alternativ kann direkt der Unicode[4] eingefügt werden, in diesem Fall &#x007B;. Dies funktioniert für jedes Zeichen.

In URIs kann es spezielle Zeichen wie einen Leerschlag haben, was zur Folge haben kann, das zum Beispiel Links nicht mehr korrekt erkannt werden. Diese können auch maskiert werden:

Ein Beispiellink zu einem (nicht existierenden) Dokument namens «mit leerschlag.html» würde nun so ausschauen: [[mit%20leerschlag.html mit Leerschlag]]. Das Resultat: mit Leerschlag. Alternativ kannst du bei internen Links auch eine vertikale Linie («|») verwenden, um Link und Linkname zu trennen: [[mit leerschlag.html|mit Leerschlag]]. Das führt zum selben Resultat: mit Leerschlag

Im Internet gibt es ein sehr gutes Nachschlagewerk, wo beinahe alle Codes, die man braucht, aufgelistet sind: w3schools.com. Top

Thumbnails

Die Ladezeiten von Seiten sollten möglichst gering bleiben. Je mehr beim Betreten einer Seite geladen werden muss, desto länger dauert der Aufbau beim User und desto mehr wird der Server belastet. Darum werden bei Bildern nicht die Originalbilder als Vorschau verwendet, sondern weniger hoch aufgelöste und somit auch von der Dateigrösse her kleinere. Thumbnails können zum Beispiel mit Programmen wie GIMP oder XnView generiert werden. Unix-User haben mit convert von ImageMagick ein mächtiges Werkzeug in der Hand.

Thumbnails speichert man am besten in einem separaten Ordner. Damit sie ohne Probleme automatisch eingebunden werden können, sollten sie den Originaldateinamen enthalten. Gute Wahlen sind zum Beispiel «bildname_thumb.jpg», «thumb_bildname.jpg» oder noch einfacher, falls die Thumbnails in einem separaten Ordner sind, «bildname.jpg», also der Name des Bildes selber. Ausnahmen können mit thumb=… manuell gesetzt werden.

Variablen (Beispiel am Bild dir/image.jpg)

Beispiele (Originaldateiname: image.jpg):

Ordnername Thumbnailname Eintrag in der Konfigurationsdatei
thumbs image.jpg {{Thumbnails:thumbs/%f}}
thumbs thumb_image.jpg {{Thumbnails:thumbs/thumb_%f}}
thumbs image_thumb.jpg {{Thumbnails:thumbs/%w_thumb%e}}
thumbs image.png {{Thumbnails:thumbs/%w.png}}

Top

Meta-Informationen

Den (x)html-Dateien können noch weitere Informationen mitgegeben werden, so genannte Metadaten. Sie dien(t)en der Unterstützung von Suchmaschinen; heute werden sie jedoch wegen der Anfälligkeit für Manipulationen weitgehend ignoriert und stattdessen der sichtbare Textteil interpretiert. wiki2xhtml unterstützt folgende Informationen:

{{Description:…}}

{{Keywords:…}}

{{Author:…}}

{{Lang:…}}

{{Meta:name=content}} (name/content-Kombinationen)
{{Meta:anything you like}} (irgendwelche Kombinationen) Diese Informationen können sowohl in der Konfigurationsdatei als auch in der Textdatei selber gesetzt werden. Top

Automatische Weiterleitung

Du kannst den Benutzer zu einer anderen Seite weiterleiten, indem du die folgende Zeile einfügst: #REDIRECT 2 index.html So wird er innerhalb von zwei Sekunden zur Seite index.html weitergeleitet. Vergiss nicht, eine kurze Notitz zu hinterlassen, da die automatische Weiterleitung von einigen Browsern nicht unterstützt wird. Top

Icon

Um der Seite ein Icon (Favicon) zuzuweisen, reicht folgender Befehl (irgendwo im Text oder in der Konfigurationsdatei): {{Icon:…}} Top

PHP, JavaScript und CSS seitenspezifisch

Für seitenspezifisches PHP, JavaScript, CSS und ähnliches können zwei verschiedene Befehle verwendet werden. Falls der Code noch vor die gesamte Seite gehört, auch vor das html-Tag, wie dies bei PHP notwendig ist, kann der Code am Anfang der Seite eingefügt werden und mit dem Befehl <!--endtop--> abgeschlossen werden. Zum Einbinden von CSS, JavaScript und ähnlichem umschliesst man den Code mit zwei Tags, wie im folgenden Beispiel für CSS dargestellt: <!--head--> <style type="text/css"> body { background-color: #fb0; } </style> <!--/head-->

Siehe auch die Dokumentationsseite zu PHP. Top

Typografie[5]

Es sind wenige Dinge, die beachtet werden sollen, diese sind es jedoch umso mehr wert.

Die „Wikipedia” gehört zu den zehn am meisten aufgerufenen Seiten im Internet.
Das Spiel «X3 Reunion» von Egosoft/DeepSilver ist ein eine geniale Weltraumsimulation.

Es regnet …
warum auch nicht?s Top

Kommandozeilenmodus

Wenn du wiki2xhtml oft verwendest, möchtest du es vielleicht über die Kommandozeile bedienen, da du da auch Scripts schreiben kannst, wenn du zum Beispiel oft die selben Dateien erstellen musst. So bist du oft viel schneller, auch weil das GUI nicht geladen werden muss.

Du erhältst eine Übersicht über alle möglichen Befehle, indem du das Argument --help oder -h hinzufügst (also java -jar wiki2xhtml.jar --help). Die wichtigsten Befehle will ich hier nun erklären. Ein $ am Anfang eines Code-Beispiel zeigt einen Befehl in der Shell (DOS, bash, ...) an (und wird weggelassen).

Wenn du die Hilfedateien erstellen willst, rufe das Programm mit dem Argument --helpfiles-de auf: $ java -jar wiki2xhtml.jar --helpfiles-de

Du kannst das «Gerüst» (mit den html-, head-, body- und weiteren Tags, die von einer kompletten (X)HTML-Datei benötigt werden) mit dem Argument --only-code weglassen, wenn du den HTML-Code sonstwo verwenden willst. $ java -jar wiki2xhtml.jar --only-code {Datei(en)}

Wenn du mit wiki2xhtml HTML-Dateien für PostNuke generieren willst: Die Zeilenumbrüche können mit --remove-newlines alle weggelassen werden (PostNuke fügt manchmal ein <br /> an jedes Zeilenende an, was zu unerwünschten Resultaten führt). Das Gerüst wird hier auch nicht benötigt. Du kannst die beiden Argumente mit --pn abkürzen; Die beiden folgenden Befehle haben die selbe Bedeutung. $ java -jar wiki2xhtml.jar --remove-newlines --only-code {Dateien, Argumente, ...} $ java -jar wiki2xhtml.jar --pn {Dateien, Argumente, ...} Willst du die Ausgabe direkt in der Shell haben, kannst du zusätzlich das Argument --stdout hinzufügen. $ java -jar wiki2xhtml.jar --remove-newlines --only-code --stdout {Datei(en), Argumente, ...} $ java -jar wiki2xhtml.jar --pns {Datei(en), Argumente, ...}

--standard bedeutet das selbe wie -m menu.txt -f footer.txt -c common.txt. Die Argumente können überschrieben werden (beispielsweise mit einem -v für den verbose-Modus).

Mit -v (oder --verbose) werden mehr Informationen zu den durchgeführten Schritten angegeben, mit --silent nur das Notwendigste. --debug ist für die Aufspürung von Fehlern gedacht. Top

Quellen, Bemerkungen

  1. [↑] Java kann kostenlos unter java.com heruntergeladen werden.
  2. [↑] Durch eine Fussnote können Anmerkungen oder Quellenangaben im Fliesstext ausgelagert werden.
  3. [↑] Vorschaubilder müssen manuell erstellt werden!
  4. [↑] http://www.decodeunicode.org/ ist eine riesige Referenz zu Unicode-Zeichen. Hier findet man wohl alles …
  5. [↑] Kurzes und präzises Dokument über Typografie: typokurz

Top