| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| module:xtrn_sec [2020/11/24 14:30] – [Configure] update xtrn_sec documentation mlong | module:xtrn_sec [2020/12/06 14:32] (current) – [Configure] Add center option. digital man |
|---|
| |
| ^ Option ^ Default ^ Description ^ | ^ Option ^ Default ^ Description ^ |
| | multicolumn | true | Use a multiple-column program list when there are more than ''singlecolumn_height'' items. This will automatically set to false if screen_columns < 80 | | | center | false | Center single-column program list in the user's terminal screen | |
| | | multicolumn | true | Use a multiple-column program list when there are more than ''singlecolumn_height'' items. This will automatically set to false if screen_columns < 80 | |
| | multicolumn_separator | " " | Separator displayed between columns of program names | | | multicolumn_separator | " " | Separator displayed between columns of program names | |
| | multicolumn_fmt | text[XtrnProgLstFmt] | Display format used for multiple columns | | | multicolumn_fmt | text[XtrnProgLstFmt] | Display format used for multiple columns | |
| | titles | text[XtrnProgLstTitles] | Program list titles | | | titles | text[XtrnProgLstTitles] | Program list titles | |
| | underline | text[XtrnProgLstUnderline] | Underline string under the titles | | | underline | text[XtrnProgLstUnderline] | Underline string under the titles | |
| | section_header_fmt | "\x01-\x01gSelect \x01hExternal Program Section\x01-\x01g:" | Header format for main section listing | | | section_header_fmt | text[SelectItemHdr] | Header format for main section listing | |
| | section_fmt | "\x01y\x01g%3d:\x01n\x01g %s" | Display format used for section entries in main section listing | | | section_fmt | text[SelectItemFmt] | Display format used for section entries in main section listing | |
| | section_which | "\r\n\x01-\x01gWhich, \x01w\x01h~Q\x01n\x01guit or [1]: \x01h" | Which prompt for main section listing | | | section_which | text[SelectItemWhich] | Which prompt for main section listing | |
| | | section_header_title | External Program Selection | Main section listing header text | |
| | which | text[WhichXtrnProg] | Which prompt | | | which | text[WhichXtrnProg] | Which prompt | |
| | sort | false | Re-sort (alphabetically) the list of programs and program sections before displaying to the user | | | sort | false | Re-sort (alphabetically) the list of programs and program sections before displaying to the user | |
| | no_programs_msg | text[NoXtrnPrograms] | Message displayed when there are no external programs available | | | no_programs_msg | text[NoXtrnPrograms] | Message displayed when there are no external programs available | |
| | prompt_on_info | false | Display a yes/no prompt after displaying external program intro file | | | prompt_on_info | false | Display a yes/no prompt after displaying external program intro file | |
| | prompt_on_info_fmt | \r\n\x01n\x01cDo you wish to continue | Formatting for prompt_on_info yes/no prompt | | | prompt_on_info_fmt | "\r\n\x01n\x01cDo you wish to continue" | Formatting for prompt_on_info yes/no prompt | |
| |
| | |
| | For all options that contain formatting, have the INI entry with a colon such as "name: value". For true/false, you can use the "=" format such as "name=value". |
| | |
| | Formatting options can contain escaped hexadecimal: "\x01" is Ctrl-A. |
| ===== Customize ===== | ===== Customize ===== |
| |
| |
| * The auto-generated external program section list can be replaced by creating the optional file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn_sec.*''. | * The auto-generated external program section list can be replaced by creating the optional file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn_sec.*''. |
| | * The external program section list can have an optional header displayed by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn_sec_head.*''. |
| | * The external program section list can have an optional footer displayed by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn_sec_tail.*''. |
| * Each program list can have an optional header displayed by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_num>_head.*'' or ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_code>_head.*''. | * Each program list can have an optional header displayed by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_num>_head.*'' or ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_code>_head.*''. |
| | * You can create a global header across all menus by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn_head.*'' |
| * Each auto-generated program list can be replaced by creating the optional file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_num>.*'' or ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_code>.*''. | * Each auto-generated program list can be replaced by creating the optional file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_num>.*'' or ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_code>.*''. |
| | * Each program list can have an optional tail section displayed by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_num>_tail.*'' or ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn<sec_code>_tail.*''. |
| | * You can create a global tail across all menus by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn_tail.*'' |
| * Each external program can have an optional file displayed before execution by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn/<code>.*'' | * Each external program can have an optional file displayed before execution by creating the file ''[[dir:text]]/[[custom:menu_files|menu]]/xtrn/<code>.*'' |
| |
