SF.net SVN: docutils:[9952 ] trunk/sandbox/manpage-wri ter/TODO.rst

Revision: 9952
          http://sourceforge.net/p/docutils/code/9952
Author:   grubert
Date:     2024-10-20 10:48:13 +0000 (Sun, 20 Oct 2024)
Log Message:
-----------
image enhancement

Modified Paths:
--------------
    trunk/sandbox/manpage-writer/TODO.rst

Modified: trunk/sandbox/manpage-writer/TODO.rst
===================================================================
--- trunk/sandbox/manpage-writer/TODO.rst	2024-10-18 08:57:32 UTC (rev 9951)
+++ trunk/sandbox/manpage-writer/TODO.rst	2024-10-20 10:48:13 UTC (rev 9952)
@@ -3,6 +3,53 @@
 
 :Date: $Date$
 
+Images
+------
+
+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.
+
+
 Issues
 ------
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.