1. open source doc
- Posted by fundamental Jan 01, 2011
- 1149 views
Hello, I just downloaded today and had a first look at the pdf among other things. I wondered if the source to the doc available? Maybe it's in the download and I have just missed it.
I'm also interested in how it was produced - what tools were used? Maybe it's a word document? Hopefully its something open source. I might want to use it as a template for another doc.
Thanks for any constructive help given. Hal.
2. Re: open source doc
- Posted by jimcbrown (admin) Jan 01, 2011
- 1116 views
Hello, I just downloaded today and had a first look at the pdf among other things. I wondered if the source to the doc available? Maybe it's in the download and I have just missed it.
I'm also interested in how it was produced - what tools were used? Maybe it's a word document? Hopefully its something open source. I might want to use it as a template for another doc.
Thanks for any constructive help given. Hal.
The source code for the pdf is written in Creole format, and it is gathers from two places.
For generic manual and introduction type stuff, there are a bunch of .txt files (such as whatiseuphoria.txt) in the doc directory. This is browsable from http://scm.openeuphoria.org/hg/euphoria/file/e724410c67ea/docs
The other location is in comments from the standard library include files itself. (The idea is to keep the docs about those methods right next to the method, so they will get updated at the same time.) You can browse those from http://scm.openeuphoria.org/hg/euphoria/file/e724410c67ea/include/std
Two tools are used to generate an .HTML file from that creole source.
creole.ex does the bulk of the work doing the conversion and is available from http://scm.openeuphoria.org/hg/creole/file/d8a720ba06bf
eudoc.ex gathers the various parts and bits and pieces of the docs and puts them in a single place to make creole.ex's job easier. It is available from http://scm.openeuphoria.org/hg/eudoc/file/e26448c0ead1
Conversion from .HTML to PDF is done with other open source tools (such as wkhtmltopdf).
creole.ex also supports generating a LaTeX file from creole source, and it's possible to use standard tools to convert that into a PDF.
