De:TSref/parseFunc
From TYPO3Wiki
| TSref/parseFunc |
|
||||
TypoScript This page is document in progress.
[edit]
parseFunc
This object is used to parse some content for stuff like special typo tags, the "makeLinks"-things and so on...
Example:
This example takes the content of the field "bodytext" and parses it through the makelinks-functions and substitutes all <LINK> and <TYPOLIST>-tags with something else.
tt_content.text.default {
20 = TEXT
20.field = bodytext
20.wrap = | <BR>
20.brTag = <br>
20.parseFunc {
makelinks = 1
makelinks.http.keep = path
makelinks.http.extTarget = _blank
makelinks.mailto.keep = path
tags {
link = TEXT
link {
current = 1
typolink.extTarget = _blank
typolink.target={$cLinkTagTarget}
typolink.wrap = <B><FONT color=red>|</FONT></B>
typolink.parameter.data = parameters : allParams
}
typolist < tt_content.bullets.default.20
typolist.trim = 1
typolist.field >
typolist.current = 1
}
}
}
| Property: | Data type: | Description: | Default: |
| externalBlocks | list of tagnames/+properties | This allows you to pre-split the content passed to parseFunc so that only content outside the blocks with the given tags is parsed.
Extra properties:
.[tagname] {
callRecursive = [boolean]; If set, the content of the block is directed into parseFunc again. Otherwise the content is just passed through with no other processing than stdWrap (see below)
callRecursive.dontWrapSelf = [boolean]; If set, the tags of the block is not wrapped around the content returned from parseFunc.
callRecursive.alternativeWrap = Alternative wrapping instead of the original tags.
callRecursive.tagStdWrap = ->stdWrap processing of the block-tags.
stdWrap = ->stdWrap processing of the whole block (regardless of whether callRecursive was set.)
stripNLprev = [boolean]; Strips off last linebreak of the previous outside block
stripNLnext = [boolean]; Strips off first linebreak of the next outside block
stripNL = [boolean]: Does both of the above.
HTMLtableCells = [boolean]; If set, then the content is expected to be a table and every table-cell is traversed.
# Below, default is all cells and 1,2,3... overrides for specific cols.
HTMLtableCells.[default/1/2/3/...] {
callRecursive = [boolean]; The content is parsed through current parseFunc
stdWrap = ->stdWrap processing of the content in the cell
tagStdWrap = -> The <TD> tag is processed by ->stdWrap
}
HTMLtableCells.addChr10BetweenParagraphs = [boolean]; If set, then all </P><P> appearances will have a chr(10) inserted between them
}
Example:
This example is used to split regular bodytext content so that tables and blockquotes in the bodytext are processed correctly. The blockquotes are passed into parseFunc again (recursively) and further their top/bottom margins are set to 0 (so no apparent linebreaks are seen)
The tables are also displayed with a number of properties of the cells overridden.
tt_content.text.20.parseFunc.externalBlocks {
blockquote.callRecursive=1
blockquote.callRecursive.tagStdWrap.HTMLparser = 1
blockquote.callRecursive.tagStdWrap.HTMLparser {
tags.blockquote.fixAttrib.style.list = margin-bottom:0;margin-top:0;
tags.blockquote.fixAttrib.style.always=1
}
blockquote.stripNLprev=1
blockquote.stripNLnext=1
table.stripNL=1
table.stdWrap.HTMLparser = 1
table.stdWrap.HTMLparser {
tags.table.overrideAttribs = border=0 cellpadding=2 cellspacing=1 style="margin-top:10px; margin-bottom:10px;"
tags.tr.allowedAttribs=0
tags.td.overrideAttribs = valign=top bgcolor="#eeeeee" style="font-family : Verdana, Geneva, Arial, Helvetica, sans-serif;font-size : 10px;"
}
}
| |
| constants | boolean | The toplevel-defined constants will be substituted in the text. The constant-name is wrapped in "###".
Example: constants.EMAIL = email@email.com (NOTE: This is toplevel TypoScript!) All cases of the string ###EMAIL### will be substituted in the text. The constants are defined as a toplevel object CONSTANTS. | |
| short | array of strings | Like constants above, but local.
Example: This substitutes all occurencies of “T3” with “TYPO3 CMS” and “T3web” with a link to typo3.com. short {
T3 = TYPO3 CMS
T3web = <a href=”http://typo3.com”>typo3</a>
}
| |
| plainTextStdWrap | ->stdWrap | This is stdWrap properties for all non-tag content. | |
| userFunc | function name | This passes the non-tag content to a function of your own choice. Similar to eg. .postUserFunc in stdWrap.
Remember the function name must possibly be prepended “user_” | |
| nonTypoTagStdWrap | ->stdWrap | Like .plainTextStdWrap. Difference:
.plainTextStdWrap works an ALL non-tag pieces in the text. .nonTypoTagStdWrap is post processing of all text (including tags) between special TypoTags (unless .breakoutTypoTagContent is not set for the TypoTag) | |
| nonTypoTagUserFunc | function name | Like .userFunc. Differences is (like nonTypoTagStdWrap) that this is post processing of all content pieces around TypoTags while .userFunc processes all non-tag content. (Notice: .breakoutTypoTagContent must be set for the TypoTag if it's excluded from nonTypoTagContent) | |
| sword | wrap | Marks up any words from the GET-method send array sword_list[] in the text. The word MUST be at least two characters long!
NOTE: works only with $GLOBALS["TSFE"]->no_cache==1 | <font color="red">|</font> |
| makelinks | boolean / makelinks | Convert webadresses prefixed with "http://" and mail-adresses prefixed with "mailto:" to links. | |
| tags | tags | Here you can define custom tags that will parse the content to something. | |
| allowTags | list of strings | List of tags, which are allowed to exist in code!
Highest priority: If a tag is found in allowTags, denyTags is ignored!! | |
| denyTags | list of strings | List of tags, which may NOT exist in code! (use "*" for all.)
Lowest priority: If a tag is NOT found in allowTags, denyTags is checked. If denyTags is not "*" and the tag is not found in the list, the tag may exist! Example: This allows <B>, <I>, <A> and <IMG> -tags to exist .allowTags = b,i,a,img .denyTags = * | |
| if | if | if "if" returns false the input value is not parsed, but returned directly. |
[tsref:->parseFunc]
