User Tools
niota-docs:niota_system_config_formatting
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
niota-docs:niota_system_config_formatting [2022/01/22 13:13] admin |
niota-docs:niota_system_config_formatting [2025/07/17 14:11] (current) |
||
|---|---|---|---|
| Line 6: | Line 6: | ||
| - | === colors, backgrounds, display options === | + | ==== corporate design - colors, backgrounds, display options ==== |
| == COLOR_THEME / COLOR_THEME_ADMIN == | == COLOR_THEME / COLOR_THEME_ADMIN == | ||
| Set the color theme of the grid editing area and the admin area. The theme determines the colors and the background images. | Set the color theme of the grid editing area and the admin area. The theme determines the colors and the background images. | ||
| - | |||
| - | == COLOR_THEME_ADMIN == | ||
| - | Set the color thema of the administration and configuration pages. | ||
| - | |||
| - | == COLOR_INACTIV_TEXT == | ||
| - | == COLOR_INACTIV_BACKGROUND == | ||
| - | == FORMSIZE_ADMINPAGE_SMALL == | ||
| - | == FORMSIZE_ADMINPAGE_MEDIUM == | ||
| - | == FORMSIZE_ADMINPAGE_LARGE == | ||
| - | == CAPTION_ADMINPAGE_OPEN_TAG == | ||
| - | == CAPTION_ADMINPAGE_CLOSE_TAG == | ||
| <code> | <code> | ||
| - | define('COLOR_THEME', 'VEGA'); | + | define('COLOR_THEME', 'VEGA'); |
| - | define('COLOR_THEME_ADMIN', 'SALVA'); | + | define('COLOR_THEME_ADMIN', 'SALVA'); |
| </code> | </code> | ||
| Line 36: | Line 25: | ||
| == CLAIM == | == CLAIM == | ||
| + | Text that is displayed as claim next to the product name. May be adapted to your needs. | ||
| == INSTALLATION_NAME == | == INSTALLATION_NAME == | ||
| + | Internal name of the installation. This value can be used in character string substitution later. | ||
| <code> | <code> | ||
| - | // --- | + | define('COMPANY_LOGO', 'niota_logo.png'); |
| - | // colors and form dimension for admin pages | + | define('PRODUCT_NAME', 'niota'); |
| - | // --- | + | define('CLAIM', '.fascinating.logical'); |
| - | define('COLOR_INACTIV_TEXT', '#FF0040'); | + | define('INSTALLATION_NAME', 'demo'); |
| - | define('COLOR_INACTIV_BACKGROUND', '#E6E6E6'); | + | </code> |
| - | define('FORMSIZE_ADMINPAGE_SMALL', '600'); | + | |
| - | define('FORMSIZE_ADMINPAGE_MEDIUM', '800'); | + | ==== default languages, window sizes, colors and pagination ==== |
| - | define('FORMSIZE_ADMINPAGE_LARGE', '1200'); | + | |
| - | define('CAPTION_ADMINPAGE_OPEN_TAG', '<h2>'); | + | == COLOR_INACTIV_TEXT / COLOR_INACTIV_BACKGROUND == |
| - | define('CAPTION_ADMINPAGE_CLOSE_TAG', '</h2>'); | + | |
| - | + | == FORMSIZE_ADMINPAGE_SMALL / FORMSIZE_ADMINPAGE_MEDIUM / FORMSIZE_ADMINPAGE_LARGE == | |
| - | // --- | + | |
| - | // page headers | + | == CAPTION_ADMINPAGE_OPEN_TAG / CAPTION_ADMINPAGE_CLOSE_TAG == |
| - | // configurable settings: | + | |
| - | // | + | == GRID_AREA_LANGUAGE == |
| - | // COMPANY_LOGO use small .png image with your companies logo | + | * ''de'' - GERMAN/DEUTSCH |
| - | // PRODUCT_NAME default "niota" - you can rename it to your needs | + | * ''en'' - ENGLISH/ENGLISCH |
| - | // CLAIM default ".fascinating.logical" - you can rename it to your needs | + | |
| - | // INSTALLATION_NAME default "niota+Version" - can be use as $installation replacement parameter in stored procedure calls / callable objects scripts | + | == FEEDBACK_MSG_DELAY == |
| - | // | + | Delay time of hide grid editing feedback message (milliseconds) |
| - | // --- | + | |
| - | define('COMPANY_LOGO', 'pbv_logo.png'); | + | == DEFAULT_PAGE_SIZE_GRID / DEFAULT_PAGE_SIZE_ADMIN == |
| - | define('PRODUCT_NAME', 'niota'); | + | The number of rows on grid pages / admin pages |
| - | define('CLAIM', '.featuring PBV Vertragsumschreibung '); | + | |
| - | define('INSTALLATION_NAME', 'niota'); | + | 10, 20, 30, 50, 100, -1 (all rows) |
| - | + | ||
| - | // --- | + | == PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH == |
| - | // grid area | + | Width of lookup combo during grid editing |
| - | // | + | |
| - | // GRID_AREA_LANGUAGE | + | == PHPGRID_EDIT_FORM_DEFAULT_WIDTH == |
| - | // de GERMAND/DEUTSCH | + | Width of default edit form |
| - | // en ENGLISH/ENGLISCH | + | |
| - | // FEEDBACK_MSG_DELAY delay time of hide grid editing feedback message (milliseconds) | + | == WIDTH_TABLE_SELECTOR == |
| - | // DEFAULT_PAGE_SIZE_GRID the number of rows on user grid pages | + | Width of table selector drop down list |
| - | // DEFAULT_PAGE_SIZE_ADMIN the number of rows on admin pages | + | |
| - | // 10, 20, 30, 50, 100, -1 (all rows) | + | == WIDTH_FILTER_CONNECTION == |
| - | // | + | Width of connection filter drop down list |
| - | // --- | + | |
| - | define('GRID_AREA_LANGUAGE', 'en'); | + | == WIDTH_FILTER_CATEGORY == |
| - | define('SYSTEM_LANGUAGE', 'en'); | + | Width of category filter drop down list |
| - | define('DEFAULT_PAGE_SIZE_GRID', 50); | + | |
| - | define('DEFAULT_PAGE_SIZE_ADMIN', 50); | + | == SHOW_TABLE_SELECTOR_BY_DEFAULT == |
| - | define('FEEDBACK_MSG_DELAY', 5000); | + | true |
| + | false (show / hide table selector) | ||
| + | |||
| + | == DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN == | ||
| + | Pattern and list of pattern-variables to build the table list. | ||
| + | |||
| + | Available patterns that are replace by metadata content. | ||
| + | |||
| + | ** ''%cat_id%'' ** - catalog id\\ | ||
| + | ** ''%inst_name%'' ** - instance name\\ | ||
| + | ** ''%inst_descr%'' ** - instance description\\ | ||
| + | ** ''%conn_name%'' ** - connection name of catalog object\\ | ||
| + | ** ''%conn_disp_name%'' ** - connection display name\\ | ||
| + | ** ''%obj%'' ** - catalog object name (table or view name)\\ | ||
| + | ** ''%desc%'' ** - catalog object description (not recommended, can be too long)\\ | ||
| + | ** ''%obj_cat%'' ** - object category\\ | ||
| + | |||
| + | |||
| + | == DEFAULT_CATALOG_ORDER_BY == | ||
| + | Order-by clause of catalog list (SQL syntax - not qualified) | ||
| + | |||
| + | <code> | ||
| + | define('COLOR_INACTIV_TEXT', '#FF0040'); | ||
| + | define('COLOR_INACTIV_BACKGROUND', '#E6E6E6'); | ||
| + | define('FORMSIZE_ADMINPAGE_SMALL', '600'); | ||
| + | define('FORMSIZE_ADMINPAGE_MEDIUM', '800'); | ||
| + | define('FORMSIZE_ADMINPAGE_LARGE', '1200'); | ||
| + | define('CAPTION_ADMINPAGE_OPEN_TAG', '<h2>'); | ||
| + | define('CAPTION_ADMINPAGE_CLOSE_TAG', '</h2>'); | ||
| + | define('GRID_AREA_LANGUAGE', 'en'); | ||
| + | define('SYSTEM_LANGUAGE', 'en'); | ||
| + | define('DEFAULT_PAGE_SIZE_GRID', 50); | ||
| + | define('DEFAULT_PAGE_SIZE_ADMIN', 50); | ||
| + | define('FEEDBACK_MSG_DELAY', 5000); | ||
| - | // --- | + | define('PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH', 300); |
| - | // widths of combo - boxes in user grid pages | + | define('PHPGRID_EDIT_FORM_DEFAULT_WIDTH', 500); |
| - | // configurable settings: | + | define('WIDTH_TABLE_SELECTOR', '320px'); |
| - | // | + | define('WIDTH_FILTER_CONNECTION', '150px'); |
| - | // PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH width of lookup combo during grid editing | + | define('WIDTH_FILTER_CATEGORY', '150px'); |
| - | // PHPGRID_EDIT_FORM_DEFAULT_WIDTH width of default edit form | + | |
| - | // WIDTH_TABLE_SELECTOR width of table selector drop down list | + | |
| - | // WIDTH_FILTER_CONNECTION width of connection filter drop down list | + | |
| - | // WIDTH_FILTER_CATEGORY width of category filter drop down list | + | |
| - | // | + | |
| - | // --- | + | |
| - | define('PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH', 300); | + | |
| - | define('PHPGRID_EDIT_FORM_DEFAULT_WIDTH', 500); | + | |
| - | define('WIDTH_TABLE_SELECTOR', '320px'); | + | |
| - | define('WIDTH_FILTER_CONNECTION', '150px'); | + | |
| - | define('WIDTH_FILTER_CATEGORY', '150px'); | + | |
| - | // --- | + | define('SHOW_TABLE_SELECTOR_BY_DEFAULT', true); |
| - | // content of table selector combo-box in user grid pages | + | define('DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN', '%desc%'); |
| - | // configurable settings: | + | define('DEFAULT_CATALOG_ORDER_BY', 'conn_name, object, instance_name'); |
| - | // | + | |
| - | // SHOW_TABLE_SELECTOR_BY_DEFAULT true/false (show / hide table selector) | + | |
| - | // DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN pattern and list of pattern-variables to build the table list ( | + | |
| - | // DEFAULT_CATALOG_ORDER_BY order by clause of catalog list (SQL syntax qualified with "g." | + | |
| - | // pattern for combo box in main grid page | + | |
| - | // %cat_id% : catalog id | + | |
| - | // %inst_name% : instance name | + | |
| - | // %conn_name% : connection name | + | |
| - | // %conn_disp_name% : connection display name | + | |
| - | // %obj% : the catalog object name (table or view name) | + | |
| - | // %desc% : description (not recommended, can be too long) | + | |
| - | // %obj_cat% : object category | + | |
| - | // | + | |
| - | // --- | + | |
| - | define('SHOW_TABLE_SELECTOR_BY_DEFAULT', true); | + | |
| - | define('DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN', '%desc%'); | + | |
| - | define('DEFAULT_CATALOG_ORDER_BY', 'g.conn_name, g.object, g.instance_name'); | + | |
| </code> | </code> | ||
| - | === format files === | + | ==== formatter files - look and feel of catalog object ==== |
| == APPLY_CUSTOM_FORMATTING == | == APPLY_CUSTOM_FORMATTING == | ||
| Line 137: | Line 132: | ||
| == CUSTOM_FORMATTING_BY_CATALOG_NAME == | == CUSTOM_FORMATTING_BY_CATALOG_NAME == | ||
| Switch to toggle if formatter files are allocated by the name of the catalog object or not. | Switch to toggle if formatter files are allocated by the name of the catalog object or not. | ||
| + | |||
| * ''true'' - format objects by names is active | * ''true'' - format objects by names is active | ||
| Line 143: | Line 139: | ||
| This folder is also root folder for the database formatter files (arranged by connection)!!! | This folder is also root folder for the database formatter files (arranged by connection)!!! | ||
| The simple table name is the name of the formatter file e.g. for table dbo.T_CURRENCY the formatter file is ''T_CURRENCY.php'' | The simple table name is the name of the formatter file e.g. for table dbo.T_CURRENCY the formatter file is ''T_CURRENCY.php'' | ||
| - | + | ||
| * ''false'' - format objects by catalog ID is active | * ''false'' - format objects by catalog ID is active | ||
| Line 166: | Line 162: | ||
| == CUSTOM_FORMAT_FILE_GENERAL == | == CUSTOM_FORMAT_FILE_GENERAL == | ||
| - | Format file name in folder CUSTOM_FORMAT_SUBFOLDER_GENERAL as overall format file. Applied always as first formatter | + | Formatter file name in folder CUSTOM_FORMAT_SUBFOLDER_GENERAL as overall format file. Applied always as first formatter |
| == CUSTOM_FORMAT_FILE_SPLIT_BY_LANGUAGE == | == CUSTOM_FORMAT_FILE_SPLIT_BY_LANGUAGE == | ||
| - | + | ||
| * ''true'' - on tablename level or/and catalog id level a formatter file with a language code of the activated language is applied as well | * ''true'' - on tablename level or/and catalog id level a formatter file with a language code of the activated language is applied as well | ||
| - | e.g. T_CURRENCY_en.php or 202_en.php | + | e.g. ''T_CURRENCY_en.php'' or ''202_en.php'' |
| - | + | ||
| <code> | <code> | ||
| - | define('APPLY_CUSTOM_FORMATTING', true); | + | define('APPLY_CUSTOM_FORMATTING', true); |
| - | define('CUSTOM_FORMATTING_BY_CATALOG_NAME', true); | + | define('CUSTOM_FORMATTING_BY_CATALOG_NAME', true); |
| - | define('CUSTOM_FORMAT_FOLDER', 'formattings'); | + | define('CUSTOM_FORMAT_FOLDER', 'formattings'); |
| - | define('CUSTOM_FORMAT_SUBFOLDER_GENERAL', 'general'); | + | define('CUSTOM_FORMAT_SUBFOLDER_GENERAL', 'general'); |
| - | define('CUSTOM_FORMAT_SUBFOLDER_CATALOG_ID', 'catalog_id'); | + | define('CUSTOM_FORMAT_SUBFOLDER_CATALOG_ID', 'catalog_id'); |
| - | define('CUSTOM_FORMAT_SUBFOLDER_CONNECTION', 'connection'); | + | define('CUSTOM_FORMAT_SUBFOLDER_CONNECTION', 'connection'); |
| - | define('CUSTOM_FORMAT_SUBFOLDER_IMAGES', 'images'); | + | define('CUSTOM_FORMAT_SUBFOLDER_IMAGES', 'images'); |
| - | define('CUSTOM_FORMAT_FILE_GENERAL', 'my_format_all.php'); | + | define('CUSTOM_FORMAT_FILE_GENERAL', 'my_format_all.php'); |
| - | define('CUSTOM_FORMAT_FILE_SPLIT_BY_LANGUAGE', true); | + | define('CUSTOM_FORMAT_FILE_SPLIT_BY_LANGUAGE', true); |
| </code> | </code> | ||
| - | <code> | + | ==== help system - welcome page ==== |
| - | // --- | + | You can configure the system to display a welcome info on the login page and also that the help icon open your own help pages. |
| - | // help and info settings | + | When in your webhelp folder a file with then name ''login_help.html'' is available, then the content of this file will be displayed right to the login form. |
| - | // configurable settings: | + | |
| - | // | + | |
| - | // CUSTOM_HELP_FILE_SPLIT_BY_LANGUAGE true/false does the default login_help.html exist on language level or not (login_help_en.html or login_help.html) | + | |
| - | // HELP_CUSTOM_FILE_GRID URL to own help pages - called from grid editing | + | |
| - | // HELP_CUSTOM_FILE_ADMIN URL to own help pages - called from admin pages | + | |
| - | // | + | |
| - | // URLs for help pages may contain placeholders | + | |
| - | // $documentRoot - document root direcotry of Apache | + | |
| - | // $confFolder - substituted as 'conf' | + | |
| - | // $clientFolder - current client folder | + | |
| - | // $niotaRoot - path part which strats at Apache's document root and ends at 'niota' folder | + | |
| - | // $customFormatFolder - substituted as 'formattings' | + | |
| - | // $languageCode - en / de | + | |
| - | // $tableName - current catalog-object-instance object name. | + | |
| - | // $adminPage - references for 'option key' (ok) in the page URL of the current admin page. Only for 'HELP_CUSTOM_FILE_ADMIN' | + | |
| - | // | + | |
| - | // Important! If you use proxy then do not use the variable $documentRoot - it will resolves the IP address/DNS | + | |
| - | // of the source machine! Instead you can define absoulte path from the document root. | + | |
| - | // E.g. #1: "/niota/conf/my-folder/my-help.html" ==> refers to file | + | |
| - | // 'C://Apache24/htdocs/niota/conf/my-folder/my-help.html' or | + | |
| - | // '/var/www/htdocs/niota/conf/my-folder/my-help.html' | + | |
| - | // | + | |
| - | // E.g. #2: $niotaRoot/$confFolder/$clientFolder/$customFormatFolder/webhelp/my-help.html ==> refers to file | + | |
| - | // 'C://Apache24/htdocs/niota/conf/my-cilent/formattings/webhelp/my-help.html' or | + | |
| - | // '/var/www/htdocs/niota/conf/my-cilent/formattings/webhelp/my-hlep.html' | + | |
| - | // | + | |
| - | // see some further samples below: | + | |
| - | // | + | |
| - | // define('HELP_CUSTOM_FILE_GRID', '$documentRoot/$niotaRoot/$customFormatFolder/webhelp/$languageCode/$tableName.html'); | + | |
| - | // define('HELP_CUSTOM_FILE_GRID', 'http://www.niota.at'); | + | |
| - | // define('HELP_CUSTOM_FILE_ADMIN', '$documentRoot/$niotaRoot/$customFormatFolder/webhelp/$languageCode/$adminPage.html'); | + | |
| - | // define('HELP_CUSTOM_FILE_ADMIN', 'http://www.niota.at'); | + | |
| - | // | + | |
| - | // --- | + | |
| - | define ('CUSTOM_HELP_FILE_SPLIT_BY_LANGUAGE', true); | + | |
| - | define('HELP_CUSTOM_FILE_GRID', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$installation/$userName.html'); | + | |
| - | //define('HELP_CUSTOM_FILE_GRID', 'http://www.niota.at'); | + | |
| - | //define('HELP_CUSTOM_FILE_ADMIN', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$adminPage.html'); | + | |
| - | define('HELP_CUSTOM_FILE_ADMIN', 'http://www.niota.at'); | + | |
| - | + | ||
| - | //define('HELP_CUSTOM_FILE_ADMIN', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$adminPage.html'); | + | |
| - | + | ||
| - | // --- | + | |
| - | // END OF GENERAL FORMAT OPTIONS | + | |
| - | // --- | + | |
| - | + | ||
| - | // --- | + | |
| - | // DEPRECATED FORMAT OPTIONS --- WILL BE REMOVED IN ONE OF THE NEXT RELEASES | + | |
| - | // --- | + | |
| - | define('CUSTOM_WEB_DOCS_IN_LANG_FOLDER', true); | + | |
| - | </code> | + | == CUSTOM_HELP_FILE_SPLIT_BY_LANGUAGE == |
| + | * ''true'' - the default login help page does exist on language level (suffixed by _<language_code>.html) | ||
| + | * ''false'' - the default login help page does exist on language level | ||
| + | Mind that at login time the user language code is not available yet. Therefore the system language code must be applied to find the proper login help page. | ||
| - | // | + | == HELP_CUSTOM_FILE_GRID / HELP_CUSTOM_FILE_ADMIN == |
| - | // | + | URL to own help pages - called from grid editing or admin pages. |
| + | URLs for help pages may contain placeholders | ||
| + | ''$documentRoot'' - document root direcotry of Apache | ||
| + | ''$confFolder'' - substituted as 'conf' | ||
| + | ''$clientFolder'' - current client folder | ||
| + | ''$niotaRoot'' - path part which strats at Apache's document root and ends at 'niota' folder | ||
| + | ''$customFormatFolder'' - substituted as 'formattings' | ||
| + | ''$languageCode'' - default language code for grid pages | ||
| + | ''$tableName'' - current catalog-object-instance object name | ||
| + | ''$adminPage'' - references for 'option key' (ok) in the page URL of the current admin page. Only for 'HELP_CUSTOM_FILE_ADMIN' | ||
| + | ** Important! If you use a proxy then do not use the variable $documentRoot - it will resolve the IP address/DNS of the source machine! Instead you can define absolute path from the document root. | ||
| + | ** | ||
| + | |||
| + | <code> | ||
| + | define ('CUSTOM_HELP_FILE_SPLIT_BY_LANGUAGE', true); | ||
| + | define('HELP_CUSTOM_FILE_GRID', '$niotaRoot/$confFolder/$customFormatFolder/webhelp/$languageCode/$installation/$userName.html'); | ||
| + | define('HELP_CUSTOM_FILE_ADMIN', 'http://www.niota.at'); | ||
| + | </code> | ||
niota-docs/niota_system_config_formatting.1642853601.txt.gz · Last modified: 2025/07/17 14:11 (external edit)