Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

--- wiki:guidelines [2012/10/08 01:56]
mrenner [Syntax]
+++ wiki:guidelines [2013/05/04 14:52] (aktuell)
mrenner [Links]
@@ Zeile 1: / Zeile 1: @@
 ====== Guidelines ======
-Im Folgenden werden Guidelines definiert, die bei der Mitarbeit auf diesem Wiki zu beachten sind. Als Grundlage dienen die Guidelines von [[http://de.wikipedia.org/wiki/Wikipedia:Richtlinien | Wikipedia]], die für dieses Wiki wie folgt erweitert werden:
+Im Folgenden werden Guidelines definiert, die bei der Mitarbeit auf diesem Wiki zu beachten sind. Als Grundlage dienen die [[wpde>Wikipedia:Richtlinien | Guidelines von Wikipedia]], die für dieses Wiki wie folgt erweitert werden:
 ===== Grundprinzipien =====
-  * Neutralität: Eigene Meinungen sind zu vermeiden.
+  * **Neutralität:** Eigene Meinungen sind zu vermeiden.
-  * Urheberrechte beachten: Sofern fremde Inhalte genutzt werden, sind diese zu zitieren und die Quelle zu referenzieren.
+  * **Quellenangabe:** Sofern fremde Inhalte genutzt werden, sind diese zu zitieren und die Quelle zu referenzieren. Es dürfen keine Urheberrechte verletzt werden.
-  * Die Sprache des Wikis ist Deutsch.
+  * **Anonymität:** Beispiele dürfen keine Inhalte dritter enthalten. So müssen IP-Adressen, Domains, E-Mail-Adressen e.t.c. unbedingt anonymisiert werden.
+  * 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.
-===== Inhalt =====
+===== Inhaltliche Abgrenzung =====
 Der Inhalt des Wikis umfasst
@@ Zeile 18: / 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.
-===== Syntax =====
+===== 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. Dazu ist der code in ''<nowiki><code DIE_VERWENDETE_PROGRAMMIERSPRACHE></nowiki>'' und ''<nowiki> </code> </nowiki>'' einzubetten, wie z.B.  e.g. ''<nowiki><code html></nowiki>'' and ''<nowiki></code></nowiki>'':
+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.
-<code html>
-<html>
-  <head>
-    <meta name="author" content="Wikimaster">
-  </head>
-  <body> ... </body>
-</html>
-</code>
-  * Aufrufe in der Befehlszeile, die root-Rechte benötigen, sind mit einer Raute zu kennzeichnen:
+==== 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>
+    ... der Quellcode ...
+  </code>
+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
+==== Links ====
+Links sollen so häufig wie möglich und sinnvoll wie nötig verwendet werden.
+  [[URL|Beschreibung oder Text im Fließtext]]
+> Fußnoten sind in kurzen Artikeln zu vermeiden, weil sie nicht direkt zum Ziel des Links führen, sondern zuvor an das Ende des Artikels springen. Dort ist dann eine Liste aller im Artikel verwendeten Links zu finden. Somit werden Fußnoten erst bei sehr umfangreichen Artikeln sinnvoll, da z.B. hier doppelt verwendete Links einfach identifiziert werden können.
+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]]
+  [[google>Wiba10]]
+  [[uu>apt]]
+erzeugt folgende Ausgabe:
+[[wpde>Deutschland]]
+[[google>Wiba10]]
+[[uu>apt]]
+==== 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}}
+{{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