Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Buckminster » A question about Buckminster Documentation...
A question about Buckminster Documentation... [message #652447] Thu, 03 February 2011 22:37 Go to next message
Henrik Lindberg is currently offline Henrik Lindberg
Messages: 2500
Registered: July 2009
Senior Member
On 2/1/11 3:14 PM, Matthew Webber wrote:
> Is there a way that the community can assist in keeping the BuckyBook
> up-to-date?
>

Simple answer:
yes please !!! :)

Longer answer:

The Bucky Book is written using DocBook, and I have edited and generated
the PDF version using a tool that runs locally (Serna-Free). (the source
is not in any way tied to Serna, but it helped manage the XSLT
stylesheets, running different types of generation etc. and I have made
a bunch of stylesheet customizations).

I have on my TODO list since quite some time to make the source of the
book available at Eclipse, but I never seem to find the time to
configure the DocBook to PDF generation part of it so it is runnable by
anyone.

Maybe as a first step, I can just make the source available, thereby
making it possible to edit and provide patches. Maybe some docbook,
xslt, fop, pdf, guru would like to take it from there :).

A bigger (and more long term) task, if someone would like to take that
on ;) - is to transform the text to wiki text so the continued
maintenance can be done on the wiki + using Mylyn wiki text (which I
have used successfully in other projects to generate both pdf and
eclipse help).

Meanwhile, logging [documentation] issues in bugzilla is very helpful,
and if there is clear instructions on what to change and where it has a
far greater chance of being included. (I hope to be able to make a round
of edits in time for Indigo release).

Regards
- henrik
Re: A question about Buckminster Documentation... [message #1007880 is a reply to message #652447] Thu, 07 February 2013 22:02 Go to previous messageGo to next message
Alan Underwood is currently offline Alan Underwood
Messages: 37
Registered: October 2010
Member
So is there now a way to contribute to the documentation yet? Do we just start adding to the Buckminster wiki pages instead? There doesn't seem to be any development on the documentation front but the documentation bugzilla entries are building up...
Re: A question about Buckminster Documentation... [message #1007994 is a reply to message #1007880] Fri, 08 February 2013 08:03 Go to previous message
Lorenzo Bettini is currently offline Lorenzo Bettini
Messages: 1351
Registered: July 2009
Senior Member
On 02/07/2013 11:02 PM, Alan Underwood wrote:
> So is there now a way to contribute to the documentation yet? Do we just
> start adding to the Buckminster wiki pages instead? There doesn't seem
> to be any development on the documentation front but the documentation
> bugzilla entries are building up...

Hi

I volunteered to port Buckminster documentation to Xdoc
(https://github.com/RvonMassow/xDoc) the same tool that is used to
produce Xtext documentation.

The nice thing about Xdoc is that it provides a
nice (Xtext-based) editor and it automatically produces:

- documentation for the web (integrated with Eclipse Phoenix web
framework),
- a plugin documentation for eclipse and
- (optionally) a pdf book...

all starting from the same
input (you can see the documentation of Xtext generated with Xdoc here
http://www.eclipse.org/Xtext/documentation.html - see also the generated
pdf). I've already used Xdoc myself for one of my projects
(http://xsemantics.sourceforge.net/documentation/).

It is not as powerful as DocBook of course, but I guess it's much easier
to use.

I still haven't started to setup that though, I hope it'll be ready soon...

cheers
Lorenzo

--
Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino
HOME: http://www.lorenzobettini.it
Previous Topic:Refresh Buckminster Metadata
Next Topic:Conditionally using a local Git clone
Goto Forum:
  


Current Time: Tue Sep 16 21:36:20 GMT 2014

Powered by FUDForum. Page generated in 0.08558 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software