Difference between revisions of "Documentation/Dashboard/Wiki Editing Policy"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Hierarchy: added BASIC Guide)
(Existing Templates)
Line 73: Line 73:
 
|-
 
|-
 
|[[Template:Documentation/Banner]]|| ||
 
|[[Template:Documentation/Banner]]|| ||
 +
|-
 +
|[[Template:Documentation/BeingEdited]]|| ||{{Documentation/BeingEdited}}
 +
|-
 +
|[[Template:Documentation/Caution]]|| ||{{Documentation/Caution|Never ever do what's written here.}}
 
|-
 
|-
 
|[[Template:Documentation/CheckedAccuracy]]|| ||{{Documentation/CheckedAccuracy|John Doe}}
 
|[[Template:Documentation/CheckedAccuracy]]|| ||{{Documentation/CheckedAccuracy|John Doe}}
 
|-
 
|-
|Template:Documentation/*TOC|| ||
+
|[[Template:Documentation/DraftPage]]|| || {{Documentation/DraftPage}}
 
|-
 
|-
|[[Template:Documentation/Imported]]|| ||
+
|[[Template:Documentation/hbar]]|| || {{Documentation/hbar|100}}
 
|-
 
|-
|[[Template:Documentation/MasterTOC]]|| ||
+
|[[Template:Documentation/HelpNeeded]]|| || {{Documentation/HelpNeeded|Check the spelling}}
 
|-
 
|-
|[[Template:Documentation/Note]]|| || {{Documentation/Note|Notable stuff}}
+
|[[Template:Documentation/Hook]]|| ||
 
|-
 
|-
|[[Template:Documentation/PDF]]|| || {{Documentation/PDF}}
+
|[[Template:Documentation/Imported]]|| ||
 
|-
 
|-
|[[Template:Documentation/hbar]]|| || {{Documentation/hbar|100}}
+
|[[Template:Documentation/LastEdited]]|| || Only works after update of mw engine to > 1.8
 
|-
 
|-
|[[Template:Documentation/BeingEdited]]|| ||{{Documentation/BeingEdited}}
+
|[[Template:Documentation/Linux]]|| || {{Documentation/Linux}}
 
|-
 
|-
|[[Template:Documentation/DraftPage]]|| || {{Documentation/DraftPage}}
+
|[[Template:Documentation/MasterTOC]]|| ||
 
|-
 
|-
|[[Template:Documentation/HelpNeeded]]|| || {{Documentation/HelpNeeded|Check the spelling}}
+
|[[Template:Documentation/NeedsRework]]|| || {{Documentation/NeedsRework}}
 
|-
 
|-
|[[Template:Documentation/LastEdited]]|| || Only works after update of mw engine to > 1.8
+
|[[Template:Documentation/Note]]|| || {{Documentation/Note|Notable stuff}}
 
|-
 
|-
 
|[[Template:Documentation/OOo]]|| || {{Documentation/OOo}}
 
|[[Template:Documentation/OOo]]|| || {{Documentation/OOo}}
 
|-
 
|-
|[[Template:Documentation/Tip]]|| ||{{Documentation/Tip|Try this little trick.}}
+
|[[Template:Documentation/Outdated]]|| || {{Documentation/Outdated|0.5}}
 
|-
 
|-
|[[Template:Documentation/Caution]]|| ||{{Documentation/Caution|Never ever do what's written here.}}
+
|[[Template:Documentation/PDF]]|| || {{Documentation/PDF}}
 
|-
 
|-
|[[Template:Documentation/Hook]]|| ||
+
|[[Template:Documentation/PRODUCTNAME]]|| || {{Documentation/PRODUCTNAME}}
 
|-
 
|-
|[[Template:Documentation/Linux]]|| || {{Documentation/Linux}}
+
|[[Template:Documentation/Tip]]|| ||{{Documentation/Tip|Try this little trick.}}
 
|-
 
|-
|[[Template:Documentation/NeedsRework]]|| || {{Documentation/NeedsRework}}
+
|Template:Documentation/*TOC|| ||
|-
+
|[[Template:Documentation/Outdated]]|| || {{Documentation/Outdated|0.5}}
+
 
|-
 
|-
 
|[[Template:Documentation/Windows]]|| ||{{Documentation/Windows}}
 
|[[Template:Documentation/Windows]]|| ||{{Documentation/Windows}}

Revision as of 09:46, 2 November 2007

Template:Documentation/Banner Template:Documentation/BeingEdited

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
   +---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

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
Template:Documentation/Abstract
Template:Documentation/Banner
Template:Documentation/BeingEdited Template:Documentation/BeingEdited
Template:Documentation/Caution
Documentation caution.png Never ever do what's written here.
Template:Documentation/CheckedAccuracy
Template:Documentation/DraftPage Template:Documentation/DraftPage
Template:Documentation/hbar Template:Documentation/hbar
Template:Documentation/HelpNeeded Template:Documentation/HelpNeeded
Template:Documentation/Hook
Template:Documentation/Imported
Template:Documentation/LastEdited Only works after update of mw engine to > 1.8
Template:Documentation/Linux Template:Documentation/Linux
Template:Documentation/MasterTOC
Template:Documentation/NeedsRework Template:Documentation/NeedsRework
Template:Documentation/Note Template:Documentation/Note
Template:Documentation/OOo Template:Documentation/OOo
Template:Documentation/Outdated
Template:Documentation/PDF Template:Documentation/PDF
Template:Documentation/PRODUCTNAME Template:Documentation/PRODUCTNAME
Template:Documentation/Tip Template:Documentation/Tip
Template:Documentation/*TOC
Template:Documentation/Windows Template:Documentation/Windows

Graphical Content

Linking

Personal tools