Difference between revisions of "Wiki Contributor Guidelines"
Davidmbrooke (Talk | contribs) (Created first draft) |
Davidmbrooke (Talk | contribs) (Added notes on diagram link formatting and refined requirement for LEAF project membership) |
||
| Line 2: | Line 2: | ||
Everyone on the Internet can read the contents of this Wiki. | Everyone on the Internet can read the contents of this Wiki. | ||
In order to contribute content various pre-requisites have to be satisfied: | In order to contribute content various pre-requisites have to be satisfied: | ||
| − | * You must have a [http://sourceforge.net/ SourceForge] account. | + | * You must have a [http://sourceforge.net/ SourceForge] account by signing up [http://sourceforge.net/account/registration/ here]. |
| − | * You | + | * You must be a member of the [[LEAF]] project. Click [http://sourceforge.net/project/memberlist.php?group_id=13751 here]. |
| − | + | ||
* You need to be listed on the [[Special:ListUsers|Users]] page for this Wiki. | * You need to be listed on the [[Special:ListUsers|Users]] page for this Wiki. | ||
** In particular you need to be listed as a member of [[Special:ListGroupRights|user class]] "editor" - the text <tt>(editor)</tt> will appear after your username. | ** In particular you need to be listed as a member of [[Special:ListGroupRights|user class]] "editor" - the text <tt>(editor)</tt> will appear after your username. | ||
| Line 33: | Line 32: | ||
A picture paints a thousand words. Diagrams should be included where they assist with understanding, or even just because they look nice. | A picture paints a thousand words. Diagrams should be included where they assist with understanding, or even just because they look nice. | ||
| + | The preferred format for screenshots is PNG. | ||
The preferred format for diagram files is SVG. | The preferred format for diagram files is SVG. | ||
The recommended tool for creating/editing SVG files is TODO (Inkscape, maybe? [[User:Davidmbrooke|Davidmbrooke]] 20:34, 12 November 2010 (UTC)) | The recommended tool for creating/editing SVG files is TODO (Inkscape, maybe? [[User:Davidmbrooke|Davidmbrooke]] 20:34, 12 November 2010 (UTC)) | ||
| + | |||
| + | When including diagram files in pages, the preferred formatting syntax is: | ||
| + | <nowiki>[[Image:filename.png|center|frame|alt=Alternative text|Caption]]</nowiki> | ||
Revision as of 21:10, 30 November 2010
Contents
Access Management
Everyone on the Internet can read the contents of this Wiki. In order to contribute content various pre-requisites have to be satisfied:
- You must have a SourceForge account by signing up here.
- You must be a member of the LEAF project. Click here.
- You need to be listed on the Users page for this Wiki.
- In particular you need to be listed as a member of user class "editor" - the text (editor) will appear after your username.
- In order to be added as an "editor" an "admin" of this Wiki needs to grant you access. The "admin" users are listed on the Users page.
- TODO - How do we advise users to contact an "admin" to request access?
Structure of Wiki Pages
The LEAF development team are keen to see this Wiki maintained as a trustworthy and up-to-date source of information for LEAF users and developers. In support of this, the policy is to have relatively few pages, each of which is managed as part of a well-defined structure. Since the Wiki concept does not enforce a good structure it is necessary to maintain this manually.
In particular:
- Most of the content should form part of "books" which have a logical structure of Chapters and (optionally) Sub-Chapters.
- The main page for each "book" shall contain a "Table of Contents", with links to the separate pages for Chapters and (optionally) Sub-Chapters.
When choosing names for new pages:
- Remember that the scope of this Wiki is all of the LEAF project, not only e.g Bering-uClibc 4.x. Pages which are specific to a particular Branch, or to a Version of a Branch, should be prefixed with the Name (and Version) of that Branch.
- For example: Bering-uClibc 4.x - User Guide, Bering-uClibc 4.1 - Release Notes.
- Somebody else might want to create a different page to describe the same aspects of a different Branch.
Content of Wiki Pages
WikiMarkup
Use WikiMarkup in preference to HTML markup.
Diagrams
A picture paints a thousand words. Diagrams should be included where they assist with understanding, or even just because they look nice.
The preferred format for screenshots is PNG. The preferred format for diagram files is SVG. The recommended tool for creating/editing SVG files is TODO (Inkscape, maybe? Davidmbrooke 20:34, 12 November 2010 (UTC))
When including diagram files in pages, the preferred formatting syntax is:
[[Image:filename.png|center|frame|alt=Alternative text|Caption]]
