search

tferr / IJ-guide

Contents and Typesetters of the ImageJ User Guide
http://imagej.nih.gov/ij/docs/guide/
8 stars 4 forks source link

Find a documentation system which can produce both PDF and HTML versions #8

Open tferr opened 10 years ago

tferr commented 10 years ago

Noted by @ctrueden, see http://article.gmane.org/gmane.comp.java.imagej/31668

ctrueden commented 10 years ago

I suggest this issue be renamed to something like: "Find a documentation system which can produce both PDF and HTML versions" or similar. Another strong option is Maven Doxia, especially now with the beautiful Reflow Maven Skin. Sphinx's sole markup language is reStructuredText, whereas Doxia supports several great markup languages including (from their website): APT (Almost Plain Text), Confluence, Simplified DocBook, Markdown, FML (FAQ Markup Language), FO, iText, LaTeX, RTF, TWiki, XDoc and XHTML.

ctrueden commented 10 years ago

A third option is Doxygen, which supports both HTML and LaTeX, as well as PDF generation from the LaTeX. We are now using this for the SLIM Curve project:

tferr commented 10 years ago

Sorry for the delay. These are great suggestions. I did not know about Doxia. You are right: simultaneous support for multiple markup languages should be priority. I was just looking at DocBook. Darktable seems to be using it. Their manual (HTML, PDF outputs) has lots of parallels with our user guide.

ctrueden commented 10 years ago

No problem @tferr—just mentioning possibilities as I come across them. Sorry I don't have time to dig deeper and try to actually convert the manual. Perhaps someday we might have a student who could make an attempt, but for right now, I need to focus on getting ImageJ2 out the door. In the meantime, let me know if there's anything I can do to help!