Hilfe:Tags/Kommentar

Aus Wikivoyage
Zur Navigation springen Zur Suche springen

Diese Seite erläutert, wie sich im Quelltext einer Wikiseite versteckte Hinweise unterbringen lassen.

Funktionalität[Bearbeiten]

Der Kommentar beginnt im Quelltext mit der Zeichenfolge <!-- und endet mit --> als Gegenstück.

Dazwischen wird ein einfacher Text erwartet. Längere Inhalte werden meist durch ein Leerzeichen an Anfang und Ende abgegrenzt.

Beispiel:

<!-- Interne Info. -->

Die Syntax ist mit HTML und XML identisch.

Der gesamte Kommentar wird innerhalb des Generierungsprozesses auf dem Wiki-Server eliminiert und ist nicht Teil des an die Leser ausgelieferten HTML-Dokuments.

Zweck[Bearbeiten]

Mittels der Kommentare können im Quelltext von Wiki-Seiten versteckt Hinweise untergebracht werden, die nur für die Bearbeiter des Wikitextes von Bedeutung sind, jedoch irrelevant für die Leser der Enzyklopädie.

Standardisierte Kommentare[Bearbeiten]

<!--sic!-->
Diese Markierung wird unmittelbar hinter dem Wort angebracht, das es betrifft.
Durch den philologischen Zusatz „sic“ wird eine von der üblichen Rechtschreibung abweichende Schreibweise gekennzeichnet.
Damit sollen Wikipedia-Autoren und automatische Korrekturskripte daran gehindert werden, einen Schreibfehler zu berichtigen.
Ansonsten wäre anzunehmen, dass dem Wikipedia-Autor beim Verfassen des Wikipedia-Artikels ein Tippfehler unterlaufen sei.
Insbesondere bei nicht-aktuellen Rechtschreibvarianten sinnvoll.
Bei Schreibfehlern in einem Originalzitat könnte es hingegen besser sein, die Leser der Enzyklopädie offen auf diesen Umstand hinzuweisen; ggf. an geeigneterer Stelle und zusätzlich zum versteckten Kommentar.
<!--schweizbezogen-->
<!-- schweizbezogen -->
Wird als erste Zeile des Quelltextes angebracht, um auf hinzuweisen.
<!-- ohne ISBN -->
Das angegebene Buch hat vorgelegen; es war jedoch keine ISBN abgedruckt und ist auch nicht bei der Nationalbibliothek registriert. Eine weitere Recherche durch Wikipedia-Autoren erübrigt sich.
Für Leser der Enzyklopädie ist diese Information sinnfrei, weil sie ihnen bei der Recherche nicht hilft.

Zulässige Kommentare[Bearbeiten]

<!-- [[Wikipedia:Formatvorlage/Lampukistan]] -->
Weist auf die Verwendung bestimmter Projektseiten hin; etwa eine.
Für eingebundene Vorlagen ist ein derartiger Hinweis redundant, da am Ende einer Seitenvorschau bzw. im VisualEditor automatisch Verlinkungen auf diese Vorlagendokumentation generiert werden. Zusätzliche Kommentare verwirren und stören deshalb mehr, als dass sie helfen würden.
<!-- Bitte keine Werbe-Links einfügen -->
Warnung vor unerwünschten Aufblähungen; etwa Links auf Webseiten, zu deren Inhalt nicht auch ein relevanter Artikel existiert.
<!-- chronologisch sortiert; neueste oben -->
Kleine Hinweise für andere Autoren; vielleicht nicht notwendigerweise für Leser sichtbar.
<!-- http://example.com/ -->
Alternative URL zu einem Beleg können hier geparkt werden; für den Fall, dass die bislang angegebene URL unerreichbar wird.
<!-- Bot: ... -->
Automatische Prozesse können Hinweise darauf hinterlassen, dass sie hier tätig gewesen sind, damit spätere menschliche Bearbeiter dies überprüfen und dann den Hinweis entfernen können.
<!-- Schreibweise im Original -->
Ähnlich sic, um klarzustellen, dass kein Schreibfehler des Wikipedia-Autors vorliegt. Mögliche Verwechslungen oder kleine Schreib- und Formatfehler im Original; technische Details zu Quellenangaben und Verlinkungen oder sonstige Tücken.
<!-- besser: "enthält" -->
Nachrangiger Vorschlag für bessere Wortwahl, Formulierung, Grammatik; den sonstigen Autoren am Artikel zur Übernahme oder anderweitiger Verbesserung empfohlen, ohne dass dies einen Abschnitt auf der Diskussionsseite rechtfertigen würde.
<!-- BKL nicht sinnvoll auflösbar -->
Zwar handelt es sich um eine nicht sehr passgenaue Verlinkung auf eine; es ist jedoch nicht sinnvoll, nur einen einzigen der dort angebotenen Artikel zu verlinken. Nachfolgende Bearbeiter müssen nicht auf die Suche nach einem Zielartikel gehen.
<!-- Eingebunden in Artikel "Meier". -->
Einbindung dieser Seite durch andere Seiten.
<!-- Vorlagenparameter 2 muss leer bleiben -->
Interne Warnung vor möglichen Fehlersituationen.

Unerwünschte Kommentare[Bearbeiten]

Inhaltliche Stellungnahmen gehören nicht in einen Kommentar, sondern in einen neuen Abschnitt auf der Diskussionsseite, damit sie wahrgenommen, kommentiert und diskutiert werden können. In Kommentaren innerhalb des Textes ist kein sinnvoller Dialog zwischen den Autoren möglich, und solche Kommentare würden auch nur zufällig während der Textbearbeitung erkennbar.

Grundsätzlich behindern unerwartete Kommentare eine Suche nach Textpassagen im Quelltext; sowohl manuell durch andere Autoren als auch automatisiert durch und Skripte. Sie sollten deshalb nur eingefügt werden, wo es einen triftigen Grund gibt.

„Leere“ Kommentare, die nur zur Gestaltung des Quelltextes eingefügt werden, sind für Bearbeiter mittels VisualEditor verwirrend; sie erzeugen nur ein OOjs UI icon notice.svg im Text und geben danach aber keinerlei Aufschluss über den Zweck.

Insbesondere innerhalb von URL wird die Wartung der Weblinks massiv gestört.

Syntaktischer Inhalt[Bearbeiten]

Der ansonsten frei wählbare Text zwischen den (oben aufgeführten) festgelegten äußeren Zeichenfolgen darf weder mit der Zeichenkette > oder der Zeichenkette -> beginnen, noch die Zeichenketten <!--, --> oder --!> enthalten, noch mit der Zeichenkette <!- enden. Kommentare können daher keine anderen Kommentare enthalten.

Soll – mithilfe der einen Kommentar abgrenzenden Zeichenfolgen – ein Teil des Wikitextes, der Tags enthält, „auskommentiert“ (also durch Umwandlung in einen Kommentar deaktiviert oder ausgeblendet) werden, so ist unbedingt darauf zu achten, dass die Tags außerhalb der Kommentare weiterhin in sich geschlossene Konstrukte bilden, jedes void element (Element in der Form eines unary tag) also mit seinem vollständigen Start-Tag unzerrissen, entweder gänzlich außerhalb oder gänzlich innerhalb eines Kommentars steht, und bei jedem sonstigen Element sowohl der es abgrenzende Start-Tag als auch der es abgrenzende End-Tag gemeinsam entweder gänzlich außerhalb oder gänzlich innerhalb eines Kommentars stehen. Es ist nicht definiert, was bei einer unausgeglichenen Verschachtelung von Kommentaren und Elemente öffnenden oder schließenden Tags geschieht. Selbst wenn es derzeit eine akzeptable Wirkung ergibt, kann sich das schlagartig ändern und bisher schlummernde, „auskommentierte“ Syntaxelemente können plötzlich wirksam werden. Im Wikitext dürfen schließende Tags auf keinen Fall vor öffnenden Tags stehen, aber auch im Kommentar soll dies vermieden werden, da solche schließenden Tags bei unausgeglichener Verschachtelung unbeabsichtigterweise auf aktive öffnende Tags bezogen werden können.

Ungeeignete Orte[Bearbeiten]

Grundsätzlich sollen die Kommentare zwischen Teile des lesbaren Textes eingebettet werden und nicht in andere Syntaxelemente, wo sie langfristig die richtige Interpretation stören können, selbst wenn es momentan scheinbar funktioniert.

Tags[Bearbeiten]

Tags beginnen mit einem < und werden mit einem > beendet.

Im Inneren eines Tag können zwar Attributwerte stehen; es darf aber nirgendwo ein < oder > vorkommen und deshalb auch kein Kommentar.

Tabellenattribute[Bearbeiten]

Die Attributbereiche der Tabellenelemente entsprechen den Tags und dürfen deshalb keine Kommentare enthalten.

Beispiel für richtige Platzierung (mit style= wird ein Attribut gesetzt):

{|
|-
|style="background:#ABCDEF"| <!-- Kommentar --> Inhaltsbereich
|}

URL[Bearbeiten]

Früher waren einige wenige Wikipedianer auf die Idee verfallen, längere URL durch eingestreute Kommentare mit Zeilenumbruch auf mehrere Quelltextzeilen aufzuteilen.

Zwar funktionieren derartige Verlinkungen; jedoch wird die Suche durch andere Autoren und vor allem die softwaregestützte Wartung und Korrektur von unerreichbaren URL damit unmöglich gemacht.

Vorlagenparameter[Bearbeiten]

Zwar werden die Kommentare eliminiert, bevor Parameterwerte an eingebundene Vorlagen übergeben werden und beeinflussen deshalb nicht die dargestellte Seite.

Jedoch können sie Wartungsskripte bei der Auswertung und Reparatur stören und sollten deshalb nur eingesetzt werden, wenn der Kommentar wirklich benötigt wird.

VisualEditor‎[Bearbeiten]

Die Bearbeitungsumgebung VisualEditor bietet im Bearbeitungsmodus zu einer Seite im Hauptmenü einen Menüfeld Einfügen Elemente einfügen, in diesem Bereich befinden sich mehrere Unterpunkte. Hilfe:Tags/Kommentar/VisualEditor

Veraltet[Bearbeiten]

In den ersten Jahren der Wikisyntax wurde auch ein Element <hiddentext> für versteckte Kommentare benutzt.

Dieses ist nicht mehr gültig, und alle wirksamen Vorkommen wurden aus den aktuellen Seiten entfernt.

Gleichwohl gibt es diverse unwirksame Vorkommen, die auch durch veraltete Software immer wieder neu importiert werden.

2011 war das noch funktionsfähig gewesen; seit 2012 wird es von der Parser-Software nicht mehr erkannt.