[
https://issues.apache.org/jira/browse/DISPATCH-26?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14253646#comment-14253646
]
Alan Conway commented on DISPATCH-26:
-------------------------------------
The book should at least refer to the man pages for the various tools qdstat,
qdmanage.
Would be better to include the man pages in the book.
man can generate HTML, maybe there's a way to turn that into markdown, or to
generate a HTML book that includes markdown content + HTML man pages. No PDF
support in the base "man" tool.
Another option is to make markdown the source of the man pages as well. There
is one markdown-to-manpage project that I found but it has to introduce
extensions to markdown. Straight markdown does not seem strong enough for
manpages, lack of definition-lists is a particular problem.
I'm starting to wonder if restructuredtext isn't a better option. No experience
to back this up but
- it has definition lists
- there is an rst2man tool at sourceforge that claims to convert unextended
(but restricted) rst to man pages.
- it is capable of neat tricks like gordon's live-demo-code-in-documentation
for the proton tutorial
markdown is nice and simple but I'm starting to feel like it is too simple.
> Documentation updates for 0.3
> -----------------------------
>
> Key: DISPATCH-26
> URL: https://issues.apache.org/jira/browse/DISPATCH-26
> Project: Qpid Dispatch
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 0.1
> Reporter: Ted Ross
> Assignee: Ted Ross
> Fix For: 0.3
>
>
> This issue will track updates to the documentation book for the 0.2 release.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
