Help:Contents

From FactorityWiki

Introduction

The FACTORITY Wiki is our tool of choice for online collaboration, allowing rapid growth and centralization of information created by the FACTORITY community.

Wiki content

This wiki focus on content about FACTORITY and related projects, such as AS+ application server and WireWare. It's not for personal notes and the likes.

Correct date and time

To set the correct date for your current timezone, go to Preferences > Date and time > Fill in from Browser.

This is really useful if you look at the page history or recent changes. Now, you will see the correct date and time.

Editing Articles

Editing the content

This is a quick list of basic MediaWiki style formatting commands.

source code

* first level item
** second level list item
*** and so on

# first level item
## second level list item
### and so on

There is an excellent editing pages description at MediaWiki web site. In addition, you can have a look at an excellent tutorial on how to create tables on MediaWiki home project page.

Font sizes and colors

Mediawiki provides the = symbol to create headers (as already seen in Editing the content). Headers have different font sizes.

A font size can be also specified using html attributes:

<font style="font-size: 110%">110% text</font>

Note that we strongly discouraged to do so since it breaks formatting. Use this only in special cases.

The same policy applies to colors. To change text's color:

<font style="color: #51990F;"><font style="color: #51990F;">Openbravo green color</font></font>

Allowed colors

To allow a better readability of our wiki, we encourage every editor to strictly use only these colors:

Avoid using HMTL

MediaWiki systems use their own mark up language to give format to text. In the section Editing the content of this document, you have a description of how to use this formatting markup. You also can use the MediaWiki quickbar that is at the top of the editing window when creating your articles to give format to your text.

Please, avoid using HTML tagging, including tables since they are not the standard way of coding styles in Mediawiki systems.

Style Guide

This is a list of recommendations for using the different formatting styles in documents.

Article titles: Use titles that reflect the content and preserve the spaces between words (i.e. Installation_Guide instead of InstallationGuide)

Titles: Capitalization and spaces between words, start with two equals headers and add more as you need subtitles (up to 6 equals)

Bold: Use only when necessary, i.e. formatting some text in bold is to remark it, but it looses this effect if an entire paragraph is bold.

Italic: Use it for quoting texts or describing a UI navigation path (i.e. go to General Setup > Application > Background Process)

Tables: Use only allowed colors and keep in mind that a wiki is for content not for visual presentations. To add a border around it start the table with:

 {|border="1" cellpadding="5" cellspacing="0"

The cellpadding and cellspacing are optional, but try to keep them logical (i.e. don't make a table with cellspacing="500")

Lists: It's not mandatory to finish each line in a list with a dot, but use the same rule in all the elements' list.

• This list.
• looks
• a little.
• weird

Formatting: It's not a good practice to use the preformat style to create headers. Instead, you should use the equal signs (==).

Links: Do not use the text click here. See W3 recommendations.

Name guidelines: Use FACTORITY and FACTORITY Product XY (with space between the words).

Documentation style guide

If you are writing an article about documentation make sure that you read our Documentation Style Guide.

Functional specification style guide

If you are writing an article about functional specification make sure that you read our Functional Specification Style Guide.

Spaces and newlines

Please add two blank lines before each header line and at least one line before and after lists, tables, images, and block texts. Keep in mind that no blank lines are allowed between list elements.

For example this text:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut 
labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco 
laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in 
voluptate velit esse cillum dolore eu ugiat nulla pariatur. Excepteur sint occaecat cupidatat 
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
[[Image:Loremipsum.svg]]
==== Header Lorem Ipsum ====
* List
** Lorem
** Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt 
ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco 
laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in 
voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat 
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Some other text

Should be formatted like this:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt 
ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco 
laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in 
voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat 
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
[[Image:Loremipsum.svg]]
 
 
==== Header Lorem Ipsum ====
 
* List
** Lorem
** Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor 
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud 
exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure 
dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit 
anim id est laborum.

Some other text

More Information

Mediawiki help pages