Differences

This shows you the differences between two versions of the page.

--- niota-docs:niota_system_config_formatting [2022/01/22 13:46]
admin
+++ niota-docs:niota_system_config_formatting [2025/07/17 14:11] (current)
@@ Line 10: / Line 10: @@
 == 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.
-== 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>
@@ Line 36: / Line 25: @@
 == CLAIM ==
+Text that is displayed as claim next to the product name. May be adapted to your needs.
 == INSTALLATION_NAME ==
+Internal name of the installation. This value can be used in character string substitution later.
 <code>
@@ Line 45: / Line 36: @@
  define('INSTALLATION_NAME', 'demo');
 </code>
+==== default languages, window sizes, colors and pagination ====
+== COLOR_INACTIV_TEXT /  COLOR_INACTIV_BACKGROUND ==
+== FORMSIZE_ADMINPAGE_SMALL / FORMSIZE_ADMINPAGE_MEDIUM / FORMSIZE_ADMINPAGE_LARGE ==
+== CAPTION_ADMINPAGE_OPEN_TAG / CAPTION_ADMINPAGE_CLOSE_TAG ==
+== GRID_AREA_LANGUAGE ==
+  * ''de'' - GERMAN/DEUTSCH
+  * ''en'' - ENGLISH/ENGLISCH
+== FEEDBACK_MSG_DELAY  ==
+Delay time of hide grid editing feedback message (milliseconds)
+== DEFAULT_PAGE_SIZE_GRID / DEFAULT_PAGE_SIZE_ADMIN ==
+The number of rows on grid pages / admin pages
+, 20, 30, 50, 100, -1 (all rows)
+== PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH  ==
+Width of lookup combo during grid editing
+== 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
+== 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.
+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');
-	// colors and form dimension for admin pages
+ define('COLOR_INACTIV_BACKGROUND',    '#E6E6E6');
-	// ---
+ define('FORMSIZE_ADMINPAGE_SMALL',    '600');
-	define('COLOR_INACTIV_TEXT',			'#FF0040');
+ define('FORMSIZE_ADMINPAGE_MEDIUM',   '800');
-	define('COLOR_INACTIV_BACKGROUND',		'#E6E6E6');
+ define('FORMSIZE_ADMINPAGE_LARGE',    '1200');
-	define('FORMSIZE_ADMINPAGE_SMALL',		'600');
+ define('CAPTION_ADMINPAGE_OPEN_TAG',  '<h2>');
-	define('FORMSIZE_ADMINPAGE_MEDIUM',		'800');
+ define('CAPTION_ADMINPAGE_CLOSE_TAG', '</h2>');
-	define('FORMSIZE_ADMINPAGE_LARGE',		'1200');
+ define('GRID_AREA_LANGUAGE',          'en');
-	define('CAPTION_ADMINPAGE_OPEN_TAG',    '<h2>');
+ define('SYSTEM_LANGUAGE',             'en');
-	define('CAPTION_ADMINPAGE_CLOSE_TAG',   '</h2>');
+ define('DEFAULT_PAGE_SIZE_GRID',       50);
+ define('DEFAULT_PAGE_SIZE_ADMIN',      50);
+ define('FEEDBACK_MSG_DELAY',           5000);
-	// ---
+ define('PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH', 300);
-	// page headers
+ define('PHPGRID_EDIT_FORM_DEFAULT_WIDTH',    500);
-	// configurable settings:
+ define('WIDTH_TABLE_SELECTOR',               '320px');
-	//
+ define('WIDTH_FILTER_CONNECTION',            '150px');
-	// COMPANY_LOGO 		use small .png image with your companies logo
+ define('WIDTH_FILTER_CATEGORY',              '150px');
-	// PRODUCT_NAME			default "niota" - you can rename it to your needs
-	// 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
-	//
-	// ---
-	// ---
+ define('SHOW_TABLE_SELECTOR_BY_DEFAULT',       true);
-	// grid area
+ define('DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN', '%desc%');
-	//
+ define('DEFAULT_CATALOG_ORDER_BY',             'conn_name, object, instance_name');
-	// GRID_AREA_LANGUAGE
-	// 	de				GERMAND/DEUTSCH
-	// 	en				ENGLISH/ENGLISCH
-	// FEEDBACK_MSG_DELAY				delay time of hide grid editing feedback message (milliseconds)
-	// DEFAULT_PAGE_SIZE_GRID 			the number of rows on user grid pages
-	// DEFAULT_PAGE_SIZE_ADMIN			the number of rows on admin pages
-	// 	10, 20, 30, 50, 100, -1 (all rows)
-	//
-	// ---
-	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);
-	// ---
-	// widths of combo - boxes in user grid pages
-	// configurable settings:
-	//
-	// PHPGRID_LOOKUP_COMBO_DEFAULT_WIDTH		width of lookup combo during grid editing
-	// 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');
-	// ---
-	// content of table selector combo-box in user grid pages
-	// configurable settings:
-	//
-	// 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>
@@ Line 199: / Line 190: @@
   * ''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 ==
@@ Line 209: / Line 202: @@
 ''$niotaRoot'' - path part which strats at Apache's document root and ends at 'niota' folder
 ''$customFormatFolder'' - substituted as 'formattings'
-''$languageCode'' - en / de
+''$languageCode'' - default language code for grid pages
-''$tableName'' - current catalog-object-instance object name.
+''$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'

niota

User Tools

Site Tools

Differences

Page Tools