summaryrefslogtreecommitdiff
path: root/docs/designers
diff options
context:
space:
mode:
authorSimon Wisselink <s.wisselink@iwink.nl>2023-08-09 00:10:41 +0200
committerSimon Wisselink <s.wisselink@iwink.nl>2023-08-09 00:10:41 +0200
commit052fee3a3054eb3b1d699ef0935a54838d218095 (patch)
tree18bc968f5e061975add435484d4f2e99f16a1797 /docs/designers
parent548a67031d0cb37863c64aa3ef3e0535a4f5191d (diff)
downloadsmarty-052fee3a3054eb3b1d699ef0935a54838d218095.tar.gz
smarty-052fee3a3054eb3b1d699ef0935a54838d218095.tar.bz2
smarty-052fee3a3054eb3b1d699ef0935a54838d218095.zip
fixed some broken links and markdown in the docs
Diffstat (limited to 'docs/designers')
-rw-r--r--docs/designers/language-basic-syntax/index.md6
-rw-r--r--docs/designers/language-basic-syntax/language-escaping.md7
-rw-r--r--docs/designers/language-basic-syntax/language-syntax-attributes.md2
-rw-r--r--docs/designers/language-basic-syntax/language-syntax-comments.md2
-rw-r--r--docs/designers/language-basic-syntax/language-syntax-tags.md (renamed from docs/designers/language-basic-syntax/language-syntax-functions.md)6
-rw-r--r--docs/designers/language-builtin-functions/index.md2
-rw-r--r--docs/designers/language-builtin-functions/language-function-block.md4
-rw-r--r--docs/designers/language-builtin-functions/language-function-extends.md6
-rw-r--r--docs/designers/language-builtin-functions/language-function-include.md4
-rw-r--r--docs/designers/language-builtin-functions/language-function-ldelim.md2
-rw-r--r--docs/designers/language-builtin-functions/language-function-literal.md2
-rw-r--r--docs/designers/language-custom-functions/index.md2
-rw-r--r--docs/designers/language-custom-functions/language-function-eval.md2
-rw-r--r--docs/designers/language-custom-functions/language-function-fetch.md2
-rw-r--r--docs/designers/language-custom-functions/language-function-html-image.md4
-rw-r--r--docs/designers/language-custom-functions/language-function-textformat.md2
-rw-r--r--docs/designers/language-modifiers/index.md4
-rw-r--r--docs/designers/language-variables/index.md4
-rw-r--r--docs/designers/language-variables/language-assigned-variables.md2
-rw-r--r--docs/designers/language-variables/language-variables-smarty.md4
20 files changed, 34 insertions, 35 deletions
diff --git a/docs/designers/language-basic-syntax/index.md b/docs/designers/language-basic-syntax/index.md
index 05c0ba69..e054d143 100644
--- a/docs/designers/language-basic-syntax/index.md
+++ b/docs/designers/language-basic-syntax/index.md
@@ -14,7 +14,7 @@ A simple Smarty template could look like this:
All Smarty template tags are enclosed within delimiters. By default
these are `{` and `}`, but they can be
-[changed](../../programmers/api-variables/variable-left-delimiter.md).
+[changed](../../designers/language-basic-syntax/language-escaping.md).
For the examples in this manual, we will assume that you are using the
default delimiters. In Smarty, all content outside of delimiters is
@@ -22,12 +22,12 @@ displayed as static content, or unchanged. When Smarty encounters
template tags, it attempts to interpret them, and displays the
appropriate output in their place.
-The basis components of the Smarty syntax are:
+The basic components of the Smarty syntax are:
- [Comments](language-syntax-comments.md)
- [Variables](language-syntax-variables.md)
- [Operators](language-syntax-operators.md)
-- [Functions](language-syntax-functions.md)
+- [Tags](language-syntax-tags.md)
- [Attributes](language-syntax-attributes.md)
- [Quotes](language-syntax-quotes.md)
- [Escaping](language-escaping.md)
diff --git a/docs/designers/language-basic-syntax/language-escaping.md b/docs/designers/language-basic-syntax/language-escaping.md
index 58e75d58..9132b8c0 100644
--- a/docs/designers/language-basic-syntax/language-escaping.md
+++ b/docs/designers/language-basic-syntax/language-escaping.md
@@ -45,8 +45,7 @@ variables.
Smarty's default delimiters { and } cleanly represent presentational
content. However, if another set of delimiters suit your needs better,
you can change them with Smarty's
-[`$left_delimiter`](../../programmers/api-variables/variable-left-delimiter.md) and
-[`$right_delimiter`](../../programmers/api-variables/variable-right-delimiter.md) values.
+`setLeftDelimiter()` and `setRightDelimiter()` methods.
> **Note**
>
@@ -57,8 +56,8 @@ you can change them with Smarty's
```php
<?php
-$smarty->left_delimiter = '<!--{';
-$smarty->right_delimiter = '}-->';
+$smarty->setLeftDelimiter('<!--{');
+$smarty->setRightDelimiter('}-->');
$smarty->assign('foo', 'bar');
$smarty->assign('name', 'Albert');
diff --git a/docs/designers/language-basic-syntax/language-syntax-attributes.md b/docs/designers/language-basic-syntax/language-syntax-attributes.md
index 41f6c458..e3c7d58b 100644
--- a/docs/designers/language-basic-syntax/language-syntax-attributes.md
+++ b/docs/designers/language-basic-syntax/language-syntax-attributes.md
@@ -1,6 +1,6 @@
# Attributes
-Most of the [functions](./language-syntax-functions.md) take attributes that
+Most of the [tags](./language-syntax-tags.md) take attributes that
specify or modify their behavior. Attributes to Smarty functions are
much like HTML attributes. Static values don't have to be enclosed in
quotes, but it is required for literal strings. Variables with or
diff --git a/docs/designers/language-basic-syntax/language-syntax-comments.md b/docs/designers/language-basic-syntax/language-syntax-comments.md
index 7052c20e..379418ef 100644
--- a/docs/designers/language-basic-syntax/language-syntax-comments.md
+++ b/docs/designers/language-basic-syntax/language-syntax-comments.md
@@ -1,7 +1,7 @@
# Comments
Template comments are surrounded by asterisks, and that is surrounded by
-the [delimiter](../../programmers/api-variables/variable-left-delimiter.md) tags like so:
+the [delimiter](../../designers/language-basic-syntax/language-escaping.md) tags like so:
## Examples
diff --git a/docs/designers/language-basic-syntax/language-syntax-functions.md b/docs/designers/language-basic-syntax/language-syntax-tags.md
index 93d94f6b..7142f0da 100644
--- a/docs/designers/language-basic-syntax/language-syntax-functions.md
+++ b/docs/designers/language-basic-syntax/language-syntax-tags.md
@@ -1,4 +1,4 @@
-# Functions
+# Tags
Every Smarty tag either prints a [variable](./language-syntax-variables.md) or
invokes some sort of function. These are processed and displayed by
@@ -31,8 +31,8 @@ within delimiters like so: `{funcname attr1="val1" attr2="val2"}`.
[`{strip}`](../language-builtin-functions/language-function-strip.md). There should be no need to
change or modify them.
-- Custom functions are **additional** functions implemented via
- [plugins](../../programmers/plugins.md). They can be modified to your liking, or you can
+- Custom tags are **additional** tags implemented via
+ [plugins](../../api/extending/introduction.md). They can be modified to your liking, or you can
create new ones. [`{html_options}`](../language-custom-functions/language-function-html-options.md)
is an example of a custom function.
diff --git a/docs/designers/language-builtin-functions/index.md b/docs/designers/language-builtin-functions/index.md
index 10dc3a6f..852b392f 100644
--- a/docs/designers/language-builtin-functions/index.md
+++ b/docs/designers/language-builtin-functions/index.md
@@ -4,7 +4,7 @@ Smarty comes with several built-in functions. These built-in functions
are the integral part of the smarty template engine. They are compiled
into corresponding inline PHP code for maximum performance.
-You cannot create your own [custom functions](../language-custom-functions/index.md) with the same name; and you
+You cannot create your own [custom tags](../language-custom-functions/index.md) with the same name; and you
should not need to modify the built-in functions.
A few of these functions have an `assign` attribute which collects the
diff --git a/docs/designers/language-builtin-functions/language-function-block.md b/docs/designers/language-builtin-functions/language-function-block.md
index c2acd197..05334e2f 100644
--- a/docs/designers/language-builtin-functions/language-function-block.md
+++ b/docs/designers/language-builtin-functions/language-function-block.md
@@ -2,7 +2,7 @@
`{block}` is used to define a named area of template source for template
inheritance. For details see section of [Template
-Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md).
+Inheritance](../../api/inheritance.md).
The `{block}` template source area of a child template will replace the
corresponding areas in the parent template(s).
@@ -195,7 +195,7 @@ The result would look like
```
See also [Template
-Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md),
+Inheritance](../../api/inheritance.md),
[`$smarty.block.parent`](../language-variables/language-variables-smarty.md#smartyblockparent-languagevariablessmartyblockparent),
[`$smarty.block.child`](../language-variables/language-variables-smarty.md#smartyblockchild-languagevariablessmartyblockchild), and
[`{extends}`](./language-function-extends.md)
diff --git a/docs/designers/language-builtin-functions/language-function-extends.md b/docs/designers/language-builtin-functions/language-function-extends.md
index eba17b9b..06241d93 100644
--- a/docs/designers/language-builtin-functions/language-function-extends.md
+++ b/docs/designers/language-builtin-functions/language-function-extends.md
@@ -2,7 +2,7 @@
`{extends}` tags are used in child templates in template inheritance for
extending parent templates. For details see section of [Template
-Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md).
+Inheritance](../../api/inheritance.md).
- The `{extends}` tag must be on the first line of the template.
@@ -10,7 +10,7 @@ Inheritance](../../programmers/advanced-features/advanced-features-template-inhe
tag it may contain only `{block}` tags. Any other template content
is ignored.
-- Use the syntax for [template resources](../../programmers/resources.md) to extend files
+- Use the syntax for [template resources](../../api/resources.md) to extend files
outside the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md) directory.
## Attributes
@@ -33,5 +33,5 @@ Inheritance](../../programmers/advanced-features/advanced-features-template-inhe
{extends 'parent.tpl'} {* short-hand *}
```
-See also [Template Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md)
+See also [Template Inheritance](../../api/inheritance.md)
and [`{block}`](./language-function-block.md).
diff --git a/docs/designers/language-builtin-functions/language-function-include.md b/docs/designers/language-builtin-functions/language-function-include.md
index 54660cd5..bb481f79 100644
--- a/docs/designers/language-builtin-functions/language-function-include.md
+++ b/docs/designers/language-builtin-functions/language-function-include.md
@@ -41,7 +41,7 @@ available within the included template.
is useful to return values from the included template to the
including template.
-- Use the syntax for [template resources](../../programmers/resources.md) to `{include}`
+- Use the syntax for [template resources](../../api/resources.md) to `{include}`
files outside of the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md)
directory.
@@ -183,5 +183,5 @@ current template.
{include file="$style_dir/$module.$view.tpl"}
```
-See also [template resources](../../programmers/resources.md) and
+See also [template resources](../../api/resources.md) and
[componentized templates](../../appendixes/tips.md#componentized-templates).
diff --git a/docs/designers/language-builtin-functions/language-function-ldelim.md b/docs/designers/language-builtin-functions/language-function-ldelim.md
index c9f73c30..05bc8ecc 100644
--- a/docs/designers/language-builtin-functions/language-function-ldelim.md
+++ b/docs/designers/language-builtin-functions/language-function-ldelim.md
@@ -4,7 +4,7 @@
template delimiters, by default **{** and **}**. You can also use
[`{literal}{/literal}`](./language-function-literal.md) to escape blocks of
text eg Javascript or CSS. See also the complementary
-[`{$smarty.ldelim}`](../../programmers/api-variables/variable-left-delimiter.md).
+[`{$smarty.ldelim}`](../../designers/language-basic-syntax/language-escaping.md).
```smarty
{* this will print literal delimiters out of the template *}
diff --git a/docs/designers/language-builtin-functions/language-function-literal.md b/docs/designers/language-builtin-functions/language-function-literal.md
index 4bc12f9d..0253f260 100644
--- a/docs/designers/language-builtin-functions/language-function-literal.md
+++ b/docs/designers/language-builtin-functions/language-function-literal.md
@@ -3,7 +3,7 @@
`{literal}` tags allow a block of data to be taken literally. This is
typically used around Javascript or stylesheet blocks where {curly
braces} would interfere with the template
-[delimiter](../../programmers/api-variables/variable-left-delimiter.md) syntax. Anything within
+[delimiter](../../designers/language-basic-syntax/language-escaping.md) syntax. Anything within
`{literal}{/literal}` tags is not interpreted, but displayed as-is. If
you need template tags embedded in a `{literal}` block, consider using
[`{ldelim}{rdelim}`](./language-function-ldelim.md) to escape the individual
diff --git a/docs/designers/language-custom-functions/index.md b/docs/designers/language-custom-functions/index.md
index 81979654..2c1d9b70 100644
--- a/docs/designers/language-custom-functions/index.md
+++ b/docs/designers/language-custom-functions/index.md
@@ -1,4 +1,4 @@
-# Custom Functions
+# Custom Tags
Smarty comes with several custom plugin functions that you can use in
the templates.
diff --git a/docs/designers/language-custom-functions/language-function-eval.md b/docs/designers/language-custom-functions/language-function-eval.md
index 70c7a3d1..e44862c2 100644
--- a/docs/designers/language-custom-functions/language-function-eval.md
+++ b/docs/designers/language-custom-functions/language-function-eval.md
@@ -22,7 +22,7 @@ output to the template.
> templates.
>
> - Evaluated variables are compiled on every invocation, the compiled
-> versions are not saved! However, if you have [caching](../../programmers/caching.md)
+> versions are not saved! However, if you have [caching](../../api/caching/basics.md)
> enabled, the output will be cached with the rest of the template.
>
> - If the content to evaluate doesn't change often, or is used
diff --git a/docs/designers/language-custom-functions/language-function-fetch.md b/docs/designers/language-custom-functions/language-function-fetch.md
index 2ff494fd..a2f07f3a 100644
--- a/docs/designers/language-custom-functions/language-function-fetch.md
+++ b/docs/designers/language-custom-functions/language-function-fetch.md
@@ -28,7 +28,7 @@ ftp and display the contents.
> If security is enabled, and you are fetching a file from the local
> file system, `{fetch}` will only allow files from within the
> `$secure_dir` path of the security policy. See the
- > [Security](../../programmers/advanced-features/advanced-features-security.md) section for details.
+ > [Security](../../api/security.md) section for details.
- If the `assign` attribute is set, the output of the `{fetch}`
function will be assigned to this template variable instead of being
diff --git a/docs/designers/language-custom-functions/language-function-html-image.md b/docs/designers/language-custom-functions/language-function-html-image.md
index 7ecde265..0ae02cae 100644
--- a/docs/designers/language-custom-functions/language-function-html-image.md
+++ b/docs/designers/language-custom-functions/language-function-html-image.md
@@ -20,7 +20,7 @@ automatically calculated from the image file if they are not supplied.
from. If not given, the web server's document root
`$_ENV['DOCUMENT_ROOT']` is used as the base. If security is
enabled, then the image must be located in the `$secure_dir` path of
- the security policy. See the [Security](../../programmers/advanced-features/advanced-features-security.md)
+ the security policy. See the [Security](../../api/security.md)
section for details.
- `href` is the href value to link the image to. If link is supplied,
@@ -37,7 +37,7 @@ automatically calculated from the image file if they are not supplied.
>
> `{html_image}` requires a hit to the disk to read the image and
> calculate the height and width. If you don't use template
-> [caching](../../programmers/caching.md), it is generally better to avoid `{html_image}`
+> [caching](../../api/caching/basics.md), it is generally better to avoid `{html_image}`
> and leave image tags static for optimal performance.
## Examples
diff --git a/docs/designers/language-custom-functions/language-function-textformat.md b/docs/designers/language-custom-functions/language-function-textformat.md
index 4089fdb3..cb2a8d70 100644
--- a/docs/designers/language-custom-functions/language-function-textformat.md
+++ b/docs/designers/language-custom-functions/language-function-textformat.md
@@ -1,6 +1,6 @@
# {textformat}
-`{textformat}` is a [block function](../../programmers/plugins/plugins-block-functions.md) used to
+`{textformat}` is a block tag used to
format text. It basically cleans up spaces and special characters, and
formats paragraphs by wrapping at a boundary and indenting lines.
diff --git a/docs/designers/language-modifiers/index.md b/docs/designers/language-modifiers/index.md
index a384c95c..329ed958 100644
--- a/docs/designers/language-modifiers/index.md
+++ b/docs/designers/language-modifiers/index.md
@@ -1,7 +1,7 @@
# Variable Modifiers
Variable modifiers can be applied to
-[variables](../language-variables/index.md), [custom functions](../language-custom-functions/index.md)
+[variables](../language-variables/index.md), [custom tags](../language-custom-functions/index.md)
or strings. To apply a modifier,
specify the value followed by a `|` (pipe) and the modifier name. A
modifier may accept additional parameters that affect its behavior.
@@ -102,4 +102,4 @@ These parameters follow the modifier name and are separated by a `:`
See also [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md), [combining
modifiers](../language-combining-modifiers.md). and [extending smarty with
-plugins](../../programmers/plugins.md)
+plugins](../../api/extending/introduction.md)
diff --git a/docs/designers/language-variables/index.md b/docs/designers/language-variables/index.md
index 58ae6eb9..0278c917 100644
--- a/docs/designers/language-variables/index.md
+++ b/docs/designers/language-variables/index.md
@@ -8,11 +8,11 @@ variable depends on what symbol it is prefixed or enclosed within.
- [{$smarty} reserved variable](language-variables-smarty.md)
Variables in Smarty can be either displayed directly or used as
-arguments for [functions](../language-basic-syntax/language-syntax-functions.md),
+arguments for [tags](../language-basic-syntax/language-syntax-tags.md),
[attributes](../language-basic-syntax/language-syntax-attributes.md) and
[modifiers](../language-modifiers/index.md), inside conditional expressions, etc.
To print a variable, simply enclose it in the
-[delimiters](../../programmers/api-variables/variable-left-delimiter.md) so that it is the only thing
+[delimiters](../../designers/language-basic-syntax/language-escaping.md) so that it is the only thing
contained between them.
```smarty
diff --git a/docs/designers/language-variables/language-assigned-variables.md b/docs/designers/language-variables/language-assigned-variables.md
index a358008f..9465a89c 100644
--- a/docs/designers/language-variables/language-assigned-variables.md
+++ b/docs/designers/language-variables/language-assigned-variables.md
@@ -110,7 +110,7 @@ zaphod@slartibartfast.example.com<br />
## Objects
-Properties of [objects](../../programmers/advanced-features/advanced-features-objects.md) assigned from PHP
+Properties of [objects](../../api/variables/objects.md) assigned from PHP
can be referenced by specifying the property name after the `->` symbol.
```smarty
diff --git a/docs/designers/language-variables/language-variables-smarty.md b/docs/designers/language-variables/language-variables-smarty.md
index b6dff73a..cbeb6687 100644
--- a/docs/designers/language-variables/language-variables-smarty.md
+++ b/docs/designers/language-variables/language-variables-smarty.md
@@ -138,12 +138,12 @@ Returns the version of Smarty the template was compiled with.
## {$smarty.block.child}
Returns block text from child template. See [Template
-inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md).
+inheritance](../../api/inheritance.md).
## {$smarty.block.parent}
Returns block text from parent template. See [Template
-inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md)
+inheritance](../../api/inheritance.md)
## {$smarty.ldelim}, {$smarty.rdelim}