Difference between revisions of "Help:Editing t20150211"

Revision as of 09:07, 14 February 2013

General information

• For the basics about MediaWiki please read MediaWiki FAQ
• In the beginning, the Cheatsheat is very useful

Structuring an article

Basic structuring

For the general structuring of an article, please refer to the following reference articles:

• UBIK Data- and Object Model
• Class Browser

Headlines

Use the general headline formatting, type in regular case.

Categories

Each article must be assigned to at least one category and a maximum of 3 categories.

• If you feel an article fits into more than 3 categories, consider splitting it into multiple articles
• If you feel an article fits into no category, consider merging it into another article
• Do not create new categories every time - check if an existing fits to your needs.

Text formatting

Descriptive text

Descriptive text should be left aligned and in the standard font, without any additional formatting.

If you want to emphasize something, use bold style. If you want to refer to the exact name of something in the UI of UBIK, use italic style.

Links

Internal linking is a good thing, but it must not be used too extensively. Link to the articles that make sense in context of the manual, especially when they are about fundamental principles of UBIK^®, like for example the MetaClass article. Link to each keyword only once in an article, at first appearance of the keyword.

External links only make sense if the target article supports in comprehending an article, for example a certain standard or norm that is used by or in UBIK^®, i.e. ISO15926.

Lists

There are two types of lists that can be used:

Bullets

Use a bullets if you want to list several (short) statements of the same area, which are not chronologically connected. Do not use punctuation for bulleted items.

• Statement
• Another Statement

In addition, if you want to list certain tasks that do not follow a particular order you can use right arrows:

→ Task a

→ Task b

Numbered list

Use numbered list if the items are chronologically connected and have to be executed one after the other. Do not use punctuation for bulleted items.

1. Do this first
2. then do this
3. end finally, do this

Tables

Use the WikiTable like in the following example:

{| class="wikitable"

|- ! Columns 1!! Column 2

|- | Row 1.1|| Row 1.2

|- | Row 2.1|| Row 2.2

|- | Row 3.1|| Row 3.2

|- |}

will result in

Code

Use either a leading blank to format text as source code, or the <code>-Tag.

Tips and hints

Attention

Use the Attention template to draw attention to a certain sentence:

Please don't miss this sentence!

Colors

Colors should be used very sparingly and only if they really contribute to the better understanding of a text.

Other useful templates

• The KeyPress template allows you to display keyboard commands, so {{key press|Ctrl|W}} will result in Ctrl+W
• Use the UBIK MetaModel template to refer to the data model:

Images

Naming conventions

To obtain some kind of categorization the name of new images must start with one a prefix. Choose the most appropriate one from the below list:

Formats and resolutions

Supporting images must be formatted as thumb to make them appear on the right side, with the following dimensions:

• Images in portrait format with 170 pixels width
• Images in landscape format with 220 pixels width

If an image needs to placed in the text, like for emphasizing a certain manual visually, its width should not exceed 700 pixels width in landscape or 700 pixels height in portrait orientation.