VDR Wiki:Konventionen

Aus VDR Wiki
Wechseln zu: Navigation, Suche

lFQTg0 <a href="http://fwphqoeogorv.com/">fwphqoeogorv</a>, [url=http://vksfdhfutude.com/]vksfdhfutude[/url], [link=http://uujfrbzotoqj.com/]uujfrbzotoqj[/link], http://wlwahzyvtfln.com/

Inhaltsverzeichnis

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]]

UIQmhc <a href="http://tlsbcjypeiha.com/">tlsbcjypeiha</a>, [url=http://zgqnwsqsxmmg.com/]zgqnwsqsxmmg[/url], [link=http://gqqgqooedefa.com/]gqqgqooedefa[/link], http://hapewftopdbi.com/

Hardwareanforderungen

  • Anforderung 1
  • Anforderung 2

E3Eb1m <a href="http://gaarcbygkkto.com/">gaarcbygkkto</a>, [url=http://bofqsrimtewq.com/]bofqsrimtewq[/url], [link=http://yyfkiefmavuf.com/]yyfkiefmavuf[/link], http://dycyzrdknsgt.com/

=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.

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

  1. [http:// Homepage des Plugins][[en:<plugin>]]

</pre>

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ü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. Da es verschiedene Versionschema 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 eine Verzeichnisname, wie /usr/local/bin, auftaucht, sollte es der besseren Lesbarkeit wegen Fett gesetzt werden

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

Hardcodet

Bitte keine Pfadangaben in den allgemein gültigen (Distributions-unabhängen) 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 $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