[publican-list] RFC -- Menu subheadings for Publican-driven websites

Darrin Mison dmison at redhat.com
Wed May 5 03:43:16 UTC 2010


On 05/05/2010, at 12:15 PM, Ruediger Landmann wrote:

> I've been trying out the web publishing features in Publican 1.99 and it's all working very very nicely so far. It certainly makes managing a library of documentation a lot less onerous and time-consuming :)
> 
> The automatically generated menus are one of the biggest time-and-effort savers in Publican 1.99; but I wonder if they could be a little more flexible?
> 
> At the moment (within each language) documents are grouped by product, then version number. However, some documents might not be tied to a specific version of a product. For example, in Fedora, we have documentation for the operating system itself, which is clearly version-specific; documentation for various other software included in Fedora (like SELinux) which is also version-specific; and then we have contributor documentation like the "Translation Quick Start Guide" which is not version specific at all.
> 
> Instead of having to tie these to a product version, it would be nice to group these as "All versions" or "Not version specific" or perhaps no subheading at all?
> 
> I guess the danger is that enabling such a feature would be a license for people to fill such a directory with all kinds of cruft -- I think that forcing writers to think in terms of "to which version of which product does this document really apply?" has been a Good Thing in Publican so far.
> 
> Therefore, I wonder what people here think is the best way to handle genuinely non-version-specific content in a documentation library?
> 
> Cheers
> Rudi

Optional configuration to override of the menu generation would be handy for these situations where more flexibility is required.  Perhaps on a book by book basis ?

Personally I'm thinking about the idea of being able to group different products together under higher level headings would be handy, eg KDE & GNOME or RHEL & JBoss. 


--
Darrin Mison - Engineering Content Services

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/publican-list/attachments/20100505/ee6dfb4b/attachment.htm>


More information about the publican-list mailing list