[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [incubation] publishing to help.eclipse.org
|
Hi
just for information if other have the same question later,
we finally chose to forget about assembling toc.xml contents or
deploying custom instances of help.eclipse.org . We finally preferred
capitalizing on the asciidoc tool chain in order to provide the online
help with an outline. ie. using the webhelp docbook backend which
offers an outline similar to eclipse help but for static html site (and
no iframe). (exemple result:
http://download.eclipse.org/gemoc/docs/nightly/index.html)
Didier
Le 31/03/2018 à 20:54, Alois Zoitl a écrit :
On Fri, 2018-03-30 at 13:34 +0200, Didier Vojtisek wrote:
Hi thanks Alois
does your xslt is able (or can be easily adapted) to deal with
several
toc.xml ?
As far as I can see in 4diac git, there is only one big
documentation
plugin (in org.eclipse.fordiac.ide plugin).
Yes we have all docs just in one plugin, which makes it a bit easier.
But our xslt is called from a php file with the toc.xml to load. So you
could write your own php which would pull in the different toc.xmls.
The main drawback I saw in our solution is that we could only get it
work with iframes. Which makes the overall behavior a little bit sub
optimal.
Alois
Didier
Le 30/03/2018 à 10:55, Alois Zoitl a écrit :
Hi,
we at Eclipse 4diac do a very simple (unfortunately half manual)
trick
we push the eclipse style help to our web-page and using an xslt
transformation translate the outline xml into a navigation bar.
With
css we even get a formating that is roughly in line with the web-
page
desing. However I would currently not recommend this approach as
the
web-page is not as usable as I would like to have it. More php
magic
would be needed and this is beyond our capabilities. But if you
would
like to use it as start I'm happy to share our current stage.
Alois
On Fri, 2018-03-30 at 09:41 +0200, Didier Vojtisek wrote:
Hi
Actually, we already have a way to convert 1 asciidoc to eclipse
help
(https://github.com/eclipse/gemoc-studio/blob/master/docs/org.ecl
ipse
.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/CrowdSourcingE
xamp
le
Wayne
On Thu, Mar 29, 2018 at 7:14 AM, Didier Vojtisek <didier.vojtis
ek@i
nria.fr> wrote:
Hi
for the documentation of the Gemoc project (https://projects.
ecli
pse.org/projects/modeling.gemoc) we would like to be able
make it
extendable, typically using a mechanism such as anchor (http:
//he
lp.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 (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
incubation@xxxxxxxxxxx
To change your delivery options, retrieve your password, or
unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation
--
Wayne Beaton
Director of Open Source Projects
The Eclipse Foundation
_______________________________________________
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
_______________________________________________
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
_______________________________________________
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
_______________________________________________
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
--
Didier Vojtisek
SED Rennes - DiverSE Team
Univ Rennes, Inria, CNRS, IRISA
Campus de beaulieu
35042 Rennes
02 99 84 75 07
