Difference between revisions of "Documentation/DevGuide/Contributing to the Developers Guide"
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Contributing to the Developer's Guide}} | {{DISPLAYTITLE:Contributing to the Developer's Guide}} | ||
| − | + | __NOTOC__ | |
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. | 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. | ||
| Line 40: | Line 40: | ||
=== The Category === | === The Category === | ||
| + | == Insert an IDL link == | ||
| + | == Optional elements == | ||
| − | + | * <nowiki>__NOTOC__</nowiki> can be used to turn off the automatic TOC that MediaWiki will insert if you have more than 4 headings on a single page. | |
{{PDL1}} | {{PDL1}} | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
Revision as of 12:55, 3 March 2008
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:
- Add at least one page to the Wiki
- Create a chapter specific TOC
- Add the new chapter TOC to the main Developer's Guide TOC at Template:Documentation/DevGuide/DevGuideTOC
- Add the new pages to the chapter TOC
Add a page to the Developer's Guide
Remove a page from the Developer's Guide
The DISPLAYTITLE
The PDL template
The Category
Insert an IDL link
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.
| Content on this page is licensed under the Public Documentation License (PDL). |
