Kommentar-Markups

Diese Seite beschreibt verschiedene Formen von Kommentaren und zeigt, wie sie man sie in Wikiseiten einfügt.

Typen und Arten von Kommentaren

Das Wort Kommentar kann viele Dinge bedeuten. Hier sind einige mögliche Interpretationen:

Quellenkommentar oder Markupkommentar

Diese Art eines Kommentars ist dazu gedacht, nur im Quelltext einer Wikiseite zu erscheinen. Sie sind nützlich, um Hinweise für (andere) Autoren der Wikiseite zu geben, die an der Seite (mit)arbeiten, siehe Beispiele unten.

Seitenkommentare oder Leserkommentare

Diese Art Kommentare sind Notizen und Hinweise von Lesern zu dem Inhalt der Wikiseiten und können verschiedene Formen annehmen. Sie können in die Seite eingefügt sein oder separat behandelt werden, sehen Sie das Beispiel unten an, bei dem Wikistile eingesetzt werden.

HTML-Kommentar

Ein Text, der als HTML-Kommentar ausgegeben wird, d. h. im ausgegebenen Ergebnis als Kommentar entsprechend der HTML-Syntax ausgezeichnet ist.

Quellenkommentare

Ein Quellenkommentar tritt typischerweise nur dann in Erscheinung, wenn ein Autor eine Seite bearbeitet. Quellenkommentare werden nicht in die erzeugten Wikiseiten eingefügt. Eine bedinge Auszeichnung ist die eine Methode, solche Kommentare zu schreiben. Hier ist ein Beispiel:

Bla...
(:if false:)
	Dieser Text ist ein Kommentar. Ein Leser wird ihn nicht sehen können,
	noch wird er im HTML-Text erscheinen.
(:ifend:)
bla.

In diesem Fall wird der Quellenkommentar nicht in die HTML-Ausgabe exportiert.

Die andere Methode nutzt die spezielle Direktive (:comment:) für Kommentare, die keine Ausgabe produzieren. Hier ist ein Beispiel:

Bla...
(:comment Hier ist ein Kommentar, der keine Ausgabe erzeugt.:)
bla.

HTML-Kommentare

Wenn Sie wünschen, dass der Kommentar im HTML-Text erscheint, sollten Sie den Kommentar stattdessen unsichtbar machen mit invisible. Sie können dazu den vordefinierten Wikistil %comment% benutzen. Hier sind Beispiele dazu:

Bla...
%comment% Dies hier wird vorhanden sein, aber in der erzeugten Ausgabe
versteckt bzw. unsichtbar sein.
>>comment<<
Dieser Text wird in der Ausgabe versteckt oder unsichtbar sein.
Sie können einen mehrzeiligen Kommentar erzeugen, wenn sie den Stil wie
hier benutzen.
>><<
bla.

oder

# Bla...
# Dies wird ebenfalls vorhanden, aber versteckt sein. %item comment%
# bla.

Anmerkung

Jemand, der sich den HTML-Text der ausgelieferten Wikiseite ansieht, wird den obigen Kommentar wiederfinden.

Technisch wird das durch den Einsatz von style='display:none' erreicht.

Warnung

Dies ist letzendlich kein Kommentar. PmWikis Markups, Direktiven, etc. sind alle aktiv und funktional (im Gegensatz zu einem HTML-Kommentar-Tag), die Ergebnisse werden halt nicht gezeigt. Siehe auch (http://de.selfhtml.org/html/allgemein/kommentare.htm#nicht_angezeigt)

Sichtbare Leserkommentare

Ein Beispiel für einen sichtbaren Leserkommentar in einer Seite, bei dem ein Wikistil benutzt wird, der ihn als Kommentar markiert und in einem speziellen Format präsentiert:

%define=commentary apply=block background-color=#f8dce1 margin=1em
border="1px dotted #ea97a4"%%%
Bla...

%commentary% Dieser Kommentar wurde erzeugt, indem ein spezieller Wikistil
benutzt wurde. %%
>>commentary<<
dieser auch
>><<

bla.

Als eine Alternative zu dem Kommentarstil, der wie oben in der Seite definiert wurde, kann der Stil auch global definiert werden, indem die folgenden Zeilen in die local/config.php-Datei eingefügt werden:

$WikiStyle['commentary']['apply'] = 'block';
$WikiStyle['commentary']['background-color'] = '#f8dce1';
$WikiStyle['commentary']['margin'] = '1em';
$WikiStyle['commentary']['border'] = '1px dotted #ea97a4';

Informationen finden sich hier auf englisch.

Links und weitere Informationen

• Wikistile
• Bedingte Auszeichnung
• Kochbuch-Rezepte (meistens für Seitenkommentaree, auf englisch)
  • Cookbook:CommentBox
  • Cookbook:CommentPageLink
  • Cookbook:Comments — benutzt separate Seiten zum Speichern der (Seiten-)Kommentare
  • Cookbook:GeneratePDF — Herkunft des HTML-Kommentars
• Übersicht über Textauszeichnungen

Contributors

• chr?

Originalseite auf PmWikiDe.CommentMarkup - Backlinks
Zuletzt geändert:
PmWikiDe.CommentMarkup am 10.09.2011