Cheers,

Following on Nuno's latest script to get the right INI stuff onto the ini_set() page, and given that I am investigating the ways to improve on the installation part's bad situation, I have tried to find out where the INI stuffs are documented in our manual. Quite diverse :)

 Getting Started >>
   Runtime Configuration >>
     Miscellaneous configuration directives

     - general INI settings with scope info
     - and their explanation
     - and the explanation of the INI scope constants

 ini_set()

     - all the INI settings with scope info
     - and the explanation of the INI scope constants

 extension pages

     - INI settings related to that extension with
       scope info
     - and their explanation
     - link to ini_set() for the scope constants
       explanation

Sine only the ini_set() page is updated from time to time, this is quite some duplicated stuff, and will no doubt confuse people. What would be ideal IMHO:

  - move extension relevant stuff to the extension pages
    (do not have this info on the ini_set() page at all)

  - move general INI settings explanation and their scope info
    to an appendix (and do not have this on the ini_set() page)

This would leave the introduction on what can be changed where in the introduction part of the manual, while extension specific stuff would be at the extensions, and reference stuff would be in the appendix. That would mean that ini_set() would not have that list of scope info anymore, since that would be distributed to the extension pages and the appendix. We can have an index of all those ini settings in the appendix, if desired.

To do that, an intelligent script should be created along the path of genPHP_INI_ENTRY.php, which maps the ini settings to the relevant extension documentation files or the appendix file, and puts the stuff there.

It would be nice to come to an agreement on this, so someone can get on the job of writing that script (Nuno said he will probably be able to do so).

Having the INI stuff sorted out, I will finally be able to propose and actually do the changes needed to make reforms in the installation section, so we can have a better organized section for our users and translators to work with.

[BTW doc-de and doc-fr also cc-ed, being the two most active translation groups - at least I suspect so]

Goba

Reply via email to