Difference between revisions of "Help:Editing"

Reference articles

Please have a look at the following reference articles

• Entity Data Model, Class Browser
• Metaclasses: METACLASSSCOPE, QUERYSCOPE
• Classifications: SYSCLS TASK, SYSCLS THUMBNAILEDFILE (with properties)
• How-To: Create a new MetaClass

It is common to use the expression: Save the changes with Ctrl+S or the save command

Do also use screenshots in How-To‘s, so that the reader is guided visually.

Texts

Descriptive text

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

Emphasizing

If you want to emphasize something, use bold style.

Colors

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

UI

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

Headlines

Use the general headline formatting, type in regular case.

Version history

Information related to previous versions should be documented using tool tip. An example can be seen on the page for the POI dialog:

• Billboard
• LLA only mode button

Technically it is also possible to enter a tool tip for a certain word which is then visualized as

Infoboxes

Infoboxes should be used as an introduction for articles that have a useful common denominator. They will appear at the top right ans summarize the article in Keywords and/or pictures. Currently there is a template for a Control Infobox implemented that should be used for all articles about UBIK^® controls.

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

If you want to add special formatted content, like <syntaxhighlight> tags within the numbered items, use one of the following workarounds to preserve continuous numbering:

# Item 1
# Item 2 <!--
--><syntaxhighlight lang="xml">
<Node1>Value1</Node1>
</syntaxhighlight>
# Item 3
# Item 4 <br /><syntaxhighlight lang="xml">
<Node1>Value1</Node1>
</syntaxhighlight>
# Item 5

Using a HTML comment <!-- --> OR <br/> for the line break prevents that the numbered list is broken and numbering starts over:

1. Item 1
2. Item 2
   <Node1>Value1</Node1>
3. Item 3
4. Item 4
   
   <Node1>Value1</Node1>
5. Item 5

Obeying this syntax it is also possible to use the {{Hint}} and {{Attention}} templates:

# Item 1
# Item 2 <!--
-->{{Hint|asdfasdf}}
# Item 3
# Item 4 <!--
-->{{Attention|asdfasdf}}
# Item 5

1. Item 1
2. Item 2

   asdfasdf

3. Item 3
4. Item 4

   asdfasdf

5. Item 5

Tables

Use the WikiTable like in the following example:

{| class="wikitable sortable" | width = "50%"

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

For larger data, the sortable table might be more useful:

{| class="wikitable sortable" | width = "50%"

|- ! 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 for regular code highlighting.

For highlighting a syntax of a specific programming language, use the syntaxhighlight-Tag (values for lang are for example: csharp, xml, ...).

<syntaxhighlight lang="csharp">
// Hello World in Microsoft C#.

using System;

class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
</syntaxhighlight>

which will result in

Wiki specific templates

Check the list of images for this Wiki.

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

Supporting images

Example Supporting images

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

Example: [[File:Example.jpg|220px|thumb|border|alt=Example|Example]]

Descriptive images

Images as part of the descriptive article text can be placed inline, like for emphasizing a certain manual visually, with the following dimensions:

• Images in landscape should not exceed 700 pixels width
• Images in portrait should not exceed 700 pixels height

Example: [[File:Example.jpg|700px|border|alt=Example|Example]]

Borders

Use the border parameter in the tag for the embedded image, for example [[File:Example.jpg|border]] results in

Image captions

Use image captions if appropriate to describe the image and to create a relation to the text.

Gallery style

If there is the need to place a series of images within the text use the gallery tag with an appropriate width and height

<gallery widths="200" heights="200">
File:Example.jpg|1 - Example
File:Example.jpg|2 - Example
File:Example.jpg|3 - Example
</gallery>

which results in

• 

  1 - Example

• 

  2 - Example

• 

  3 - Example

{{Clear}} Template

If one or more images should be located next to the descriptive text but which is organized in several sections, use the {{Clear}} template. Have a look at the below section example:

Use this command very rarely - try to place the images in a gallery style!

Section 1 starts here

Example

Some text 1

Watch that section 2 starts after some spacing.

Section 2 starts here

Example

Some text 2

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 OR use at least the category UBIK
• Do not create new categories every time - check if an existing fits to your needs.

Sub Categories

A new sub category can be created by pasting a category within the source of another category page.

Sort Key

Use sort keys for articles and subcategories, e.g. objects of category Classifications, so that the article is sorted by a propery sort key instead of S always. Example: [[Category:System Classifications|T]]

Category Tree

The articles and categories are evaluated by the Category Tree extension and used on the SiteMap page.

• Extension:Category Tree
• Help:Extension:CategoryTree

Certain types of articles should be assigned to a namespace, which is simply done by adding a namespace-prefix in front of the article name like HowTo:Assign_a_Namespace

Find a list of namespaces and how its realted to a main category below.

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.

Download links

Use the {{FileLink|1|2}} template to create download links within wiki articles, like Start_Screen_Configuration.zip

There are four types of pages related to client documentation,

• Features (technical documentation, etc.)
• How-Tos
• FAQ
• Version pages

Documentation related to the different platforms (Android, Windows and Web) should be placed as within those pages as described below.

Page types

Features

Features and behavior of the clients sometimes have a rather big overlap, especially how it is documented. On the other side, due to different platforms we have varying UI elements in both, form and handling. Nevertheless, documentation should be kept to a minimum and hence, the features described in the most generic way possible. The parts which differ in between the platforms (UI, handling, etc.) should be described in different sections and by using according screenshots. Add a suffix to the section's name or figure's title, which is

• (Android) ... for Android client
• (Windows) ... for Windows client
• (Web) ... for the Web client

→ See Map View or Live Values for examples.

How-Tos

Platform / component specific documentation is to be placed onto distinctive tabs. Hence, the information is placed onto the following tabs

• Studio: describing actions to be performed with UBIK Studio
• Android: describing actions performed in the Android client
• Windows: describing actions performed in the Windows client
• Web: describing actions performed in the Web client

→ See Install UBIK Client Certificate for an example

FAQ

An additional tab Windows is added to the FAQ page for the clients. FAQs related to the Windows client is to be placed here.

→ See Client for an example

Version pages

Separate version pages are created for the Windows client, rather similar to the version pages for Android or the Server.

Categories

Assign the platform related category Android, Windows, Web to pages, respectively.

HowTos

Create a How-To to describe HOW to solve a certain issue. The given instructions should be clear and easy to follow, therefore use screenshots (server and client side) to document your explanations. Use a descriptive name for the How-To article, such that already describes the content.

Consider the KISS principle - Keep It Short and Simple

Place images within the items of the numbered list (its width should remain 220 pixels width in landscape or 170 pixels height in portrait orientation).

FAQ

Create or edit a FAQ page to provide answers to questions or issues the reader would ask using WHY, WHO, WHEN, etc. Provide a short answer, which probably also includes a few instructions.

If the issue requires more detailed explanations refer to an existing wiki article or create a new one.

Wiki specific templates

Check the list of templates for a comprehensive list of available templates in this Wiki.

Download links

Use the {{FileLink|1|2}} template to create download links within wiki articles, like Start_Screen_Configuration.zip.

Attention

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

{{Attention|Please don't miss this sentence!}}

will result in

Please don't miss this sentence!

Hints

Use the Hint template to outline useful tips and hints:

{{Hint|You should read this, it will simplify your work!}}

will result in

You should read this, it will simplify your work!

HintEvents

Use HintEvents to outline that the type has specific events.

{{HintEvents}}

will result in

There are specific events available for this type!

HintMethods

Use HintMethods to outline that the type has specific events.

{{HintMethods}}

will result in

There are specific methods available for this type!

Infoboxes

See also the list of available Infoboxes templates.

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:

Template list

A list of available templates can be found here List of Templates

The Editing Wizard offers a convenient way to create articles having a pre-defined structure and purpose.