One of the things that was suggested on the groups about this kind of function was to include a hook so that modules could provide module-specific information to include in the listing. I'm not sure if I satisfied that part, but here's what I came up with:
A currently planned feature is to allow administrators to see which modules implement selected hooks. This will also use hook_sitedoc to get a list of invoked hooks from contributed modules.
I'm still designing this part. Any input you might offer will be welcome. What would a module developer want to highlight? In what format should it be returned?
The module may return the following arrays of information:
This is a list of hook names that the module invokes.
Virtually all modules have settings. Even though most modules store their settings in system variables, which are already dumped in the display, the developer may want to emphasize the settings by including this hook. This will generate a separate section in the report that carries a title indicating which module is reporting them. There may be additional information displayed with the setting.
return array('settings' => array('name' => 'setting1', 'value' => 'value1', 'more' => 'more info1', 'name' => 'setting2', 'value' => 'value2', 'more' => 'more info2', ..., 'name' => 'settingn', 'value' => 'valuen', 'more' => 'more infon', );
For any other information the called module may wish to display in the report, you may return an array of text lines. Note: it is the called module's responsibility to ensure that the text is "safe" to display.
return array('other' => array('line1' => 'text1', 'line2' => 'text2', ..., 'linen' => 'textn'));
The sitedoc module will display these values line by line as they appear.