Contributing to the Developer's Guide

The Developer's Guide in the Wiki uses many standard markup features of MediaWiki. This Contribution guide assumes that you already have some knowledge of MediaWiki markup.

OpenOffice.org documentation is organized using the subpages feature of MediaWiki. The subpages group the document contents together, give structure to the documents, and keep similarly named pages apart.

The Developer's Guide is located at Documentation/DevGuide, and each chapter is an additional subpage:

• The chapter titled First Steps is in Documentation/DevGuide/FirstSteps
• The chapter titled Professional Uno is in Documentation/DevGuide/ProUNO/
• etc.

A page in the Developer's Guide has several elements that are mandatory.

• The link to the Table of Contents (TOC) for the chapter
• The DISPLAYTITLE
• The page content
• The PDL
• The Category

The TOC

The TOC template is used to insert a navigation tree or Table of Contents (TOC) on the right side of the Wiki page. The TOC template is documented in the MasterTOC template page.

Add a new chapter to the Developer's Guide

To add a new chapter to the Developer's guide:

1. Add at least one page to the Wiki
2. Create a chapter specific TOC
3. Add the new chapter TOC to the main Developer's Guide TOC at Template:Documentation/DevGuide/DevGuideTOC
4. Add the new pages to the chapter TOC
5. Add the new chapter Category to the Developer's Guide master category

Add a page to the Developer's Guide

To add a new page to an existing chapter in the Developer's Guide:

1. Add the page to the Wiki. Make sure that the page is in the correct subpage.
2. Add the TOC link
3. Add the PDL template
4. Add the correct Category
5. Edit the chapter TOC template, and add the link to the new page

Remove a page from the Developer's Guide

To remove a page from the Developer's Guide:

1. Delete the page from the Wiki
2. Delete the link to the page from the chapter TOC

The DISPLAYTITLE

MediaWiki displays the full Wiki page title including the subpages. This can make the title very difficult to read. DISPLAYTITLE is used to rewrite the Wiki page title. To use the DISPLAYTITLE to rewrite the page title, add this markup at or near the top of your document:

 {{DISPLAYTITLE:Wiki page title that should be shown}}

The PDL template

Documentation on the OpenOffice.org Wiki must have a license. The Developer's Guide has been released under the PDL, so all pages added to the Developer's Guide should have this license statement at the bottom of each page. The Wiki markup to add the PDL license to a Wiki page is:

{{PDL1}}

The Category

The MediaWiki Category feature is used to group the Developer's Guide by book and by chapter.

Each page in a chapter belongs to a Category named the same as the chapter title, and each chapter Category belongs to the master Developer's Guide Category.

Optional elements

__NOTOC__ can be used to turn off the automatic TOC that MediaWiki will insert if you have more than 4 headings on a single page. This has been done throughout the Developer's Guide where there are enough headings in a page to trigger the MediaWiki autotoc.

Content on this page is licensed under the Public Documentation License (PDL).