[docutils:bugs] #497 manpage writer renders links incorrectly

engelbert gruber via Docutils-develop <[email protected]> Thu, 20 Feb 2025 08:01:46 -0000
Newsgroups gmane.text.docutils.devel
Message-ID </p/docutils/bugs/497/0a6ada3e30f0c8054b2c000af83855360a8d8d80.bugs@docutils.p.sourceforge.net>
thanks for the report.

pt1 is indentional. 
when adding refernce handling in this writer, i wanted this to be undisturbing.
not expanding some "email: [email protected]" into "email: [email protected] <mailto:[email protected]>
No one recognized up to you, so i was successful ... will be removed

pt2 spaces are mostly random IMHO ... will try to improve
pt3 newlines are vertical spaces

references are tricky because

when viewed in a terminal, having them clickable is great.
this is done by most terminals by themselves, seam to parse the text

but there are also manpage macros for this UR/UE/MT/ME 
with these the manpage processor takes over and
produces clickables for terminals and pdf

on printouts clicking is hard and so the uris must be printed in the footer
which is done by lynx when dumping html pages, but maybe no one else.
which means the document is loosing something.

long uris should be broken, so that the long uris dont ruin the layout or go over borders, which might be physical on/off paper.
this my current problem: there are nonprinting breakpoints for roff

if your document is opensource send me a link
if not send me samples
if not report bugs, try latest source

all the best
  



---

**[bugs:#497] manpage writer renders links incorrectly**

**Status:** open
**Labels:** manpage writer 
**Created:** Tue Feb 11, 2025 11:03 PM UTC by Ulya Trofimovich
**Last Updated:** Wed Feb 19, 2025 09:25 PM UTC
**Owner:** engelbert gruber


Hi! Here's an example bug.rst file (trimmed from a real-world manpage AUTHORS section and changed to hide real names):
~~~
$ cat bug.rst
Aaaaa ([email protected]),
`Bbb <https://github.com/cc>`_ ([email protected]),
`mm <https://github.com/m>`_
`nn <https://github.com/nn>`_
and `OooOoooo <https://github.com/OooOoooo>`_.
~~~
With rst2man (Docutils 0.21.2, Python 3.12.8, on linux) it is rendered as follows (I cut first and last output lines in the output as they obscure the view and are irrelevant):
~~~
$ rst2man bug.rst > bug.1 && man ./bug.1
NAME
        - Aaaaa ( <[email protected]> ), Bbb <https://github.com/cc>
        ( <[email protected]> ), mm <https://github.com/m>

        <nn> and  <OooOoooo> .
~~~
What I think is wrong:

1. In <nn> and <OooOoooo> URI had been removed completely (note that they are different from other addresses in that the substitution text is the same as the last URI path component)
2. spaces surrounding email in parentheses look weird
3. newlines seem to be inserted at random

I would like it to be rendered like this:
~~~
NAME
        - Aaaaa ([email protected]), Bbb <https://github.com/cc> ([email protected]), mm <https://github.com/m> nn <https://github.com/nn> and OooOoooo <https://github.com/OooOoooo>.
~~~
    
I suspect this is the change in https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09, as I saw other changes listed in this release in the same diff with the breaking changes described above.


---

Sent from sourceforge.net because [email protected] is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.