search

hoop33 / wry

App.net command-line client for Mac OS X
http://grailbox.com/wry
MIT License
43 stars 6 forks source link

Improve the help documentation #36

Open hoop33 opened 11 years ago

hoop33 commented 11 years ago

Ideas:

jeremy-w commented 11 years ago

Ooh the HTML idea is cool.

After the man page experience, it occured to me that it would be nice to have the help documentation live outside the class file itself, ideally in some sort of semantic markup format.

From what I saw snooping in vi $(man --page git), it looks like Git uses DocBookXML and then converts that to man page and whatever else they need.

HTML with some semantic class tags might be enought to massage HTML->manpage and also HTML->text for the commands to emit.

Something to think about, anyway.