On 1/15/2010 at 12:32 AM, Florian Haas <florian.h...@linbit.com> 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.
Mmm... Yuck. > 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. :) Surprisingly, it's actually not too bad - the description ends up in a scrollable text area, and linebreaks and whitespace in the metadata seem to be mostly preserved, although the trailing backslashes in the example crm config in step 5 seem to throw this out somewhat (the same is true for the shell, if you run "crm ra info ocf:heartbeat:CTDB"). But, yeah, it's a bit unweildy :) > 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? That'll work. Regards, Tim -- Tim Serong <tser...@novell.com> Senior Clustering Engineer, Novell Inc. _______________________________________________________ Linux-HA-Dev: Linux-HA-Dev@lists.linux-ha.org http://lists.linux-ha.org/mailman/listinfo/linux-ha-dev Home Page: http://linux-ha.org/
