niota

fascinating. logical.

User Tools

Site Tools


niota-docs:niota_system_config_formatting

This is an old revision of the document!


configure format / look and feel

There are a lot of option you can set by changing the values of pre-defined system variables.

navigate to the configuration folder of the client where you want to change the settings.

corporate design - colors, backgrounds, display options

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.

 define('COLOR_THEME', 				'VEGA');
 define('COLOR_THEME_ADMIN', 			'SALVA');

Valid values for the themename can be found on the system constants page (→ link)

Name of a .png - file that is displayed as logo.

PRODUCT_NAME

Name of the product. Shown on the upper left corner in the top menu bar. May be adapted to your needs.

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.

 define('COMPANY_LOGO',      'niota_logo.png');
 define('PRODUCT_NAME',      'niota');
 define('CLAIM',             '.fascinating.logical');
 define('INSTALLATION_NAME', 'demo');

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

10, 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.

<code>%cat_id%</code> - 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)

 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);
 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);
 define('DEFAULT_CATALOG_DISPLAY_TEXT_PATTERN', '%desc%');
 define('DEFAULT_CATALOG_ORDER_BY',             'conn_name, object, instance_name');

formatter files - look and feel of catalog object

APPLY_CUSTOM_FORMATTING

Switch to turn on custom formatting files or to turn it of completely.

  • true - apply custom formatting (generic, database level, table level)
  • false - switch of all custom formatting
CUSTOM_FORMAT_FOLDER

Root folder of custom format files - this path is relative to the client root folder.

CUSTOM_FORMATTING_BY_CATALOG_NAME

Switch to toggle if formatter files are allocated by the name of the catalog object or not.

  • true - format objects by names is active

CUSTOM_FORMAT_FOLDER + / + FORMATFOLDER_SUBFOLDER_CONNECTION folder is the root of the formatter files. Connection subfolders are mandatory!!! 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

  • false - format objects by catalog ID is active

CUSTOM_FORMAT_FOLDER + / + FORMATFOLDER_SUBFOLDER_CATALOG_ID folder is the root of the formatter files. The catalog id of an object is the name of the formatter file. E.g. for table dbo.T_CURRENCY the formatter file could be 202.php

CUSTOM_FORMAT_SUBFOLDER_GENERAL

Subfolder of CUSTOM_FORMAT_FOLDER where generic format files are located

CUSTOM_FORMAT_SUBFOLDER_CATALOG_ID

Subfolder of CUSTOM_FORMAT_FOLDER where format files are located when formatter files are named like the catalog id. (if CUSTOM_FORMATTING_BY_CATALOG_NAME = false)

CUSTOM_FORMAT_SUBFOLDER_IMAGES

Subfolder of CUSTOM_FORMAT_FOLDER for menu item images and own icons and background images

CUSTOM_FORMAT_SUBFOLDER_CONNECTION

Subfolder of CUSTOM_FORMAT_FOLDER for format folders on connectionlevel (if CUSTOM_FORMATTING_BY_CATALOG_NAME = true)

CUSTOM_FORMAT_FILE_GENERAL

Formatter file name in folder CUSTOM_FORMAT_SUBFOLDER_GENERAL as overall format file. Applied always as first formatter

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

e.g. T_CURRENCY_en.php or 202_en.php

	
 define('APPLY_CUSTOM_FORMATTING',              true);
 define('CUSTOM_FORMATTING_BY_CATALOG_NAME',    true);
 define('CUSTOM_FORMAT_FOLDER',                'formattings');
 define('CUSTOM_FORMAT_SUBFOLDER_GENERAL',     'general');
 define('CUSTOM_FORMAT_SUBFOLDER_CATALOG_ID',  'catalog_id');
 define('CUSTOM_FORMAT_SUBFOLDER_CONNECTION',  'connection');
 define('CUSTOM_FORMAT_SUBFOLDER_IMAGES',      'images');
 define('CUSTOM_FORMAT_FILE_GENERAL',          'my_format_all.php');
 define('CUSTOM_FORMAT_FILE_SPLIT_BY_LANGUAGE', true);

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. 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.

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.

	
 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');	
niota-docs/niota_system_config_formatting.1650561131.txt.gz · Last modified: 2025/07/17 14:11 (external edit)