FR/Documentation/TableauBord/Organisation

Cette page est en cours d'édition

Flepennu Decembre 2007 (CEST)

Cet article a pour but de vous aider a contribuer a la section Documentation/FR de ce wiki.

Structure du Wiki Documentation

Hiérarchie

La section Documentation est une partie du Wiki. Le projet doc.oo.o cherche a présenter les informations dans cette section d'une facon accessible et a une structure qui permet la navigation pour les utilisateurs et les contributeurs.

Toutes les pages documentation sont des sous-pages de la page Documentation principale. 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/FR/
   |
   +---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:

1. Create a Category named after the current chapter.
2. Add all pages of that chapter to the chapter Category.
3. 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

Existing Templates

Template Name	Usage	Example
Template:Documentation/Abstract
Template:Documentation/Banner
Template:Documentation/FR/EnCours		Cette page est en cours d'édition
Template:Documentation/FR/Attention		Ne faite jamais ce qui est écrit ici.
Template:Documentation/FR/PertinenceVerifiee		Cet article a été vérifié sur sa pertinence technique par Jean Dupond
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/FR/EnAttente		Cet article a besoin d'être vérifié sur ses aspects techniques, de pertinence et/ou de styles.
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

General guidelines for images are:

1. Use the image description page to describe an image and copyright status (if any).
2. Use a descriptive and unique title.
3. If possible, do not pre-scale the images you are uploading. Use the MediaWiki image thumbnail feature to scale the image.
4. Edit the image if necessary to make sure that the important part is clear and visible.
5. Keep in mind that people may be translating the page where you are placing an image. Try not to include callouts or other extra text on the image.
6. JPG is usually best for photos, SVG, for icons, logos etc, and PNG for screen captures. Try not to use BMP.

You can use the MediaWiki Image thumb feature to "wrap" your illustrations in an image box. This image box includes a spot for an image caption. The syntax is [[Image:image.png|thumb|position|size|Image caption]], where:

• thumb = thumbnail the image and wrap in an image box
• position = position on page. "none" places the image on the left of the frame with no text wrapping. "left" and "right" places the image on the left or right of the page with full text wrapping.
• size = max width in pixels for the image. If the image is larger than this value it is scaled down. If the image is smaller it is left as is.

If you do not declare a position and size, the image is scaled to a small thumbnail, and defaults to the right hand side of the page with full text wrapping.

An example using [[Image:LoadSaveOptions.png|thumb|none|500px|An example image caption]]

An example image caption