The IProcFunc can be configured with the following options:
Property: | Data type: | Description: | Default: |
|---|---|---|---|
dfn | boolean | Activate the generation of <dfn> tags | 0 |
dfn.menuSet | string | Set this to the same value to keep the counter across multiple TMENU's. Without a menuSet, each TMENU's dfn-count starts with “1”. Example: temp.listMenu = TMENU temp.listMenu { .. IProcFunc = user_cronaccessiblemenus->makeAccessible IProcFunc.dfn = 1 IProcFunc.dfn.menuSet = mainmenu .. } Use this, for example, if you compose your menu in a COA of different HMENU's. Use this TMENU in all your HMENU's that you use to compose your “mainmenu”, and the counter will be continue across them. The counter will also respect the nesting level. | |
dfn.start | integer | Start the dfn counter for this level at a different value. This will also respect dfn.menuSet, so that the counter will just start at this value in the first TMENU of a set. | 1 |
dfn.stdWrap | +stdWrap | Pass the generated value through the stdWrap function. This allows you to add a prefix or suffix to your dfn. Example: temp.listMenu = TMENU temp.listMenu { .. IProcFunc = user_cronaccessiblemenus->makeAccessible IProcFunc.dfn = 1 IProcFunc.dfn.stdWrap.noTrimWrap = |1.| | .. } This will prefix the dfn content with “1.” and suffix it with a “space”. | |
dfn.inATag | boolean | If set to true, it will place the <dfn> tag inside the <a> tag, if present. Default behaviour (false) is to place the <dfn> tag right after the <li> tag. Refer to this article (german only) for more information on when to use which method. | 0 |
accessKeys | boolean | Activate the addition of accesskeys | 0 |
accessKeys.noAutoGenerated | boolean | Deactivates the auto-generation of access-keys. Set this to true to get only the access-keys set in the gov_accesskey field. | 0 |
accessKeyWrap | wrap | The first occurrence of the accesskey in the title will get this wrap wrapped around it. Useful to highlight the accesskey of a menu item. Example: temp.listMenu = TMENU temp.listMenu { .. IProcFunc = user_cronaccessiblemenus->makeAccessible IProcFunc.accessKeyWrap = <span class="accessKey"> | </span> .. } | |
appendWrap | wrap | This will get appended to the title, wrapping around the used accesskey. Example: temp.listMenu = TMENU temp.listMenu { .. IProcFunc = user_cronaccessiblemenus->makeAccessible IProcFunc.appendWrap = <span class=”hidden”> (ALT- | )</span> .. } | |
forbiddenKeys | string | A comma separated list of characters that should never be used in auto-generated accesskeys. This is useful if you already have a couple of accesskeys being used in your main template and don't want other menu items to use them (e.g. ALT-0 to go to the start page). Example: temp.listMenu = TMENU temp.listMenu {.. IProcFunc = user_cronaccessiblemenus->makeAccessible IProcFunc.forbiddenKeys = 0,D,B,A,F,X .. } |
Examples
This will generate a simple text-based menu with accessible features (dfn and accesskeys):
temp.listMenu = TMENU
temp.listMenu {wrap = <ul> | </ul>
noBlur = 1
IProcFunc = user_cronaccessiblemenus->makeAccessible
IProcFunc.accessKeys = 1
IProcFunc.dfn = 1
IProcFunc.accessKeyWrap = <span class="accessKey"> | </span>
IProcFunc.appendWrap = <span class=”hidden”> (ALT- | )</span>
IProcFunc.forbiddenKeys = 0,D,B,A,F,X
NO {allWrap = <li> | </li>
stdWrap.htmlSpecialChars = 1
}
ACT = 1
ACT {wrapItemAndSub = <li class="act"> | </li>
stdWrap.htmlSpecialChars = 1
}
RO = 0
}
Here, the current accesskey will be highlighted in the title (CSS-class “accessKey”) and an accessible text will be appended to the title (ALT-<accesskey>). The keys 0, D, B, A, F, X will never be used for auto-generating, only if the user explicitly set them with gov_accesskey.
