Article

Naming schemes

General

Plugins

Titles of articles about plugins are written lowercase. The name consists
of the plugin name and an appended -plugin, so

name-plugin

Patches

Titles of articles about patches are written lowercase. The name consists
of the patch name and an appended -patch, so

name-patch

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

Structure

General

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.

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.

Those points in the extended example that are not necessary, can be
omitted. Section of the basic example are left empty (like ==Problems== above).

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

Formatting rules/style guide

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.

Directories

Directory names in the text should be highlighted with italics, like /usr/local/bin. This should improve readability.

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

Images

Naming schemes

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.

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

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

Format

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

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.