Budo-Lexikon | PmWikiDe / Grundlagen der Bearbeitung

Autoren (Grundlagen) (deutsche Übersetzung der Seite PmWiki.BasicEditing, Stand 2008-03-07)

Die Seiten auf dieser Netzseite sind WikiWikiWeb-Seiten. Dies bedeutet, dass Seiten einfach neu angelegt und von mehreren Autoren bearbeitet werden können. Durch Klicken auf den Bearbeiten-Link (der sich üblicherweise im Kopf- oder im Fußbereich befindet) kann eine Seite zum Bearbeitet geöffnet werden. Einige Seiten können durch Passwörter geschützt sein. Dies hängt von den Sicherheitseinstellungen des Systems ab. Viele Wiki Wiki Web-Systeme erlauben jedoch das freie Bearbeiten aller Seiten.

Wenn eine Seite bearbeitet wird, sieht man die Wikisyntax ('markup text') welche den Inhalt der Seite beschreibt. Die grundlegenden Regeln der Syntax sind sehr einfach:

Zwischen zwei Absätze gehört eine Leerzeile.
Um eine Liste wie diese hier zu erstellen, muss jede Zeile mit # (numerierte Liste) oder * (unnumerierte Liste) begonnen werden.
Um eine Überschrift zu erzeugen, muss eine Zeile mit einem oder mehreren Rufzeichen ! begonnen werden; !! ist eine Überschrift zweiter Ordnung und !!! eine Überschrift dritter Ordung.
Um Text hervorzuheben, kann dieser in 2 oder 3 Hochkommata (Umschalttaste und #) gesetzt werden; ''text'' für Kursiv und '''text''' für Fettdruck.
Um einen Verweis zu einer anderen Seite zu setzen, wird deren Seitenname in doppelte eckige Klammern gefaßt; z.B. verweist [[basic editing]] auf diese Seite. Verweise zu nichtexistierenden Seiten werden speziell markiert, um andere zum Anlegen solcher Seite einzuladen.
Um einen Verweis auf eine andere Netzseite zu setzen, wird einfach die Adresse eingegeben, z.B. http://www.example.com/ .

Zum Ausprobieren steht der Sandkasten zur Verfügung. Dort kann das Bearbeiten getestet werden, ohne dass die Gefahr besteht, etwas Wichtiges zu löschen. Beim Bearbeiten sonstiger Seiten kann es angebracht sein, die eigenen Beiträge kenntlich zu machen. Mittels [[~Bartolin]] unterzeichnet man mit dem Namen, den man im Feld "Autor" des Bearbeitenformulars eingibt.

Beispiele

Die nachfolgende Tabelle zeigt die gebräuchlichsten Formatierungsanweisungen, um Seiten zu gestalten. Die rechte Spalte zeigt das erzielte Ergebnis, die linke Spalte welche Syntax dieses erzeugt. Weitere Formatierungsanweisungen finden sich in den Textformatierungsregeln und auf anderen Seiten der Dokumentation. Eine vollständige Liste der Standardregeln ist unter Übersicht der Auszeichnungen verfügbar.

Allgemeiner Gebrauch

Eingabe

Ergebnis

Ein einfacher Zeilensprung
hat im Allgemeinen keine 
Auswirkung auf das Layout.

Ein Autor muss eine oder mehrere 
Leerzeilen einfügen, um einen neuen
Absatz zu beginnen.

Ein einfacher Zeilensprung hat im Allgemeinen keine Auswirkung auf das Layout.

Ein Autor muss eine oder mehrere Leerzeilen einfügen, um einen neuen Absatz zu beginnen.

Listen

* Listen werden durch einen Stern begonnen.
** Mehrere Sterne führen zu einer tieferen Ebene.
*** Die Liste wird durch die
erste Zeile beendet, die kein Listenelement ist.
* Ein Listenelement kann auf
  der nächsten Zeile fortgesetzt
  werden, indem der Text mit
  Leerzeichen eingerückt wird.
* Mit einem doppelten Backslash \\ 
  erzwingt man einen Zeilenumbruch
  in einem Element.

Listen werden durch einen Stern begonnen.
- Mehrere Sterne führen zu einer tieferen Ebene.
  - Die Liste wird durch die

erste Zeile beendet, die kein Listenelement ist.

Ein Listenelement kann auf der nächsten Zeile fortgesetzt werden, indem der Text mit Leerzeichen eingerückt wird.
Mit einem doppelten Backslash
erzwingt man einen Zeilenumbruch in einem Element.

# Numerierte Listen
# sind ebenfalls möglich.
## Mehrere #-Zeichen führen zu einer tieferen Ebene.
*** Nummerierte und nicht
    nummerierte Listen können
    verschachtelt werden.
--> Man benutzt [[ListStyles]]
    (besondere Wikistile) um
    die Nummerierung zu erhalten:
## Text zwischen Listenelementen
   kann zu einem Neubeginn der
   Nummerierung führen.
## %item value=3% Das kann aber auch manuell geändert werden.

Numerierte Listen
sind ebenfalls möglich.
1. Mehrere #-Zeichen führen zu einer tieferen Ebene.
  - Nummerierte und nicht nummerierte Listen können verschachtelt werden.
Man benutzt ListStyles (besondere Wikistile) um die Nummerierung zu erhalten:
1. Text zwischen Listenelementen kann zu einem Neubeginn der Nummerierung führen.
2. Das kann aber auch manuell geändert werden.

-> Ein Pfeil (->) rückt einen
   Absatz ein.

   Mit Leerzeichen eingerückter
   Text passt sich an den durch
   Pfeile erzeugten Einzug an.

--> Längere Pfeile (-->) erzeugen
    einen stärkeren Einzug.

-< Ein umgekehrter Pfeil (-<) erzeugt
   einen hängenden Einzug: die erste
   Zeile ist herausgezogen, die
   folgenden Zeilen sind eingerückt.

--< Längere umgekehrte Pfeile rücken stärker ein.

Ein Pfeil (->) rückt einen Absatz ein.

Mit Leerzeichen eingerückter Text passt sich an den durch Pfeile erzeugten Einzug an.

Längere Pfeile (-->) erzeugen einen stärkeren Einzug.

Ein umgekehrter Pfeil (-<) erzeugt einen hängenden Einzug: die erste Zeile ist herausgezogen, die folgenden Zeilen sind eingerückt.

Längere umgekehrte Pfeile rücken stärker ein.

: Definitionslisten : Listen mit Definitionen
: Eintrag : Definition des Eintrags
: ein anderer Eintrag: Definition des zweiten Eintrags
:: Einrückung : Mehrere Doppelpunkt am Zeilenanfang erzeugen
tiefere Listen.

Definitionslisten

Listen mit Definitionen

Eintrag

Definition des Eintrags

ein anderer Eintrag

Definition des zweiten Eintrags

Einrückung: Mehrere Doppelpunkt am Zeilenanfang erzeugen

tiefere Listen.

 Zeilen, die mit einem Leerzeichen
 beginnen, werden exakt so formatiert
 wie eingegeben -- in einer Schriftart
 mit fester Zeichenbreite.

Achtung: Sehr lange Zeilen können dabei
sehr breite Wikiseiten verursachen.

 Zeilen, die mit einem Leerzeichen
 beginnen, werden exakt so formatiert
 wie eingegeben -- in einer Schriftart
 mit fester Zeichenbreite.

Achtung: Sehr lange Zeilen können dabei sehr breite Wikiseiten verursachen.

%rfloat% Dieser Text schwebt auf der rechten Seite.

%rframe% Dieser Text schwebt mit einem Rahmen auf der rechten Seite.

Hier etwas normaler Text, damit der Effekt des Zentrierens im folgenden Beispiel deutlich wird.

%center% Dieser Text ist zentriert.

%right% Dieser Text ist rechtsbündig ausgerichtet. (Eine Einrückung -> wird benötigt, wenn der vorstehende Text nicht eingerückt ist.)

Dieser Text schwebt auf der rechten Seite.

Dieser Text schwebt mit einem Rahmen auf der rechten Seite.

Hier etwas normaler Text, damit der Effekt des Zentrierens im folgenden Beispiel deutlich wird.

Dieser Text ist zentriert.

Dieser Text ist rechtsbündig ausgerichtet. (Eine Einrückung -> wird benötigt, wenn der vorstehende Text nicht eingerückt ist.)

Vier oder mehr Bindestriche am Beginn
einer Zeile
----
erzeugen eine horizontale Linie.

Vier oder mehr Bindestriche am Beginn einer Zeile

erzeugen eine horizontale Linie.

Verweise

Eingabe

Ergebnis

* Text in doppelten, eckigen Klammern wird zu einem Verweis auf eine andere Seite.
* Die einzelnen Wörter im Titel werden automatisch groß begonnen.
Ein Beispiel ist die Hilfeseite zu [[Links]].

Text in doppelten, eckigen Klammern wird zu einem Verweis auf eine andere Seite.
Die einzelnen Wörter im Titel werden automatisch groß begonnen.

Ein Beispiel ist die Hilfeseite zu Links.

Ein Verweis auf eine Seite in einer anderen Wikigruppe besteht aus dem Namen der Gruppe, gefolgt von einem Trennzeichen, gefolgt vom Namen der Zielseite.
- Wenn ein Punkt . als Trennzeichen genutzt wird, erscheint der komplette Name (Gruppenname und Seitenname).
- Wenn ein Schrägstrich / als Trennzeichen genutzt wird, erscheint nur der Seitenname der Zielseite.

Übe das Bearbeiten in der [[Main/WikiSandbox]].

Welche WikiSandbox?  Oh, diese hier: [[Main.WikiSandbox]].

Übe das Bearbeiten in der WikiSandbox.

Welche Wiki Sandbox ?? Oh, diese hier: Main.WikiSandbox.

Text nach dem pipe-Zeichen (|) wird zum Verweistext. Stattdesssen kann auch die alternative (möglicherweise einfacher zu verstehende) Pfeil-Syntax genutzt werden: Text -> Verweis.
Pm Wiki wandelt alle Verweise so um, dass sie mit einem Großbuchstaben beginnen.

Übe das Bearbeiten im
[[WikiSandbox | Sandkasten]].
Übe das Bearbeiten im
[[Main.WikiSandbox | Sandkasten]].

Übe das Bearbeiten im
[[Sandkasten -> WikiSandbox]].

Komplexe Tabellen werden unter [[table directives]] beschrieben.

Übe das Bearbeiten im Sandkasten ?. Übe das Bearbeiten im Sandkasten.

Übe das Bearbeiten im Sandkasten ?.

Komplexe Tabellen werden unter table directives beschrieben.

Suffixe werden Bestandteil des Verweistextes
Klammern blenden Teile des Links aus

Übe das Bearbeiten
in den [[wiki sandbox]]en!.

Übe das Bearbeiten 
in der [[(wiki) sandbox]]!

Übe das Bearbeiten in den wiki sandboxen ?!.

Übe das Bearbeiten in der sandbox ?!

Pmw Wiki ? verwendet InterMap Präfixe mit spezieller Bedeutung.
Mit Klammern können diese ausgeblendet werden.

Was ist ein [[(Wikipedia:)Wiki]]?

Was ist ein Wiki?

Verweise zu externen Quellen:
# nur die URL: http://www.google.de/
# mit Verweistext: [[http://www.google.de | Google]]
# als Referenz: [[http://www.google.de |#]]

Verweise zu externen Quellen:

nur die URL: http://www.google.de/
mit Verweistext: Google
als Referenz: [1]

Nur der Vollständigkeit halber:

Verweise zu Wikiseiten:
# als Referenz: [[Tables |#]]
# auf einen Seitentitel: [[Basic editing|+]]

Verweise zu Wikiseiten:

als Referenz: [1]
auf einen Seitentitel: Grundlagen der Bearbeitung

Verweise können in einem neuen Fenster geöffnet werden:
%newwin% http://www.pmwiki.org.

Verweise können in einem neuen Fenster geöffnet werden: http://www.pmwiki.org.

Zeilenumbrüche

* Zwei umgekehrte Schrägstriche erzeugen \\
einen Zeilenwechsel.

Wikistile und andere '''%red%Formatierungen\\
werden auf%% auf der nächsten''' Zeile fortgesetzt.

Man kann die Anweisung [[<<]] nutzen,
um einen Zeilenumbruch zu forcieren.

* Mit mehreren umgekehrten Schrägstrichen \\\
lassen sich zusätzliche Leerzeilen erzeugen.

Zwei umgekehrte Schrägstriche erzeugen
einen Zeilenwechsel.

Wikistile und andere Formatierungen
werden auf auf der nächsten Zeile fortgesetzt.

Man kann die Anweisung
nutzen, um einen Zeilenumbruch zu forcieren.

Mit mehreren umgekehrten Schrägstrichen

lassen sich zusätzliche Leerzeilen erzeugen.

Ein einzelner umgekehrter Schrägstrich \
am Ende einer Zeile verbindet \
diese mit der nächsten Zeile.

Ein einzelner umgekehrter Schrägstrich am Ende einer Zeile verbindet diese mit der nächsten Zeile.

Zeichenformatierung

Eingabe

Ergebnis

Verwendet werden Apostrophe (einfache Anführungszeichen, keine doppelten)

''Emphasize'', '''strongly''',
'''''very strongly'''''.

Emphasize, strongly, very strongly.

@@Schrift mit fester Weite@@

[@Dies ist ein
   vorformatierter
   Textblock@]

Schrift mit fester Weite

Dies ist ein
   vorformatierter
   Textblock

* Text mit '^Hochstellung^'
* Text mit '_Tiefstellung_'
* {-durchgestrichener-} Text
* {+unterstrichenener+} Text 
* [+großer+], [++größerer++] Text
* [-kleiner-], [--kleinerer--] Text

Text mit ^Hochstellung
Text mit _Tiefstellung
~~durchgestrichener~~ Text
unterstrichenener Text
großer, größerer Text
kleiner, kleinerer Text

Wikistile

in RGB Farbangaben keine Großbuchstaben verwenden (#ff7f00, nicht #FF7F00)

[[WikiStyles|Wikistile]] erlauben %red% (roten) Text,
%blue% (blauen), %green% (grünen) oder mit
%color=#ff7f00% anderen %%Farben.

Wikistile erlauben (roten) Text, (blauen), (grünen) oder mit anderen Farben.

Überschriften

Eingabe

Ergebnis

Überschriften sind nützlich, um gut strukturierte Seiten zu erzeugen. Sie sind nicht nur zum Hervorheben von Text geeignet.

!! Hauptüberschrift
!! [-Hauptüberschrift mit kleinerer Schrift-]
!!! Überschrift geringerer Ordnung
!!!! noch geringer
!!!!! Unterüberschrift

Hauptüberschrift

Hauptüberschrift mit kleinerer Schrift

Überschrift geringerer Ordnung

noch geringer

Unterüberschrift

Seitentitel

Die (:title:)-Direktive setzt den Titel einer Seite unabhängig vom tatsächlichen Namen der Seite.

(:title Grundlagen der Bearbeitung:)
Der Titel dieser Seite lautet {$Title}.

Der Titel dieser Seite lautet Grundlagen der Bearbeitung.

Seiten-Zusammenfassungen

Die (:Summary:Zusammenfassung hier:)-Direktive setzt die Zusammenfassung einer Seite. Solche Zusammenfassungen werden oft in Suchergebnissen oder Seitenlisten ('page lists') angezeigt.

(:Summary: Grundlegende Syntax für Pmwiki-Seiten :)
Die Zusammenfassung dieser Seite lautet {$:Summary}.

Die Zusammenfassung dieser Seite lautet Grundlegende Syntax für Pmwiki-Seiten .

Wikistile blockweise definieren

Blöcke erlauben es, Wikistile über Zeilen- oder Absatzgrenzen hinweg zu definieren.

>>purple<<
Der gesamte Text dieses Blockes ist violett.
* violetter Eintrag 1
* violetter Eintrag 2
>>red<<
* hier ein roter Eintrag
>>center<<
* Und dieser Text ist zentriert.
>>right green<<
* Und dieser Text ist grün und rechsbündig.
>><<
* Und dies ist normal.

Der gesamte Text dieses Blockes ist violett.

violetter Eintrag 1
violetter Eintrag 2

hier ein roter Eintrag

Und dieser Text ist zentriert.

Und dieser Text ist grün und rechsbündig.

Und dies ist normal.

<< | Dokumentations-Index | Erzeugung neuer Seiten >>

Ich bin neu bei Pm Wiki, wo kann ich ein paar grundlegende Erklärungen für den Einstieg finden?

Die Seite Grundlagen der Bearbeitung ist ein guter Startpunkt. Von dort aus kannst du dann dem am Seitenende (direkt über den häufig gestellten Fragen) befindlichen Verweis Index der Dokumentation folgen. Dort findet sich eine strukturierte Übersicht über die wichtigsten Dokumentationsseiten.

Wie kann ich Sonderzeichen in den Text meiner Wikiseiten einfügen?

Benutze Auszeichnungen von der Seite Sonderzeichen, zB. Copyright (©) und Trademark (® oder ™) sind Symbole, die nicht auf der Tastatur zu finden sind.

Warum werden mehrere Zeilen im Wiki-Quelltext zu einer einzigen Zeile bei der Darstellung der Seite?

Pm Wiki behandelt untereinanderstehende Zeilen mit Text als einen Abschnitt (Paragrafen) und fügt deshalb die Zeilen des Quelltextes zusammen und bricht sie bei der Darstellung im Browser je nach Breite des Browserfensters um. Dies wird auch bei den meisten anderen Wiki-Programmen so gemacht. Ein Autor kann aber die Direktive (:linebreaks:) verwenden, um zu erreichen, dass getrennte Zeilen im Quelltext auch bei der Ausgabe als getrennte Zeilen behandelt werden.

Kann ich auch einfach HTML-Kode eingeben?

Standardmäßig unterstützt Pm Wiki die Verwendung von HTML-Elementen im Wiki-Quelltext nicht. Hierfür gibt es eine Reihe von Gründen, die in der PmWiki-Philosophie und auf der Seite PmWiki:Audiences erläutert werden. Um es kurz zu sagen, vertritt Pm die Auffassung, dass potenzielle Autoren vom Bearbeiten von Wikiseiten abgeschreckt oder sogar ausgeschlossen werden, wenn dort HTML-Kode enthalten ist. Außerdem bringt die Verwendung von HTML-Kode eine Reihe von Darstellungs- und Sicherheits-Problemen mit sich. Ein Administrator kann allerdings das Kochbuch-Rezept Cookbook:EnableHTML nutzen, um die Nutzung von HTML-Kode in Wikiseiten zu ermöglichen.