[ic] Documentation updates call (config directives)

[Davor Ocelic]

Hello folks,

There are some bits of information missing in our documentation
on Interchange configuration directives.

(Index page is at
  http://d.icdevgroup.org/cgi-bin/online/confs/index.html )


I have a helper script that identifies the missing elements,
output of which you can see below.

Please go over the list, and see if you can supply any of the 
missing information.

If you have information on some of the items, send it to the list
(reply to this email) or to me ( docelic+icdevgroup.org). Take care
of the content only, I'll take care of the formatting and committing
to docs CVS.

Also, if you have useful examples you'd like to share, you're
encouraged to send them in as well, regardless of the below list.

Thanks,
Davor Ocelic
Interchange Development Group


The list:

{
  'AdminUser' => [
    'Missing field \'example\', using unsuitable default'
  ],
  'AliasTable' => [
    'describe cgi passing of control: "Allows initialization of CGI
inputs via base_control field."', 'produce working example'
  ],
  'AllowGlobal' => [
    'how does SafeTrap/Untrap play with AllowGlobal?',
  ],
  'AutoEnd' => [
    'Missing field \'example\', using unsuitable default'
  ],
  'AutoModifier' => [
    'improve description based on syntax seen in examples',
    'in the examples, explain mv_sku lookup, not clear now',
  ],
  'Catalog' => [
    'List all possible hash keys used with Catalog',
  ],
  'CodeDef' => [
		'synopsis',
    'more description',
  ],
  'CustomShipping' => [
    'Real-world example',
    'Make shipping.txt database to supplement the example',
		'More description',
  ],
  'Database' => [
    'Examples for each DB type supported (Oracle, Mys,... )',
    'List of all keys that can occur in a specification'
  ],
  'DatabaseAuto' => [
    'Description of extra params, catalog, schema, name, type'
  ],
  'DatabaseDefault' => [
    'Missing field \'synopsis\', using unsuitable default'
  ],
  'DebugTemplate' => [
    'Missing field \'example\', using unsuitable default'
  ],
  'DomainTail' => [
    'How does it work with non-resolving hostnames?',
  ],
  'ErrorDestination' => [
    'In examples, show how exactly would you call [error] tag (or
whatever) to see ErrorDestination in practice' ],
  'FallbackIP' => [
    'Missing field \'description\', using unsuitable default'
  ],
  'Filter' => [
    'More examples',
  ],
  'FormAction' => [
    'check if basic example works, and add a form that triggers the
action', ],
  'HouseKeepingCron' => [
    'run_macro() also supports calling Interpolate::tag_profile if
argument is \\w+-\\w+ but it\'s not documented ATM as I have no idea
what to do with it', 'more about <>= in target specification', 'Last
example (batch jobs) needs to be fixed (or clarified how it works?)',
'Clarify what the first 6 fields mean and adjust
synopsis/description' ], 'Levy' => [
    'synopsis',
    'descriptions',
    'turn list into NAME (SYNOPSIS, default DEF) - DESC',
    'add examples',
    'description of all levy keys',
    'Missing field \'synopsis\', using unsuitable default'
  ],
  'Limit' => [
    'fill in complete limits table',
    'Missing field \'synopsis\', using unsuitable default'
  ],
  'Locale' => [
    'purpose and description is wrong completely',
    'The description doesn\'t seem to match the description of the same
variable when set in catalog.cfg', 'The usual list format of NAME (SYN,
default DEF) - DESC', 'More sound examples',
  ],
  'LocaleDatabase' => [
    'example of LocaleDatabase structure (what fields etc.?)'
  ],
  'LockoutCommand' => [
    'Give lockout examples for ipchains, iptables and ipfw',
  ],
  'Options' => [
    'Missing field \'synopsis\', using unsuitable default',
    'Missing field \'description\', using unsuitable default'
  ],
  'OptionsAttribute' => 'Missing all (undocumented)',
  'OptionsEnable' => [
    'Missing field \'description\', using unsuitable default'
  ],
  'OrderCleanup' => 'Missing all (undocumented)',
  'OrderProfile' => [
    'Diff between Profiles and OrderProfile ?',
    'Confusing note in NOTES about scratch space and mv_click actions'
  ],
  'PageTableMap' => [
    'Missing field \'synopsis\', using unsuitable default',
    'Missing field \'description\', using unsuitable default',
    'Missing field \'example\', using unsuitable default'
  ],
  'PageTables' => [
    'Missing field \'purpose\', using unsuitable default',
    'Missing field \'synopsis\', using unsuitable default',
    'Missing field \'description\', using unsuitable default',
    'Missing field \'example\', using unsuitable default'
  ],
  'PermanentDir' => [
    'description',
  ],
  'Profile' => 'Missing all (undocumented)',
  'Profiles' => [
    'Add self-contained profile example',
  ],
  'RobotLimit' => [
    'Didn\'t we change this from 127.0.0.1 to something else ?'
  ],
  'Route' => [
    'Missing field \'synopsis\', using unsuitable default',
    'Missing field \'description\', using unsuitable default',
    'Missing field \'example\', using unsuitable default'
  ],
  'RouteDatabase' => 'Missing all (undocumented)',
  'RunDir' => [
    'Where to document /reconfig, /restart, /jobsqueue, /flag.* ...'
  ],
  'SearchProfile' => [
    'Difference between SearchProfile and OrderProfile ??'
  ],
  'SessionDB' => [
    'Why DBI sessions are not encouraged?'
  ],
  'Shipping' => [
    'Missing field \'purpose\', using unsuitable default',
    'Missing field \'synopsis\', using unsuitable default',
    'Missing field \'description\', using unsuitable default'
  ],
  'SpecialPage' => [
    'Descriptions for possible keys, and default values'
  ],
  'Sub' => [
    'Example isn\'t working? Sub gets called, but doesn\'t sort!'
  ],
  'SysLog' => [
    'Missing field \'synopsis\', using unsuitable default'
  ],
  'TagGroup' => [
    'TagGroup :file or file?'
  ],
  'UserControl' => [
    'what do you get by enabling enhanced userdb functions?'
  ],
  'UserTag' => [
    'Take a look in there',
    'Missing field \'description\', using unsuitable default',
    'Missing field \'example\', using unsuitable default'
  ],
  'UserTrack' => [
    'Missing field \'example\', using unsuitable default'
  ],
}