[Docutils-develop] [ docutils-Patches-3527401 ] manpage writer addmonition's don't preserve indentation

[SourceForge.net <no...@so...>]

Patches item #3527401, was opened at 2012-05-16 14:12
Message generated for change (Comment added) made by grubert
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=422032&aid=3527401&group_id=38414

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Joshua Graff (joshuagraff)
>Assigned to: engelbert gruber (grubert)
Summary: manpage writer addmonition's don't preserve indentation

Initial Comment:
In the manpage writer admonitions use troff's ``.IP``/``.RE`` for paragraph 
indentation. This unfortunately does not appear to preserve indentation for 
bullets and other block types (literal) that might be contained within an 
admonition.

Example:

$ cat example.rst
=====
Title
=====
  
:Version: 1.1
:Author: joe...@ex...
  
  
Example
=======
  
This is an example.
  
.. NOTE::
   This is an important note.
  
   * Bullet
  
   Example::
  
     $ man ls

$ rst2man.py example.rst > example.man
$ ./example.man
NAME
       Title -

EXAMPLE
       This is an example.

       Note   This is an important note.

       o Bullet

       Example:

       $ man ls

AUTHOR
       joe...@ex...

In the above example both the bullet and literal block start at the same indentation
level as 'Note'. A solution that has worked well for me is to treat admonitions as 
block quotes with a strong heading.

Example:

$ rst2man.py example.rst > example.man
$ man ./example.man
NAME
       Title -

EXAMPLE
       This is an example.

       NOTE:
          This is an important note.

          o Bullet

          Example:

          $ man ls

AUTHOR
       joe...@ex...


Please note the missing indentation of the literal block 'Example:' is 
described in patch item #3527397.

Attached is a patch with the changes described above which I hope other may find useful.

-Josh


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

>Comment By: engelbert gruber (grubert)
Date: 2012-05-24 21:22

Message:
* needs to pass sandbox/manpage-writer (obviously test will need change)
* check against mercurial
* maybe mplayer also uses manpage-writer

in progress

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

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=422032&aid=3527401&group_id=38414