VDR Wiki:Konventionen

Aus VDR Wiki
(Weitergeleitet von Konventionen)
Wechseln zu: Navigation, Suche

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

Bsp.

[[C't-VDR - Set timer]]

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

Gliederung

Allgemein

Plugins

Beim eintragen neuer Plugins in die Plugins#Liste, Bitte folgendes beachten.

Plugin Beschreibung
<name>|<status>]] Eine kurze und knappe Beschreibung des Plugins (möglichst in Deutsch)
  • <name> ist der Name des Plugins ohne nachgestelltes -plugin
  • <status> ist die Farbe
    lime  
      Lauffähig unter der aktuellen VDR Version 1.4.x
    yellow  
      Lauffähig unter der VDR Version 1.2.x/1.3.x (oder muss erst per Modifikation lauffähig gemacht werden)
    red  
      Technisch überholt, nicht lauffähig
    blue  
      Demonstrations-plugins
    lightgrey 
      Nicht klassifiziert

Ein Artikel über ein Plugin enthält folgenden Inhalt (siehe auch Templates#Plugins):

==Beschreibung==
'''Autor:''' <NAME-1>, <NAME-2>

Hier die Beschreibung des Plugins.

===Status===
Ein besonders erwähnenderwerter Entwicklungsstatus.

==Bilder==
{|
|[[Bild:<plugin>-plugin-00.jpg|thumb|none|''kurze beschreibung'']]
|[[Bild:<plugin>-plugin-01.jpg|thumb|none|''kurze beschreibung'']]
|}

==Bedienung==
Eine Liste der benötigten Tasten und ihre Funktion, sowie vielleicht ein paar zusätzliche Anmerkungen.
{| width="100%" class="wikitable"
|-
!Taste
!Funktion
|-
| Rechts, FastFwd || Schneller Vorlauf (5 sec.)
|-
| Links, FastRew  || Schneller Rücklauf (5 sec.)
|-
| Hoch            || Nächstes Stück
|}

====Hardcoded====
Bitte keine Pfadangaben in den allgemein gültigen ('''distributions-unabhängigen''') Artikel verwenden ([[Plugins]] e.t.c.).

Beispiel:

Es heißt:

 $SOURCEDIR

Nicht:

 /usr/local/src

Somit bleibt es (Linux üblich) jeden selbst überlassen, wie was und wo.

Noch besser ist ein Verweis zur Quelle.

Beispiel.

 cp [[Struktur|$SOURCEDIR]]/VDR/PLUGINS/src/loadepg/[[loadepg.conf]] [[Struktur|$VDRCONFIG]]

Oft verwendete Kürzel im Wiki sind (meist):

 $HOME      ~/vdr
 $SOURCEDIR  /usr/local/src
 $PATH       /usr/bin:/usr/local/bin:$PATH
 $VDRCONFIG  /usr/etc/vdr

==Hardwareanforderungen==
* Anforderung 1
* Anforderung 2

==Softwareanforderungen==
* Anforderung 1
* Anforderung 2

Hier haben sich die Kürzel bewährt.

* <benötigt folgendes>  = (gleich) '''<version>'''
* <benötigt folgendes> >= (gleich oder größer) '''<version>'''
* <benötigt folgendes> <= (gleich oder kleiner '''<version>'''

* Zbs.:
* vdr >= '''1.3.35''' will heißen -> plugin benötigt vdr in der version 1.3.35 oder höher.
* ...

Bei einer bestimmten Version (Software), die Plugin Version dazu schreiben.

* Anforderung (plugin-<VERSION>)

==Installation==
Damit sind aufzulösende Abhängigkeiten für ein Plugin gemeint, zbs Installieren von Software.

Aber nicht das Plugin selbst, zbs:

 apt-get install <plugin>

Sowas gehöhrt auf die entsprechenden Seiten der jeweiliegen Distribution.

Sollten es mehrere Punkte werden, weil zbs Installation, von Distribution zu Distribution unterschiedlich ist, wie folgt.

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

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

===Source==
 Anweisungen zum übersetzen von Sourcen.

===[[Arch-Linux]]===
 pacman -S <pakete>

===[[Crux]]===
 prt-get <pakete>

===[[Debian]]===
 apt-get <pakete>

===[[Gentoo]]===
 emerge <pakete>

===[[SuSE]]===
 yast -i <pakete>

===[[Weitere]]===
 Befehle

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

===Einstellungen===
Damit sind meist die Einstellungen im Plugin selbst gemeint.

===Parameter===
Hier werden schließlich die möglichen Kommandozeilenparameter des Plugins aufgeführt.
{| border=1 class="wikitable"
|-
!Parameter (kurz)
!Parameter (lang)
!Beschreibung
|-
| -a ABC || --aaa=ABC || irgendein Parameter
|-
| -b     || --bbb     || ein anderer Parameter
|}

==Sonstiges==
===Probleme===
Probleme sollten der Lesbarkeit halber gruppiert werden.
* Problem 1
* Problem 2
* Problem 3

===Tipps===
Tipps sollten der Lesbarkeit halber gruppiert werden.
* Tipp 1
* Tipp 2
* Tipp 3

===Wunschliste===
Wünsche sollten der Lesbarkeit halber gruppiert werden.
* Wunsch 1
* Wunsch 2
* Wunsch 3

===Snapshot===
 cvs ... login
 cvs ... co ...

==Links==
# [http:// Homepage des Plugins]

[[Kategorie:Plugins]]
[[en:<plugin>]]

Wenn es zu bestimmten Punkten keine Informationen gibt, wird die Überschrift ausgeblendet, das geht so.

<!-- ==Installation== -->

Wenn etwas nicht klar sein sollte, einfach bei den anderen Plugins schauen.

Patches

Das Format ist ähnlich wie bei den Plugins (siehe Templates#Patches). Lediglich die Bild- und Kategorieangaben müssen hier angepasst werden:

[[Bild:name-patch-00.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ürfte, dass nur eine ganz bestimmte Version verwendet werden kann und das dann sowieso gesondert hervorgehoben werden sollte, ist es besser, einen Platzhalter zu verwenden. Da es verschiedene Versionsschemata gibt, ist

mediawiki-<VERSION>.tar.gz

die wohl allgemeinste (beste?) Möglichkeit, unterschiedliche Versionen unterschiedlicher Programme in gleicher Weise darzustellen, und wird hier verwendet.

Verzeichnisse

Wenn im Textfluss ein Verzeichnisname, wie /usr/local/bin, auftaucht, sollte er der besseren Lesbarkeit wegen fett gesetzt werden:

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

Hardcoded

Bitte keine Pfadangaben in den allgemeingültigen (distributions-unabhängigen) Artikeln verwenden (Plugins e.t.c.).

Beispiel.

Es heißt:

$SOURCEDIR

Nicht:

/usr/local/src

Somit bleibt es (Linux üblich) jedem selbst überlassen, wie was und wo.

Noch besser ist ein Verweis zur Quelle.

Beispiel.

cp $SOURCEDIR/VDR/PLUGINS/src/loadepg/loadepg.conf $VDRCONFIG

Oft verwendete Kürzel im Wiki sind (meist):

$HOME      ~/vdr
$SOURCEDIR  /usr/local/src
$PATH       /usr/bin:/usr/local/bin:$PATH
$VDRCONFIG  /usr/etc/vdr

Links

Bitte Links wie im Bsp. 1 + 2 erstellen (siehe auch VDR Wiki:Links).

Eine Zeit lang war Bsp. 3 die Referenz für die meisten Seiten im VDR Wiki, wie hier zu lesen.

Jedoch nicht die beste Wahl, was...

  • Nutzung des Platzes anbelangt
  • Sowie den Aufwand fürs Tabellen erstellen
  • Auch das manuelle durchnummerieren sollte nicht unerwähnt bleiben

Bsp.1

Bsp.2

  1. Namib-Bilddokumentation
  2. Lodges in der Namib
  3. Gobabeb Training & Research Centre

Bsp.3

[1] http://www.geoimage.ch/177468 Namib-Bilddokumentation
[2] http://safarinow.com/destinations/Namib-Desert/?a=10986 Lodges in der Namib
[2] http://www.gobabeb.org/index.htm Gobabeb Training & Research Centre

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-screenshot-xx.jpg

wobei xx von 00-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-xx.jpg

wobei xx von 00-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-xx.jpg

wobei xx von 00-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, siehe SVDRP#GRAB

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

Für vdr >= 1.3.38 (mit --grab=DIR gestartet).

svdrpsend.pl grab "<FILENAME>.jpg" 50

Oder (benötigt sharutils):

svdrpsend.pl 'grab -' | sed -n -e 's/^216-//p' -e '1ibegin-base64 644 -' -e '$a====' | uudecode > "/tmp/<FILENAME>.jpg"
svdrpsend.pl 'grab -' | sed -n -e 's/^216-//p' -e '1ibegin-base64 644 -' -e '$a====' | uudecode -o "/tmp/<FILENAME>.jpg"

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

Spezial:Categories

In anderen Sprachen