Re: [incubation] (HTML) Documentation editor

[David Green <david.green@xxxxxxxxxxx>]

Jens thanks for the pointers, those look great.  I also prefer to have WikiText-based files as source, and generate Eclipse Help content from them.  Jens has some great links there, but you may also find these useful:

http://help.eclipse.org/neon/index.jsp?topic=%2Forg.eclipse.mylyn.wikitext.help.ui%2Fhelp%2FMarkup-Generation.html

https://wiki.eclipse.org/DocumentationGuidelines/CrowdSourcingExample

The documentation includes details of files-as-source, but also covers an alternate approach of using the Eclipse wiki as source (see mediawiki-to-eclipse-help in the docs).

David

On Tue, Jul 12, 2016 at 1:14 PM Jens v.P. <developer@xxxxxxxxx> wrote:

Dear Keith,

We are currently switching to Asciidoc (http://www.methods.co.nz/asciidoc/), using Asciidoctor (http://asciidoctor.org/) for tooling. It is supported by Mylyn’s WikiText (https://wiki.eclipse.org/Mylyn/WikiText/AsciiDoc), and we already create Eclipse Help, HTML pages, and PDF from a single source.

We are at the very beginning, and we have only migrated some user documentation, see https://github.com/NumberFour/n4js/tree/master/docs/eu.numberfour.n4js.doc. In the long run, we want to port our Latex based specification to Asciidoc and use that as the only format. For that, we are currently investigating custom macros (both for AsciiDoc and Mylyn Wikitext).

Regards,

Jens

_______________________________________________
incubation mailing list
incubation@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation

--

David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx