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

Ruediger Landmann r.landmann at redhat.com
Wed May 5 02:15:55 UTC 2010


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






More information about the publican-list mailing list