Difference between revisions of "Documentation/Dashboard/Wiki Editing Policy"
(→Use of Categories) |
(→Documentation Wiki Structure) |
||
Line 4: | Line 4: | ||
This article helps you to contribute effectively to the Documentation part of the wiki. | This article helps you to contribute effectively to the Documentation part of the wiki. | ||
+ | |||
+ | =Requirements (Notes)= | ||
+ | * Inline templates or styles for | ||
+ | ** keys | ||
+ | ** Menus | ||
=Documentation Wiki Structure= | =Documentation Wiki Structure= |
Revision as of 14:13, 9 November 2007
Template:Documentation/Banner Template:Documentation/BeingEdited
This article helps you to contribute effectively to the Documentation part of the wiki.
Requirements (Notes)
- Inline templates or styles for
- keys
- Menus
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 +---BASIC 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 | |
Documentation/BASIC Guide |
Use of Categories
Look here if you are unfamiliar with Wiki Categories.
A simple example of how to use Categories in Wiki books:
- Create a Category named after the current chapter.
- Add all pages of that chapter to the chapter Category.
- Add the chapter Category to the book Category.
The reader can then view the book Category. The book Category shows all the chapters in the book. If the reader clicks on a chapter Category, they can see all of the pages in that chapter (in alphabetical order).
Do not add a category and its subcategory to the same wiki page. For more information see the MediaWiki Help:Category section on Category considerations.
You can use Templates to add a common category to a large group of pages, but it is not recommended. It may appear to save time, but "adding or deleting a category tag in the template does not add or delete the listings on the category page of pages that use the template, until some edit is made in the page that uses the template." For more information, see the MediaWiki Help:Category section on Using templates to populate 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