[Tickets #4717] Re: In config/prefs.php, document all possible types

[bugs@bugs.horde.org]

DO NOT REPLY TO THIS MESSAGE. THIS EMAIL ADDRESS IS NOT MONITORED.

Ticket URL: https://dev.horde.org/horde/whups/ticket/?id=4717
-----------------------------------------------------------------------
 Ticket             | 4717
 Updated By         | Otto.Stolz at uni-konstanz.de
 Summary            | In config/prefs.php, document all possible types
 Queue              | Horde Base
 Version            | 3.1.2
 Type               | Enhancement
 State              | Feedback
 Priority           | 1. Low
 Owners             | 
-----------------------------------------------------------------------


Otto.Stolz at uni-konstanz.de (2006-12-01 05:07) wrote:

> If you are referring to configuring what appears in the horde menu, 
> that is done by an administrator, via the 'setup' screens for each 
> application.

No. This only the coonfig.php is setup in this way; the other config/*.php
have to be set up manually, and this is why the administrator needs a
comprehensive documentation of the pertinent conventions and options.

>  If *you* are asking, as an administrator how to do 
> this, or how to configure 'locked' prefs,  or even if your writing 
> your own horde application, you will find *very* friendly and helpful 
> advise on the mailling lists.

It is certainly less work for everybody, if the administrators can find
the neccessary documentation in the ditribution and need not bother all
the subscribers of those lists with trivial questions.

> In some cases, I would agree [that the documentation should really be
> comprehensive], but given the choice of fixing actual 
> bugs in functionality, implementing new, requested features, or 
> writing documentation - I know what most of the (relatively few) 
> developers that contribute to the project would choose...

When a developer invents a new sort of entry for some configuration file
(such as a new prefs type), it would him cost only some minutes to add one
or two lines, in the pertinent config file, while the information is
readily available. If he, however, has neclected this duty, it will cause
headaches to countless administrators, and it will cost hours to close the
gap, later.

In this particular case, I had hoped that somebody, who knows the code,
could provide the missing details (just a few lines) straight off the bat.
Now, after I have spent some hours trying to fill in the missing
information, still somebody knowledgable has to check, and amend, my
proposal.