Difference between revisions of "WritingRules"
From ArmadeusWiki
Line 60: | Line 60: | ||
To insert image, you must use the following syntax : | To insert image, you must use the following syntax : | ||
− | <source lang=" | + | <source lang="bash"> |
[[image:imagename.png|center|frame|'''figure <number>''' - ''legend title'']] | [[image:imagename.png|center|frame|'''figure <number>''' - ''legend title'']] | ||
</source> | </source> | ||
If '''QDWL''' find this syntax, it will download the picture and print the legend. | If '''QDWL''' find this syntax, it will download the picture and print the legend. |
Revision as of 11:03, 2 December 2008
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 normal user on your development Host then use:
<source lang="bash"> [ ] $ command </source>
- If you're speaking about a command launched as root on your development Host then use:
<source lang="bash"> [ ] # command </source>
- If you're speaking about a command launched on the target then use:
<source lang="bash"> # command </source>
Traduction
- Use the "LanguageBar" Template to add multiple languages selection to your page:
{{LanguageBar|Page_English_Name|Page_French_Name|Page_German_Name}}
QDWL
[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|frame|'''figure <number>''' - ''legend title'']]
If QDWL find this syntax, it will download the picture and print the legend.