fan2asciidoc converts files in fandoc format to asciidoc format, and from there we can generate pdf (or html, etc). I have packaged up the manuals into a single pdf document for searching or printing: fantom-document.pdf.
Hey I noticed you also made a wrapper for SWT charts
https://github.com/petercrlane/swtChartWrapper/
I'm thinking some people might be interested to know that too.
peterlaneWed 20 Mar 2013
swtChartWrapper is quite old, first announced #1441. But yes, I did just add it to the repository, so hopefully it will be more visible.
Peter.
brianWed 20 Mar 2013
This is really great! Thanks Peter
andyWed 20 Mar 2013
Cool!
Be nice to have a Fandoc-Markdown converter too to take advantage of all the Markdown tools out there.
JonasLThu 21 Mar 2013
Thanks a lot for this, I've been using the google search engine in chrome on the forums (http://fantom.org/sidewalk/search/?q=%s) - both good and bad because it hits the forums aswell as the docs.
Nice to be able to search the docs alone.
peterlaneFri 22 Mar 2013
I've tidied up the output from fan2asciidoc, and added a few switches to control the output of links and source highlighting. Also, I've added an option to output markdown format (thanks Andy).
$ fan fan2asciidoc [OPTIONS] dir1/file1 dir2/file2 ...
Will construct an asciidoc file containing all fandoc documentation contained in the listed files or directories. The program places all its converted documents in the directory text, unless changed using a --dir:NAME switch. The top-level file to process with asciidoc is called master.txt.
If no files or directories are passed as input, then the program will attempt to convert the standard documentation material in docIntro/docLang/docTools/docFanr.
Options:
--dir:NAME sets the output directory to NAME
--help, -h outputs a help message
--md writes output in markdown format (rather than asciidoc)
--no-internal-links do not include links (helpful if you need to convert a single document into pdf format)
--pod-html-links add links for pod references to <http://fantom.org>
-- source-highlighting uses syntax highlighting on the code. Only supported in pdf mode, and you must use a2x with parameter: --dblatex-opts "-s fantom-asciidoc-dblatex.sty"
--with-parts include part labels for the top-level directories, to group documentation.
Examples
The shell script (on bitbucket) make-fantom-documentation.sh generates a pdf document from the official documentation for Fantom (requires asciidoc). Download.
To create an html file of the complete set of documentation using markdown and including all links:
$ fan fan2asciidoc --md --pod-html-links
$ cd text
$ markdown master.txt > master.html
andySat 23 Mar 2013
Also, I've added an option to output markdown format
peterlane Wed 20 Mar 2013
fan2asciidoc converts files in fandoc format to asciidoc format, and from there we can generate pdf (or html, etc). I have packaged up the manuals into a single pdf document for searching or printing: fantom-document.pdf.
The code is on bitbucket, and is essentially a clone of
fandoc::HtmlDocWriter
.Let me know if this is useful to anyone.
cheers,
Peter.
tcolar Wed 20 Mar 2013
Hey I noticed you also made a wrapper for SWT charts
https://github.com/petercrlane/swtChartWrapper/
I'm thinking some people might be interested to know that too.
peterlane Wed 20 Mar 2013
swtChartWrapper is quite old, first announced #1441. But yes, I did just add it to the repository, so hopefully it will be more visible.
Peter.
brian Wed 20 Mar 2013
This is really great! Thanks Peter
andy Wed 20 Mar 2013
Cool!
Be nice to have a Fandoc-Markdown converter too to take advantage of all the Markdown tools out there.
JonasL Thu 21 Mar 2013
Thanks a lot for this, I've been using the google search engine in chrome on the forums (http://fantom.org/sidewalk/search/?q=%s) - both good and bad because it hits the forums aswell as the docs.
Nice to be able to search the docs alone.
peterlane Fri 22 Mar 2013
I've tidied up the output from fan2asciidoc, and added a few switches to control the output of links and source highlighting. Also, I've added an option to output markdown format (thanks Andy).
The pod is available from the repository: http://repo.status302.com/browse/fan2asciidoc or in source format on bitbucket.
How to Use
Will construct an asciidoc file containing all fandoc documentation contained in the listed files or directories. The program places all its converted documents in the directory
text
, unless changed using a--dir:NAME
switch. The top-level file to process with asciidoc is calledmaster.txt
.If no files or directories are passed as input, then the program will attempt to convert the standard documentation material in docIntro/docLang/docTools/docFanr.
Options:
Examples
make-fantom-documentation.sh
generates a pdf document from the official documentation for Fantom (requires asciidoc). Download.andy Sat 23 Mar 2013
Sweet!