rss

Formatting articles of the knowledge base

Published by aquarelle, last Update le Wednesday July 16, 2008 08:47:14 PM by fleursdespyrenees

Formatting articles of the knowledge base


/!\Be careful /!\ : Don't do a copy/paste of a tip found on another website :
  • First of all, it's unuseful since the same tip is twice on internet.
  • Moreover it's possible that there's a copyright on the tip. If you have nothing further to add, don't write anything.








The knowledge base (also called KB or FAQ) section Tips & Tricks uses a formatting type Wiki
Here are the possibilities.

1 - Titles

  • The overall title is placed between the "equal" ("=").
  • The title of level 1 is placed between 2 equal signs ("==").
  • The title of level 2 is placed between 3 equal signs ("===").
  • .. etc ...


Warning : the line must begin and finish with the sign "="

1.1 - Example


=title of level 1=
==title of level 2==
=====title of level 5=====

2 - Lists


* Bullet of level 1
** Bullet of level 2
*** Bullet of level 3


Note that it is not advisable to begin with a bullet of level 2, because the display will be preceded by an empty bullet of level! For the same reason, you should not skip level between each item.

2.1 - Advised example


*Test1
*Test2
**Test2.1
**Test2.2
***Test2.2.1
***Test2.2.2
**Test2.3
***Test2.3.1
****Test2.3.1.1
**Test2.4
**Test2.5
*Test3
*Test4

2.1.1 - Result

  • Test1
  • Test2
    • Test2.1
    • Test2.2
      • Test2.2.1
      • Test2.2.2
    • Test2.3
      • Test2.3.1
        • Test2.3.1.1
      • Test2.4
      • Test2.5
    • Test3
    • Test4

2.2 - Discouraged example


2.2.1 - Begin with a level X


2.2.1.1 - Example

****Example

2.2.1.2 - Result
        • Example

2.2.2 - Skip levels of bullet


2.2.2.1 - Example

*Test1
*Test2
***Test2.1.1
*Test3

2.2.2.2 - Result
  • Test1
  • Test2
  • Test2.1.1
  • Test2.1.1
  • Test3

3 - Table of Contents


Write twice underscore ("__") on each side of TOC (written in capitals), which will automatically create table of contents (with links) based on titles and subtitles.
__TOC__


Note that you must avoid putting links in your titles and subtitles!

4 - Links


To create a link, simply use the following syntax :

[url text]


It is important to leave a space between the URL and the text. If you put no text, the URL will be used as text.

4.1 - Quick Links (Warning : this part doesn’t work on en.kioskea for the moment)


You can also make a direct link to an article using the following syntax:
[[Keyword]]


For example, [[motherboard]] will automatically create a link to the article about motherboard.

5 - Anchors


You can use the "anchors" to create a direct link to a specific paragraph of the article using titles of level 1 or 2.
You have to put the anchor between brackets [], use the anchor (# immediately followed by the title of level 1 or 2), followed by a space and finally by the visible text which will see to the reading.

5.1 - Example


... go to the paragraph [without space here #3-table-of-contents 3 - Table of Contents without space here]

5.2 - Result


... go to the paragraph 3 - Table of Contents

5.3 - Rules for the anchors

  • Use only tiny letters without an accent
  • No punctuation
  • Replace the spaces by a hyphen "-"
  • Replace the apostrophe " ' " by a hyphen "-"
  • Don't put links in the titles of level 1 or 2
  • Don't use parentheses ()
  • "1 - title" becomes "# 1-title"

6 - Images


To add an image, just use the following syntax :
[[Image: url_of_the_image]]

6.1 - Attributes


It’s possible to use additionnal attibutes which can be combined. The attributes are separated by the sign "|" (AltGr+6). They can be placed in any order but the ALT attribute must be always be the last.

6.2 - List of attributes

  • Positioning the image left :
    [[Image: url_of_the_image|left]]
  • Positioning the image right :
    [[Image: Image: url_of_the_image|right]]
  • Positioning the image centered (by default) :
    [[Image: url_of_the_image]]
  • Resizing the image (pixels) :
    [[Image: url_of_the_image|200px]]
  • The ALT of the image, it is the last attribute before the bracket :
    [[Image: url_of_the_image|right|150px|The ALT attribute of the image]]

7 - The code tags


With those tags, you can post some programming source code which would require a non-proportional font. The text put between the code tags will be automatically indented, and the spacing will be preserved.
<code>Code</code>

8 - To write a text in bold


<gras>Text in bold</gras>

9 - To write a text in italics


<ital>Text in italics</ital>

10 - To write an underlined text


<souligne>Underlined text</souligne>


NB ► this tip is a free english translation of teutates's tip on CommentCaMarche :

Other Tips in the category FAQ

Software found in the relevant downloads
Download Visual Basic Express Edition 2008Visual Basic Express Edition - Visual Basic 2008 Express is the free version of Visual Basic 2008, containing all the basic features of the software....Category: Visual Basic
License: Freeware/gratuit
Download K-Lite Codec Pack Full 4.1.4K-Lite Codec Pack Full - K-Lite Codec Pack is a collection of VFW/ACM codecs, DirectShow filters and tools. Codecs and DirectShow filters are needed...Category: Codec
License: Open Source
Download OpenOffice 2.4.1OpenOffice - OpenOffice is a free office application suite, including a word processor, spreadsheet, presentation tool, drawing package...Category: Office suite
License: Open Source
Download Money Manager Ex 0.9.2.0Money Manager Ex - Possibilty to download a version compatible with Linux <h2> </h2> Money Manager Ex is a free, open-source, cross...Category: Budget
License: Open Source
More freeware about « Formatting articles of the knowledge base »