Wiki Editing Hints/de
Die ersten Schritte
- Dieses Wiki ist der richtige Ort um Wissen über Qt zu teilen. Aber die Artikel sollten auf Themen beschränkt werden, die mit Qt zu tun haben.
- Wenn eine neue Seite erstellt werden soll, ist es wichtig zuerst zu überprüfen, ob sie nicht bereits existiert. Das Suchfeld rechts oben auf dieser Seite ist für diesen Zweck gedacht. Wenn es schon eine Seite zum gesuchten Thema gibt, wird sie in den Suchergebnissen erscheinen.
- Da diese Webseite ein Wiki ist, kann der Inhalt auf fast allen Seiten bearbeitet werden.
- Wenn keine Seite zu einem Thema existiert, kann sie erstellt werden, indem man auf den Link Create the page "Suchbegriff" on this wiki! in den Suchergebnissen klickt.
- Um ein "Vermüllen" der Versionsgeschichte einer Seite durch Tests zu verhindern, sollte die Sandbox stattdessen für Tests genutzt werden.
Wie man eine Seite bearbeitet
Das Qt Wiki basiert auf MediaWiki, der Wiki-Engine, die von Wikipedia und vielen anderen Wikis genutzt wird.
Wenn eine Seite bearbeitet wird, wird eine Werkzeugleiste angezeigt, die es erlaubt die meist genutzten Syntax-Elemente einzufügen. Die Wikicode-Syntax ist unkompliziert und man kann Wikicode direkt schreiben ohne die Werkzeugleiste zu nutzen. Ein Blick auf die MediaWiki Bearbeitungshilfe bietet einen schnellen Überblick.
Es soll bitte immer die "Preview"-Option genutzt werden, um die Änderungen an der Seite vor dem Abspeichern zu überprüfen. So wird verhindert, dass die Versionsgeschichte mit überflüssigen Einträgen vermüllt wird, wenn man die zuvor gemachten Eingabefehler behebt.
Wie man eine gute Seite erstellt
Ein paar einfache Richtlinien sollten eingehalten werden um anderen Entwicklern zu helfen, die Information zu finden nach der sie suchen:
So schreiben wie man programmiert
Gute Wikis sind wie guter Code: einfach zu überblicken und einfach zu warten. Jeder Artikel sollte sich mit einem Thema beschäftigen (sehr ähnlich zu einer Klasse). Jeder Absatz sollte sich mit einem Aspekt des Themas beschäftigen (wie eine Funktion).
Überschriften für eine bessere Übersicht verwenden
Lange Artikel kann man einfacher lesen, wenn informative Überschriften hinzugefügt werden. Für die Einleitung sollte bitte die MediaWiki-Überschriftstiefe (==) verwendet werden und danach die Tiefen === und ====, um einzelne Aspekte des Themas abzugrenzen. (Der Editor enthält Schaltflächen, mit denen sich die Überschriften schnell einfügen lassen.) Die Überschriften sollten aussagekräftig den Inhalt des Abschnitts zusammenfassen.
Ein Inhaltsverzeichnis hinzufügen
Wenn ein Leser einen Artikel findet, wird er die erste Seite zunächst überfliegen, um herauszufinden, ob der Artikel enthält, wonach er sucht. Ist der Artikel nicht länger als eine Buchseite, kann er einfach geschrieben werden. Wenn der Artikel länger als eine Buchseite ist, sollte ein Inhaltsverzeichnis erstellt werden, damit der Leser schnell weiß, was im Artikel enthalten ist. Der erste Abschnitt und das Inhaltsverzeichnis sollten dem Leser reichen, um zu entscheiden, ob er auf der Seite bleiben oder sie verlassen möchte.
Ein Inhaltsverzeichnis wird automatisch generiert, sobald drei Überschriften hinzugefügt worden sind (unabhängig von ihrer Tiefe). Manchmal möchte man nicht, dass ein Inhaltsverzeichnis erstellt wird (z.B. wenn die erstellte Seite selbst ein Inhaltsverzeichnis ist). In so einem Fall kann der Befehl __NOTOC__ am Anfang der Seite eingefügt werden.
Kategorien hinzufügen
Um einen Link zu dem neu erstellten Artikel auf den passenden Übersichtsseiten zu erzeugen, kann man ihn einer oder mehreren existierenden Kategorien hinzufügen. Auf diese Weise wird den Lesern geholfen den neuen Artikel zu finden.
Wenn eine neue Kategorie mit Übersichtsseite angelegt werden soll, kann der Artikel einfach mit einer Kategorie gekennzeichnet werden, die noch nicht existiert:
[[Category:Wiki Help]].
Zusammenarbeit
Wikis wurden zur gemeinschaftlichen Arbeit an Inhalten entworfen. Um das für alle so einfach wie möglich zu machen, sollten bitte die folgenden Grundregeln beachtet werden:
- Ein Artikel sollte auf der zugehörigen "Talk"-Seite diskutiert werden
- Eine verständliche, informative, aber nicht zu formelle Sprache hilft dem Leser, den Inhalt besser zu verstehen
- Gegliederte Seiten (durch Überschriften und durch eine angemessenen Zahl von Absätzen) fördern die Verständlichkeit und den Lesefluss
- Abkürzungen sollten zumindest bei ihrer ersten Benutzung erklärt werden
- Eindeutige Seitennamen sollten verwendet werden
- Die Arbeit anderer sollte nicht leichtfertig verworfen werden
- Kategorien [[Category:...]] sollten genutzt werden, um Seiten thematisch zu gruppieren
Kategorieseiten
Sobald eine neue Kategorie auf einer Seite verwendet und damit erstellt wird, generiert die Wiki-Software auch eine Einstiegsseite für diese Kategorie. Diese Seite kann genauso bearbeitet werden wie jede andere Seite des Wikis auch. Dafür muss der angezeigte Link für die Kategorie nur angeklickt werden und die Kategorieseite kann direkt bearbeitet werden. Alle Seiten dieser Kategorie werden auf der Kategorieseite angezeigt. Warum also nicht eine Einleitung zum Thema auf der Kategorieseite verfassen?
Templates
Es können auch MediaWiki-Templates im Wiki genutzt werden. Dieser Abschnitt fasst den aktuellen Stand der verfügbaren Templates zusammen:
| Name des Templates | Befehl | Ergebnis | |
|---|---|---|---|
| Template:DocLink erstellt einen Link zur Qt-Referenz (doc.qt.io) |
|
| |
| Template:LangLinks erstellt eine Liste der zuvor erstellten Sprachlinks, sodass schnell gesehen werden kann, welche Sprachen für die angegebene Seite verfügbar sind | {{LangLinks|base=Download Data from URL}} | bg de el es fr it ja ko pt ru zh | |
| Template:LangSwitch hat die gleiche Funktion wie LangLinks, aber es führt das Template für die Seite aus, auf der es eingefügt worden ist. Es überprüft alle verfügbaren Sprach-Unterseiten und fügt die Links ein. Für dieses Template muss kein Parameter angegeben werden. | {{LangSwitch}} | ||
| Template:Ambox fügt eine Box mit einem Hinweis hinzu | {{Ambox|text=Some notification text}} |
| |
| Template:WarningBox fügt eine Box mit einer Warnung hinzu | {{WarningBox|text=Some warning text}} |
| |
| Template:Cleanup fügt eine Notiz hinzu, dass der Artikel verbessert werden muss und fügt den Artikel in die Category:Articles needing cleanup hinzu. Eine Begründung kann auch angegeben werden. | {{Cleanup|reason=The text is too repetitive.}} |
| |
| Template:Delete fügt eine Notiz hinzu, dass der Artikel für die Löschung nominiert ist und fügt den Artikel in die Category:Delete hinzu. Eine Begründung kann auch angegeben werden. | {{Delete|reason=This page is empty.}} |
|
Artikel in mehreren Sprachen
Wenn ein neuer Artikel erstellt wird, sollte die erste Sprache Englisch sein und als Referenz dienen. Sobald ein Artikel übersetzt werden soll, wird einfach ein Slash und der ISO-639-1 Sprachcode an die URL angehangen und Enter gedrückt. Das Wiki bestätigt nun, dass die Seite erstellt werden kann.
Beispiel:
Tabellen
Die MediaWiki-Hilfsseite für Tabellen ist nützlich für jeden, der Tabellen bearbeiten möchte.
Syntax-Highlighting von Programmcode
Dieses Wiki verwendet den GeSHi Syntax-Highlighter.
Die einzige Anpassung, die gemacht worden ist, ist das Hinzufügen des <code>-Elements zu der Elementliste, die von GeSHi behandelt wird. Die Standardprogrammiersprache ist auf C++/Qt gesetzt. Das Syntax-Highlighting kann mit Hilfe des Attributs lang="" geändert werden.
Zum Beispiel können folgende Einstellungen gemacht werden:
- Javascript/QML : <code lang="javascript">
- Qt .pro : <code lang="make">
- Kommandozeilen : <code lang="bash">
- XML : <code lang="xml">