VDR Wiki:Conventions
From VDR Wiki
Contents |
[edit] Article
[edit] Naming schemes
[edit] General
[edit] Plugins
Titles of articles about plugins are written lowercase. The name consists of the plugin name and an appended -plugin, so
name-plugin
[edit] Patches
Titles of articles about patches are written lowercase. The name consists of the patch name and an appended -patch, so
name-patch
[edit] Distribution specific articles
The majority of articles in this wiki should general enough to apply to all common distributions. Nontheless some article there also exists some articles that describe distribution specific characteristics. To avoid a collision with with other articles, their name should start with the name of the distribution in upper case letters. E.g.
DISTRIBUTION article name
[edit] Structure
[edit] General
[edit] Plugins
An article about a plugin has to include the following minimal structure. There also exist a template for this. To use it just place {{subst:Article (plugin)}} in the otherwise empty article, save it and edit again.
==Description==
[[Image:plugin-name.jpg|thumb|Description]]
If the link to the UPLOADED image is placed in the above form before
the text, it will be shown right aligned besides the text. This looks
nice and is space saving.
==Hardware requirements==
* Requirement 1
* Requirement 2
* ...
==Software requirements==
* Requirement 1
* Requirement 2
* ...
==Installation==
See [[plugin installation]].
==Problems==
==Links==
{|
| [1]
| http://
| Plugin homepage
|}
[[Category:Plugins]]
<!-- Link to the german VDR Wiki -->
[[de:german title]]
For articles where more sections are necessary, here is an example. There also exist a template for this. To use it just place {{subst:Article (plugin ext)}} in the otherwise empty article, save it and edit again.
==Description==
[[Image:plugin-name.jpg|thumb|Description]]
If the link to the UPLOADED image is placed in the above form before
the text, it will be shown right aligned besides the text. This looks nice
and is space saving.
===Handling===
A list of key with description, used by the plugin.
{| border=1 cellpadding=2 cellspacing=0
|- bgcolor=#efdead
!Key
!Description
|-
!bgcolor=#efefef| Right || Fast forward (5 sec.)
|-
!bgcolor=#efefef| Left || Fast backward (5 sec.)
|-
!bgcolor=#efefef| Up || Next song
|}
==Hardware requirements==
* Requirement 1
* Requirement 2
* ...
==Software requirements==
* Requirement 1
* Requirement 2
* ...
==Installation==
If the description of [[plugin installation]] is not appropiate or some
subsection are necessary, use these
===Options===
Compile or '''Makefile''' options shouldgo here.
{| border=1 cellpadding=2 cellspacing=0
|- bgcolor=#efdead
!Option
!Description
|-
| SOME_OPTION=1 || Description of the option
|}
===Patches===
Information about Patches here.
==Configuration==
Information about settings in system files (like '''/etc/fstab''') or
in configuration files of the plugin (like '''mp3sources.conf''').
===Parameter===
The commandline parameters of the plugins
{| border=1 cellpadding=2 cellspacing=0
|- bgcolor=#efdead
!Parameter (short)
!Parameter (long)
!Description
|-
| -a ABC || --aaa=ABC || some Parameter
|-
| -b || --bbb || another Parameter
|}
==Problems==
==CVS==
cvs ... login
cvs ... co ...
==Links==
{|
| [1]
| http://
| Plugin homepage
|}
[[Category:Plugins]]
<!-- Link to the german VDR Wiki -->
[[de:german title]]
Those points in the extended example that are not necessary, can be omitted. Section of the basic example are left empty (like ==Problems== above).
[edit] Patches
The article stucture is the same as for the plugins, only the image names and the categories has to be adapted. There also exist a template for this. To use it just place {{subst:Article (patch)}} in the otherwise empty article, save it and edit again.
[[Image:name-patch.jpg]] [[Category:Patches]]
[edit] Formatting rules/style guide
[edit] Version numbers
Nearly every program archive has a version number in it's name. Since in most cases several versions of a program are possible, a placeholder for the version number should be used.
mediawiki-<VERSION>.tar.gz
This placeholder seems to be the most general possible.
[edit] Directories
Directory names in the text should be highlighted with italics, like /usr/local/bin. This should improve readability.
[...] '''/usr/local/bin''' [...]
[edit] Images
[edit] Naming schemes
[edit] General
A screenshot or image makes a text look more nicely and is a good visible discription. Images should alway be uplouded. Only uplouded images ensure accessability and resizeability. Also the copyright issue is a reason againt external linking.
Screenshots of programs should be named like the program and possibly a description in brackets like
programname(screen name).jpg
where screen name can be setup, main,...
For images of hardware and other objects, one should choose a good descriptive name, e.g. for DVB cards include the revision number.
[edit] Plugins
Every plugin should have one or more screenshots. For plugins the same naming rules as above apply.
name-plugin.jpg name-plugin(screen name).jpg
where screen name can be setup, main,...
[edit] Patches
If a patch visually changes the behaviour of VDR, a screenshot would be nice, too. For patches the same naming rules as above apply.
name-patch.jpg name-patch(screen name).jpg
where screen name can be setup, main,...
[edit] Format
[edit] General
For photographs and screenshots, the JPEG format fits best. For electronic circuits the PNG format is better.
A resolution of 800x600 for program screenshot and other images should be enough. 768x576 for shots of TV screen. Please optimize the file size of the image before uploading it. HOWTOS for this can be found in the internet for varies programs.
To make screenshots of VDR and his Plugins, use
svdrpsend.pl grab "/video/"$(date --iso-8601=seconds)".jpg" jpeg 50
[edit] Categories
Categories are a practical way give the article masses a structure. But one should think twice, wether a new category is necessary or not.
One can create categories and sub-categories and one or more of them could be assigned to an article. Es gibt dabei nicht nur die Möglichkeit einen Artikel einer Kategorie zuzuordnen man kann ihn auch mehreren Kategorien und/oder Unter-Kategorien zuordnen.
This is only a suggestion at the moment some don't even exist!
General
VDR Wiki
