Inner Mod Menu Programmer Documentation

This is a work in progress

  1. For more general Inner Mod Menu documentation, see TNG Wiki documentation.
In theory, Inner Mod Menus could be placed in end-user programs, but, so far, they have placed only in Admin programs, primarily because they link to the Wiki and to mod settings, .
  1. In TNG admin programs, just after the call to tng_adminheader(), and before the program's hard-coded </head> tag, insert the PHP statement include_once('rrshared_innermodmenu3.php');;
  2. Immediately before the program's call to doMenu(), insert a PHP statement in this form:
    $innermenu = rrBuildInnerModMenu3(a, b, c, d, e)
    , where the function arguments are
    1. a mod name,
    2. A binary or boolean flag that indicates whether the mod's Wiki article has a "Mod Options" section,
    3. The name of the Admin>>Setup program where the mod's settings can be edited (if there are any),
      (The prefix "admin" and the file extension ".php" may be omitted.,
    4. The ID of the subform within that Admin>>Setup program that contains the mod's settings (if there is one),
      (See notes below),
    5. A TNG Help filename that contains information about the changes that the mod makes to the program, and, generally, the name of an anchor that would scroll the help page to that text.
    For example:
    $innermenu .= rrBuildInnerModMenu3('Admin Cemeteries Search',
    1, //The Wiki article has a "Mod Options" Section. amd the menu will link to it.
    'genconfig', //i.e. admin_genconfig.php, at Admin>>Setup>>General Settings
    '', //which, for admin_genconfig.php, defaults to the new subform with id='robin',
    'cemeteries_help.php#searchmod"
    )