suggestion for better manpage image handling

Guenter Milde via Docutils-develop <[email protected]> Thu, 17 Oct 2024 22:31:31 -0000 (UTC)
Newsgroups gmane.text.docutils.devel
Message-ID <[email protected]>
Dear Engelbert, dear Docutils developers,

with man pages usually presented on a terminal, it is no surprise that
the "manpage" writer does not support images. However, the current
behavior around this limitation may, IMO, be iproved.

If the image has an "alt" attribute, use its value *instead of* the filename.
Example::

  text

  .. image:: gibsnich.png
     :alt: an image of something

  more text

With ``rst2man foo.rst > foo.roff`` I get a ::

  (WARNING/2) "image" not supported

and `man ./foo.roff` shows::


  ()                                                                        ()

  Name
          - text [image: an image of something/gibsnich.png]

         more text

I would prefer an (INFO/1) instead of a warning and ::

  ()                                                                        ()

  Name
         text

	     an image of something

         more text



For images without an :alt: attribute, the warning should be kept
but amended with something in the line of

   (WARNING/2) "image" not supported by "manpage" writer.
   Please provide an "alt" attribute with textual replacement.


Thanks,

Günter



_______________________________________________
Docutils-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/docutils-develop

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