参与编辑《开发者指南》

From Apache OpenOffice Wiki
< Zh‎ | Documentation
Revision as of 05:49, 2 June 2008 by Jirong (Talk | contribs)

Jump to: navigation, search


维基版的《开发者指南》使用了许多MediaWiki标记,参与编辑之前您应对MediaWiki标记有一些了解。

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.

英文版的《开发者指南》位于Documentation/DevGuide目录下,每个章节都是一个独立的子页面:

  • 章节First Steps 位于 Documentation/DevGuide/FirstSteps 目录下
  • 章节Professional Uno 位于 in Documentation/DevGuide/ProUNO/ 目录下
  • 如此类推.


注:基于《英文版开发者指南》的基础上使用原有的英文路径,所有中文文档被置于/Zh/Documentation/路径下,因此在所有中文版开发者指南的页面路径/Zh/Dcoumentation/将对应于英文版文档的路径/Documentation/

  • 章节“准备工作” - First Steps 位于 Zh/Documentation/DevGuide/FirstSteps 目录下
  • 章节“专业 UNO" - Professional Uno 位于 Zh/Documentation/DevGuide/ProUNO/ 目录下
  • 如此类推.


《开发者指南》中的每一页必需包含以下几个元素:

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

To contribute to existing pages, all you need to do is simply edit the Wiki pages just as you would any other Wiki page.

The TOC

目录模板(The TOC templet)用于在维基页面的右侧插入一个导航工具或一个目录索引(Table of Contents)。英文的目录模板(The TOC template)是 MasterTOC模板页。中文版使用:中文主目录模板

目录模板包含两部分:

  • 中文主目录模板应用于所有的中文目录, 不需要修改此模板。
  • 章节模板定义了所有该章节的各独立部分或页面,以及他们的顺序。


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 template with the name <chaptername>TOC
  3. Add the new chapter TOC to the main Developer's Guide TOC at Template:Documentation/DevGuide/DevGuideTOC/Zh注:此模板已编辑完毕。
  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

Move a page in the Developer's Guide

To move a page in the Developer's Guide:

  1. Move the page to the right subpage
  2. Delete the link to the page from the old chapter TOC location
  3. Add a link to the page in the new chapter TOC location

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

PDL 许可模板

OpenOffice.org 维基上的文档都必需包含一个许可。《开发者指南》是在PDL许可下发布的,因此所有添加到《开发者指南》下页面都必在页面下方需包含这一许可声明。使用如下标记会将PDL许可添加到该Wiki页面上:

{{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 章节中的每一页都属于以该章节名命名的类别,而所有章节类别都属于主类别 开发者指南.

IDL 链接

The IDL extension provides an easy and convenient way to add links to the IDL webpages. Use the IDL tags for all IDL cross references.

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).
Personal tools