View Revisions: Note 2748
| Summary | 1190: The power of tempcode |
|---|---|
| Revision | 2015-04-30 08:44 by Guest |
| Note |
The Power of Tempcode Tempcode is the base template language of Composr, and its very powerful and also serves as a complete programming language with support for control structures, built-in core functions and variable substitutions. Tempcode provides four constructs other than the plain text of the template itself: Parameters: {PARAMETER} where PARAMETER is a code-name of something that was actually passed to the template Language strings: {!STRING,<parameters>...} where STRING is a real language string from a loaded language file (e.g. Banner code could use strings from banners.ini, but most other code could not; global.ini contains strings usable anywhere) Symbols: {$SYMBOL,<parameters>...} where SYMBOL is a real symbol Composr supports. Embedding a symbol is like making a function call or running a command in the complex place, or a substitution in the simple case Directives: {+START,DIRECTIVE,<parameters>...}...{+END,DIRECTIVE} where DIRECTIVE is a real directive Composr supports. Directives essentially wrap portions of the template, controlling that portion; they are generally used for types of condition checking (e.g. IF) or loop. There are also directives like {+IMPLODE,<parameters>...} that do not wrap, but work outside the normal "string manipulation" bounds that symbols do Examples below should help you understand how to use Tempcode practically, The [semihtml] tag is a special tag that allows Comcode and HTML to be naturally mixed together, eg: [semihtml] {+START,IF,{$LT,{$RAND},8000}} This shows 1/4 of the time. How does it work? RAND picks a random number between 0 and 32000, so the number will be less than 8000 1/4 of the time. {+END} The next example demonstrates how built-in language constructs like SET_RAND can be used to randomly make a selection from given options, <p style="color: {$SET_RAND,red,green,blue,#EE1167};"> I think you are a {$SET_RAND,lovely,beautiful,groovy} person. We randomly selected a word, and randomly picked a text colour. This would resolve to something like this, eg: <p style="color: green"> I think you are a groovy person. We randomly selected a word, and randomly picked a text colour. Tempcode is also equipped with security aspects such as obfuscating a mail, get an obfuscated "mailto: " string which makes it hard for e-mail scavengers to read it and hence preventing spam, eg:
TRUNCATE_LEFT can be used to trim data from the left, you can use TRUNCATE_RIGHT to do the same from right, and TRUNCATE_SPREAD to keep an equal left/right portion, all the three functions have the same parameter order, parameter order is as follows, {$TRUNCATE_LEFT, data, truncation length, optional binary value to show a tool tip, optional binary value for whether the input text is already in HTML format} eg:
The menu system can use match-keys for matching against the URL the menu is being viewed from, and we can use that show a specific message only if a condition is satisfied, eg: {+START,IF,{$MATCH_KEY_MATCH,site:downloads:browse:3}}
{+END} This is an alternative way of achieving the same result as above, we perform a string equality here(EQ) on the ID parameter, if it is equal then the message will be displayed. {+START,IF,{$EQ,{$_GET,id},3}}
{+END} It's useful to know which browser is being used by the user to view the web page. We might have to make some tweaks specifically for browsers like Internet Explorer to ensure cross-browser compatibility, eg: {+START,IF,{$BROWSER_MATCHES,ie}}
{+END} This functionality can be used to display messages or alerts specifically for admins, eg: {+START,IF,{$IS_ADMIN}}
{+END} This functionality is similar to IS_ADMIN it checks if the member belongs to 1, 3,4 or 5 if yes , then the message will be displayed, eg: {+START,IF,{$IS_IN_GROUP,1,3-5}}
{+END} Dynamically change the image resolution of your avatar to make it a thumbnail using the THUMBNAIL language construct, current avatar can be fetched using AVATAR and the second parameter defines the resolution, eg: <img alt="Your avatar made into a really tiny thumbnail" title="Your avatar made into a really tiny thumbnail" src="{$THUMBNAIL*,{$AVATAR},20x20}" /> [/semihtml] This will work within Tempcode only (i.e. a template), we can use loops within tempcode using the LOOP language construct, and the loop variable can be fetched within the loop using the _loop_var variable, In this example, it loops from A to I and in the loop it uses the language construct CYCLE to go through the parameters passed to it in a sequence, so the first in loop the background property will be set to the first value i.e #EEE and _loop_var will display the current loop value which should be A, eg: <div> Zebra-striping by setting up a named cycle (we use the loop to simulate an arbitrary repeating situation to use the cycle within): {+START,LOOP,A\,B\,C\,D\,E\,F\,G\,H\,I} <div style="background: {$CYCLE,bgcol,#EEE,#AAA}"> {_loop_var} </div> {+END} </div> |
| Revision | 2015-04-30 08:44 by Guest |
| Note |
The Power of Tempcode Tempcode is the base template language of Composr, and its very powerful and also serves as a complete programming language with support for control structures, built-in core functions and variable substitutions. Tempcode provides four constructs other than the plain text of the template itself: Parameters: {PARAMETER} where PARAMETER is a code-name of something that was actually passed to the template Language strings: {!STRING,<parameters>...} where STRING is a real language string from a loaded language file (e.g. Banner code could use strings from banners.ini, but most other code could not; global.ini contains strings usable anywhere) Symbols: {$SYMBOL,<parameters>...} where SYMBOL is a real symbol Composr supports. Embedding a symbol is like making a function call or running a command in the complex place, or a substitution in the simple case Directives: {+START,DIRECTIVE,<parameters>...}...{+END,DIRECTIVE} where DIRECTIVE is a real directive Composr supports. Directives essentially wrap portions of the template, controlling that portion; they are generally used for types of condition checking (e.g. IF) or loop. There are also directives like {+IMPLODE,<parameters>...} that do not wrap, but work outside the normal "string manipulation" bounds that symbols do Examples below should help you understand how to use Tempcode practically, The [semihtml] tag is a special tag that allows Comcode and HTML to be naturally mixed together, [semihtml] {+START,IF,{$LT,{$RAND},8000}} This shows 1/4 of the time. How does it work? RAND picks a random number between 0 and 32000, so the number will be less than 8000 1/4 of the time. {+END} The next example demonstrates how built-in language constructs like SET_RAND can be used to randomly make a selection from given options, <p style="color: {$SET_RAND,red,green,blue,#EE1167};"> I think you are a {$SET_RAND,lovely,beautiful,groovy} person. We randomly selected a word, and randomly picked a text colour. This would resolve to something like this, eg: <p style="color: green"> I think you are a groovy person. We randomly selected a word, and randomly picked a text colour. Tempcode is also equipped with security aspects such as obfuscating a mail, get an obfuscated "mailto: " string which makes it hard for e-mail scavengers to read it and hence preventing spam, eg:
TRUNCATE_LEFT can be used to trim data from the left, you can use TRUNCATE_RIGHT to do the same from right, and TRUNCATE_SPREAD to keep an equal left/right portion, all the three functions have the same parameter order, parameter order is as follows, {$TRUNCATE_LEFT, data, truncation length, optional binary value to show a tool tip, optional binary value for whether the input text is already in HTML format} eg:
The menu system can use match-keys for matching against the URL the menu is being viewed from, and we can use that show a specific message only if a condition is satisfied, eg: {+START,IF,{$MATCH_KEY_MATCH,site:downloads:browse:3}}
{+END} This is an alternative way of achieving the same result as above, we perform a string equality here(EQ) on the ID parameter, if it is equal then the message will be displayed. {+START,IF,{$EQ,{$_GET,id},3}}
{+END} It's useful to know which browser is being used by the user to view the web page. We might have to make some tweaks specifically for browsers like Internet Explorer to ensure cross-browser compatibility, eg: {+START,IF,{$BROWSER_MATCHES,ie}}
{+END} This functionality can be used to display messages or alerts specifically for admins, eg: {+START,IF,{$IS_ADMIN}}
{+END} This functionality is similar to IS_ADMIN it checks if the member belongs to 1, 3,4 or 5 if yes , then the message will be displayed, eg: {+START,IF,{$IS_IN_GROUP,1,3-5}}
{+END} Dynamically change the image resolution of your avatar to make it a thumbnail using the THUMBNAIL language construct, current avatar can be fetched using AVATAR and the second parameter defines the resolution, eg: <img alt="Your avatar made into a really tiny thumbnail" title="Your avatar made into a really tiny thumbnail" src="{$THUMBNAIL*,{$AVATAR},20x20}" /> [/semihtml] This will work within Tempcode only (i.e. a template), we can use loops within tempcode using the LOOP language construct, and the loop variable can be fetched within the loop using the _loop_var variable, In this example, it loops from A to I and in the loop it uses the language construct CYCLE to go through the parameters passed to it in a sequence, so the first in loop the background property will be set to the first value i.e #EEE and _loop_var will display the current loop value which should be A, eg: <div> Zebra-striping by setting up a named cycle (we use the loop to simulate an arbitrary repeating situation to use the cycle within): {+START,LOOP,A\,B\,C\,D\,E\,F\,G\,H\,I} <div style="background: {$CYCLE,bgcol,#EEE,#AAA}"> {_loop_var} </div> {+END} </div> |
