Hi
Actually, we already have a way to convert 1 asciidoc to eclipse help
(https://github.com/eclipse/gemoc-studio/blob/master/docs/org.eclipse.gemoc.studio.doc/src/userguide/pom.xml#L189
+ )
Our concern is about extracting the set of eclipse help of an eclipse
product (the Gemoc studio) and produce the web site from it.
The intent here is to consider the product help as the reference
documentation and publish it. Since this documentation is an aggregation
of several tool, we cannot consider a single place as entry (ie. a wiki
or a single asciidoc cannot be the entry point)
Additionally, the concept of anchor (available in eclipse help) would be
useful to create a coherent table of content from multiple documentation
plugins that would contribute to it by injecting content in the correct
chapter.
Didier
Le 29/03/2018 à 18:45, Wayne Beaton a écrit :
The Mylyn projects generate documentation from the wiki. I'm pretty
sure that their techniques could be adapted to an Asciidoc-based source.
https://wiki.eclipse.org/DocumentationGuidelines/CrowdSourcingExample
Wayne
On Thu, Mar 29, 2018 at 7:14 AM, Didier Vojtisek
<[email protected] <mailto:[email protected]>> wrote:
Hi
for the documentation of the Gemoc project
(https://projects.eclipse.org/projects/modeling.gemoc
<https://projects.eclipse.org/projects/modeling.gemoc>) we would
like to be able make it extendable, typically using a mechanism
such as anchor
(http://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fua_help_content_nested.htm
<http://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fua_help_content_nested.htm>)
so the contribution may comes from various plugins and
contributors. (and thus do not force contributors to use our
current solution based on asciidoc in a central place when
contributing)
However, as far as I know the anchor works only within eclipse
help system, but we also whish to have an online version in
addition the embedded eclipse help.
One option would be to mimic http://help.eclipse.org/oxygen web
server but only for the Gemoc eclipse package.
Does someone know how to publish on help.eclipse.org
<http://help.eclipse.org> (typically in a sub folder named gemoc
or gemoc/myrelease_x.y.z ?)
Alternatively does someone has some script that is able to build
an html version (ie. something we can deploy on a basic web
server) from a set of documentation plugins ?
Thanks
Didier
--
Didier Vojtisek
SED Rennes - DiverSE Team
Univ Rennes, Inria, CNRS, IRISA
Campus de beaulieu
35042 Rennes
02 99 84 75 07
_______________________________________________
incubation mailing list
[email protected] <mailto:[email protected]>
To change your delivery options, retrieve your password, or
unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation
<https://dev.eclipse.org/mailman/listinfo/incubation>
--
Wayne Beaton
Director of Open Source Projects
The Eclipse Foundation
_______________________________________________
incubation mailing list
[email protected]
To change your delivery options, retrieve your password, or unsubscribe from
this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation
--
Didier Vojtisek
SED Rennes - DiverSE Team
Univ Rennes, Inria, CNRS, IRISA
Campus de beaulieu
35042 Rennes
02 99 84 75 07
_______________________________________________
incubation mailing list
[email protected]
To change your delivery options, retrieve your password, or unsubscribe from
this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation
