[Magick-bugs] Any plans to document ImageMagick?

Ilya Zakharevich nospam-abuse at ilyaz.org
Wed Oct 29 22:40:58 PDT 2008


[A complimentary Cc of this posting was sent to

<duc.sequere.aut.de.via.decede at imagemagick.org>], who wrote in article <200810291256.m9TCu6Zg024415 at studio.imagemagick.org>:
> > What's the suggested means for contributions?
> 
> We could write a help subsystem based on XML.  So your contribution would
> be an XML file with help for each option:
> 
>   <helpmap>
>     <topic name="-encoding">Use this option ... </topic>
>     <topic name="-resize">Use this option ...</topic>
>     ...
>   </helpmap>
> 
> The help subsystem we write would need to consider localization.
> 
> When you have completed this XML file, post a URL here and we will include
> it in the next release of ImageMagick.   Thanks.

???  When I did something like this for one of my programs (perl
     debugger?), it would just run over the manpage, and would print
     out the relevant section of the manpage.  No additional
     duplication of documentation needed.

But this assumes that the options manpage makes some sense.  Since the
current state is that for about 80% of the options, their
"documenation" is just a placeholder, it makes little sense to design
an easier way of access...

Hope this helps,
Ilya




More information about the Magick-bugs mailing list