De:Wikistil

Aus YaCyWiki
Wechseln zu: Navigation, Suche

Stil im YaCy-Wiki

Grundlegendes

  1. Das Zusammenfassungsfeld sollte sinnvoll genutzt werden.
  2. Der Schreibstil ist sachlich neutral.
  3. Probleme werden im Forum gelöst, das Wiki dient zur Dokumentation.
  4. Besser die Vorschau nutzen, als hinterher nocheinmal nachzubessern.

Artikellänge

Bitte keine kurzen FAQ-Artikel, die nur eine Frage beantworten. Entweder sollte die Frage auf einer größeren FAQ Seite einen Abschnitt bekommen, oder der Artikel sollte mehr als nur eine kurze Antwort oder Begriffserklärung sein.

Zusammenfassungen

Zusammenfassungen wie "form", "typo", etc. sind bei kleineren Änderungen in Ordnung. Bei größeren Ergänzungen und Neuem sollte eine treffende Zusammenfassung verwendet werden.

/* abschnitt */

sollte stehengelassen werden, da dann in der Übersicht sinnvoll gezeigt wird, welchen Abschnitt man verändert hat.

InterWiki und Wikibereiche

Das Wiki ist in vier Bereiche aufgeteilt: Den Deutschen(De:), den Englischen(En:), den Französichen(Fr:) und den Entwicklerteil(Dev:)

De:, En: und Fr: sollen jeweils Seiten für den Benutzer sein, die ihm in der entsprechenden Sprache helfen. Dev: ist der Bereich für Entwicklerseiten. Das heißt, in Dev: stehen Details, die einen einfachen Nutzer nicht interessieren, in En:/De:/Fr: Grundlagen, die ein Entwickler sowieso schon weiß.

Momentan gibt es eine Menge Entwicklerseiten im deutschem Bereich. Langfristig sollten alle übersetzt in Dev: landen. Wer eine Entwicklerseite in Deutsch schreiben möchte, soll das in De: tun. Besser eine Deutsche Entwicklerseite, als keine. Jemand anders kann die Seite dann später übersetzen.

Nach Möglichkeiten sollten die Sprachen auf dem gleichem Stand gehalten werden.

Schreibstil

Der Schreibstil sollte sachlich und neutral sein. Das heißt, es werden keine Personalpronomen wie "ich", "du", "ihr" verwendet. Sätze werden also im Passiv gebildet.

Falsch:

Falls du auch YaCy mit SSL nutzen möchtest ...

Richtig:

Wenn man YaCy mit SSL nutzen möchte ...

Unfertige Seiten dürfen mit der Vorlage TODO enden, allerdings sollte diese nach Möglichkeit nicht länger als ein paar Tage nötig sein. Ansonsten entsteht ein "Baustelleneindruck".

Vorlagen

Liste der Vorlagen

TODO

Icon work.png TODO: Hier muss noch etwas ergänzt werden

Diese Vorlage wird so erzeugt:

{{todo|Hier muss noch etwas ergänzt werden}}

Artikel, in die diese Vorlage eingefügt wird, werden automatisch in die Kategorie: TODO aufgenommen.

Important / Wichtig

Warning.png Das ist wichtig!
{{Important|Das ist wichtig!}}

Note

Icon info.png Note: Hilfreicher Hinweis
{{Note|Hilfreicher Hinweis}}
ImgNote

Diese Vorlage ist nötig, weil Bilder sich nicht gut in die Vorlage Note einpassen. Prinzipiell kann sie auch für andere Dinge als nur für Bilder verwendet werden.

Icon info.png Note:
Warning.png Dieses Symbol wird in der Vorlage "Wichtig" verwendet
{{ImgNote|[[Bild:Warning.png]]|Dieses Symbol wird in der Vorlage "Wichtig" verwendet}}

Interwiki

Flag-germany.gif Von dieser Seite existiert auch eine deutsche Version.

{{interwikiDE|De:Wikistil}}

Flag-england.gif There is an english version of this page.

{{interwikiEN|En:Wikistyle}}

Flag-france.gif Il y a une version française de cette page.

{{interwikiFR|Fr:Wikistyle}}

Icon work small.png There is a developer's version of this page.

{{interwikiDEV|Dev:Wikistyle}}

Icon work small.png We need a developer version of this page. Create it, and replace this template by the approriate interwiki template.

{{interwikiWANTED|Dev:Wikistyle|developer version}}

Anderes

Bisher auf wenigen Seiten verwendet, und noch nicht ideal ist die YaCyLink Vorlage. Sie sollte schöner überarbeitet werden, dass man sofort erkennt, dass es ein YaCyLink ist. Eventuell könnte per php automatisch der (vom User angegebene) Port seines Peers eingesetzt werden?

http://localhost:8090/foo.html

{{YacyLink|foo.html}}

Trennung von Forum und Wiki

Das Wiki dient zur Dokumentation von Funktionen, Installation und Anwendung von YaCy. Die Diskussionsseiten dienen dazu, Fehler im Artikel zu korrigieren, nicht über Fehler in der beschriebenen Funktion zu berichten.

Im Forum kann unter Nennung des Links über die Funktion und deren eventuelle Fehler diskutiert werden.