mirror of
https://github.com/smarty-php/smarty.git
synced 2025-11-01 21:01:37 +01:00
9d4d0c08a1
- domain.com => example.com, as suggested by RFC 2606 - fix and introduce more dockbook tags - fix white spaces and use CDATA sections - add some paras to make the text more reader friendly
95 lines
3.1 KiB
XML
95 lines
3.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<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.
|
|
</para>
|
|
<example>
|
|
<title>Example of config file syntax</title>
|
|
<programlisting>
|
|
<![CDATA[
|
|
# global variables
|
|
pageTitle = "Main Menu"
|
|
bodyBgColor = #000000
|
|
tableBgColor = #000000
|
|
rowBgColor = #00ff00
|
|
|
|
[Customer]
|
|
pageTitle = "Customer Info"
|
|
|
|
[Login]
|
|
pageTitle = "Login"
|
|
focus = "username"
|
|
Intro = """This is a value that spans more
|
|
than one line. you must enclose
|
|
it in triple quotes."""
|
|
|
|
# hidden section
|
|
[.Database]
|
|
host=my.example.com
|
|
db=ADDRESSBOOK
|
|
user=php-user
|
|
pass=foobar
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<para>
|
|
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 <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.
|
|
</para>
|
|
<para>
|
|
Config files are loaded into templates with the built-in function
|
|
<command>config_load</command>.
|
|
</para>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</chapter>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|