.. include:: /Includes.rst.txt
.. _tags:
tags
^^^^
Used to create custom tags and define how they should be parsed. This
is used in conjunction with *parseFunc*.
The best known is the "link" tag, which is used to create links.
.. ### BEGIN~OF~TABLE ###
.. container:: table-row
Property
*(array of strings)*
Data type
cObject
Description
Every entry in the array of strings corresponds to a tag, that will
be parsed. The elements **must** be in lowercase.
Every entry must be set to a content object.
"current" is set to the content of the tag, eg content:
here "current" is set to "content". It can be used with
stdWrap.current = 1.
**Parameters:**
Parameters of the tag are set in $cObj->parameters (key is lowercased)::
content
This sets $cObj->parameters[color] = red.
$cObj->parameters[allParams] is automatically set to the whole
parameter-string of the tag. Here it is ' color="red"'
**Special properties for each content object:**
**[cObject].stripNL:** Boolean option, which tells *parseFunc* that
newlines before and after the content of the tag should be stripped.
**[cObject].breakoutTypoTagContent:** Boolean option, which tells
parseFunc that this block of content is breaking up the nonTypoTag
content and that the content after this must be re-wrapped.
**Examples:** ::
tags.bold = TEXT
tags.bold {
stdWrap.current = 1
stdWrap.wrap =
|
}
tags.bold.stdWrap.stripNL = 1
This example would e.g. transform :html:`Important!`
to :html:`
Important!
`.
.. ###### END~OF~TABLE ######
[tsref:->tags]
.. _tags-examples:
Example:
""""""""
This example creates 4 custom tags. The -, -,
- and -tags:
is made into a typolink and provides an easy way of creating
links in text.
is used to create bullet-lists.
will create an image file with 90x10 pixels where the text is
the content of the tag.
lets us place an image in the text. The content of the tag
should be the image-reference in "fileadmin/images/". ::
tags {
link = TEXT
link {
stdWrap.current = 1
stdWrap.typolink.extTarget = _blank
stdWrap.typolink.target = {$cLinkTagTarget}
stdWrap.typolink.wrap =