From: Bob P. <rgp...@gm...> - 2011-10-15 03:33:47
|
I have written a 500+ page textbook on assembly language. It has lots of code listings, figures (vector graphics), and math. The source is currently LaTeX. The book is currently used at the university where I used to teach and the local community college. I make it available in both in pdf and print versions. For the past couple of years, students get only the pdf version. They tell me that they much prefer eReaders to print books. I want to produce an ePub version. (Ironically, I started the book in 1999 using html.) I realize that much of the LaTeX formatting will have to go away, but I think the ePub format will make up for that loss. My first thought was to use html. Then I got into a DocBook mood. Then I discovered restructuredtext! Neat! My question: Am I crazy trying to convert my LaTeX source into RST? I've done a couple of chapters, and it looks good. I realize that this will be LOTS of work. But I'm retired, so it would be sort of a hobby for me. And who knows, I may be able to contribute something back to the docutils community that would improve the production of technical eBooks. Any thoughts on this are very welcome. Examples of books written with RST would be especially helpful. --Bob |
From: Roberto A. <ra...@ne...> - 2011-10-15 13:33:28
|
On 10/15/2011 12:33 AM, Bob Plantz wrote: > My question: Am I crazy trying to convert my LaTeX source into RST? I've > done a couple of chapters, and it looks good. > > I realize that this will be LOTS of work. But I'm retired, so it would > be sort of a hobby for me. And who knows, I may be able to contribute > something back to the docutils community that would improve the > production of technical eBooks. Having written about 200 pages of my own book using restructured text, I think you will not regret it. Moving from LaTeX to rst is mostly *deleting* stuff, AFAICS, except for tables. > Any thoughts on this are very welcome. Examples of books written with > RST would be especially helpful. Here's mine (it's in spanish though): http://nomuerde.netmanagers.com.ar > --Bob > > > ------------------------------------------------------------------------------ > All the data continuously generated in your IT infrastructure contains a > definitive record of customers, application performance, security > threats, fraudulent activity and more. Splunk takes this data and makes > sense of it. Business sense. IT sense. Common sense. > http://p.sf.net/sfu/splunk-d2d-oct > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. |
From: Alan G I. <ai...@am...> - 2011-10-15 15:01:58
|
On 10/14/2011 11:33 PM, Bob Plantz wrote: > Am I crazy trying to convert my LaTeX source into RST? I've > done a couple of chapters, and it looks good. I love reST. But reST does not have the full capabilities of LaTeX. If you have a *completed* book that you just want to change to reST, and you do not mind typing your own references and numbering your own equations and figures, this should work pretty well. I have written articles and book chapters in reST, and I encounter the following problems regularly: - lack of serious citation support - lack of automatic numbering of figures and tables (which will mean no generation of a list of tables or list of figures - the quote environment is misused to indent literal blocks. (But this mostly matters for LaTeX output, where it means you can independently style quotes and code blocks.) - math support has greatly (!!!!) improved and is very good for LaTeX output, but MathML output is mediocre. (To be clear, this is an assessment, *not* a complaint; I am very grateful for the new math support.) Partially offsetting: - you can partly address the lack of citation support via bibstuff - EPub won't support MathML until version 3 anyway http://idpf.org/epub/30/spec/epub30-contentdocs.html#sec-xhtml-mathml so maybe it is not yet a good format for presenting math - post-processing an reST document can often be fairly simple But if I had a book in LaTeX, I'd first consider: 1. Is PDF really inadequate for current ereaders? 2. is pandoc's LaTeX -> epub possibly adequate? Well, that's one *user's* view, Alan Isaac PS Having never learned assembly language, I'd be curious to see your book. |
From: Paul T. <pau...@gm...> - 2011-10-16 22:54:34
|
On 10/15/11 11:01 AM, Alan G Isaac wrote: > - math support has greatly (!!!!) improved and is very good > for LaTeX output, but MathML output is mediocre. (To be > clear, this is an assessment, *not* a complaint; I am very > grateful for the new math support.) > > Huh? I didn't think there was nay MathML support. How does one get MathML into a document? Thanks Paul |
From: Alan G I. <ai...@am...> - 2011-10-17 00:29:50
|
On 10/16/2011 6:54 PM, Paul Tremblay wrote: > How does one get > MathML into a document? http://docutils.sourceforge.net/docs/user/config.html#math-output Alan Isaac |
From: Paul T. <pau...@gm...> - 2011-10-17 03:28:37
|
On 10/16/11 8:29 PM, Alan G Isaac wrote: > On 10/16/2011 6:54 PM, Paul Tremblay wrote: >> How does one get >> MathML into a document? > http://docutils.sourceforge.net/docs/user/config.html#math-output > > Alan Isaac > > > Thanks Alan. But it appears that MathML can only be put into an HTML document, not an XML document. MathML is pretty essential for XML. Can it be put in the XML writer? Paul |
From: Guenter M. <mi...@us...> - 2011-10-17 10:04:05
|
On 2011-10-17, Paul Tremblay wrote: > On 10/16/11 8:29 PM, Alan G Isaac wrote: >> On 10/16/2011 6:54 PM, Paul Tremblay wrote: >>> How does one get >>> MathML into a document? >> http://docutils.sourceforge.net/docs/user/config.html#math-output >> Alan Isaac > Thanks Alan. But it appears that MathML can only be put into an HTML > document, not an XML document. MathML is pretty essential for XML. Can > it be put in the XML writer? Patches welcome. Günter |
From: Paul T. <pau...@gm...> - 2011-10-17 14:16:27
|
On 10/17/11 6:03 AM, Guenter Milde wrote: > On 2011-10-17, Paul Tremblay wrote: >> On 10/16/11 8:29 PM, Alan G Isaac wrote: >>> On 10/16/2011 6:54 PM, Paul Tremblay wrote: >>>> How does one get >>>> MathML into a document? >>> http://docutils.sourceforge.net/docs/user/config.html#math-output >>> Alan Isaac > > >> Thanks Alan. But it appears that MathML can only be put into an HTML >> document, not an XML document. MathML is pretty essential for XML. Can >> it be put in the XML writer? > Patches welcome. > > Günter > > > Any hints here would be welcome. The code in writers/html4css1/__init__.py is much different for the code for the XML writer. I can't figure out what code handles the writing of each element. Paul |
From: Erik H. <eg...@e6...> - 2011-10-18 02:11:24
|
At Sat, 15 Oct 2011 11:01:37 -0400, Alan G Isaac wrote: > > […] > > I have written articles and book chapters in reST, and > I encounter the following problems regularly: > > - lack of serious citation support > > […] If you use Zotero_ or are willing to try it out, you might have a look at zot4rst_, which provides serious citation support for reST via Zotero_. best, Erik .. _zot4rst: https://bitbucket.org/egh/zotero-plain/ .. _Zotero: http://www.zotero.org/ |
From: Alan G I. <ai...@am...> - 2011-10-18 23:59:10
|
On 10/17/2011 10:11 PM, Erik Hetzner wrote: > If you use Zotero_ or are willing to try it out, you might have a look > at zot4rst_, which provides serious citation support for reST via > Zotero_. > > best, Erik > > .. _zot4rst:https://bitbucket.org/egh/zotero-plain/ > .. _Zotero:http://www.zotero.org/ It looks like one writes a document using the xcite role and some special @key syntax instead of using reST's citation references. So this is essentially a *replacement* for the reST citation facility. Do I have that right? And if I understand, the citation references produced are not style controlled (for the most part). What if reST were to add the support for incident-specific data that I suggested. Would that be enough to allow the Zotero scripts to use the built in citation handling while styling the citation references? (E.g., for a given style, [doe-1969-jie{page=25}]_ might produce as formatted output Doe (1969, p.25).) But introducing the xcite role (despite the name ;-)) and supporting writers is an interesting approach. Thanks, Alan |
From: Erik H. <eg...@e6...> - 2011-10-19 05:47:15
|
Hi Alan, At Tue, 18 Oct 2011 19:58:52 -0400, Alan G Isaac wrote: > > It looks like one writes a document using the xcite role and some > special @key syntax instead of using reST's citation references. So > this is essentially a *replacement* for the reST citation facility. > Do I have that right? And if I understand, the citation references > produced are not style controlled (for the most part). Yes, zot4rst uses a completely different citation system. This is because the reST citation system cannot handle all the requirements of author & author-date citation systems. For instance, author-date citations may have spaces. Another tricky bit is that some citation formats use footnotes. Using the xcite syntax allows a user to use the same syntax for a footnote citation format and an author-date, author, or numeric based citation system, with the rst tools generating the appropriate footnotes or in-text citations and bibliography when you run them. zot4rst uses the pandoc syntax [1]_; basically, prefix @key locator suffix where locator is a string and then numerals, e.g. “p. 10, 11, 23-45”. See [2]_ for more examples. I’m not sure what you mean by “style controlled”. You can use any Zotero style [3]_ to generate your citations. > What if reST were to add the support for incident-specific > data that I suggested. Would that be enough to allow > the Zotero scripts to use the built in citation handling > while styling the citation references? (E.g., for a given > style, [doe-1969-jie{page=25}]_ might produce as formatted > output Doe (1969, p.25).) I don’t really think that the existing reST citation system could be used with zot4rst, for the reasons stated above. > But introducing the xcite role (despite the name ;-)) and > supporting writers is an interesting approach. It’s a bit tricky to use right now, becuase of some limitations of Zotero that I hope can be resolved, but I encourage you to have a look if you are interested in citations with reST. agreed, xcite is an ugly name :), but I hope that the role can be reused by systems that are not tied to Zotero, in the way that pandoc handles citations, for instance (reading from a BibTeX or similar file). xcite seemed generic, so I went with it. Suggestions welcome. :) best, Erik .. [1] http://johnmacfarlane.net/pandoc/README.html#citations .. [2] https://bitbucket.org/egh/zotero-plain/src/tip/example/example.rst .. [3] http://www.zotero.org/styles |
From: Guenter M. <mi...@us...> - 2011-10-19 21:47:24
|
On 2011-10-17, Paul Tremblay wrote: > On 10/17/11 6:03 AM, Guenter Milde wrote: >> On 2011-10-17, Paul Tremblay wrote: >>> On 10/16/11 8:29 PM, Alan G Isaac wrote: >>>> On 10/16/2011 6:54 PM, Paul Tremblay wrote: >>>>> How does one get >>>>> MathML into a document? >>>> http://docutils.sourceforge.net/docs/user/config.html#math-output >>>> Alan Isaac >>> Thanks Alan. But it appears that MathML can only be put into an HTML >>> document, not an XML document. MathML is pretty essential for XML. Can >>> it be put in the XML writer? >> Patches welcome. >> Günter > Any hints here would be welcome. The code in > writers/html4css1/__init__.py is much different for the code for the XML > writer. I can't figure out what code handles the writing of each element. I see. As there is no set of "visit_*/depart_*" functions the XML writer, the conversion from LaTeX-math to MathML would have to be done in a "transform" (i.e. a doctree -> doctree mapping similar to section numbering etc.). Günter |
From: Paul T. <pau...@gm...> - 2011-10-20 00:38:12
|
On 10/19/11 5:46 PM, Guenter Milde wrote: > On 2011-10-17, Paul Tremblay wrote: >> On 10/17/11 6:03 AM, Guenter Milde wrote: >>> On 2011-10-17, Paul Tremblay wrote: >>>> On 10/16/11 8:29 PM, Alan G Isaac wrote: >>>>> On 10/16/2011 6:54 PM, Paul Tremblay wrote: >>>>>> How does one get >>>>>> MathML into a document? >>>>> http://docutils.sourceforge.net/docs/user/config.html#math-output >>>>> Alan Isaac > >>>> Thanks Alan. But it appears that MathML can only be put into an HTML >>>> document, not an XML document. MathML is pretty essential for XML. Can >>>> it be put in the XML writer? >>> Patches welcome. >>> Günter > > >> Any hints here would be welcome. The code in >> writers/html4css1/__init__.py is much different for the code for the XML >> writer. I can't figure out what code handles the writing of each element. > I see. As there is no set of "visit_*/depart_*" functions the XML writer, > the conversion from LaTeX-math to MathML would have to be done in a > "transform" (i.e. a doctree -> doctree mapping similar to section numbering > etc.). > > I had actually worked out an unacceptable hack in the docutils/writers/docutils.xml: # Get the node, translate to a string, read it into etree, transform, output # MAJOR HACK! def translate(self): .... import xml.etree.cElementTree as etree xml_string = (''.join(output_prefix) + docnode.toprettyxml(indent, newline)) new_tree = etree.XML(xml_string) for element in new_tree.iter('math_block'): mathml_tree = docutils.math.latex2mathml.parse_latex_math(element.text) math_code = ''.join(mathml_tree.xml()) mathml_tree = etree.XML(math_code) element.append(mathml_tree) self.output = (''.join(output_prefix) + etree.tostring(new_tree)) Obviously far from ideal. However, I didn't think I wanted to change anything in the transform stage, because that changes the whole tree and would not be suitable for other transformations? For example, changing code in docutils/parsers/rst/directives changes the code when it comes time to transform the document to LaTeX, no? Paul |
From: Guenter M. <g....@qu...> - 2011-10-20 10:14:31
|
On 19.10.11, Paul Tremblay wrote: > On 10/19/11 5:46 PM, Guenter Milde wrote: > >>>> MathML is pretty essential for XML. Can it be put in the XML > >>>> writer? > >>Any hints here would be welcome. The code in > >>writers/html4css1/__init__.py is much different for the code for the XML > >>writer. I can't figure out what code handles the writing of each element. > >I see. As there is no set of "visit_*/depart_*" functions the XML writer, > >the conversion from LaTeX-math to MathML would have to be done in a > >"transform" (i.e. a doctree -> doctree mapping similar to section numbering > >etc.). > I had actually worked out an unacceptable hack in the > docutils/writers/docutils.xml: ... > However, I didn't think I wanted to change anything in the transform > stage, because that changes the whole tree and would not be suitable > for other transformations? The writer can configure which transformations are performed. See for example the html writer which adds docutils.transforms.writer_aux.Admonitions to the standard writer transforms by overloading the get_transforms() method:: def get_transforms(self): return writers.Writer.get_transforms(self) + [writer_aux.Admonitions] For an introduction in the concept of transforms, see docs/ref/transforms.html In short: * The parsing step is performed first (in one pass over the rst source) and generates a doctree. * The transforms traverse the doctree and modify selected nodes (sometimes also insert new ones) in several passes. This allows for cross-linking, generating a toc, etc. * The writer does again a one-pass traversal over the doctree generating the output document. The idea would be to define a new transform (transforms.math.latex2mathml, in a file docutils/docutils/transforms/math.py say) that would replace the content of math and math-block nodes. The code would be a mixture of examples from other transforms and the visit_math() method in the html writer. (to avoid duplicating code, once it is in place and tested, the html writer should be modified to use it as well) > For example, changing code in > docutils/parsers/rst/directives changes the code when it comes time > to transform the document to LaTeX, no? A new transform will not change the LaTeX (etc) output unless it is also added to the "transforms list" in the latex2e writer. (OTOH, changing code in the parser affects all writers.) Günter |
From: Paul T. <pau...@gm...> - 2011-10-20 16:18:59
|
On 10/20/11 6:14 AM, Guenter Milde wrote: > On 19.10.11, Paul Tremblay wrote: >> On 10/19/11 5:46 PM, Guenter Milde wrote: >>>>>> MathML is pretty essential for XML. Can it be put in the XML >>>>>> writer? >>>> Any hints here would be welcome. The code in >>>> writers/html4css1/__init__.py is much different for the code for the XML >>>> writer. I can't figure out what code handles the writing of each element. >>> I see. As there is no set of "visit_*/depart_*" functions the XML writer, >>> the conversion from LaTeX-math to MathML would have to be done in a >>> "transform" (i.e. a doctree -> doctree mapping similar to section numbering >>> etc.). >> I had actually worked out an unacceptable hack in the >> docutils/writers/docutils.xml: > ... > >> However, I didn't think I wanted to change anything in the transform >> stage, because that changes the whole tree and would not be suitable >> for other transformations? > The writer can configure which transformations are performed. See for > example the html writer which adds > docutils.transforms.writer_aux.Admonitions to the standard writer > transforms by overloading the get_transforms() method:: > > def get_transforms(self): > return writers.Writer.get_transforms(self) + [writer_aux.Admonitions] > > For an introduction in the concept of transforms, see > docs/ref/transforms.html In short: > > * The parsing step is performed first (in one pass over the rst source) > and generates a doctree. > > * The transforms traverse the doctree and modify selected nodes > (sometimes also insert new ones) in several passes. This allows for > cross-linking, generating a toc, etc. > > * The writer does again a one-pass traversal over the doctree generating > the output document. > > > The idea would be to define a new transform > (transforms.math.latex2mathml, in a file > docutils/docutils/transforms/math.py say) that would > replace the content of math and math-block nodes. > > The code would be a mixture of examples from other transforms and the > visit_math() method in the html writer. (to avoid duplicating code, once it > is in place and tested, the html writer should be modified to use it as well) > >> For example, changing code in >> docutils/parsers/rst/directives changes the code when it comes time >> to transform the document to LaTeX, no? > A new transform will not change the LaTeX (etc) output unless it is also > added to the "transforms list" in the latex2e writer. (OTOH, changing > code in the parser affects all writers.) > > Following your directions, I created math.py in the docutils/transform directory. To the __init__ .py in writers, I added: from docutils.transforms import math ^^^^^^ added ... .. def get_transforms(self): return Component.get_transforms(self) + [ universal.Messages, universal.FilterMessages, universal.StripClassesAndElements, math.Math_Block, ^^^^ added ] math.py looks like this; """ math used by writers from docutils import writers from docutils.transforms import writers """ __docformat__ = 'reStructuredText' from docutils import nodes, utils, languages from docutils.transforms import Transform from docutils.math.latex2mathml import parse_latex_math class Math_Block(Transform): """ Change the text in the math_block from plain text in LaTeX to a MathML tree """ default_priority = 910 # not sure if this needs to be loaded earlier or not def apply(self): for math_block in self.document.traverse(nodes.math_block): math_code = math_block.astext() mathml_tree = parse_latex_math(math_code, inline=False) # need to append the mathml_tree to math_block I have a few questions. (1) How do you get just the text from a node.Element? In my code, the math_block.astext actually returns a text representation of the node, including the elements tags, etc. I looked everywhere in docutils/nodes.py for a method to get just text, but could not find one. Somehow, feeding the string with the tags to parse_latex_math worked anyway (following the example in the html writer). (2) How do I append the resulting tee to the math_block? I tried math_block.append() and other methods, but it seems the latext2mathml.py returns a different type of tree then that already created. I could convert the mathml tree to an XML string and then create a tree from that, and then append the tree? I'm just not sure how to do this. (3) How do I make this transformation optional, depending on an options by the user. The user might have put asciimath in the math_block element, in which case it should not be transformed by the latex2mathml.py modulel. Thanks Paul |
From: Bob P. <rgp...@gm...> - 2011-10-22 18:40:41
|
Please excuse my ignorance here. I am new to both python and docutils. Both python 3.2 and 2.7 are installed on my Ubuntu 11.10 system. Since I am new to python, I decided to start my python learning on 3.2. I installed docutils with python3.2 setup.py install I changed my default /usr/bin/python to point to python3.2, but that broke all the Ubuntu things that use python. So I had to change the link back to python2.7. But when I simply run something like rst2html.py it calls python2.7, and since I installed docutils for 3.2 it does not work. Of course, I can explicitly specify all the paths, for example, bob-desktop:~/my_book_rst$ python3 ../docutils_things/docutils/tools/rst2html.py IntroCompArch.rst IntroCompArch.html and it works fine, but this is something I would rather not do. Of course, I could use a Makefile. Is there a good way to fix this problem? For example, should I change the line: #!/usr/bin/python in all my /usr/local/bin/res*.py files to be: #!/usr/bin/python3.2 Would life be easier if I reinstall docutils to use python 2.7? If a 2.7 installation is the preferred method, how do I uninstall docutils for python 3.2? Do I remove everything in this directory: bob-desktop:/usr/local/lib/python3.2/dist-packages$ ls docutils docutils-0.9.egg-info __pycache__ roman.py roman.pyc test tools Overall, I'm trying to get a sense of whether I'm jumping the gun by using python3 with docutils. I'm the sort of person who likes being out in the front and am willing to deal with some of the issues this brings, but I also want to get a little work done. --Bob |
From: engelbert g. <eng...@gm...> - 2011-10-22 19:23:03
|
hi, you said it all, at least enough. the choice is up to you. if you really start using docutils, i assume you will always end up with sort of build system so python version will not concern you cheers engelbert On Sat, Oct 22, 2011 at 8:40 PM, Bob Plantz <rgp...@gm...> wrote: > Please excuse my ignorance here. I am new to both python and docutils. > > Both python 3.2 and 2.7 are installed on my Ubuntu 11.10 system. Since I > am new to python, I decided to start my python learning on 3.2. I > installed docutils with > > python3.2 setup.py install > > I changed my default /usr/bin/python to point to python3.2, but that > broke all the Ubuntu things that use python. So I had to change the link > back to python2.7. > > But when I simply run something like rst2html.py it calls python2.7, and > since I installed docutils for 3.2 it does not work. > > Of course, I can explicitly specify all the paths, for example, > > bob-desktop:~/my_book_rst$ python3 > ../docutils_things/docutils/tools/rst2html.py IntroCompArch.rst > IntroCompArch.html > > and it works fine, but this is something I would rather not do. Of > course, I could use a Makefile. > > Is there a good way to fix this problem? For example, should I change > the line: > > #!/usr/bin/python > > in all my /usr/local/bin/res*.py files to be: > > #!/usr/bin/python3.2 > > > Would life be easier if I reinstall docutils to use python 2.7? > > If a 2.7 installation is the preferred method, how do I uninstall > docutils for python 3.2? Do I remove everything in this directory: > > bob-desktop:/usr/local/lib/python3.2/dist-packages$ ls > docutils docutils-0.9.egg-info __pycache__ roman.py roman.pyc > test tools > > Overall, I'm trying to get a sense of whether I'm jumping the gun by > using python3 with docutils. I'm the sort of person who likes being out > in the front and am willing to deal with some of the issues this brings, > but I also want to get a little work done. > > --Bob > > > ------------------------------------------------------------------------------ > The demand for IT networking professionals continues to grow, and the > demand for specialized networking skills is growing even more rapidly. > Take a complimentary Learning@Cisco Self-Assessment and learn > about Cisco certifications, training, and career opportunities. > http://p.sf.net/sfu/cisco-dev2dev > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > -- http://darefoot.blogspot.com |
From: Bob P. <rgp...@gm...> - 2011-10-22 20:13:41
|
Thank you, Engelbert, for your input. I would like to use Python3, so I created a Makefile, which seems like the least intrusive way to do this. I was mostly looking for confirmation that I was not doing something stupid by using Python3. A little "hand holding." --Bob On 10/22/2011 12:22 PM, engelbert gruber wrote: > hi, > > you said it all, at least enough. the choice is up to you. > > if you really start using docutils, i assume you will always end up > with sort of build system so python version will not concern you > > cheers > engelbert > > On Sat, Oct 22, 2011 at 8:40 PM, Bob Plantz<rgp...@gm...> wrote: >> Please excuse my ignorance here. I am new to both python and docutils. >> >> Both python 3.2 and 2.7 are installed on my Ubuntu 11.10 system. Since I >> am new to python, I decided to start my python learning on 3.2. I >> installed docutils with >> >> python3.2 setup.py install >> >> I changed my default /usr/bin/python to point to python3.2, but that >> broke all the Ubuntu things that use python. So I had to change the link >> back to python2.7. >> >> But when I simply run something like rst2html.py it calls python2.7, and >> since I installed docutils for 3.2 it does not work. >> >> Of course, I can explicitly specify all the paths, for example, >> >> bob-desktop:~/my_book_rst$ python3 >> ../docutils_things/docutils/tools/rst2html.py IntroCompArch.rst >> IntroCompArch.html >> >> and it works fine, but this is something I would rather not do. Of >> course, I could use a Makefile. >> >> Is there a good way to fix this problem? For example, should I change >> the line: >> >> #!/usr/bin/python >> >> in all my /usr/local/bin/res*.py files to be: >> >> #!/usr/bin/python3.2 >> >> >> Would life be easier if I reinstall docutils to use python 2.7? >> >> If a 2.7 installation is the preferred method, how do I uninstall >> docutils for python 3.2? Do I remove everything in this directory: >> >> bob-desktop:/usr/local/lib/python3.2/dist-packages$ ls >> docutils docutils-0.9.egg-info __pycache__ roman.py roman.pyc >> test tools >> >> Overall, I'm trying to get a sense of whether I'm jumping the gun by >> using python3 with docutils. I'm the sort of person who likes being out >> in the front and am willing to deal with some of the issues this brings, >> but I also want to get a little work done. >> >> --Bob >> >> >> ------------------------------------------------------------------------------ >> The demand for IT networking professionals continues to grow, and the >> demand for specialized networking skills is growing even more rapidly. >> Take a complimentary Learning@Cisco Self-Assessment and learn >> about Cisco certifications, training, and career opportunities. >> http://p.sf.net/sfu/cisco-dev2dev >> _______________________________________________ >> Docutils-users mailing list >> Doc...@li... >> https://lists.sourceforge.net/lists/listinfo/docutils-users >> >> Please use "Reply All" to reply to the list. >> > > |
From: Guenter M. <mi...@us...> - 2011-10-24 09:18:07
|
On 2011-10-22, Bob Plantz wrote: > Both python 3.2 and 2.7 are installed on my Ubuntu 11.10 system. Since I > am new to python, I decided to start my python learning on 3.2. > I installed docutils with > python3.2 setup.py install > I changed my default /usr/bin/python to point to python3.2, but that > broke all the Ubuntu things that use python. So I had to change the link > back to python2.7. However, python3 should be a "moving link" to the "default Python 3 version" which should also work fine with Docutils built for Pyhton 3. > But when I simply run something like rst2html.py it calls python2.7, and > since I installed docutils for 3.2 it does not work. You could try with a parallel install: do also python setup.py install without removing the Py3k files in /usr/local/lib/python3.2/ ... > Is there a good way to fix this problem? For example, should I change > the line: > #!/usr/bin/python > in all my /usr/local/bin/res*.py files to be: > #!/usr/bin/python3.2 I recommend two sets of front-end scripts: /usr/local/bin/rst2html with #!/usr/bin/python and /usr/local/bin/rst2html3 with #!/usr/bin/python3 or similar for all the rst2* scripts in the binary PATH. > Would life be easier if I reinstall docutils to use python 2.7? This depends. If you want to learn Python starting with Python 3, no. However, Docutils development is done in Python 2, we ensure backwards compatibility down to 2.3. This means that * Docutils is less tested on Python 3 and we still discover problems and incompatibilities (especially the neverending encoding problems). * Due to backwards compatibility issues, we cannot do things "the Py3k way". * Contributing patches requires the change to be done in the 2.x modules. > If a 2.7 installation is the preferred method, how do I uninstall > docutils for python 3.2? This is not required, as there are the parallel libs: > /usr/local/lib/python3.2/ and /usr/local/lib/python2.x/ Günter |
From: Doug H. <dou...@gm...> - 2011-10-15 18:36:47
|
On Oct 14, 2011, at 11:33 PM, Bob Plantz wrote: > I have written a 500+ page textbook on assembly language. It has lots of > code listings, figures (vector graphics), and math. The source is > currently LaTeX. The book is currently used at the university where I > used to teach and the local community college. I make it available in > both in pdf and print versions. For the past couple of years, students > get only the pdf version. They tell me that they much prefer eReaders to > print books. > > I want to produce an ePub version. (Ironically, I started the book in > 1999 using html.) I realize that much of the LaTeX formatting will have > to go away, but I think the ePub format will make up for that loss. > > My first thought was to use html. Then I got into a DocBook mood. Then I > discovered restructuredtext! Neat! > > My question: Am I crazy trying to convert my LaTeX source into RST? I've > done a couple of chapters, and it looks good. > > I realize that this will be LOTS of work. But I'm retired, so it would > be sort of a hobby for me. And who knows, I may be able to contribute > something back to the docutils community that would improve the > production of technical eBooks. > > Any thoughts on this are very welcome. Examples of books written with > RST would be especially helpful. I prepared "The Python Standard Library By Example" [1] using reStructuredText converted to LaTeX by Sphinx. I don't have a lot of figures or tables, but there are definitely a lot of code listings. I ended up doing a little bit of work to customize the builder that generated the LaTeX so the results would fit the style guide required by my publisher, but you may not have to do as much if you are self-publishing. Doug [1] http://www.doughellmann.com/books/byexample/ |
From: Guenter M. <mi...@us...> - 2011-10-15 20:22:02
|
On 2011-10-15, Bob Plantz wrote: > I have written a 500+ page textbook on assembly language. It has lots of > code listings, figures (vector graphics), and math. The source is > currently LaTeX. The book is currently used at the university where I > used to teach and the local community college. I make it available in > both in pdf and print versions. For the past couple of years, students > get only the pdf version. They tell me that they much prefer eReaders to > print books. > I want to produce an ePub version. (Ironically, I started the book in > 1999 using html.) I realize that much of the LaTeX formatting will have > to go away, but I think the ePub format will make up for that loss. > My first thought was to use html. Then I got into a DocBook mood. Then I > discovered restructuredtext! Neat! > My question: Am I crazy trying to convert my LaTeX source into RST? I've > done a couple of chapters, and it looks good. > I realize that this will be LOTS of work. But I'm retired, so it would > be sort of a hobby for me. And who knows, I may be able to contribute > something back to the docutils community that would improve the > production of technical eBooks. > Any thoughts on this are very welcome. Examples of books written with > RST would be especially helpful. For such a large project, I would use LyX, a LaTeX front end (with its own file format and "WYSIWYM" GUI) that recently developed native HTML export (besides the also magnificent eLyXer lyx->html converter). It is far more powerful than the current docutils, especially for academic writing. Also, you can import fairly complex LaTeX documents and work with parent/child documents. Have a look at www.lyx.org. There are also examples of books etc written using LyX on wiki.lyx.org. Günter |
From: Bob P. <rgp...@gm...> - 2011-10-16 04:00:42
|
On 10/15/2011 01:21 PM, Guenter Milde wrote: > On 2011-10-15, Bob Plantz wrote: > >> I want to produce an ePub version. (Ironically, I started the book in >> 1999 using html.) I realize that much of the LaTeX formatting will have >> to go away, but I think the ePub format will make up for that loss. > > For such a large project, I would use LyX, a LaTeX front end (with its > own file format and "WYSIWYM" GUI) that recently developed native HTML > export (besides the also magnificent eLyXer lyx->html converter). It is > far more powerful than the current docutils, especially for academic > writing. > > Also, you can import fairly complex LaTeX documents and work with > parent/child documents. > > Have a look at www.lyx.org. > There are also examples of books etc written using LyX on wiki.lyx.org. > > Günter > > First, I very much appreciate the excellent comments from everyone here. Very helpful to me! The GUI aspect of LyX is nice, but I'm very comfortable using LaTeX, which produces excellent print copy. But trying to convert my LaTeX source directly to epub (html) does not work. The question I need to decide is whether the additional power of LyX carries through to epub. At this point I see four choices for myself: 1. Cut out the LaTeX that prevents the conversion to html. 2. Convert my LaTeX source to RST. 3. Convert my LaTeX source to LyX. 4. Convert my LaTeX source to DocBook. I recognize that I will lose some formatting with all of these choices. That is inherent in going from paper to ereader. (The ereader also adds features, like linking, searching, etc.) I installed LyX and eLyXe, and produced html versions of the eLyXer User Guide from each. eLyXer clearly produces nicer html. LyX does a so-so job of importing my LaTeX sources. Still lots of work to do by hand. I am leaning toward either 2 or 3. I suspect, as Guenter suggests, that choice 3 will give me a better final result. I also suspect that choice 4 adds more work without adding to the final result. --Bob |
From: Paul T. <pau...@gm...> - 2011-10-16 23:13:32
|
On 10/16/11 12:00 AM, Bob Plantz wrote: > First, I very much appreciate the excellent comments from everyone here. > Very helpful to me! > > The GUI aspect of LyX is nice, but I'm very comfortable using LaTeX, > which produces excellent print copy. But trying to convert my LaTeX > source directly to epub (html) does not work. The question I need to > decide is whether the additional power of LyX carries through to epub. > > At this point I see four choices for myself: > > 1. Cut out the LaTeX that prevents the conversion to html. > 2. Convert my LaTeX source to RST. > 3. Convert my LaTeX source to LyX. > 4. Convert my LaTeX source to DocBook. > > I recognize that I will lose some formatting with all of these choices. > That is inherent in going from paper to ereader. (The ereader also adds > features, like linking, searching, etc.) > > I installed LyX and eLyXe, and produced html versions of the eLyXer User > Guide from each. eLyXer clearly produces nicer html. > > LyX does a so-so job of importing my LaTeX sources. Still lots of work > to do by hand. > > I am leaning toward either 2 or 3. I suspect, as Guenter suggests, that > choice 3 will give me a better final result. I also suspect that choice > 4 adds more work without adding to the final result. > > I would think choice 4, Docbook, would produce quite a nice result, since HTML is a subset of XML, and there should be good stylesheets already written to convert to HTML. If I were doing this project, I would convert to RST, then to some type of XML (like Docbook), and then to HTML. But then again, I am very comfortable with XML and writing XSLT stylesheets. |
From: m h <ses...@gm...> - 2011-10-24 03:48:58
|
Bob- I'm currently publishing an ebook written in rst. I'll give you my advice, feel free to ignore it. (Full disclosure I've written rst2odp - converts rst to openoffice slideware, so I'm not completely unbiased). On Fri, Oct 14, 2011 at 9:33 PM, Bob Plantz <rgp...@gm...> wrote: > I have written a 500+ page textbook on assembly language. It has lots of > code listings, figures (vector graphics), and math. The source is > currently LaTeX. The book is currently used at the university where I > used to teach and the local community college. I make it available in > both in pdf and print versions. For the past couple of years, students > get only the pdf version. They tell me that they much prefer eReaders to > print books. > > I want to produce an ePub version. (Ironically, I started the book in > 1999 using html.) I realize that much of the LaTeX formatting will have > to go away, but I think the ePub format will make up for that loss. Why epub? Are you aiming for ipad? If you are aiming for Kindle you want mobi. Admittedly both are just subsets of html, but depending on what you want as your final destination it might impact what toolchain you use. > > My first thought was to use html. Then I got into a DocBook mood. Then I > discovered restructuredtext! Neat! > Many geeky authors are using docbook plus xsl stylesheets to convert to epub and mobi. If you are comfortable with xml and your editor of choice supports it well, go for it. It is probably going to be better supported than any rst related tool. > My question: Am I crazy trying to convert my LaTeX source into RST? I've > done a couple of chapters, and it looks good. I don't think so. Pre-render your images and math and you should be good to go, unless you have fancy formatting (in which case you probably want something other than an ebook). > > I realize that this will be LOTS of work. But I'm retired, so it would > be sort of a hobby for me. And who knows, I may be able to contribute > something back to the docutils community that would improve the > production of technical eBooks. Depends on if you like lots of markup (ala docbook and latex) or relatively none (rst). rst has some drawbacks in that it lacks some of the power of the other markups, but ebooks are relatively simplistic, and so rst should suffice. That's what I'm finding. > > Any thoughts on this are very welcome. Examples of books written with > RST would be especially helpful. I've actually written rst2epub2 [0]. It pretty much works for me, but still has some issues I'm working out. My book works in ipad, iphone ereaders, and android ereaders. I use calibre to generate mobi files and they work wonderfully on Kindle hardware. If you are interested in seeing my book (but don't want to purchase it), let me know and I'll send you a copy. Yeah I should probably monitor this list more, write a blog post about rst2epub2, etc, but I'm too busy writing.... cheers, -matt 0 - https://github.com/mattharrison/rst2epub2 1 -http://hairysun.com/books/tread/ > > --Bob > > > ------------------------------------------------------------------------------ > All the data continuously generated in your IT infrastructure contains a > definitive record of customers, application performance, security > threats, fraudulent activity and more. Splunk takes this data and makes > sense of it. Business sense. IT sense. Common sense. > http://p.sf.net/sfu/splunk-d2d-oct > _______________________________________________ > Docutils-users mailing list > Doc...@li... > https://lists.sourceforge.net/lists/listinfo/docutils-users > > Please use "Reply All" to reply to the list. > |
From: Guenter M. <mi...@us...> - 2011-10-26 16:19:57
|
On 2011-10-24, m h wrote: ... > On Fri, Oct 14, 2011 at 9:33 PM, Bob Plantz <rgp...@gm...> wrote: >> I have written a 500+ page textbook on assembly language. It has lots of >> code listings, figures (vector graphics), and math. The source is >> currently LaTeX. The book is currently used at the university where I >> used to teach and the local community college. I make it available in >> both in pdf and print versions. For the past couple of years, students >> get only the pdf version. They tell me that they much prefer eReaders to >> print books. >> I want to produce an ePub version. (Ironically, I started the book in >> 1999 using html.) I realize that much of the LaTeX formatting will have >> to go away, but I think the ePub format will make up for that loss. > Why epub? Are you aiming for ipad? If you are aiming for Kindle you > want mobi. However, epub is an open standard, you can use it with a free reader (e.g. fbreader) as well as with a firefox extension or many other supporting hardware while mobi can only be read on one very specific piece of hardware. ... > I don't think so. Pre-render your images and math and you should be > good to go, unless you have fancy formatting (in which case you > probably want something other than an ebook). Especially for a book with lots of math, I would abstain from the widely used custom to render formulae as bitmap graphics. The main point of an ebook - scalable content is lost. The problem is that math support is hard in HTML and even harder for e-books. MathML might be the preferable choice but is not supported by all epub readers. ... > I've actually written rst2epub2 [0]. It pretty much works for me, but > still has some issues I'm working out. Epub support is on the agenda for Docutils. Do you think we could work together to make this a standard feature? > 0 - https://github.com/mattharrison/rst2epub2 Günter |