diff --git a/docs/en/designers/config-files.xml b/docs/en/designers/config-files.xml index eed22a5d..d41b705a 100644 --- a/docs/en/designers/config-files.xml +++ b/docs/en/designers/config-files.xml @@ -3,17 +3,12 @@ Config Files - Config files are handy for designers to manage global - template - variables from one file. One example is template colors. - Normally if - you wanted to change the color scheme of an application, you - would have - to go through each and every template file and change the - colors. With - a config file, the colors can be kept in one place, and only - one file - needs to be updated. + Config files are handy for designers to manage global template + variables from one file. One example is template colors. Normally + if you wanted to change the color scheme of an application, you + would have to go through each and every template file and change the + colors. With a config file, the colors can be kept in one place, and + only one file needs to be updated. Example of config file syntax @@ -45,78 +40,50 @@ pass=foobar - Values of - config file - variables - can be in quotes, but not necessary. - You can use either single or double quotes. If you have a - value that - spans more than one line, enclose the entire value with - triple quotes - ("""). You can put comments into config files by any syntax - that is not - a valid config file syntax. We recommend using a - # - (hash) at the beginning of the line. + Values of config file + variables can be in quotes, but not necessary. You can use + either single or double quotes. If you have a value that spans more + than one line, enclose the entire value with triple quotes + ("""). You can put comments into config files by any syntax that is + not a valid config file syntax. We recommend using a + # (hash) at the beginning of the line. This config file example has two sections. Section names are - enclosed in - brackets []. Section names can be arbitrary strings not - containing - [ or ] symbols. The - four variables - at the top are global variables, or variables not within a - section. - These variables are always loaded from the config file. If a - particular - section is loaded, then the global variables and the - variables from that - section are also loaded. If a variable exists both as a - global and in a - section, the section variable is used. If you name two - variables the - same within a section, the last one will be used unless - - $config_overwrite - is disabled. + enclosed in brackets []. Section names can be arbitrary strings not + containing [ or ] symbols. The + four variables at the top are global variables, or variables not + within a section. These variables are always loaded from the config + file. If a particular section is loaded, then the global variables + and the variables from that section are also loaded. If a variable + exists both as a global and in a section, the section variable is + used. If you name two variables the same within a section, the last + one will be used unless + $config_overwrite is disabled. - Config files are loaded into templates with the built-in - function - - {config_load} - (see also - + {config_load} (see also config_load() ). - You can hide variables or entire sections by prepending the - variable + You can hide variables or entire sections by prepending the variable name or section name with a period. This is useful if your - application - reads the config files and gets sensitive data from them - that the - template engine does not need. If you have third parties - doing template - editing, you can be certain that they cannot read sensitive - data from - the config file by loading it into the template. + application reads the config files and gets sensitive data from them + that the template engine does not need. If you have third parties + doing template editing, you can be certain that they cannot read + sensitive data from the config file by loading it into the template. + + + See also {config_load}, $config_overwrite, get_config_vars(), clear_config() and config_load() - - - See also - {config_load}, - $config_overwrite, - get_config_vars(), - clear_config() - and - config_load() - - - -