Difference between revisions of "Documentation/Dashboard/Wiki Editing Policy"
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
{{Documentation/Banner}} | {{Documentation/Banner}} | ||
− | + | This article helps you to contribute effectively to the Documentation part of the wiki. | |
− | + | =Documentation Wiki Structure= | |
− | + | ==Hierarchy== | |
− | + | ||
− | + | ||
− | + | The Documentation section is only part of the large OpenOffice.org Wiki. The doc.oo.o project | |
− | + | tries to present the information in this section in a way that it is easily accessible and | |
+ | has a structure that allows straightforward navigation for both users and contributors. | ||
− | + | All documentation pages are subpages of the main Documentation page. A further substructure | |
+ | presents sections as subpages containing further subpages. Think of it as a hierarchical | ||
+ | representation, just like a file system. | ||
− | + | The current wiki page tree looks like this: | |
− | + | wiki.services.openoffice.org/wiki/Documentation | |
+ | | | ||
+ | +---Dashboard | ||
+ | +---Administration Guide | ||
+ | +---FAQ | ||
+ | +---How Tos | ||
+ | +---OOoAuthors User Manual | ||
+ | +---Tutorials | ||
+ | +---Samples, Templates and Clipart | ||
+ | +---Setup Guide | ||
− | + | {|border=1 style="border-collapse:collapse;" cellpadding=3 cellspacing=4 | |
+ | |- | ||
+ | !Subpage!!Description | ||
+ | |- | ||
+ | |Documentation/Dashboard|| | ||
+ | |- | ||
+ | |Documentation/Administration Guide|| | ||
+ | |- | ||
+ | |Documentation/FAQ|| | ||
+ | |- | ||
+ | |Documentation/How Tos|| | ||
+ | |- | ||
+ | |Documentation/OOoAuthors User Manual|| | ||
+ | |- | ||
+ | |Documentation/Tutorials|| | ||
+ | |- | ||
+ | |Documentation/Samples, Templates and Clipart|| | ||
+ | |- | ||
+ | |Documentation/Setup Guide|| | ||
+ | |} | ||
− | == | + | ==Use of Categories== |
− | + | =Template Usage= | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | == | + | |
− | + | ||
− | + | [http://www.mediawiki.org/wiki/Help:Templates Look here] if you are unfamiliar with mediawiki templates. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | If you create a new template to be used in the wiki documentation, name it as a subpage of Documentation | |
+ | * wrong: '''mytemplate''' | ||
+ | * right: '''Documentation/mytemplate''' | ||
− | {|style="border: | + | ==Existing Templates== |
− | |- | + | |
− | + | {|border=1 style="border-collapse:collapse;" cellpadding=3 cellspacing=4 | |
+ | |- | ||
+ | !Template Name!!Usage!!Example | ||
+ | |- | ||
+ | |Documentation/Abstract|| || | ||
+ | |- | ||
+ | |Documentation/Banner|| || | ||
+ | |- | ||
+ | |Documentation/Checked Accuracy|| || | ||
+ | |- | ||
+ | |Documentation/*TOC|| || | ||
+ | |- | ||
+ | |Documentation/Imported|| || | ||
+ | |- | ||
+ | |Documentation/MasterTOC|| || | ||
+ | |- | ||
+ | |Documentation/Note|| || | ||
+ | |- | ||
+ | |Documentation/PDF|| || | ||
+ | |- | ||
+ | |Documentation/hbar|| || | ||
+ | |- | ||
+ | |Documentation/BeingEdited|| || | ||
+ | |- | ||
+ | |Documentation/DraftPage|| || | ||
+ | |- | ||
+ | |Documentation/HelpNeeded|| || | ||
+ | |- | ||
+ | |Documentation/Last Edited|| || Only works after update of mw engine to > 1.8 | ||
+ | |- | ||
+ | |Documentation/OOo|| || | ||
+ | |- | ||
+ | |Documentation/Tip|| || | ||
+ | |- | ||
+ | |Documentation/Caution|| || | ||
+ | |- | ||
+ | |Documentation/Hook|| || | ||
+ | |- | ||
+ | |Documentation/Linux|| || | ||
+ | |- | ||
+ | |Documentation/NeedsRework|| || | ||
+ | |- | ||
+ | |Documentation/Outdated|| || | ||
|- | |- | ||
− | | | + | |Documentation/Windows|| || |
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | =Graphical Content= | |
− | + | =Linking= |
Revision as of 15:30, 14 September 2007
This article helps you to contribute effectively to the Documentation part of the wiki.
Documentation Wiki Structure
Hierarchy
The Documentation section is only part of the large OpenOffice.org Wiki. The doc.oo.o project tries to present the information in this section in a way that it is easily accessible and has a structure that allows straightforward navigation for both users and contributors.
All documentation pages are subpages of the main Documentation page. A further substructure presents sections as subpages containing further subpages. Think of it as a hierarchical representation, just like a file system.
The current wiki page tree looks like this:
wiki.services.openoffice.org/wiki/Documentation | +---Dashboard +---Administration Guide +---FAQ +---How Tos +---OOoAuthors User Manual +---Tutorials +---Samples, Templates and Clipart +---Setup Guide
Subpage | Description |
---|---|
Documentation/Dashboard | |
Documentation/Administration Guide | |
Documentation/FAQ | |
Documentation/How Tos | |
Documentation/OOoAuthors User Manual | |
Documentation/Tutorials | |
Documentation/Samples, Templates and Clipart | |
Documentation/Setup Guide |
Use of Categories
Template Usage
Look here if you are unfamiliar with mediawiki templates.
If you create a new template to be used in the wiki documentation, name it as a subpage of Documentation
- wrong: mytemplate
- right: Documentation/mytemplate
Existing Templates
Template Name | Usage | Example |
---|---|---|
Documentation/Abstract | ||
Documentation/Banner | ||
Documentation/Checked Accuracy | ||
Documentation/*TOC | ||
Documentation/Imported | ||
Documentation/MasterTOC | ||
Documentation/Note | ||
Documentation/PDF | ||
Documentation/hbar | ||
Documentation/BeingEdited | ||
Documentation/DraftPage | ||
Documentation/HelpNeeded | ||
Documentation/Last Edited | Only works after update of mw engine to > 1.8 | |
Documentation/OOo | ||
Documentation/Tip | ||
Documentation/Caution | ||
Documentation/Hook | ||
Documentation/Linux | ||
Documentation/NeedsRework | ||
Documentation/Outdated | ||
Documentation/Windows |