Difference between revisions of "Help:Editing t20150211"

Revision as of 08:54, 29 January 2013

General information

For the basics about MediaWiki please read MediaWiki FAQ
Add at least one category to every topic
In the beginning, the Cheetsheat is very useful

Structuring an article

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.

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

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.

Do this first
then do this
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

Columns 1	Column 2
Row 1.1	Row 1.2
Row 2.1	Row 2.2
Row 3.1	Row 3.2

Code

Use 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:

UBIK^® MetaModel: A descriptive model, where objects provide information about the aspects of the data, is also called “Metamodel”.

Images

Naming conventions

Formats and resolutions

Supporting images must be fomatted 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.

@@ Line 83: / Line 83: @@
 ===Formats and resolutions===
+Supporting images must be fomatted as <code>thumb</code> 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.
 [[Category:UBIK]][[Category:How to...]]