Hilfedatei – wiki2xhtml @ .::wiki2xhtml.sf.net

Andere Sprache: (en)

Diese Hilfedatei wurde von wiki2xhtml erstellt, das du unter sourceforge.net finden kannst.

Um dieses Programm ausführen zu können, brauchst du die Java Runtime Version 1.5^[1] oder höher. wiki2xhtml läuft sowohl mit einer grafischen Oberfläche (GUI) als auch über die Konsole. Wenn in der Konsole keine Argumente angegeben werden (einfach java -jar wiki2xhtml.jar), wird das GUI gestartet. wiki2xhtml kann auch gestartet werden, indem man die Datei wiki2xhtml.jar oder start.bat doppelklickt (auf Unix-Systemen: start.sh ausführen).

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

Was ist es?

: Fettblatt (Pinguicula)

wiki2xhtml hilft dir, eine eigene Internetseite zu erstellen. Du musst wiki2xhtml nur Textdateien in Wikitext übergeben, um das Design und den (X)HTML-Code kümmert sich das Programm.

Es ist auch möglich, eigene Designs zu verwenden und mit PHP-Dateien zu arbeiten. Top

Letzte Änderungen

Menu
Fenstertitel (%p)
Seiten-/Zeilenumbrüche (neu)
Links (Anker)
Bilder (Argumente)
Listen (Definitionslisten)
Tabellen (weitere Möglichkeiten)
Automatische Weiterleitung (neu)

Neue Seiten erstellen

: Ein Teil des GUI in wiki2xhtml 3.2

Wenn du eine neue Seite parsen (d. h. in den (X)HTML-Code übersetzen), musst du zuerst den Inhalt der Seite in einer neuen Datei speichern. Sie kann irgendeine Endung haben (.html wird nur kopiert). Die Datei muss Reintext sein, also kein von Word gespeichertes .doc oder etwas in diese Art. Unter Windows kann dazu zum beispiel der (ziemlich primitive) «Editor» von Microsoft (zu finden unter Windows > Zubehör) oder mächtigere Programme wie Notepad++, den ich persönlich bevorzuge, oder jEdit (etwas grösser) verwenden. Für Unix-Betriebssysteme sind genügend gute Programme vorhanden.

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

(nur eine Datei kann ausgewählt werden, z. B. die header-Datei)

(Wenn du mehr als eine Datei auf einmal auswählen willst; Hier kannst du Shift oder Ctrl halten) oder

(wenn du zu Dateien eine weitere Datei hinzufügen willst)

Um eine Datei mit dem Text in der Wiki-Syntax zu parsen, wird ihr Name an den Befehl angehängt. Ist der Name zum Beispiel «helloWorld.txt», würde der Befehl (vorerst ohne irgendwelche Argumente) folgendermassen ausschauen: $ java -jar wiki2xhtml.jar helloWorld.txt

Um deiner Seite ein Menu hinzuzufügen, musst du die Links mit ihren Namen in eine Datei (hier «menu.txt») schreiben (siehe unten, wie diese ausschauen muss). Dann kannst du sie dem Programm mit dem Argument -i übergeben: $ java -jar wiki2xhtml.jar -i menu.txt helloWorld.txt

Du kannst einen Standard-Seitentitel, der in der Titelleiste sichtbar ist, in einer Datei angeben (Aufbau siehe unten) und diese mit dem Argument --common oder -c übergeben. Im Beispiel heisst die Datei «common.txt». $ java -jar wiki2xhtml.jar -c common.txt -i menu.txt helloWorld.txt oder $ java -jar wiki2xhtml.jar --common=common.txt -i menu.txt helloWorld.txt

Eine Beispielseite könnte folgendermassen aussehen: Der '''Bogen''' ist ein alte Jagd- und Kriegswaffe. Seit der jüngeren Altsteinzeit (30.000–10.000 v. Chr.), nutzen Menschen Pfeil und Bogen für die Jagd und auch für kriegerische Auseinandersetzungen. Als älteste Bogendarstellung gilt eine Kalksteinplatte aus der Grotte des Fadets, Dept. Vienne, Frankreich aus dem späten Magdalénien. Heute gilt der Bogen meist als Jagd- und Sportgerät und gilt nach dem deutschen Waffengesetz nicht als Waffe. Im Gegensatz dazu ist die Armbrust einer Schusswaffe gleichgestellt, allerdings erlaubnisfrei. Die Bogenjagd auf Schalenwild und das Bogenfischen sind in der Bundesrepublik Deutschland verboten. Bis zum heutigen Tage werden Bögen benutzt und ständig weiter entwickelt. Moderne Compound- und Recurve-Bögen sind spitzentechnische Geräte. Das meist bunte mit allerlei Federn versehene oder auch selbstgebastelte Kinderspielzeug Pfeil und Bogen wird umgangssprachlich auch als '''Flitzbogen''' oder '''Flitzebogen''' bezeichnet.

== Geschichtliches ==
=== Langbogen ===
Die ältesten bekannten Bögen (Felsbilder und Funde, z.…B. Mare Heath oder Holmegard) sind Langbögen. Diese Funde sind, im Gegensatz zum englischen Langbogen als Flachbögen (Bögen mit annähernd flach rechteckigem Querschnitt) gestaltet. Sehr viel später entwickelte sich daraus der englische Typ mit tiefem D-förmigem Querschnitt, der gegen Ende des 13. Jahrhunderts in Westeuropa zur effektivsten Fernkampfwaffe wurde, die von einem einzigen Menschen bedient werden konnte. Der militärische Einsatz des Langbogens wurde im europäischen Mittelalter zuerst in England realisiert. (Quelle: Wikipedia: Bogen (Waffe), Sa 20. Jan 13:39:30 CET 2007)

Tipp: Wenn du nur den formatierten xhtml-Code benötigst und nicht die ganze Datei (mit den html-, header- und weiteren Tags), z. B. für eine Verwendung in PostNuke, kannst du mit den Argumenten --only-code und --remove-linebreaks oder -- für PostNuke -- direkt mit --pn oder --pns. Falls du mit dem GUI arbeitest, öffne das Code-Paste-Fenster und tippe deinen Text; er wird im Code-Fenster automatisch umgewandelt. Ein Klick dort hinein kopiert den Inhalt in die Zwischenablage. Falls erwünscht, kannst du noch den Haken bei «Rmove Linebreaks» setzen. Top

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 …) Auf der ersten Zeile muss das Ziel stehen, auf der zweiten der Linkname. Um ein Untermenu einzufügen, kannst du einen bzw. zwei Sterne vor das Ziel setzen.

Hier ein Beispiel: Ein Menueintrag mit dem Namen «Links», der zur Datei «links.html» verweist und ein Untermenu mit Links zu http://inkscape.org/ mit dem Namen «Inkscape» und http://www.scribus.net mit dem Namen «Scribus» enthält. links.html Links *http://inkscape.org/ Inkscape *http://www.scribus.net Scribus 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.

Hinweis: Wenn du keinen Titel angibst, wird der vorgegebene Titel «wiki2xhtml» gesetzt. Um dies zu vermeiden, kannst du einen leeren Titel setzen, indem du in der Datei ein {{Title: }} einfügst, also einen Leerschlag als Titel setzt. 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

Footer

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

Tip: Vor den Fussnoten werden keine Leerschläge gesetzt. Top

Konfigurationsdatei

Um die Handhabung der verschiedenen Einstellungen (u. a. Titel-Datei, Header-Datei, …) 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 – 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

Links

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.

Für relative Links – um innerhalb deiner Seiten zu navigieren – benötigst du zwei eckige Klammern. [[help-de.txt]] führt dich zur Datei «help-de.txt» im selben Verzeichnis, wie wir uns jetzt befinden: help-de.txt. Es ist möglich, einen Namen für den Link zu setzen; Er kann entweder mit einem Leerzeichen oder einem vertikalen Strich («|») angehängt werden. 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:

Wenn du einen relativen Link zu einer Seite einfügst, die vom Programm generiert wird, vergiss nicht, dass die Endung nachher .html lautet!
Interne Links auf die aktuelle Seite werden deaktiviert: [[help-de.html]] wird zu help-de.html (siehe auch im Menu).
Link und Beschreibung können entweder mit einem | oder mit einem Leerschlag getrennt werden. Das Pipe-Symbol ist für das Programm «wichtiger» als ein Leerschlag.

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 (Tags, Zeichen '"#!?.,:) werden entfernt und Leerschläge durch Unterstriche ersetzt. Die Überschrift «Neue IDs!» wird so h_neue_ids (klein geschrieben!). 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 {{Mark: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»: {{Mark:gallery}} … [[help-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.

pwidth=auto – Vergrössert/verkleinert Bilder auf der Bilderseite nicht (falls das Bild zum Beispiel kleiner ist als auf der Seite eingestellt, ist es sinnvoll, es nicht zu vergrössern, umgekehrt jedoch nicht)
caption=… – Ersetzt die Bildüberschrift, die sonst einfach aus dem Namen des Bildes besteht
thumb — Fügt ein Vorschaubild^[3] (Thumbnail) ein und erstellt automatisch eine Bildbeschreibungsseite (diese kann allerdings mit direct unterdrückt werden)
thumb=… – Setzt den Link zum Thumbnail (Vorschaubild). Wird es weggelassen, nimmt das Programm stattdessen den (anpassbaren) Standard-Pfad.
ld=… – Setzt eine lange Bildbeschreibung, die nur auf der Bildseite sichtbar ist
w=... oder width=... – Setzt die Breite des Bildes. w=auto bewirkt auch hier, dass die Originalgrösse des Bildes verwendet wird.
direct — Verlinkt direkt zu einem Bild ohne Bildbeschreibungsseite

Beispiel: ... [[Image:sunrise.jpg|thumb|Sonnenaufgang über dem Meer|caption=Sonnenaufgang|ld=Ein Sonnenuntergang, wie wir ihn täglich erlebt haben im Urlaub]] ...

Zur Übersicht

Ohne Argumente: [[Image:ahorn-300.jpg]]





  Mit Text und 100 Pixel breit: [[Image:ahorn-300.jpg|Ahorn|w=100]]





Ahorn



  Vorschaubild: [[Image:ahorn-300.jpg|thumb|thumb=ahorn-thumb.jpg|Ein Ahornblatt|ld=Silber-Ahorn <em>(Acer saccharinum)</em>|caption=Ahornblätter]]





Ein Ahornblatt




 Vorschaubild, direkt verlinkt: [[Image:ahorn-300.jpg|thumb|direct|thumb=ahorn-thumb.jpg|Silber-Ahorn]]





Silber-Ahorn



Top

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



Bildergalerie

























Das Zeichen «|» wird benutzt, um einem Bild eine Beschreibung hinzuzufügen.





Nur Text führt zu einem reinen Textfeld. Auch hier ist es möglich, einen Link einzufügen. Die Überschrift kann mit dem Befehl <gallery caption"…"> gesetzt werden.






Segelboote

























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.



  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

HTML unterstützt die Formatierung von Code mit dem code-Tag. Du solltest es nur für Beispiele in normalem Text verwenden. Wenn du Code über mehere Linien einfügen willst, setze die Klasse auf «code», und die CSS-Datei wird es ein wenig tunen ;)

Der Code, der hierfür verwendet wird:

<code class="code">

Dein Code hier<br />

Eine neue Linie benötigt ein <br />.

</code>

Auch möglich für Befehle:

$ echo 'Verwende "command" an Stelle von "code"'

Wenn du ein Zitat einfügen willst, hast du die Möglichkeit, es wie in diesem Beispiel hervorzuheben:

… Und er sprach: <cite class="example"> Beispieltext </cite>.

Und es wurde ein Zitat.

Top


Horizontale Linien

Du kannst horizontale Linien einfügen, solltest sie aber nur verwenden, wenn es wirklich nötig ist. Der Code:
----
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 help-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:


  < → &lt;
  > → &gt; (sollte auch verwendet werden!)
  & → &amp;
  [ → &#91;
  \ → &#92;
  ] → &#93;
  { → &#123;
  | → &#124;
  } → &#125;
  ' → &#39;
  — → &mdash; (m-dash, langer Gedankenstrich)
  – → &ndash; (n-dash, normaler Gedankenstrich)
  Leerschlag → &nbsp; (geschütztes Leerzeichen)



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;.



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:


  Leerzeichen → %20
  [ → %5b
  ] → %5d
  | → %7c



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)


  %n – voller Name, mit Pfad (dir/image.jpg)
  %f – Dateiname (image.jpg)
  %d – Pfad (dir)
  %w – Ohne Erweiterung (image)
  %e – Erweiterung (.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:


  Beschreibung: Eine kurze Beschreibung des Seiteninhaltes. {{Description:…}}
  Schlüsselwörter: Was ein Suchender in die Suchmaschine tippen kann, um hierher zu gelangen. {{Keywords:…}}
  Author: Der Autor der Seite. {{Author:…}}
  Eigene: Entweder mit {{Meta:name||content}} oder, wenn der ganze Inhalt definiert werden soll, mit {{Meta:name="…" content="…"}}



Weiter kann die Sprache des Inhaltes angegeben werden (z. B. de oder en):

{{Lang:…}}

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 zuzuweisen, reicht folgender Befehl (irgendwo im Text oder in der Konfigurationsdatei):

{{Icon:…}}

Top


Typografie^[5]

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


  Gedankenstriche haben ungefähr die Länge eines «n» (beim Binde-Strich ist es ungefähr die Hälfte davon) und sowohl davor als auch danach ein Leerzeichen. Sie werden im HTML-Code mit &ndash; angegeben. Bei eingeschobenen Sätzen –␣wie bei diesem hier␣– kann auf der «Innenseite» der beiden Gedankenstriche ein geschütztes Leerzeichen (&nbsp;, hier durch ein ␣ dargestellt) gesetzt werden, damit sie bei einem Zeilenumbruch nicht an der falschen Stelle hängen bleiben. Bei nur einem Gedankenstrich würde das geschützte Leerzeichen davor gesetzt werden␣– damit man im Falle eines Zeilenumbruches die Gedankenpause früh genug erkennen kann. Weitere Informationen sind auf der Wikipedia zu finden.
  Anführungs- und Schlusszeichen werden oft falsch gesetzt, da sie auf der Tastatur schlicht und einfach nicht vorkommen. Das Zeichen «"» ist ein Zollzeichen und hat mit einem echten Anführungszeichen wenig gemeinsam. In Deutschland werden hierzu die beiden Zeichen „/” (gut zu merken mit der Eselsbrücke 99/66) oder »/« verwendet, in der Schweiz «/» (auch französische Anführungszeichen oder Guillemets genannt). Man bekommt sie im HTML-Code mit &bdquo;/&rdquo; (99/66) oder &laquo;/&raquo; (Guillemets). Weitere Informationen auch zur Eingabe per Tastatur siehe Wikipedia: Anführungszeichen. Die „Wikipedia” gehört zu den zehn am meisten aufgerufenen Seiten im Internet.
Das Spiel «X³ Reunion» von Egosoft/DeepSilver ist ein eine geniale Weltraumsimulation.
  Auslassungspunkte sind nicht drei einzelne Punkte, sondern ein separates Zeichen. Im HTML-Code kann es mit der Entität &hellip; (steht für «horizontal ellipsis») erzeugt werden. Wird ein Wort durch diese Zeichen unterbrochen (Oh Sch…), wird kein Leerzeichen gesetzt, ansonsten ein geschütztes danach oder davor – so dass es nicht an der falschen Stelle hängen bleibt. Die Wikipedia bietet hierzu weitere Informationen. Es regnet …
warum auch nicht?

Sie schaute sich um. 
… Vielleicht war das doch keine so gute Idee.



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 --helpfile auf:

$ java -jar wiki2xhtml.jar --helpfile




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 
 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 --silent -i menu.txt --header=header.txt -t title.txt --consistent-gallery. Die Argumente können überschrieben werden (beispielsweise mit einem -v für den verbose-Modus).



Das Argument --lang=de oder --lang=de-CH ergibt eine Deutsche Ausgabe der Zusammenfassung. 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



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


Top

› wiki2xhtml-Dokumentation

Table of Contents

Was ist es?

Letzte Änderungen

Neue Seiten erstellen

Menu

Fenstertitel

Header

Footer

Inhaltsverzeichnis

Quellenangaben

Konfigurationsdatei

Seitengestaltung

Überschriften

Absätze

Zeilenumbrüche

Seitenumbrüche

Formatierung

Links

Bilder

Galerie

Bildergalerie

Listen

Tabellen

Beispiele, Zitate

Horizontale Linien

Tipps

Zeichen «escapen»

Thumbnails

Meta-Informationen

Automatische Weiterleitung

Icon

Typografie^[5]

Kommandozeilenmodus

Quellen, Bemerkungen

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

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}}

› wiki2xhtml-Dokumentation

Table of Contents

Was ist es?

Letzte Änderungen

Neue Seiten erstellen

Menu

Fenstertitel

Header

Footer

Inhaltsverzeichnis

Quellenangaben

Konfigurationsdatei

Seitengestaltung

Überschriften

Absätze

Zeilenumbrüche

Seitenumbrüche

Formatierung

Links

Bilder

Galerie

Bildergalerie

Listen

Tabellen

Beispiele, Zitate

Horizontale Linien

Tipps

Zeichen «escapen»

Thumbnails

Meta-Informationen

Automatische Weiterleitung

Icon

Typografie[5]

Kommandozeilenmodus

Quellen, Bemerkungen

Typografie^[5]