VDR Wiki:Konventionen

Aus VDR Wiki
Wechseln zu: Navigation, Suche

So, ich starte mal einen Versuch, die hier auf VDR Wiki entstandenen "Standards" aufzuschreiben und evtl. Neue zu entwickeln.

Dies erscheint mir wichtig, da besonders neue Helfer sich damit noch nicht auskennen und es bei den "Alten" Streit über die richtige Auslegung geben könnte und gab. Außerdem gibt es immer noch Bereiche, besonders in der Namesgebung (z.B. bei Bildern), die mir überhaupt nicht geklärt zu sein scheinen.

Da demnächst auch noch ein englisches VDR Wiki an den Start geht und nicht alles von Vorn losgehen sollte, wäre es schön wenn sich viele hier beteiligen und Vorschläge diskutieren, beisteuern und ändern.

--Monroe 12:22, 16. Sep 2004 (CEST)


Hi

Sollten wir uns bei den Plugin Screens nicht auch auf ein Format einiegen das es nicht zu wild wird (zize/x/y)?

Weiß auch nicht, oder doch besser ein wenig kleiner?

svdrpsend.pl grab "/video/"$(date --iso-8601=seconds)".jpg" jpeg 100 500 400

Ist das auch 4:5?

Gruß

--213.6.77.58 21:09, 17. Sep 2004 (CEST)


Inhaltsverzeichnis

Artikel

Namensgebung

Allgemein

Plugins

Artikel über Plugins werden grundsätzlich klein geschrieben. Der Name besteht aus dem Pluginnamen und einem angehängten -plugin, also

name-plugin

Patches

Artikel über Patches werden grundsätzlich klein geschrieben. Der Name besteht aus dem Patchnamen und einem angehängten -patch, also

name-patch

Distribution-spezifische Artikel

Das Hauptaugenmerk von VDR Wiki liegt bei allgemeinen für alle Distributionen gültigen Beschreibungen. Trotzdem gibt es auch Artikel, die auf Eigenschaften und Eigenheiten von bestimmten Distributionen eingehen. Um eine Kollision mit anderen Artikeln zum gleichen Thema, aber anderen Distributionen zu vermeiden, sollten Distributiones-spezifische Artikel mit dem Namen der Distribution in Großbuchstaben anfangen, also

DISTRIBUTION Artikelname

Auf diese Weise ist der Artikel eindeutig gekennzeichnet und der eigentliche Titel immer noch leicht erkennbar.

Format

Allgemein

Plugins

Ein Artikel über ein Plugin enthält folgenden minimalen Inhalt

==Beschreibung==
...
[[Bild:plugin-bild.png]]

==Hardwareanforderungen==
* Anforderung 1
* Anforderung 2
* ...

==Softwareanforderungen==
* Anforderung 1
* Anforderung 2
* ...

==Installation==
Siehe [[Plugin Installation]].

==Probleme==

==Links==
{|
| [1]
| http://
| Homepage des Plugins
|}[[Kategorie:Plugins]]

Wenn es zu bestimmten Punkten keine Informationen gibt, bleibt die Überschrift trotzdem stehen (s.o. ==Probleme==).

Patches

Das Format ist das gleiche wie bei den Plugins. Nur die Bild- und Kategorieangaben müssen natürlich angepasst werden

[[Bild:patch-bild.png]]
[[Kategorie:Patches]]

Ein Bild für einen Patch macht natürlich nur dann Sinn, wenn er eine visuelle Veränderung erzeugt.

Bilder

Namensgebung

Allgemein

Plugins

Zu jedem Plugin sollte auch ein Screenshot dem Artikel hinzugefügt werden. Das lockert den Text etwas auf, außerdem will jeder sowas sehen ;-). Ein direktes Verlinken mit Bildern auf der Homepage des Plugins sollte vermieden werden, da diese sich ändern können und es auch rechtlich sicher nicht ganz einwandfrei ist?!

Um das zu einem Plugin passende Bild schnell zu finden sollte es sich aus dem Namen des Plugins und einem angehängten -bild, sowie einer Nummer zusammensetzen

name-bildxx.png

wobei xx von 01-99 läuft.

Patches

Wenn ein Patch eine visuelle Veränderung erzeugt, sollte auch ein Screenshot dem Artikel hinzugefügt werden. Ein direktes Verlinken mit Bildern auf der Homepage des Patches sollte vermieden werden, da diese sich ändern können und es auch rechtlich sicher nicht ganz einwandfrei ist?!

Um das zu einem Patch passende Bild schnell zu finden sollte es sich aus dem Namen des Patches und einem angehängten -bild, sowie einer Nummer zusammensetzen

name-bildxx.png

wobei xx von 01-99 läuft.

Format

Allgemein

Kategorien

Kategorien sind eine praktische Möglichkeit eine Struktur in die Artikelmassen zu bringen. Aber wildes drauflos-kategorisieren ist eher kontraproduktiv.

Es gibt dabei nicht nur die Möglichkeit einen Artikel einer Kategorie zuzuordnen man kann ihn auch mehreren Kategorien und/oder Unter-Kategorien zuordnen.

Um Wildwuchs zu vermeiden, sollte man schauen, ob nicht schon eine passende Kategorisierung existiert. Kategorien existieren im Moment für

Dies ist im Moment nur ein Vorschlag, das Meiste existiert also noch nicht!

Allgemein

VDR Wiki