en:Style guidelines
From WekaDoc
| Table of contents |
Naming conventions
To distinguish different versions and languages of articles, images, etc. easily, they have to added to the names according to the following rules. It is necessary that all the articles, images, etc. comply with these rules, in order to make export from the Wiki to static HTML easily scriptable.
Articles
An article title has to be of the following format:
- language namespace, e.g., en for english
- namespace separator, i.e., a colon ":"
- actual title of the article, e.g., Experimenter
- version number of Weka the article is referring to in parentheses, e.g., (3.4.6)
Examples:
en:Experimenter (3.4.6) en:Explorer - Attribute Selection (3.4.6)
Images and Uploads
The name of Images and uploaded files must have the Weka version they're based on as suffix
- language namespace, e.g., en for english
Note: real namespaces exist only for articles, unfortunately.
Since a localizeable version of Weka will come sooner or later, it is necessary to distinguish between the different languages. - namespace separator, i.e., a hyphen "-"
- Image name, e.g., GUIChooser
Note: all hyphens "-" must be changed to underscores "_", e.g., Explorer-Attribute-Selection becomes Explorer_Attribute_Selection - version suffix, e.g., -346 for version 3.4.6
Examples:
en-GUIChooser-346.jpg en-Explorer_Attribute_Selection_346.jpg
Categories
For better grouping should all articles contain the namespace also as category. I.e., an english article with the namespace en will be member of the en category. A category can be added via the following Wiki link:
[[Category:<name>]]
For an english article one would add the following tag at the end of the article:
[[Category:en]]
One can then easily browse over all articles of a namespace via the appropriate category. An overview over all available categories can be found in the menu on the left side with the Categories menu item.
You should also include a category that reflects the version of Weka, e.g., for 3.4.6 you would use the following category:
[[Category:Weka 3.4.6]]
Author name
If you want to show, who wrote the article, you can add your username at the end of the page with this:
Author: [[User:Fracpete|Peter Reutemann]]
Which will be displayed like that:
Author: Peter Reutemann
Redirects between different versions
Most of the time, there won't be big changes between different versions of Weka; it's more likely to be small changes. Instead of copy/pasting all the content from a previous version and generating new screenshots, one can just redirect to the old article.
Redirecting is done via the #REDIRECT directive, e.g., redirecting from the en:What is Weka? (3.5.1) article to the one from version 3.4.6 is done by inserting the following statement:
#REDIRECT [[en:What is Weka? (3.4.6)]]
If a user selects an article that consists of such a redirect, he/she is automatically transferred to the new one.
Note: a version should never link from its table of contents directly to the old page. It is recommended to create a new article for the specific version and then add a #REDIRECT directive to this page. This makes it easier to add information, in case something did indeed change.
