Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

--- wiki:guidelines [2013/04/17 13:34]
mrenner [Inhalt]
+++ wiki:guidelines [2013/04/17 14:18]
mrenner
@@ Zeile 9: / Zeile 9: @@
   * **Quellenangabe:** Sofern fremde Inhalte genutzt werden, sind diese zu zitieren und die Quelle zu referenzieren. Es dürfen keine Urheberrechte verletzt werden.
   * **Anonymität:** Beispiele dürfen keine Inhalte dritter enthalten. So müssen IP-Adressen, Domains, E-Mail-Adressen e.t.c. unbedingt anonymisiert werden.
-  * Die Sprache des Wikis ist Deutsch.
+  * Ein Artikel sollte ein möglichst **hohes Maß an Vollständigkeit** bezüglich des beschriebenen Themas aufweisen. Unvollständige Artikel sind an geeigneter Stelle mit FIXME (Syntax: %%FIXME%%) zu kennzeichnen.
+  * **Die Sprache** des Wikis ist Deutsch.
@@ Zeile 19: / Zeile 20: @@
-===== Artikel =====
+===== Erstellung von Artikeln =====
   * Vor dem Erstellen eines Artikels sollte geprüft werden, ob der gleiche oder ein ähnlicher Artikel bereits existiert.
   * Nicht erläuterte Fachbegriffe, die essentiell für das Verständnis des Artikels sind, sollten zu weiterführenden internen Artikeln oder zu einer Enzyklopädie, wie z.B. Wikipedia, verlinkt werden.
@@ Zeile 26: / Zeile 28: @@
 ===== Formatierung von Artikeln (Syntax) =====
-Beim **Einfügen von Code** aus Programmiersprachen, Pfade zu Dateiverzeichnissen u.ä. sollte das [[ http://qbnz.com/highlighter/ | automatische Syntax-Highlighting ]] verwendet werden:
+Eine vollständige Beschreibung der Syntax findet sich unter https://www.dokuwiki.org/wiki:syntax. Die im Folgenden gelisteten Bereiche sollte primär wie hier beschrieben syntaktisch umgesetzt werden.
+==== Leerzeilen in der Artikelsyntax ====
+In der Syntax ist nach einer Überschrift eine Leerzeile einzufügen und zwei Leerzeilen vor der nächsten Überschrift. Dies erleichtert die Lesbarkeit des Codes.
+==== Einfügen von Code ====
+Umfasst der Code nur eine oder wenige Zeilen oder für den Fall, dass Syntax-Highlighting die Lesbarkeit nicht unbedingt erleichtert, kann zum Einbinden des Codes zwei hintereinanderfolgende Leerzeichen genutzt werden.
+  Diesem Text gehen zwei Leerzeichen zuvor.
+Beim Einfügen von Code aus Programmiersprachen, Pfade zu Dateiverzeichnissen u.ä. sollte das [[ http://qbnz.com/highlighter/ | automatische Syntax-Highlighting ]] verwendet werden:
   <code VERWENDETE PROGRAMMIERSPRACHE>
@@ Zeile 32: / Zeile 48: @@
   </code>
-**Aufrufe in der Befehlszeile**, die root-Rechte benötigen, sind mit einer Raute zu kennzeichnen:
+Eine Liste der derzeit unterstützten Programmiersprachen findet sich unter https://www.dokuwiki.org/wiki:syntax#syntax_highlighting.
+==== Aufrufe in der Befehlszeile ====
+Aufrufe in der Befehlszeile, die root-Rechte benötigen, sind mit einer Raute zu kennzeichnen:
   # passwd
-**Inter-Wiki-Links**: Links zu anderen Wikis (z.B. Wikipedia, wiki.ubuntuusers.de) oder auch anderen wichtigen Seiten können durch Inter-Wiki-Links erstellt werden, z.B:
+==== Links ====
+Links zu anderen Wikis (z.B. Wikipedia, wiki.ubuntuusers.de) oder auch anderen wichtigen Seiten können durch Inter-Wiki-Links erstellt werden, z.B:
   [[wpde>Deutschland]]
@@ Zeile 50: / Zeile 74: @@
 [[uu>apt]]
-{{tag>guidelines syntax}}
+==== Taggen von Artikeln ====
+Alle Artikel sind in der letzten Zeile des Codes wie folgt zu taggen:
+  {{tag>tag1 tag2 tag3}}
+Für das Taggen gelten folgende Konventionen:
+  * Jeder Artikel hat ein bis beliebig viele Tags. Die Anzahl der Tags ist themenabhängig, es sollte jedoch mehr als ein Tag benutzt werden.
+  * Tags treten nur im Singular auf.
+  * Themennahe Artikel sollten ähnliche Tags aufweisen.
+{{tag>guidelines syntax konvention}}

Bei Verwendung dieses Wikis erklären Sie sich mit dem Haftungsausschluss, Nutzungsbedingungen und der Datenschutzerklärung dieses Wikis einverstanden. Impressum.

Wiba10 wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge