Eclipse Community Forums: TMF (Xtext)

Help

Home

Home » Modeling » TMF (Xtext) » help with Xdoc

Show: Today's Messages :: Show Polls :: Message Navigator

help with Xdoc [message #794692]

Thu, 09 February 2012 15:28

Lorenzo Bettini

Messages: 1812
Registered: July 2009
Location: Firenze, Italy

Senior Member

Hi

I was trying to start using Xdoc, but it doesn't seem that easy ;)

I noted that Spray had started using xdoc (I grabbed the
xdoc_updatesite.zip from their git branch, to have something
installable), but it looks like they gave up using it and went back to
textile (which I've been using myself); I managed to generate pdf
documentation (through latex) by grabbing the .mwe from org.xtext.doc
plugin...

the eclipse help files seem to be created correctly... concerning the
html for the website, I see that it generates php files which refer to
(include) php files directly from eclipse.org file (actually, they seem
to assume that the html files will be installed on the eclipse website):

e.g., <?php require_once($_SERVER['DOCUMENT_ROOT'] .
"/eclipse.org-common/system/app.class.php");

is there same way to customize this?

I basically found no documentation about xdoc (besides
https://github.com/RvonMassow/xDoc/blob/master/README.textile)

thanks in advance
Lorenzo

--
Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino
ICQ# lbetto, 16080134 (GNU/Linux User # 158233)
HOME: http://www.lorenzobettini.it MUSIC: http://www.purplesucker.com
http://www.myspace.com/supertrouperabba
BLOGS: http://tronprog.blogspot.com http://longlivemusic.blogspot.com
http://www.gnu.org/software/src-highlite
http://www.gnu.org/software/gengetopt
http://www.gnu.org/software/gengen http://doublecpp.sourceforge.net

HOME: http://www.lorenzobettini.it
TDD Book: https://leanpub.com/tdd-buildautomation-ci
Xtext Book: https://www.packtpub.com/application-development/implementing-domain-specific-languages-xtext-and-xtend-second-edition

Report message to a moderator

Re: help with Xdoc [message #796074 is a reply to message #794692]

Sat, 11 February 2012 10:49

Jan Koehnlein

Messages: 760
Registered: July 2009
Location: Hamburg

Senior Member

The default HTML generation in Xdoc is based on Eclipse's web
infrastructure. I guess it won't help you much unless you are
documenting an Eclipse.org project.

You could have a look at the documentation generation for Xtend using
HTML and twitter's bootstrap libs. Looks slicker anyway:

org.eclipse.xtend/plugins/org.eclipse.xtend.bootstrapdoc

Xdoc is not part of Xtext. The link you posted is the official home of
Xdoc. You could contact the project owner to make him write some more docs.

Am 09.02.12 16:28, schrieb Lorenzo Bettini:
> Hi
>
> I was trying to start using Xdoc, but it doesn't seem that easy ;)
>
> I noted that Spray had started using xdoc (I grabbed the
> xdoc_updatesite.zip from their git branch, to have something
> installable), but it looks like they gave up using it and went back to
> textile (which I've been using myself); I managed to generate pdf
> documentation (through latex) by grabbing the .mwe from org.xtext.doc
> plugin...
>
> the eclipse help files seem to be created correctly... concerning the
> html for the website, I see that it generates php files which refer to
> (include) php files directly from eclipse.org file (actually, they seem
> to assume that the html files will be installed on the eclipse website):
>
> e.g., <?php require_once($_SERVER['DOCUMENT_ROOT'] .
> "/eclipse.org-common/system/app.class.php");
>
> is there same way to customize this?
>
> I basically found no documentation about xdoc (besides
> https://github.com/RvonMassow/xDoc/blob/master/README.textile)
>
> thanks in advance
> Lorenzo
>

--
Need professional support for Eclipse Modeling?
Go visit: http://xtext.itemis.com

---
Get professional support from the Xtext committers at www.typefox.io

Report message to a moderator

Re: help with Xdoc [message #808154 is a reply to message #796074]

Mon, 27 February 2012 13:15

Lorenzo Bettini

Messages: 1812
Registered: July 2009
Location: Firenze, Italy

Senior Member

Hi

the project owner gave me some further information, and indeed the
eclipse's web framework phoenix on which xdoc html generation is based
upon looks pretty flexible :)

https://github.com/RvonMassow/xDoc/issues/76

cheers
Lorenzo

On 02/11/2012 11:49 AM, Jan Koehnlein wrote:
> The default HTML generation in Xdoc is based on Eclipse's web
> infrastructure. I guess it won't help you much unless you are
> documenting an Eclipse.org project.
>
> You could have a look at the documentation generation for Xtend using
> HTML and twitter's bootstrap libs. Looks slicker anyway:
>
> org.eclipse.xtend/plugins/org.eclipse.xtend.bootstrapdoc
>
> Xdoc is not part of Xtext. The link you posted is the official home of
> Xdoc. You could contact the project owner to make him write some more docs.
>
> Am 09.02.12 16:28, schrieb Lorenzo Bettini:
>> Hi
>>
>> I was trying to start using Xdoc, but it doesn't seem that easy ;)
>>
>> I noted that Spray had started using xdoc (I grabbed the
>> xdoc_updatesite.zip from their git branch, to have something
>> installable), but it looks like they gave up using it and went back to
>> textile (which I've been using myself); I managed to generate pdf
>> documentation (through latex) by grabbing the .mwe from org.xtext.doc
>> plugin...
>>
>> the eclipse help files seem to be created correctly... concerning the
>> html for the website, I see that it generates php files which refer to
>> (include) php files directly from eclipse.org file (actually, they seem
>> to assume that the html files will be installed on the eclipse website):
>>
>> e.g., <?php require_once($_SERVER['DOCUMENT_ROOT'] .
>> "/eclipse.org-common/system/app.class.php");
>>
>> is there same way to customize this?
>>
>> I basically found no documentation about xdoc (besides
>> https://github.com/RvonMassow/xDoc/blob/master/README.textile)
>>
>> thanks in advance
>> Lorenzo
>>
>
>

--
Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino
ICQ# lbetto, 16080134 (GNU/Linux User # 158233)
HOME: http://www.lorenzobettini.it MUSIC: http://www.purplesucker.com
http://www.myspace.com/supertrouperabba
BLOGS: http://tronprog.blogspot.com http://longlivemusic.blogspot.com
http://www.gnu.org/software/src-highlite
http://www.gnu.org/software/gengetopt
http://www.gnu.org/software/gengen http://doublecpp.sourceforge.net

Report message to a moderator

Previous Topic:	limit scoping of first fragment of qualified name?
Next Topic:	(XText 1.0) importUri and ProposalProvider

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Fri Apr 26 08:08:50 GMT 2024

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter