[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [rmf-dev] Better RMF documentation
|
Dear all,
While I didn't hear anything on this list, I know that Ingo and
Lukas would be fine with a switch to Latex. I tweaked some
scripts and put the resulting latex in a new repository
(org.eclipse.rmf.documentation). I am happy with the result, as
it allows us to scale the the documentation up. I attached the
resulting PDF, using the vanilla Latex Book template. Of course,
this could be made much prettier with a better template. There is
also a HTML generator (producing multiple pages, therefore hard to
attach).
The next steps would be:
- Building the documentation (PDF and HTML) on Hudson
- Removing the corresponding Wiki-Pages (to prevent redundant
information from lingering)
- Updating links to the new documentation.
This is your last chance to raise a flag, if you don't like where
this is heading.
Best,
- Michael
On 13.06.2014 16:43, Michael Jastram wrote:
Hi all,
I had a talk with Gael (Eclipse Foundation) the other day, and one
area where we need improvement is documentation (I am currently
trying to raise some funds to co-finance this). But I'd like to
start a technical discussion here.
I started to look into our current solution (Mylyn/WikiText), and
there are a few problems. For one, it's buggy: If you look at the
generated Eclipse Help, there are a few pictures missing - I don't
know why, but I can reproduce it when regenerating the
documentation locally. Also, as cross-references use the text of
section names, they are brittle.
The main reason to stick with the current solution is that it
makes it really easy for anyone to contribute (no Software
required, just edit the wiki).
Do you know of anything better, or do you have objections to
moving away from what we have right now? Several years back, we
implemented a solution using Latex and Plastex [1]. That worked
well, but I can imagine that Latex scares a lot of contributors.
Also, there may be something better around by now.
I look forward to your thoughts.
Best,
- Michael
[1] http://handbook.event-b.org/
_______________________________________________
rmf-dev mailing list
rmf-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/rmf-dev
|
Attachment:
main.pdf
Description: Adobe PDF document
