== Introduction ==
*For the basics about MediaWiki please read ''[http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]''
*In the beginning, the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Cheatsheat] is very useful
== Most frequently asked ==
* [[Help:List_of_Templates|Available templates]]
* [[Help:Editing#Lists|Editing lists]]
* [[Help:Editing#tab=Categorizing|Categories]]
== Acceptance criteria ==
{{Hint|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 tips. An example of an image tool tip can be seen on the page for the POI dialog:<br />
* [[POI_View#Billboard|Billboard]]
* [[POI_View#LLA_only_mode_button|LLA only mode button]]
Technically it is also possible to place an {{#tip-text: inline tool tip | inline tool tip text}}.
==Infoboxes==
</syntaxhighlight>
# Item 3
</pre> or <pre># Item 1# Item 24 <br /><syntaxhighlight lang="xml">
<Node1>Value1</Node1>
</syntaxhighlight>
# Item 35
</pre>
</syntaxhighlight>
# Item 3
# Item 4 <br /><syntaxhighlight lang="xml">
<Node1>Value1</Node1>
</syntaxhighlight>
# Item 5
orObeying this syntax it is also possible to use the <nowiki>{{Hint}}</nowiki> and <nowiki>{{Attention}}</nowiki> templates:<pre># Item 1# Item 2 <!---->{{Hint|asdfasdf}}# Item 3# Item 4 <!---->{{Attention|asdfasdf}}# Item 5</pre>
# Item 1
# Item 2<br /><syntaxhighlight lang="xml"><Node1>Value1</Node1>!--</syntaxhighlight-->{{Hint|asdfasdf}}
# Item 3
# Item 4 <!--
-->{{Attention|asdfasdf}}
# Item 5
==Tables==
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. [http://en.wikipedia.org/wiki/ISO_15926 ISO15926].
=== Linking to category pages ===
Unlike links to other pages, <code><nowiki>[[Category:CategoryName]]</nowiki></code> will not work as a link. For that, you need to add ":" at the beginning like <code><nowiki>[[:Category:CategoryName]]</nowiki></code>.
=== Download links ===
* Use the <nowiki>{{FileLink|1|2}}</nowiki> template to create download links within wiki articles, like {{FileLink|Start_Screen_Configuration.zip|Start_Screen_Configuration.zip}}* All downloads should be prepared as .zip files. ==== Naming ====* <version>: Version number as stated on Release portal* <date>: Creation date of file / download resources* <description>: Short description of .zip package content{| class="wikitable" | width = "50%"|- ! Type !! Comment !! File name|- | .xaml || XAML files for the WinX client || xaml_<version>_<date>_<description>.zip|- | .uwf || UBIK workflow files || uwf_<version>_<date>_<description>.zip|- | .xyz / ABC || Arbitrary files / folders || <date>_<description>.zip|} = Client articles =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 [[HowTo: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 [[FAQ: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.
=Special articles=
== Download links ==
Use the <nowiki>{{FileLink|1|2}}</nowiki> template to create download links within wiki articles, like {{FileLink|Start_Screen_Configuration.zip|Start_Screen_Configuration.zip}}.
==Attention==
== Infoboxes ==
See also the list of available [[Help:List_of_Templates#Infoboxes|Infoboxes templates]].
==Other useful templates==