Difference between revisions of "WritingRules"

Latest revision as of 16:47, 17 February 2015

On this page are explained the rules to follow when writing articles for this wiki

Shell commands

• If you're speaking about a command launched as a user on your development Host then use:

<pre class="host">
  [  ] $ command
</pre>

That will give you :

  [  ] $ command

• If you're speaking about a command launched on the target then use:

<pre class="apf">
 # command
</pre>

That will give you :

 # command

• If you're speaking about a make menuconfig configuration then use :

<pre class="config">
[*] Networking support  --->
    Wireless  --->
        <*> Generic IEEE 802.11 Networking Stack (mac80211)
</pre>

That will give you :

[*] Networking support  --->
    Wireless  --->
        <*> Generic IEEE 802.11 Networking Stack (mac80211)

Traduction

• Use the "LanguageBar" Template to add multiple languages selection to your page:

 {{LanguageBar|Page_English_Name|Page_French_Name|Page_German_Name}}

Warning

{{Warning| it's dangerous !}}

give :

Warning: it's dangerous !

Note

 {{Note| A little information flash}}

give:

Note: A little information flash

Pages under construction

• Use the "Under_Construction Template:

 {{Under_Construction}}

Page under construction... Informations on this page are not guaranteed !!

Page need update

• Some page are too old and may need some update. In that case use this template :

 {{Need_Update}}

This page is too old and need some updates. Informations on this page are not guaranteed !!

Page to be deleted

• Some pages may be too old and won't be updated. In that case, use this template :

 {{to_be_deleted}}

This page is obsolete and will be deleted soon

QDWL

Quick and Dirty Wiki to Latex is an home made script used to convert Wikimedia pages in Latex (that can be converted in pdf). To use this script, some special writing rules must be followed:

Source code syntax highlighting

• When you write code or bash script directly in the Wiki, you must use the automatic syntax highlighting feature with "source" tag; for example:

<source lang="c">
#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
    printf( "APF9328 says: Hello World ! ;-)\n" );
    exit(0);
}
</source>

will give you:

#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
    printf( "APF9328 says: Hello World ! ;-)\n" );
    exit(0);
}

Insert image

To insert image, you must use the following syntax :

[[image:imagename.png|center|500px|thumb|'''figure <number>''' - ''legend title'']]

Replace 500px|thumb with frame, if you want to keep the orignal size of the picture and have a legend.

If QDWL find this syntax, it will download the picture and print the legend.

Tables

If you want to insert a table then please use the following template:

{| border="1" cellpadding="5" cellspacing="0" summary="put summary here"
|- style="background:#efefef;" align="center"
! width="33%" | Title A !! width="33%" | Title B !! Title C
|- align="center"
| A1
| B1
| C1
|- align="center"
| A2
| B2
| C2
|- align="center"
| A3
| B3
| C3
|}

or

{| border="1" cellpadding="5" cellspacing="0" summary="put summary here"
|- style="background:#efefef;" align="center"
! width="33%" | Title A !! width="33%" | Title B !! Title C
|- align="center"
| A1 || B1 || C1
|- align="center"
| A2 || B2 || C2
|- align="center"
| A3 || B3 || C3
|}

That will both give you:

• There is a tool to generate the wiki code for you, if you have complicated tables to create: [1]

File/directory names

Please put the file/directory names in italic:

''buildroot/target/device/armadeus/''

which gives: buildroot/target/device/armadeus/

Redirection

When several page name point on the same wiki page, it's a good idea to do a redirection page with following syntax :

#REDIRECT [[destination_page]]