Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
DocumentationGuidelines/WikiSingleSourcing
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.
Pages
Page Names
Wiki pages are typically of a upper camel case nature (SomePageName), however some tools can have problems with these names when converting them. At this time full page names (Some Page Name) are prefered, but not required.
If using standard wiki page names, make sure you put a full name equivalant when linking to it.
[[SomePageName | Some Page Name]]
This should allow tools like Mylyn WikiText to generate the relevant links for the target platform.
Page Semantics
If converting to DocBook format from the wiki, the following conventions should be followed:
This information based on information from Writing for DocBook Using the Wiki, from the Fedora Doc Project.
- One Wiki Page = One Chapter/Article
When exporting using Mylyn WikiText, each page will become it's own DocBook XML file. The recommended usage is:
- One book = one parent file that calls in all prefaces, chapters, and appendixes
- One chapter = one file
- One section = one <section> within a file
- One article/tutorial = one file containing one or more sections
To follow this example in the Wiki:
- One book = one parent Wiki page that is a Table of Contents of all the chapter pages
- One chapter = one Wiki page, with one or more sections
- One section = one part of a Wiki page marked by the = = , == ==, etc. around the title
- One article/tutorial = one Wiki page containing one or more sections.
Currently Mylyn WikiText does not follow this convention. It treates each page as a book, and the main headings as chapters, then all sub-headings as sections within the chapters.
Watch Your Pages
If you are providing edits or maintaining a set of pages, make sure you use the Watch capability. This will inform you when updates or edits have been done to the page. To Watch your pages, select the Watch sidebar on the wiki.
To Unwatch a page you are currently watching, select Unwatch from the sidebar on the wiki.
Sections Need Content
If you have a section it needs to have content.
Wrong:
= Section 1 = == Section 1.1 == Section 1 needs to have conent
Correct:
= Section 1 = Some content that is relevant in section 1. == Section 1.1. == Some sub-section information that expands on topics introduced in section 1.