Fixed several typos and grammar errors (#821)

This commit is contained in:
Andrew Dawes
2022-10-22 22:08:38 +02:00
committed by GitHub
parent 1ff79c6c38
commit f81720941c
31 changed files with 43 additions and 43 deletions

View File

@ -109,7 +109,7 @@ the corresponding error is in the template.
- This means that your application registered a custom error hander - This means that your application registered a custom error handler
(using [set\_error\_handler()](&url.php-manual;set_error_handler)) (using [set\_error\_handler()](&url.php-manual;set_error_handler))
which is not respecting the given `$errno` as it should. If, for which is not respecting the given `$errno` as it should. If, for
whatever reason, this is the desired behaviour of your custom error whatever reason, this is the desired behaviour of your custom error

View File

@ -3,14 +3,14 @@
`{block}` is used to define a named area of template source for template `{block}` is used to define a named area of template source for template
inheritance. For details see section of [Template inheritance. For details see section of [Template
Interitance](#advanced.features.template.inheritance). Inheritance](#advanced.features.template.inheritance).
The `{block}` template source area of a child template will replace the The `{block}` template source area of a child template will replace the
correponding areas in the parent template(s). corresponding areas in the parent template(s).
Optionally `{block}` areas of child and parent templates can be merged Optionally `{block}` areas of child and parent templates can be merged
into each other. You can append or prepend the parent `{block}` content into each other. You can append or prepend the parent `{block}` content
by using the `append` or `prepend` option flag with the childs `{block}` by using the `append` or `prepend` option flag with the child's `{block}`
definition. With the {\$smarty.block.parent} the `{block}` content of definition. With the {\$smarty.block.parent} the `{block}` content of
the parent template can be inserted at any location of the child the parent template can be inserted at any location of the child
`{block}` content. {\$smarty.block.child} inserts the `{block}` content `{block}` content. {\$smarty.block.child} inserts the `{block}` content

View File

@ -3,7 +3,7 @@
`{extends}` tags are used in child templates in template inheritance for `{extends}` tags are used in child templates in template inheritance for
extending parent templates. For details see section of [Template extending parent templates. For details see section of [Template
Interitance](#advanced.features.template.inheritance). Inheritance](#advanced.features.template.inheritance).
- The `{extends}` tag must be on the first line of the template. - The `{extends}` tag must be on the first line of the template.
@ -33,5 +33,5 @@ Interitance](#advanced.features.template.inheritance).
See also [Template Interitance](#advanced.features.template.inheritance) See also [Template Inheritance](#advanced.features.template.inheritance)
and [`{block}`](#language.function.block). and [`{block}`](#language.function.block).

View File

@ -2,7 +2,7 @@
===== =====
The `{for}{forelse}` tag is used to create simple loops. The following The `{for}{forelse}` tag is used to create simple loops. The following
different formarts are supported: different formats are supported:
- `{for $var=$start to $end}` simple loop with step size of 1. - `{for $var=$start to $end}` simple loop with step size of 1.

View File

@ -131,7 +131,7 @@ cache lifetime of 500 seconds.
In this example included template will be cached independent of the In this example included template will be cached independent of the
global cahing setting. global caching setting.
{include 'sub_template.tpl' caching} {include 'sub_template.tpl' caching}

View File

@ -65,7 +65,7 @@ and display the returned results in place of the {insert} tag.
The path can be either absolute, or relative to The path can be either absolute, or relative to
[`$trusted_dir`](#variable.trusted.dir). If security is enabled, [`$trusted_dir`](#variable.trusted.dir). If security is enabled,
then the script must be located in the `$trusted_dir` path of the then the script must be located in the `$trusted_dir` path of the
securty policy. See the [Security](#advanced.features.security) security policy. See the [Security](#advanced.features.security)
section for details. section for details.
The Smarty object is passed as the second argument. This way you can The Smarty object is passed as the second argument. This way you can

View File

@ -251,8 +251,8 @@ The above example will output:
{section}\'s can be nested as deep as you like. With nested {section}\'s can be nested as deep as you like. With nested
{section}\'s, you can access complex data structures, such as {section}\'s, you can access complex data structures, such as
multi-dimensional arrays. This is an example `.php` script thats multi-dimensional arrays. This is an example `.php` script that
assign\'s the arrays. assigns the arrays.
<?php <?php

View File

@ -10,7 +10,7 @@ The filter can be:
- A variable filter plugin specified by it\'s name. - A variable filter plugin specified by it\'s name.
- A modidier specified by it\'s name and optional additional - A modifier specified by it\'s name and optional additional
parameter. parameter.
`{setfilter}...{/setfilter}` blocks can be nested. The filter definition `{setfilter}...{/setfilter}` blocks can be nested. The filter definition

View File

@ -22,7 +22,7 @@ ftp and display the contents.
> >
> If security is enabled and you are fetching a file from the local > If security is enabled and you are fetching a file from the local
> file system, `{fetch}` will only allow files from within the > file system, `{fetch}` will only allow files from within the
> `$secure_dir` path of the securty policy. See the > `$secure_dir` path of the security policy. See the
> [Security](#advanced.features.security) section for details. > [Security](#advanced.features.security) section for details.
- If the `assign` attribute is set, the output of the `{fetch}` - If the `assign` attribute is set, the output of the `{fetch}`

View File

@ -19,7 +19,7 @@ automatically calculated from the image file if they are not supplied.
from. If not given, the web server\'s document root from. If not given, the web server\'s document root
`$_ENV['DOCUMENT_ROOT']` is used as the base. If security is `$_ENV['DOCUMENT_ROOT']` is used as the base. If security is
enabled, then the image must be located in the `$secure_dir` path of enabled, then the image must be located in the `$secure_dir` path of
the securty policy. See the [Security](#advanced.features.security) the security policy. See the [Security](#advanced.features.security)
section for details. section for details.
- `href` is the href value to link the image to. If link is supplied, - `href` is the href value to link the image to. If link is supplied,

View File

@ -115,7 +115,7 @@ These parameters follow the modifier name and are separated by a `:`
- Secondly - if security is enabled, all php-functions that are to - Secondly - if security is enabled, all php-functions that are to
be used as modifiers have to be declared trusted in the be used as modifiers have to be declared trusted in the
`$modifiers` property of the securty policy. See the `$modifiers` property of the security policy. See the
[Security](../programmers/advanced-features/advanced-features-security.md) section for details. [Security](../programmers/advanced-features/advanced-features-security.md) section for details.
See also [`registerPlugin()`](../programmers/api-functions/api-register-plugin.md), [combining See also [`registerPlugin()`](../programmers/api-functions/api-register-plugin.md), [combining

View File

@ -15,5 +15,5 @@ modifier](#language.modifier.to_charset).
> modifier should only be used in cases where the application cannot > modifier should only be used in cases where the application cannot
> anticipate that a certain string is required in another encoding. > anticipate that a certain string is required in another encoding.
See also [Charset Enconding](#charset), [from\_charset See also [Charset Encoding](#charset), [from\_charset
modifier](#language.modifier.from_charset). modifier](#language.modifier.from_charset).

View File

@ -15,5 +15,5 @@ modifier](#language.modifier.from_charset).
> modifier should only be used in cases where the application cannot > modifier should only be used in cases where the application cannot
> anticipate that a certain string is required in another encoding. > anticipate that a certain string is required in another encoding.
See also [Charset Enconding](#charset), [from\_charset See also [Charset Encoding](#charset), [from\_charset
modifier](#language.modifier.from_charset). modifier](#language.modifier.from_charset).

View File

@ -157,13 +157,13 @@ Returns the version of Smarty the template was compiled with.
---------------------- ----------------------
Returns block text from child template. See [Template Returns block text from child template. See [Template
interitance](#advanced.features.template.inheritance). inheritance](#advanced.features.template.inheritance).
{\$smarty.block.parent} {#language.variables.smarty.block.parent} {\$smarty.block.parent} {#language.variables.smarty.block.parent}
----------------------- -----------------------
Returns block text from parent template. See [Template Returns block text from parent template. See [Template
interitance](#advanced.features.template.inheritance) inheritance](#advanced.features.template.inheritance)
{\$smarty.ldelim}, {\$smarty.rdelim} {#language.variables.smarty.ldelim} {\$smarty.ldelim}, {\$smarty.rdelim} {#language.variables.smarty.ldelim}
------------------------------------ ------------------------------------

View File

@ -29,7 +29,7 @@ determined by your needs, but use the first method whenever possible to
keep template syntax to a minimum. keep template syntax to a minimum.
If security is enabled, no private methods or functions can be accessed If security is enabled, no private methods or functions can be accessed
(beginningwith \'\_\'). If a method and property of the same name exist, (beginning with \'\_\'). If a method and property of the same name exist,
the method will be used. the method will be used.
You can restrict the methods and properties that can be accessed by You can restrict the methods and properties that can be accessed by

View File

@ -2,7 +2,7 @@ Security {#advanced.features.security}
======== ========
Security is good for situations when you have untrusted parties editing Security is good for situations when you have untrusted parties editing
the templates eg via ftp, and you want to reduce the risk of system the templates e.g. via ftp, and you want to reduce the risk of system
security compromises through the template language. security compromises through the template language.
The settings of the security policy are defined by properties of an The settings of the security policy are defined by properties of an
@ -10,7 +10,7 @@ instance of the Smarty\_Security class. These are the possible settings:
- `$secure_dir` is an array of template directories that are - `$secure_dir` is an array of template directories that are
considered secure. [`$template_dir`](#variable.template.dir) considered secure. [`$template_dir`](#variable.template.dir)
concidered secure implicitly. The default is an empty array. considered secure implicitly. The default is an empty array.
- `$trusted_dir` is an array of all directories that are considered - `$trusted_dir` is an array of all directories that are considered
trusted. Trusted directories are where you keep php scripts that are trusted. Trusted directories are where you keep php scripts that are
@ -27,7 +27,7 @@ instance of the Smarty\_Security class. These are the possible settings:
like authentication-tokens). like authentication-tokens).
The expression `'#https?://.*smarty.net$#i'` would allow accessing The expression `'#https?://.*smarty.net$#i'` would allow accessing
the follwing URIs: the following URIs:
- `http://smarty.net/foo` - `http://smarty.net/foo`
@ -140,5 +140,5 @@ Smarty\_Security class or create an instance of it.
> **Note** > **Note**
> >
> Most security policy settings are only checked when the template gets > Most security policy settings are only checked when the template gets
> compiled. For that reasion you should delete all cached and compiled > compiled. For that reason you should delete all cached and compiled
> template files when you change your security settings. > template files when you change your security settings.

View File

@ -33,7 +33,7 @@ can override all or some of the parent named block areas.
you can define the whole template inheritance tree in the PHP script you can define the whole template inheritance tree in the PHP script
when you are calling [`fetch()`](#api.fetch) or when you are calling [`fetch()`](#api.fetch) or
[`display()`](#api.display) with the `extends:` template resource [`display()`](#api.display) with the `extends:` template resource
type. The later provides even more flexibillity. type. The later provides even more flexibility.
> **Note** > **Note**
> >

View File

@ -8,7 +8,7 @@ Modifications done to the Smarty object will be global for all
templates. templates.
However the Smarty class variables and functions can be accessed or However the Smarty class variables and functions can be accessed or
called by induvidual template objects. Modification done to a template called by individual template objects. Modification done to a template
object will apply only for that template and its included subtemplates. object will apply only for that template and its included subtemplates.

View File

@ -26,7 +26,7 @@ the following parameters:
variables assigned to any of the objects in it\'s parent chain. variables assigned to any of the objects in it\'s parent chain.
Data objects are used to create scopes for assigned variables. They can Data objects are used to create scopes for assigned variables. They can
be used to have controll which variables are seen by which templates. be used to control which variables are seen by which templates.
<?php <?php

View File

@ -9,7 +9,7 @@ string
disableSecurity disableSecurity
This disables securty checking on templates. This disables security checking on templates.
See also [`enableSecurity()`](#api.enable.security), and See also [`enableSecurity()`](#api.enable.security), and
[Security](#advanced.features.security). [Security](#advanced.features.security).

View File

@ -25,7 +25,7 @@ string
enableSecurity enableSecurity
This enables securty checking on templates. It uses the following This enables security checking on templates. It uses the following
parameters: parameters:
- `securityclass` is an optional parameter. It\'s the name of the - `securityclass` is an optional parameter. It\'s the name of the

View File

@ -16,6 +16,6 @@ given error was produced deliberately and must be ignored, or should be
passed on to the next error handler. passed on to the next error handler.
`Smarty::unmuteExpectedErrors()` removes the current error handler. `Smarty::unmuteExpectedErrors()` removes the current error handler.
Please note, that if you\'ve registerd any custom error handlers after Please note, that if you\'ve registered any custom error handlers after
the muteExpectedErrors() call, the unmute will not remove Smarty\'s the muteExpectedErrors() call, the unmute will not remove Smarty\'s
muting error handler, but the one registered last. muting error handler, but the one registered last.

View File

@ -18,7 +18,7 @@ not find a definition for a tag otherwise. It uses the following
parameters: parameters:
If during compilation Smarty encounters tag which is not defined If during compilation Smarty encounters tag which is not defined
internal, registered or loacted in the plugins folder it tries to internal, registered or located in the plugins folder it tries to
resolve it by calling the registered default plugin handler. The handler resolve it by calling the registered default plugin handler. The handler
may be called several times for same undefined tag looping over valid may be called several times for same undefined tag looping over valid
plugin types. plugin types.

View File

@ -10,7 +10,7 @@ void
testInstall testInstall
This function verifies that all required working folders of the Smarty This function verifies that all required working folders of the Smarty
installation can be accessed. It does output a corresponding protocoll. installation can be accessed. It does output a corresponding protocol.
<?php <?php

View File

@ -1,7 +1,7 @@
\$compile\_id {#variable.compile.id} \$compile\_id {#variable.compile.id}
============= =============
Persistant compile identifier. As an alternative to passing the same Persistent compile identifier. As an alternative to passing the same
`$compile_id` to each and every function call, you can set this `$compile_id` to each and every function call, you can set this
`$compile_id` and it will be used implicitly thereafter. `$compile_id` and it will be used implicitly thereafter.
@ -10,7 +10,7 @@ post-filters](#plugins.prefilters.postfilters) you must use a unique
`$compile_id` to keep the compiled template files separated. `$compile_id` to keep the compiled template files separated.
For example a [prefilter](#plugins.prefilters.postfilters) that For example a [prefilter](#plugins.prefilters.postfilters) that
localizes your templates (that is: translates language dependend parts) localizes your templates (that is: translates language dependent parts)
at compile time, then you could use the current language as at compile time, then you could use the current language as
`$compile_id` and you will get a set of compiled templates for each `$compile_id` and you will get a set of compiled templates for each
language you use. language you use.

View File

@ -2,6 +2,6 @@
================== ==================
This is maximum time in seconds a cache lock is valid to avoid dead This is maximum time in seconds a cache lock is valid to avoid dead
locks. The deafult value is 10 seconds. locks. The default value is 10 seconds.
See also [`$cache_locking`](#variable.cache.locking) See also [`$cache_locking`](#variable.cache.locking)

View File

@ -10,7 +10,7 @@ environments do not allow PHP processes to create directories, so this
must be disabled which is the default. must be disabled which is the default.
Sub directories are more efficient, so use them if you can. Sub directories are more efficient, so use them if you can.
Theoretically you get much better perfomance on a filesystem with 10 Theoretically you get much better performance on a filesystem with 10
directories each having 100 files, than with 1 directory having 1000 directories each having 100 files, than with 1 directory having 1000
files. This was certainly the case with Solaris 7 (UFS)\... with newer files. This was certainly the case with Solaris 7 (UFS)\... with newer
filesystems such as ext3 and especially reiserfs, the difference is filesystems such as ext3 and especially reiserfs, the difference is

View File

@ -25,10 +25,10 @@ like.
- You CANNOT remove a specified template name under multiple cache - You CANNOT remove a specified template name under multiple cache
groups such as `'/a/b/*/foo.tpl'`, the cache grouping works groups such as `'/a/b/*/foo.tpl'`, the cache grouping works
left-to-right ONLY. You will need to group your templates under a left-to-right ONLY. You will need to group your templates under a
single cache group heirarchy to be able to clear them as a group. single cache group hierarchy to be able to clear them as a group.
Cache grouping should not be confused with your template directory Cache grouping should not be confused with your template directory
heirarchy, the cache grouping has no knowledge of how your templates are hierarchy, the cache grouping has no knowledge of how your templates are
structured. So for example, if you have a template structure like structured. So for example, if you have a template structure like
`themes/blue/index.tpl` and you want to be able to clear all the cache `themes/blue/index.tpl` and you want to be able to clear all the cache
files for the "blue" theme, you will need to create a cache group files for the "blue" theme, you will need to create a cache group

View File

@ -15,7 +15,7 @@ Smarty recognizes `UTF-8` as the internal charset if
> `ISO-8859-1` has been PHP\'s default internal charset since the > `ISO-8859-1` has been PHP\'s default internal charset since the
> beginning. Unicode has been evolving since 1991. Since then it has > beginning. Unicode has been evolving since 1991. Since then it has
> become the one charset to conquer them all, as it is capable of > become the one charset to conquer them all, as it is capable of
> encoding most of the known characters even accross different character > encoding most of the known characters even across different character
> systems (latin, cyrillic, japanese, ...). `UTF-8` is unicode\'s most > systems (latin, cyrillic, japanese, ...). `UTF-8` is unicode\'s most
> used encoding, as it allows referencing the thousands of character > used encoding, as it allows referencing the thousands of character
> with the smallest size overhead possible. > with the smallest size overhead possible.

View File

@ -3,20 +3,20 @@ Extends Template Resources {#resources.extends}
The `extends:` resource is used to define child/parent relationships for The `extends:` resource is used to define child/parent relationships for
template inheritance from the PHP script. For details see section of template inheritance from the PHP script. For details see section of
[Template Interitance](#advanced.features.template.inheritance). [Template Inheritance](#advanced.features.template.inheritance).
As of Smarty 3.1 the `extends:` resource may use any available [template As of Smarty 3.1 the `extends:` resource may use any available [template
resource](#resources), including `string:` and `eval:`. When [templates resource](#resources), including `string:` and `eval:`. When [templates
from strings](#resources.string) are used, make sure they are properly from strings](#resources.string) are used, make sure they are properly
(url or base64) encoded. Is an `eval:` resource found within an (url or base64) encoded. Is an `eval:` resource found within an
inheritance chain, its \"don\'t save a compile file\" property is inheritance chain, its \"don\'t save a compile file\" property is
superseeded by the `extends:` resource. The templates within an superseded by the `extends:` resource. The templates within an
inheritance chain are not compiled separately, though. Only a single inheritance chain are not compiled separately, though. Only a single
compiled template will be generated. compiled template will be generated.
> **Note** > **Note**
> >
> Use this when inheritance is required programatically. When inheriting > Use this when inheritance is required programmatically. When inheriting
> within PHP, it is not obvious from the child template what inheritance > within PHP, it is not obvious from the child template what inheritance
> took place. If you have a choice, it is normally more flexible and > took place. If you have a choice, it is normally more flexible and
> intuitive to handle inheritance chains from within the templates. > intuitive to handle inheritance chains from within the templates.

View File

@ -47,7 +47,7 @@ Templates from a specific \$template\_dir {#templates.from.specified.template.di
Smarty 3.1 introduced the bracket-syntax for specifying an element from Smarty 3.1 introduced the bracket-syntax for specifying an element from
[`$template_dir`](#variable.template.dir). This allows websites [`$template_dir`](#variable.template.dir). This allows websites
employing multiple sets of templates better control over which template employing multiple sets of templates better control over which template
to acces. to access.
The bracket-syntax can be used from anywhere you can specify the `file:` The bracket-syntax can be used from anywhere you can specify the `file:`
resource type. resource type.