Help:AVRFreaks Wiki Editing guidelines

From AVRFreaks Wiki

Jump to: navigation, search

Have you already looked at this How to edit a page introduction?

Contents

[edit] Creating new pages

Check existing pages before adding new page, and avoid redundancy.

When making new documentation, remember to use the Documentation namespace.

Documentation:nodename

[edit] Organizing the wiki hierarchically

Authors are also encouraged to use hierarchical organization when adding pages. Using the "/" operator in the document name, creates a child node. Every child node will by default display a link to its parent node on the top of the page. This makes navigation back and forth more convenient.

See Documentation:AVR_GCC/AVR_GCC_Tool_Collection as an example.


[edit] Use a precise name as possible

Wrong:

[[ Changelog ]]

Correct:

[[ STK1000 BSP Changelog | Changelog ]]

[edit] Images

  • png-format is prefered, alternatively use jpeg (photos only!, not for drawings and screenshots).
  • Resize pictures before uploading. Keep image size.
Personal tools