Hi, On Thu, Jan 14, 2010 at 02:32:23PM +0100, Florian Haas wrote: > On 2010-01-14 14:11, Tim Serong wrote: > > My lovely usage instructions in the > > RA metadata all get squished onto one illegible long line when > > the manpage is generated - any ideas on how I can force some > > vaguley sane formatting here? Thanks -- Tim > > Hmm. Well we can use XSL whitespace preservation, but it won't affect > newlines. The only thing that I can currently think of is to inject > something like </para><para> in the generated intermediate DocBook XML > whenever we encounter a newline in a description metadata field. Which > is ugly. > > The other option, which is even uglier, is to allow DocBook elements > inside the metadata. > > But, keep in mind that it's not just the man page that uses longdesc, > but also the GUI. And your longdesc probably makes for a pretty big > popup. :) > > My takeaway from this is that longdesc should really just be a "long > description" of the RAs functionality, not full prose documentation > detailing each and every aspect of the RA. Instead, you should probably > document this on a page in the new Mediawiki website, and ultimately > when we get proper docs for the RA, move that content there. Sounds like > a plan?
longdesc should be long description, i.e. it should entail whatever the author finds necessary to explain about the resource agent. So, it may get big and we have to deal with it in some way. Ditto for longdesc for parameters. Of course, it shouldn't be a full blown howto either. Thanks, Dejan > Cheers, > Florian > > _______________________________________________________ > Linux-HA-Dev: [email protected] > http://lists.linux-ha.org/mailman/listinfo/linux-ha-dev > Home Page: http://linux-ha.org/ _______________________________________________________ Linux-HA-Dev: [email protected] http://lists.linux-ha.org/mailman/listinfo/linux-ha-dev Home Page: http://linux-ha.org/
