gmane.text.docutils.user

Re: capturing errors/warning

Michael Prisant — 2013-05-22T13:48:43

Sorry this link should have been in the previous email:

http://stackoverflow.com/questions/2077897/substitute-multiple-whitespace-with-single-whitespace-in-python

And especially note this repsonse:

A simple possibility (if you'd rather avoid REs) is

' '.join(mystring.split())

The split and join perform the task you're explicitly asking about -- plus,
they also do the extra one that you don't talk about but is seen in your
example, removing trailing spaces;-).
  share <http://stackoverflow.com/a/2077944>|improve this
answer<http://stackoverflow.com/posts/2077944/edit>
  answered Jan 16 '10 at 15:54
 <http://stackoverflow.com/users/95810/alex-martelli>
 Alex Martelli <http://stackoverflow.com/users/95810/alex-martelli>
261k27458810

    1
Oh cool, I was fumbling with a similar solution, but using split(' ') and
then a filter to remove empty elements. I never knew split with no
arguments worked like this. This is also much faster, timeit.py gives me
around 0.74usec for this, versus 5.75usec for regular exp

Re: capturing errors/warning

Michael Prisant — 2013-05-22T13:41:11

Perhaps just identify and rectify the indentation/tabbing errors in the
preprocessing by using python string split to first split the reST string
source into lines  and then using python string replace to correct
mistabbing.

Don't know of a publish method option for this but would be great if one
existed.  Sort of need a reST source string "lint"

MIchael

PS Ditto to being occasionally vexed by the seeming need for precise and
consistent indentation in reST source for error free publishing .  Emacs
handles this for me but like you will have to implement
checking/rectification for documents prepared for others


On Wed, May 22, 2013 at 9:17 AM, Peter L. Soendergaard
<peter< at >sonderport.dk>wrote:

capturing errors/warning

Peter L. Soendergaard — 2013-05-22T13:17:20

Hi,

I am running docutils.core.publish_string inside some python scripts and 
I need to process a lot of REST files from other people, and they often 
contains errors. I need to do some preprocessing to the files before 
passing them onto docutils, so that is why I call publish_string from 
inside of Python instead of the command line tools.

Currently, I just see errors and warnings on the command line like:

<string>:73: (ERROR/3) Unexpected indentation.
<string>:74: (WARNING/2) Block quote ends without a blank line; 
unexpected unindent.

Are there some parameters that I can pass onto publish_string so that I 
can capture the error output instead of it going straight to stderr?

Or some better method than calling publish_string ?

Cheers,
Peter.





------------------------------------------------------------------------------
Try New Relic Now & We'll Send You this Cool Shirt
New Relic is the only SaaS-based application performance monitoring service 
that delivers powerful full stack analytics. Optimi

Re: Fwd: custom directive: publish html andlatex2e differently

Guenter Milde — 2013-05-15T15:39:31


It actually makes sense to split your question into several ones:

a) How to write a custom directive?
b) How to get specific output for html and latex from the same source?




How to write a custom directive
===============================

* Get a clear understanding of the intended input and output.

* Try to "reverse-engineer": write down "explicit" rst input that results in
  the desired output.

  For example, let us assume the rst-source code ::

    .. bibentries:: database

       BCC+87;;

  should produce the same result as::

    .. [fntguide] LaTeX3 Project Team, `LaTeX2ε font selection`, 2005.
       http://mirror.ctan.org/macros/latex/doc/fntguide.pdf
    .. [encguide] Frank Mittelbach, Robin Fairbairns, Werner Lemberg,
       LaTeX3 Project Team, `LaTeX font encodings`, 2006.
       http://mirror.ctan.org/macros/latex/doc/encguide.pdf
    .. [greek-usage] Apostolos Syropoulos, `Writing Greek with the greek option
       of the babel package`, 1997.

* Translating the "rst representation"

Fwd: Problem: rst2latex --use-bibtex works but produces double references.

Michael Prisant — 2013-05-15T15:19:59

Thanks, sorry dumb error on my part. This works!

Thanks for coding this feature.  The latex writer and the rst2latex command
line properly translates citations in the reST source for BibTeX processing
in the latex output.

Cool and very useful! (At least for me)

Michael


On Wed, May 15, 2013 at 10:34 AM, Guenter Milde <milde< at >users.sf.net> wrote:

Re: Problem: rst2latex --use-bibtex works but produces double references.

Guenter Milde — 2013-05-15T14:34:37

...


null? bool(self.bibtex) == False, because self.bibtex == '' # empty string


      ^^^^^^^^^^^^^^^^^


using the key 'use_bibtex' two times, the second time with an empty string.

Günter


------------------------------------------------------------------------------
AlienVault Unified Security Management (USM) platform delivers complete
security visibility with the essential security capabilities. Easily and
efficiently configure, manage, and operate all of your security controls
from a single console and one unified framework. Download a free trial.
http://p.sf.net/sfu/alienvault_d2d
_______________________________________________
Docutils-users mailing list
Docutils-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.

Re: Fwd: custom directive: publish html andlatex2e differently

Michael Prisant — 2013-05-14T20:51:27

Hi,

Thanks for this response. I posted to this thread asking the maintainers to
provide a simple example of defining a custom role and writing different
versions to html and latex. This was essentially requesting a "toy" version
of how a stock directive was coded: Intercept a custom directive in a
python reading of  rst document tree and be able to publish from that
amended tree to html and latex.

This seems clear enough to me and in my view this question has come up
before though in other forms on the list. The rest of my response follows
in text and should be brief enough for even the extremely time challenged :)

On Tue, May 14, 2013 at 12:30 PM, David Goodger <goodger< at >python.org> wrote:

printing various url links etc



No for the html output; yes for stuff which is later latex'd.  Once again I
said this in my previous post.



I don't ask for help with LaTeX/BiBTeX -- just with python
parsing/processing restructured text using your docutils software.[1]


I gave a simple version -- but you called it

Re: Fwd: custom directive: publish html andlatex2e differently

David Goodger — 2013-05-14T16:30:22

On Tue, May 14, 2013 at 1:56 AM, Michael Prisant
<michael.prisant< at >gmail.com> wrote:

In what way, exactly, do they have to differ? And please: *briefly*.
Sorry, I don't have time to read long email messages like this one.

Can your desired output be constructed from primitives that are
already supported in Docutils? If "yes", your job will be much easier.
Try. If "no", you may have to derive custom Writers for your
application (recommended), or go the "raw" directive route you've been
using (not recommended). But maybe the answer is that Docutils isn't
the right tool for the job.

That's about all the advice I can give. I don't know
bibtex/bibliography details, and I have no desire to learn them. I
tried to read your message but found it difficult to follow. I don't
know what you're trying to accomplish. If you try again, use a
different approach. Perhaps "show us, don't tell us" will work better.


ISTM that you may be trying to load too much functionality onto
Docutils/reST. If you have an interactive web

Re: Fwd: custom directive: publish html andlatex2e differently

Michael Prisant — 2013-05-14T06:56:11

Hi David,

Thanks for this reply and for writing docutils. I will try to respond to
your questions (to help you help me),  But bear with a me bit -- I don't
think that I can directly comply with your comments other than to note that
"yes I think that the rendered text and functionality" are different in the
html and latex published versions so it really has to change depending on
the output format.

First in overview. I am trying to write a sort of annotated bibliography
wiki application using reST as the underlying markup language for the wiki
pages.  In my view it provided a richer markup set than markdown and more
natural and pythonic code base for extension. Unwinding my actual code is a
little bit difficult because it is interwined with the python web framework
"BottlePy" that I am using and its native simple template.  But I will try
to provide more explanation to better help you help me.

It seems to me what I want to do is "publish" html and latex from the same
reST input source and by using the doct

Re: Fwd: custom directive: publish html andlatex2e differently

David Goodger — 2013-05-14T04:29:27

On Mon, May 13, 2013 at 8:13 PM, Michael Prisant
<michael.prisant< at >gmail.com> wrote:

You can start by giving us a minimal but *real* example of what you
want as output. I think you're over-complicating the issue by trying
to simplify it in an unnatural way.

Unnatural, because the it's the job of the Writer classes to translate
Docutils document trees (doctrees) into their final formats. Don't try
to do the job of Writers from within your directive, that's the wrong
approach. You should be trying to write correct doctree nodes from
your code.

Apart from the differences in markup/tagging/codes, do you really need
different output from the two writers? IOW, does the content itself
(the rendered text & functionality) have to change depending on the
output format?

Don't worry about the HTML or LaTeX output, except to illustrate what
you want. Show us some real input, and some real desired output.


Are you talking about your message, or the reply? If your message, it
could be that the first time you posted, yo

Fwd: custom directive: publish html and latex2edifferently

Michael Prisant — 2013-05-14T00:13:19

Hi

OK after reading Guenter's note I see my misunderstanding of this piece of
code:

return [nodes.raw('', biblsthtml, format='html')]

but my question still stands.

As noted I had adapted it from another source; it seemed to do what I
wanted. But I didn't really understand what it did. This mistake may have
created some confusion around my underlying request for explanation and
sample code.

equivalent to using the raw directive in the reST source. Which in that
manner -- ie raw directives in the rest source -- as Guenter noted could be
adapted and targeted to the various other writers.

But my specific question remains.  If I have the custom directive

.. bibentries::

    BCC+87;;

How do I write python code in the proper "Docutilic idiom" perhaps
resembling my start with

class BibDirective(Directive):
    has_content = True
    def run(self):
...
directives.register_directive("bibentries", BibDirective)

which will allow me to translate the content to both html and latex.

So for purposes of explanati

Re: Problem: rst2latex --use-bibtex works butproduces double references.

Michael Prisant — 2013-05-13T20:12:35

Hi,

Answering my own question but posing a followup.  I am getting a "double"
references section because I substitute a custom template on translation to
latex which contains the following code adding a bibliography:

$head_prefix% generated by Docutils <http://docutils.sourceforge.net/>
\usepackage{fixltx2e} % LaTeX patches, \textsubscript
\usepackage{cmap} % fix search and cut-and-paste in Acrobat
$requirements
%%% Custom LaTeX preamble
...
\bibliography{Articles,Books,Theses}
\bibliographystyle{no_abstract}
\end{body}

Eliminating the problematic stuff from my template it would seem that the
relevant code in  docutils/writers/latex2e/__init__.py should do the right
thing if the use_bibtex string is not null

        # * bibliography
        #   TODO insertion point of bibliography should be configurable.
        if self._use_latex_citations and len(self._bibitems)>0:
            if not self.bibtex:
                widest_label = ''
                for bi in self._bibitems:
                    if len(wide

Re: custom directive: publish html and latex2edifferently

Guenter Milde — 2013-05-13T19:51:37


For specific adwise, we need a specific task. Otherwise, I could just
copy one of the standard directive classes (all of them are good examples
and (almost) all or them are properly translated to all output formats
that Docutils supports.


The problem I have with your example is, that it uses "raw" without any
need. I don't know for certain, but I don't think "raw" is required for
the real task either. Therefore, a solution to the stated problem of
providing two raw nodes -- one for latex one for html -- is just going
further in the wrong direction, away from a generic solution to the real
problem behind the example. 

...


Did you already try to let the directive class return a list of "raw"
nodes (one for each supported output format)? AFAIK, "raw" nodes of the
"wrong" format are just ignored by the writers. Caveat: I did not test
this approach nor do I know whether it works this way.

Günter


------------------------------------------------------------------------------
AlienVault Unified Security M

Problem: rst2latex --use-bibtex works but producesdouble references.

Michael Prisant — 2013-05-13T16:50:41

Hi,

I have been experimenting with the --use-bibtex=mybibsty,mybib option.  The
good news is I am able to this to properly process citations in reST.  But
the latex translation creates tex code on processing which has two
references sections.  Is this the way it is supposed to work? What am I
doing wrong?

Here is my example:

- This reST snippet (extracted and edited):

Here is a citation [HLD+00]_. Here is more text with citations [PM60]_.
Donec id elit non mi porta gravida at eget metus.
Fusce dapibus, tellus accursus commodo, tortormauris condimentum nibh, ut
fermentum massa justo sit ametrisus.
Etiam porta sem malesuada magna mollis euismod [Dwy04]_.

.. [HLD+00]
.. [PM60]
.. [Dwy04]

- Produces this tex (extracted and edited):

Here is a citation \cite{HLD+00}. Here is more text with citations \cite{PM60}.
Donec id elit non mi porta gravida at eget metus.
Fusce dapibus, tellus ac cursus commodo,tortor mauris condimentum
nibh, ut fermentum massa justo sit ametrisus.
Etiam porta sem malesuada magna moll

Re: custom directive: publish html and latex2edifferently

Michael Prisant — 2013-05-13T16:20:59

Hi Guenter,

Thanks for this reply but I was looking for more specific advice with
regard to coding rest custom directives (as opposed to using the "raw:
approach) which are properly translated to both html and latex (like
non-custom directives).  Admittedly, I tried to pare my actual python code
snippet to a bare minimum more or else working example. (This eliminated my
actual bibtex processing which is what actually necessitated python code as
opposed to just using "raw".  So some confusion seems to stem from the
example given which  doesn't do very much)   On this basis I was hoping
that one of the experienced coders could offer an *explicit* but *simple*
python example to the group based on the very *simple* code snippets that I
provided.

The custom directive appears in the reST document:

.. bibentries::

    BCC+87;;

Once again (with a few minor clarifications and corrections), when I code a
custom directive which only "goes to the html writer" it works. But  I want
to "publish"/translate this rest/t

Re: custom directive: publish html and latex2edifferently

Guenter Milde — 2013-05-13T07:58:31













In a custom directive class, you can manipulate both, the input stream (i.e.
the part that is not yet parsed) and the document tree.

This means you could prepend reStructuredText that would result in the
desired html/latex/... output::

  .. raw:: html
  
     this is raw html
     
  .. raw:: latex
  
     this is raw latex
     
  .. raw:: man
  
     this is raw manpage writer content ...
     
and let the parser parse it (see the include directive for an example of
input stream manipulation by a directive).

However, I rather recommend to avoid "raw" if possible. If you can represent
the content of whatever the directive should produce as reStructuredText,
use this, instead of raw. Then you are free to either prepend the
reStructuredText source to the input stream or (better) the nodes that would
result from parsing this input direct to the document tree.

The advantage of this approach is better portability: the resulting document
tree can be processed by any writer.
 
Günter


----------

custom directive: publish html and latex2edifferently

Michael Prisant — 2013-05-08T11:48:29

Dear Group,

Let's say I have a custom restructured text directive of the following form
in the string "content":

.. bibentries::

    BCC+87;;

For the purpose of this question when I call

print publish_string( source=content,
writer_name='html',settings_overrides=overrides)

I would like to emit something similar to the following in my html stream:

<pre> This is the html bibdirective </pre>

and when I call:

print publish_string(
source=content,writer_name='latex2e',settings_overrides=overrides)

to emit something similar to the following in my latex stream:

/begin{verbatim} This is the latex bibdirective /end{endverbatim}

Of course in my real code I do some munching on the content of bibdirective
but for the purposes of this example/question  I'll work with this
simplification.

In any case I have written code for a custom directive as follows::

class BibDirective(Directive):
    has_content = True
    def run(self):
        self.assert_has_content()
        text = '<pre> This is the html bibdirect

Re: replacement text for enumeration sequenceinitializer

David Goodger — 2013-05-06T20:06:50

Hi Carl,

Sorry, reST doesn't provide the functionality you're looking for (and
cannot, at least without major work). List enumeration is block-level
syntax, which is recognized earlier in parsing, but substitutions are
at the inline level, dealt with later. This means that a block is
recognized as a list item before substitutions are considered, so
substitutions cannot affect block-level objects such as list items.

The best you can do in reST is this:

1. first
#. second
#. third...

(A) new list, first
(#) second
(#) third...

Then you'd only have to edit the first enumerator in each list to
change the sequence.

The reason you get "a. abc #. def" on one line (your "first option")
is due to "|seq1|. abc" not being recognized as a list item because of
the parsing order (block-level first, then inline).

The reason your second option doesn't work is that the replacement
text, "a." is seen as a list item enumerator, but the "replace"
substitution directive may only contain a paragraph, not a list item.
(Tha

Re: broken rst cheatsheet?

Guenter Milde — 2013-05-06T11:14:02

Dear Michael,

...


I have reservations to make such a "fragile" environment (which may
require manual inspection and fine-tuning) the default.

Also, in many cases floating figures are the better choice. Currently this
is possible to select via LaTeX code in the preamble or raw LaTeX:
http://docutils.sourceforge.net/docs/user/latex.html#figure-placement

The placement of figure floats might become configurable via class arguments
http://docutils.sourceforge.net/docs/dev/todo.html#configurable-placement-of-figure-and-table-floats

This could also include the spcial class argument "wrap" for wrapfig use:
http://docutils.sourceforge.net/docs/dev/todo.html#image-and-figure-directives


(if not used at inappropriate places)




This figure does not set the :figwidth: option.
It is not clear, whether the default :figwidth: should be
the width of the included image or the width of the containing element.

With LaTeX, "figwidth" is currently ignored and the width of a figure is
always 100%.




I just commited a

Re: why i can't use the search function in restructuredtext?

13718354131 — 2013-05-06T10:13:00

i solved it .

it is the bug of old version.





apt-get remove  python-sphinx  #1.1.13

 easy_install  /home/debian/Sphinx-1.2b1-py2.7.egg   #1.2b1




everything is ok now.





--------------------------------------------------------------------------------

----The following is the content of the forwarded email----
From：BlackJack<marc< at >rintsch.de>
To：13718354131 <13718354131< at >139.com>
Date：2013-05-06 15:43:46
Subject：Re: [Docutils-users] why i can't use the search function in restructuredtext?

On 06/05/13 06:53, 13718354131 wrote:

First, this is not a reStructuredText question.  It is a Sphinx related
one.  Sphinx uses reStructuredText for the source text markup, but
reStructuredText has nothing to do with the search feature provided by
Sphinx.

Sphinx' search relies on JavaScript.  Maybe you have disabled it in your
browser(s)?

Or maybe you can not find the word Django in it because according to
your screen shot the documentation's title is „R_statistics 1”.

Ciao,
Marc 'BlackJack' Rint

Re: why i can't use the search function in restructuredtext?

13718354131 — 2013-05-06T09:23:04

strange !

1.when i open 

http://docs.python.org/2/tutorial/

to search  something in `quick search ` frame both in chrome and in firefox,it is ok ,i can get result.




2.wwhen i open  a  restructured text  made myself ,

to search  something in `quick search ` frame 

it can get right result only in firefox 

it can get nothing result in chrome. (Version 26.0.1410.63)






--------------------------------------------------------------------------------

----The following is the content of the forwarded email----
From：BlackJack<marc< at >rintsch.de>
To：13718354131 <13718354131< at >139.com>
Date：2013-05-06 15:43:46
Subject：Re: [Docutils-users] why i can't use the search function in restructuredtext?

On 06/05/13 06:53, 13718354131 wrote:

First, this is not a reStructuredText question.  It is a Sphinx related
one.  Sphinx uses reStructuredText for the source text markup, but
reStructuredText has nothing to do with the search feature provided by
Sphinx.

Sphinx' search relies on JavaScript.  Maybe you have