mirror of
https://github.com/smarty-php/smarty.git
synced 2025-08-06 11:24:27 +02:00
indentation
This commit is contained in:
@@ -3,17 +3,12 @@
|
||||
<chapter id="config.files">
|
||||
<title>Config Files</title>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<example>
|
||||
<title>Example of config file syntax</title>
|
||||
@@ -45,78 +40,50 @@ pass=foobar
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>
|
||||
Values of
|
||||
<link linkend="language.config.variables">config file
|
||||
variables</link>
|
||||
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 <literal>
|
||||
#</literal>
|
||||
(hash) at the beginning of the line.
|
||||
Values of <link linkend="language.config.variables">config file
|
||||
variables</link> 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 <literal>
|
||||
#</literal> (hash) at the beginning of the line.
|
||||
</para>
|
||||
<para>
|
||||
This config file example has two sections. Section names are
|
||||
enclosed in
|
||||
brackets []. Section names can be arbitrary strings not
|
||||
containing
|
||||
<literal>[</literal> or <literal>]</literal> 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
|
||||
<link linkend="variable.config.overwrite">
|
||||
$config_overwrite</link>
|
||||
is disabled.
|
||||
enclosed in brackets []. Section names can be arbitrary strings not
|
||||
containing <literal>[</literal> or <literal>]</literal> 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 <link linkend="variable.config.overwrite">
|
||||
$config_overwrite</link> is disabled.
|
||||
</para>
|
||||
<para>
|
||||
Config files are loaded into templates with the built-in
|
||||
function
|
||||
<link
|
||||
linkend="language.function.config.load"><command>
|
||||
{config_load}</command></link>
|
||||
(see also
|
||||
<link
|
||||
Config files are loaded into templates with the built-in function
|
||||
<link linkend="language.function.config.load"><command>
|
||||
{config_load}</command></link> (see also <link
|
||||
linkend="api.config.load"><command>config_load()</command></link> ).
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
See also <link
|
||||
linkend="language.function.config.load">{config_load}</link>, <link
|
||||
linkend="variable.config.overwrite">$config_overwrite</link>, <link
|
||||
linkend="api.get.config.vars">get_config_vars()</link>, <link
|
||||
linkend="api.clear.config">clear_config()</link> and <link
|
||||
linkend="api.config.load">config_load()</link>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
See also
|
||||
<link linkend="language.function.config.load">{config_load}</link>,
|
||||
<link linkend="variable.config.overwrite">$config_overwrite</link>,
|
||||
<link linkend="api.get.config.vars">get_config_vars()</link>,
|
||||
<link linkend="api.clear.config">clear_config()</link>
|
||||
and
|
||||
<link linkend="api.config.load">config_load()</link>
|
||||
</para>
|
||||
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
@@ -137,4 +104,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
|
Reference in New Issue
Block a user