VDR Wiki:Konventionen

Version vom 20. September 2004, 22:33 Uhr

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.

Das hier Beschriebe muss nicht unbedingt der Realität entsprechen, auch wenn es darauf basiert. --Monroe 12:22, 16. Sep 2004 (CEST)

Diskussion:Konventionen

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.

Gliederung

Allgemein

Plugins

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

==Beschreibung==
[[Bild:plugin-name.jpg|thumb|Beschreibung]]
Wenn das hochgeladene! Bild in der obigen Form vor dem Beschreibungstext 
gesetzt wird, erscheint es auf der rechten Seite und wird von Text 
umflossen. Das sieht nett aus und verbraucht wenig Platz.

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

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

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

==Probleme==

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

[[Kategorie:Plugins]]

[[en:englischer Titel]]

Wenn weitere Punkte nötig, oder wünschenswert sind, kann man wie folgt einfügen

==Beschreibung==
[[Bild:plugin-name.jpg|thumb|Beschreibung]]
Wenn das hochgeladene! Bild in der obigen Form vor dem Beschreibungstext 
gesetzt wird, erscheint es auf der rechten Seite und wird von Text 
umflossen. Das sieht nett aus und verbraucht wenig Platz.

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

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

==Installation==
Wenn die Beschreibung unter [[Plugin Installation]] nicht ausreicht, 
weil z.B. verschiedene Optionen für das Kompilieren gesetzt werden können,

===Optionen===
können diese hier aufgeführt und beschrieben werden.

===Patches===
Bei evtl. vorhandenen, oder notwendigen Patches, wird hier dann ebenso 
verfahren.

==Konfiguration
Unter Konfiguration können dann notwendige Einstellungen an Systemdateien 
- wie der ''fstab'' - oder an Konfigurationsdateien des Plugins - 
wie der mp3sources.conf - beschrieben werden.

==Parameter==
Hier werden schließlich die möglichen Kommandozeilenparameter des Plugins 
aufgeführt.
{| border=1 cellpadding=2 cellspacing=0
|- bgcolor=#efefef
!Parameter (kurz)
!Parameter (lang)
!Beschreibung
|-
| -a ABC || --aaa=ABC || irgendein Parameter
|-
| -b     || --bbb     || ein anderer Parameter
|}

==Bedienung==
Eine Liste der benötigten Tasten und ihre Funktion, sowie vielleicht ein 
paar zusätzliche Anmerkungen.
{| border=1 cellpadding=2 cellspacing=0
|- bgcolor=#efefef
!Taste
!Funktion
|-
!bgcolor=#efefef| Rechts, FastFwd || Schneller Vorlauf (5 sec.)
|-
!bgcolor=#efefef| Links, FastRew  || Schneller Rücklauf (5 sec.)
|-
!bgcolor=#efefef| Hoch            || Nächstes Stück
|}

==Probleme==

==CVS==
<pre>
cvs ... login
cvs ... co ...
<nowiki>

Links

</pre>

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:name-patch.jpg]]
[[Kategorie:Patches]]

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

Formatierung/Gestaltung

Versionsnummern

Fast alle Programmpakete haben eine Versionsnummer in ihren Namen. Da es eher selten der Fall sein dürfe, dass nur eine ganz bestimmte Version verwendet werden kann und das dann sowieso gesondert hervorgehoben werden sollte, ist es besser einen Platzhalter zu verwenden, etwa in dieser Form

mediawiki-x.y.z.tar.gz

Allerdings ist dieses dreiteilige Versionschema nicht bei jedem Programm üblich und dann z.B. auf das ".z" zu verzichten etwas inkonsistent, auch gibt es noch stärker abweichende Versionsschemata.

mediawiki-<VERSION>.tar.gz

scheint die wohl am allgemeinsten (beste?) Möglichkeit zu sein unterschiedliche Versionen unterschiedlicher Programme in gleicher Weise Darzustellen.

Worauf wollen wir uns einigen? --> Diskussion:Konventionen

Verzeichnisse

Wenn im Textfluss eine Verzeichnisname, wie /usr/local/bin, auftaucht, sollte es der besseren Lesbarkeit wegen kursiv gesetzt werden

[...] ''/usr/local/bin'' [...]

Bilder

Namensgebung

Allgemein

Ein Screenshot, oder Bild verschönert den Text und kann auf eindrucksvolle Weise das Objekt der Beschreibung illustrieren.

Wenn es sich um Screenshots für Programme handelt, sollte man als Namen den des Programms, plus ein angehängtes -screenshot wählen, also

programmname-screenshotxx.jpg

wobei xx von 01-99 läuft.

Bei Fotos von Hardware oder anderen Gegenständen, sollte man einen möglichst eindeutigen Namen wählen, bei DVB-Karten also z.B. mit Revisionsnummer.

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 den Namen des Pluginartikels und evtl. eine Nummer haben

name-plugin.jpg
name-pluginxx.jpg

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 Um das zu einem Patch passende Bild schnell zu finden sollte es den Namen des Patchartikels und evtl. eine Nummer haben

name-patch.jpg
name-patchxx.jpg

wobei xx von 01-99 läuft.

Format

Allgemein

Für Fotos und Screenshots ist das JPEG-Format am besten geeignet, für Skizzen und Zeichnungen sollte das PNG-Format gewählt werden.

Eine Auflösung von 800x600 bei Fotos und Programm-Screenshots, bzw. 768x576 bei Fernseh-Screenshots sollte ausreichend Details liefern. Vor dem hochladen, sollte man die Größe des Bildes optimieren. Anleitungen hierzu gibt's vielfach und für verschieden Programme im Internet.

Für Screenshots von VDR / Plugins:

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

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

• Kategorie:Software
  • Kategorie:VDR
    • Kategorie:Plugins
    • Kategorie:Patches
• Kategorie:Hardware

VDR Wiki

• Kategorie:Hilfe