View source for DocumentationGuidelines/Publishing

{{DocumenationGuidelines/DraftHeader}}

= Target Formats =

Since all content is stored within Eclipsepedia which use MediaWiki text format for structure and styling, it is recommended that projects leverage [[Mylyn/WikiText | Mylyn WikiText]] for the publishing process.   Mylyn <nowiki>WikiText</nowiki> allows for the export of mediawiki files into a variety of ouput formats.  The sections that follow describe these formats and steps to produce the content in more detail.

[[Mylyn/WikiText | Mylyn WikiText]] provides documentation describing how to generate various output formats.  See the [[Mylyn/FAQ#Where_can_I_find_WikiText_documentation.3F | WikiText FAQ]] for details.

= Eclipse Help =

[[Mylyn/WikiText | Mylyn WikiText]] can generate Eclipse Help directly from a MediaWiki.  Improvements are being made to this process, see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=299838 bug 299838].  A working Ant build script used by the Mylyn project [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.mylyn/org.eclipse.mylyn.help.ui/build-helper.xml?root=Tools_Project&view=markup can be found here].

Some projects may choose to transform to formats such as DocBook or DITA as an intermediary step.  This has the advantage of greater control over the output, with the disadvantage of complicating the build process.

= DocBook =

The following information comes from [[Authoring_Eclipse_Help_Using_DocBook | Authoring Eclipse Help Using DocBook]] page.

{{:Authoring_Eclipse_Help_Using_DocBook}}

= DITA =
The following sections come from [[Authoring_Eclipse_Help_Using_DITA | Authoring Eclipse Help Using DITA]].

{{:Authoring_Eclipse_Help_Using_DITA}}


[[Category:Draft_Documentation ]]
[[Category:Documentation Guidelines]]