Technical Documentation: Wiki Editor's FAQ

From Go4IT project

Why a Wiki documentation?

Wiki allows a collaborative, online work, and is an easy way to generate technical documentation, and share a common vision of the project documentation. Wiki (through Wikipedia) is a well known edition solution, available now under open source licence. Wiki allows to generate pdf files. This will be the solution for Deliverable Document production (use wiki for collaborative edition, then produce pdf for EC deliverable generation).

How to modify a Wiki document?

Wiki file edition is online: chose the "edit" item in the wiki page menu: you access to the Wiki editor.

Minor changes

You should choose online edition; it's convenient for beginners, because it will help you in the Wiki syntax acquisition.

After a change, please: - check that the Wiki code is correct. "show preview" - check the "This is a minor edit" box - clik on the "Save Page" button

Wiki syntax is quite simple: see What are the presentation rules? for help. This item explains the syntaxic elements that are used for the existing Go4IT technical documents. Feel free to contribute to that section.

First edition and major changes

If you plan to make a lot of modification, it's better to work off line. One of the possible methods (from our experience) is:

• use a text editor (WordPad is nice for that), for the edition work
• when you want to check the document content, copy/paste the corresponding text in the wiki editor, and use the "show preview' button. Then, continue the edition in your local text editor until you reach the version you want to publish. Then, you can "save" from the wiki editor (do not forget to preview, correct the last problems).
• we suggest that you keep one version of the wiki source code in .txt format on your computer (copy past from the Wiki editor if you want to download a wiki source code)

What are the presentation rules?

1. Chapters: Use the wiki standard: =Level1=, ==Level2==, ===Level3===. Example in this document.
2. Tables: Use the wikiclass style. Example in Technical Documentation: General Design Functional Coverage.
3. Images/Figures: Example in Figure.
4. At that moment, the Go4IT wiki style is not fixed. If you prefer the standard wiki style, chose "Switch to MediaWiki mode" in the menu.

Howto create a file ?

• Naming conventions

Howto create a link ?

• Anchor: used for reference list, figure, definition. Syntax is <span id="anchor_xxx">blabla</span>. Example in Technical Documentation: General Design Document
• Internal link in the same document
  • To an anchor
  • To a chapter
• Link to another wiki file (wiki page, image, pdf, ...)
• External link

Howto insert an Image, pdf, etc ...?

File Modification

• Summary