1. is ref man available in text format?
- Posted by SunPsych08 Jul 18, 2011
- 1313 views
Much as I enjoy reading the ref man in html or pdf, there are times when i miss the ability to edit, change, rearrange, summarise, and otherwise pervert the original.
Is there a version of the manual in text format? Or is there are way to convert it to text? So far my best (but very slow) attempts have been to use cut/paste from the html, or use an installed pdf_to_word utility, or an online facility to achieve the same thing. (Usually the upload fails or, when conversion occurs, the result takes ages to clean up.)
Ah for the old days, of refman.txt... 
Alex Caracatsanis
2. Re: is ref man available in text format?
- Posted by mattlewis (admin) Jul 18, 2011
- 1330 views
Much as I enjoy reading the ref man in html or pdf, there are times when i miss the ability to edit, change, rearrange, summarise, and otherwise pervert the original.
Is there a version of the manual in text format? Or is there are way to convert it to text? So far my best (but very slow) attempts have been to use cut/paste from the html, or use an installed pdf_to_word utility, or an online facility to achieve the same thing. (Usually the upload fails or, when conversion occurs, the result takes ages to clean up.)
Here is the raw refman source from the hg repo. The other source files are there, although the standard library and built-in functions are documented inline with the std library source code.
I'm sure we could output a text version. It would require enhancing creole as well as the documentation build process. Please enter a ticket to that effect.
Matt
3. Re: is ref man available in text format?
- Posted by jeremy (admin) Jul 19, 2011
- 1240 views
We could generate a single HTML file easily enough from eudoc/creole and then use html2txt, or lynx to generate the .txt file.
Jeremy
4. Re: is ref man available in text format?
- Posted by jeremy (admin) Jul 19, 2011
- 1198 views
Here is a quick and dirty conversion...
$ cd euphoria/docs $ eudoc -a manual.af --single -o manual.txt $ creole -A manual.txt $ lynx -print -dump manual.txt > euphoria-manual.txt
The result is: http://jeremy.cowgar.com/files/euphoria-manual.txt
Jeremy
5. Re: is ref man available in text format?
- Posted by mattlewis (admin) Jul 19, 2011
- 1208 views
We could generate a single HTML file easily enough from eudoc/creole and then use html2txt, or lynx to generate the .txt file.
Yes, that works for a quick and dirty conversion. I was thinking that a text mode for creole should be pretty trivial. Basically, just strip out all of the creole stuff. OK, maybe tables would take a bit of work to get right, but shouldn't be too bad.
I guess you'd have to figure out how to handle hyperlinks, but that's not difficult, either.
Matt
6. Re: is ref man available in text format?
- Posted by jeremy (admin) Jul 19, 2011
- 1259 views
That'll output the text for sure, but it will not look very pretty. For example, you would need to find a way to offset H1, H2, H3 type entries accordingly. Indent quotes, offset eucode, etc... It is a little more than trivial but I wouldn't think too difficult. The example .txt file should give a good example/idea of what it should look like (for the most part).
Jeremy
7. Re: is ref man available in text format?
- Posted by mattlewis (admin) Jul 20, 2011
- 1198 views
That'll output the text for sure, but it will not look very pretty. For example, you would need to find a way to offset H1, H2, H3 type entries accordingly. Indent quotes, offset eucode, etc... It is a little more than trivial but I wouldn't think too difficult. The example .txt file should give a good example/idea of what it should look like (for the most part).
Oh, sure, now you want pretty!
Matt
