== 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 ==*In the beginning, the [http[Help://en.wikipedia.org/wiki/WikipediaList_of_Templates|Available templates]]* [[Help:Cheatsheet CheatsheatEditing#Lists|Editing lists]]* [[Help:Editing#tab=Categorizing|Categories]] is very useful
== Acceptance criteria ==
===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==
# Item 5
Obeying this syntax it is also possible to use the <nowiki>{{HintsHint}}</nowiki> and <nowiki>{{Attention}}</nowiki> templates:
<pre>
# Item 1
# Item 1
# Item 2 <!--
-->{{Hint|asdfasdf}}
# Item 3
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 =
Features and behavior There are four types of the clients have a rather big overlappages related to client documentation, especially how its documented. Hence, it is advised to describe the features in the most general way possible and to specialize only those parts which are platform dependent * Features (due to different UI designstechnical documentation, etc.).* How-Tos* FAQ* Version pages
The approach is Documentation related to create a common article for a certain feature. Special parts the different platforms (Android, Windows and Web) should be separated by using tabs for each platform, where an according code snippet for adding tabs can be found here:placed as within those pages as described below.
<syntaxhighlight lang="xml"><tabs style="width:80%"><tab namePage types ="Android">[[File:UI_TechSpec_UBIKClient_EditDownloadedFile.png|thumb|Notification for editing a downloaded file]]Android description goes here...</tab><tab name="Windows">Windows description goes here...</tab><tab name="Web">[[File:UI_WEB_CONTENTLIST.png|thumb|220px|{{UBIK}} Web Content List]]Web description goes here...</tab></tabs></syntaxhighlight >
will result in<tabs style="width:80%"><tab name="Android">= Features ===[[File:UI_TechSpec_UBIKClient_EditDownloadedFileFeatures and behavior of the clients sometimes have a rather big overlap, especially how it is documented.png|thumb|Notification for editing 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 downloaded file]]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 description goes here) ...for Android client</tab><tab name="* (Windows">) ... for Windows description goes hereclient* (Web) ...for the Web client ''→ See [[Map View]] or [[Live Values]] for examples.''</tab><tab name="== 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 [[FileHowTo:UI_WEB_CONTENTLIST.png|thumb|220px|{{UBIK}} Web Content ListInstall_UBIK_Client_Certificate]]for an example''Web description goes === 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.</tab></tabs>== 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==