Documentation/Dashboard/Wiki Editing Policy

From Apache OpenOffice Wiki
< Documentation‎ | Dashboard
Revision as of 10:12, 2 November 2007 by Ccornell (Talk | contribs)

Jump to: navigation, search

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

Look here if you are unfamiliar with Wiki Categories.

An 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).

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