doc.arkadia.com

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== List of template system tags ======

===== Generic Parameters =====

This are generic parameters to functions call. Ex <#myString **lowercase**=1>

^ Syntax                                                             ^ Type     ^ Context  ^ Description                             ^
| [[en:public:developer:template_system:tags:parameters:AnalyzeTagParams]]    | parameter | all tags  | Analyze all params before to call a function |
| [[en:public:developer:template_system:tags:parameters:Base64Encode]]    | parameter | all tags | Base64 encode the returning value   |
| [[en:public:developer:template_system:tags:parameters:Default]]    | parameter | all tags | Return default if the returning value is empty  |
| [[en:public:developer:template_system:tags:parameters:Checksum]]    | parameter | all tags | Return checksum of the returning value |
| [[en:public:developer:template_system:tags:parameters:ConvertCurrency]]    | parameter | all tags | Return the currency converted |
| [[en:public:developer:template_system:tags:parameters:CurrencyString]]    | parameter | [[en:public:developer:template_system:tags:parameters:Format]] | The currency string to use when formating the value    |
| [[en:public:developer:template_system:tags:parameters:Format]]    | parameter | all tags | Format the returning value   |
| [[en:public:developer:template_system:tags:parameters:ThousandSeparator]]    | parameter | [[en:public:developer:template_system:tags:parameters:Format]] | The thousand separator to use when formating the value  |
| [[en:public:developer:template_system:tags:parameters:Decimalseparator]]    | parameter | [[en:public:developer:template_system:tags:parameters:Format]] | The decimal separator to use when formating the value    |
| [[en:public:developer:template_system:tags:parameters:TrueStr]]    | parameter | [[en:public:developer:template_system:tags:parameters:Format]] | The TrueStr to use when formating the value    |
| [[en:public:developer:template_system:tags:parameters:FalseStr]]    | parameter | [[en:public:developer:template_system:tags:parameters:Format]] | The FalseStr to use when formating the value    |
| [[en:public:developer:template_system:tags:parameters:JsEncode]]    | parameter | all tags | Javascript encode the returning value   |
| [[en:public:developer:template_system:tags:parameters:HexEncode]]    | parameter | all tags | Hex encode the returning value   |
| [[en:public:developer:template_system:tags:parameters:HtmlEncode]]    | parameter | all tags | Html encode the returning value   |
| [[en:public:developer:template_system:tags:parameters:HttpEncode]]    | parameter | all tags | Http encode the returning value   |
| [[en:public:developer:template_system:tags:parameters:Lowercase]]    | parameter | all tags | Lowercase the returning value   |
| [[en:public:developer:template_system:tags:parameters:MaxChars]]    | parameter | all tags | the maximum number of chars to output |
| [[en:public:developer:template_system:tags:parameters:MaxcharsTruncStr]]    | parameter | all tags | use only with maxchars. specify the end string when output was truncated |
| [[en:public:developer:template_system:tags:parameters:NoOutput]]    | parameter | all tags | return empty string |
| [[en:public:developer:template_system:tags:parameters:PreserveNullStr]]    | parameter | all tags | Do not replace null result by an empty string |
| [[en:public:developer:template_system:tags:parameters:SentenceCase]]    | parameter | all tags | First letter of the sentence capitalized, all others lower case |
| [[en:public:developer:template_system:tags:parameters:StripHtmlTags]]    | parameter | all tags | remove all html tags from the output |
| [[en:public:developer:template_system:tags:parameters:SetValue]]    | parameter | all tags | Set a value to a custom var |
| [[en:public:developer:template_system:tags:parameters:TitleCase]]    | parameter | all tags | First letter of each word is capitalized, the rest are lower case |
| [[en:public:developer:template_system:tags:parameters:Trim]]    | parameter | all tags | Trims leading and trailing spaces and control characters from a string. |
| [[en:public:developer:template_system:tags:parameters:UpperCase]]    | parameter | all tags | Uppercase the returning value   |
| [[en:public:developer:template_system:tags:parameters:XmlEncode]]    | parameter | all tags | XML/XHTML encode the returning value   |
===== Analytics tags =====

^ Syntax                                                                              ^ Type                                                                                   ^ Context      ^ Description                ^
| <#[[en:public:developer:template_system:tags:analytics:TAnalytics_Tracker|Analytics_Tracker]]>        | var ([[en:public:developer:template_system:tags:analytics:TAnalytics_Tracker]])       | anywhere     | analytics Tracker object |

===== Api functions =====

All of these Api functions can return result in 
[[en:public:developer:template_system:tags:api:JSON_Response_Format]] or in 
[[en:public:developer:template_system:tags:api:REST_Response_Format]]

^ Syntax                                                                         ^ Type           ^ Context      ^ Description ^
| <#[[en:public:developer:template_system:tags:api:Add_lead]]>                   | Function       | anywhere     | API Function to add lead in the database |
| <#[[en:public:developer:template_system:tags:api:Share_url_by_email]]>         | Function       | anywhere     | API Function to share an URL by email |
| <#[[en:public:developer:template_system:tags:api:Contact_us]]>                 | Function       | anywhere     | API Function to contact us by email |
| <#[[en:public:developer:template_system:tags:api:Get_contacts]]>               | Function       | anywhere     | API Function to retrieve list of a contacts |
| <#[[en:public:developer:template_system:tags:api:Get_contact]]>                | Function       | anywhere     | API Function to get details of a contact |
| <#[[en:public:developer:template_system:tags:api:Set_contact]]>                | Function       | anywhere     | API Function to add or update a contact |
| <#[[en:public:developer:template_system:tags:api:Get_GeoPlaces]]>              | Function       | anywhere     | API Function to retrieve list of geo places |
| <#[[en:public:developer:template_system:tags:api:Get_GeoPlace]]>               | Function       | anywhere     | API Function to retrieve detail of one geo place |
| <#[[en:public:developer:template_system:tags:api:Get_Object_Ids]]>             | Function       | anywhere     | API Function to retrieve list of object ids via keywords |
| <#[[en:public:developer:template_system:tags:api:Set_prospect]]>               | Function       | anywhere     | API Function to add or update a prospect |
| <#[[en:public:developer:template_system:tags:api:Get_wwwfile_content]]>        | Function       | anywhere     | API Function to retrieve the raw content of a template file  |
| <#[[en:public:developer:template_system:tags:api:Set_wwwfile_content]]>        | Function       | anywhere     | API Function to set the raw content of a template file |
| <#[[en:public:developer:template_system:tags:api:Get_wwwfile_logs]]>           | Function       | anywhere     | API Function to retrieve the logs of a template file |
| <#[[en:public:developer:template_system:tags:api:Get_lookuplist_content]]>     | Function       | anywhere     | API Function to retrieve the items of a lookup list |
| <#[[en:public:developer:template_system:tags:api:Set_lookuplist_content]]>     | Function       | anywhere     | API Function to set the items of a lookup list |
| <#[[en:public:developer:template_system:tags:api:Delete_lookuplist_content]]>  | Function    | anywhere  | API Function to delete an item of a lookup list |
| <#[[en:public:developer:template_system:tags:api:Get_pageCfg_content]]>        | Function       | anywhere     | API Function to retrieve the raw content of the page configuration |
| <#[[en:public:developer:template_system:tags:api:Set_pageCfg_content]]>        | Function       | anywhere     | API Function to set the raw content of the page configuration |
| <#[[en:public:developer:template_system:tags:api:Get_urlResources_content]]>   | Function       | anywhere     | API Function to retrieve the raw content of the url resources file |
| <#[[en:public:developer:template_system:tags:api:Set_urlResources_content]]>   | Function       | anywhere     | API Function to set the raw content of a the url resources file |
| <#[[en:public:developer:template_system:tags:api:Register]]>                      | Function       | anywhere     | API Function to register a new user |
| <#[[en:public:developer:template_system:tags:api:Password_recovery]]>          | Function       | anywhere     | API Function reset the password |
| <#[[en:public:developer:template_system:tags:api:Login]]>                      | Function       | anywhere     | API Function to login |
| <#[[en:public:developer:template_system:tags:api:Logout]]>                      | Function       | anywhere     | API Function to logout|
===== Authentication functions =====

^ Syntax                                                                                    ^ Type           ^ Context      ^ Description ^
| <#[[en:public:developer:template_system:tags:authentication:google_oauth2callback]]>      | Function       | anywhere     | Handle the google Oauth 2 callback |
| <#[[en:public:developer:template_system:tags:authentication:facebook_oauth2callback]]>    | Function       | anywhere     | Handle the facebook Oauth 2 callback |
| <#[[en:public:developer:template_system:tags:authentication:windowslive_oauth2callback]]> | Function       | anywhere     | Handle the windowslive Oauth 2 callback |
| <#[[en:public:developer:template_system:tags:authentication:yahoo_oauth1authorization]]>  | Function       | anywhere     | Handle the yahoo Oauth 1 authorization popup |
| <#[[en:public:developer:template_system:tags:authentication:yahoo_oauth1callback]]>       | Function       | anywhere     | Handle the yahoo Oauth 2 callback |

===== debug tags =====

^ Syntax                                                                      ^ Type                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:debug:AdminLog_Enabled]]>      | function  | anywhere     | If the engine is build with admin log  |
| <#[[en:public:developer:template_system:tags:debug:Beta_Enabled]]>          | function  | anywhere     | If the engine is build for "beta"  |
| <#[[en:public:developer:template_system:tags:debug:Debug_Enabled]]>         | function | anywhere     | If the engine is build in "debug" mode |
| <#[[en:public:developer:template_system:tags:debug:Debug_TimeTaken]]>       | function  | anywhere     | the total time taken of the current request |
| <#[[en:public:developer:template_system:tags:debug:Debug_Templates_Used]]>  | var ([[en:public:developer:template_system:tags:string:TStringList]])  | anywhere     | The list of templates used by the current request |
| <#[[en:public:developer:template_system:tags:debug:Debug_Templates]]>       | var ([[en:public:developer:template_system:tags:string:TStringList]])  | anywhere     | The list of all the templates |

===== Contact related tags =====

^ Syntax                                                              ^ Type                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:contact:contact]]>      | var ([[en:public:developer:template_system:tags:contact:TContact]])  | anywhere     | Retrieve the details of one contact |
| <#[[en:public:developer:template_system:tags:contact:contacts]]>    | var ([[en:public:developer:template_system:tags:contact:TContacts]]) | anywhere     | Retrieve the details of several contacts |
| <#[[en:public:developer:template_system:tags:contact:user]]>         | var ([[en:public:developer:template_system:tags:contact:TContact]])  | anywhere     | Retrieve the details of current web user |

===== Error tags =====

^ Syntax                                                                       ^ Type              ^ Context        ^ Description                                      ^
| <#[[en:public:developer:template_system:tags:error:error_message]]>          | var (string)      | Error template | Error message                                    |
| <#[[en:public:developer:template_system:tags:error:error_btn_back_url]]>         | var (string)      | Error template | Url of the back button                           |
| <#[[en:public:developer:template_system:tags:error:error_btn_back_method]]>      | var (string)      | Error template | Method to use for the back action                |
| <#[[en:public:developer:template_system:tags:error:error_btn_back_post_params]]> | var ([[en:public:developer:template_system:tags:string:TStringList]]) | Error template | Params of the back action if it's a post method  |

===== Expression tags =====

^ Syntax                                                             ^ Type     ^ Context  ^ Description                             ^
| <#[[en:public:developer:template_system:tags:expression:abs]]>    | function | anywhere | return the absolute value of an expression       |
| <#[[en:public:developer:template_system:tags:expression:calc]]>    | function | anywhere | Calculator to evaluate expression       |
| <#[[en:public:developer:template_system:tags:expression:caseof]]>  | function | anywhere | Case of statement                       |
| <#[[en:public:developer:template_system:tags:expression:for]]>     | function | anywhere | for statement                            |
| <#[[en:public:developer:template_system:tags:expression:break]]>     | function | anywhere | break a loop                            |
| <#[[en:public:developer:template_system:tags:expression:if]]>      | function | anywhere | IF statement                            |
| <#[[en:public:developer:template_system:tags:expression:php]]>     | function | anywhere | Execute arbitrary PHP code              |
| <#[[en:public:developer:template_system:tags:expression:while]]>     | function | anywhere | while statement                            |

===== Geo Place related tags =====

^ Syntax                                                               ^ Type                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:geoplace:tgeoplace|Geoplace]]>     | var ([[en:public:developer:template_system:tags:geoplace:TGeoPlace]])  | anywhere     | Retrieve the details of one geo place|
| <#[[en:public:developer:template_system:tags:geoplace:tGeoplaces|Geoplaces]]>   | var ([[en:public:developer:template_system:tags:geoplace:TGeoPlaces]]) | anywhere     | Retrieve the details of several geo places |
===== Head element tags =====

^ Syntax                                                                          ^ Type     ^ Context  ^ Description                     ^
| <#[[en:public:developer:template_system:tags:headelement:Doctype]]>             | function | anywhere | The HTML <!DOCTYPE> Declaration |
| <#[[en:public:developer:template_system:tags:headelement:isChromeBrowser]]>     | function | anywhere | Return 1 if the browser is Chrome |
| <#[[en:public:developer:template_system:tags:headelement:isIEBrowser]]>     | function | anywhere | Return 1 if the browser is IE |
| <#[[en:public:developer:template_system:tags:headelement:isFirefoxBrowser]]>     | function | anywhere | Return 1 if the browser is Firefox |
| <#[[en:public:developer:template_system:tags:headelement:isSafariBrowser]]>     | function | anywhere | Return 1 if the browser is Safari |
| <#[[en:public:developer:template_system:tags:headelement:isOperaBrowser]]>     | function | anywhere | Return 1 if the browser is Opera |
| <#[[en:public:developer:template_system:tags:headelement:Meta_Title]]>          | function | anywhere | Return the <title>...</title> element |
| <#[[en:public:developer:template_system:tags:headelement:Meta_Description]]>    | function | anywhere | Return the <meta description=""> element |
| <#[[en:public:developer:template_system:tags:headelement:Meta_Keywords]]>       | function | anywhere | Return the <meta keywords=""> element |
| <#[[en:public:developer:template_system:tags:headelement:TMeta_Robots|Meta_Robots]]>         | var ([[en:public:developer:template_system:tags:headelement:TMeta_Robots]]) | anywhere | Return the <meta name="robots" content="..."> element |
| <#[[en:public:developer:template_system:tags:headelement:TMeta_pagination|Meta_Pagination]]>        | var ([[en:public:developer:template_system:tags:headelement:TMeta_Pagination]])  | anywhere | the link rel="next" and rel="prev" |
| <#[[en:public:developer:template_system:tags:headelement:TOpenGraph|OpenGraph]]>        | var ([[en:public:developer:template_system:tags:headelement:TOpenGraph]])  | anywhere | the list of meta used by the open graph protocole |
| <#[[en:public:developer:template_system:tags:headelement:Trsslinks|RssLinks]]>            | var ([[en:public:developer:template_system:tags:headelement:TRsslinks]]) | anywhere | The list of rss links of the current document  |
| <#[[en:public:developer:template_system:tags:headelement:Tstylesheets|StyleSheets]]>         | var ([[en:public:developer:template_system:tags:headelement:TStyleSheets]]) | anywhere | The list of stylesheets used by the document |
| <#[[en:public:developer:template_system:tags:headelement:Tjavascripts|JavaScripts]]>         | var ([[en:public:developer:template_system:tags:headelement:TJavaScripts]]) | anywhere | The list of javascripts used by the document |
| <#[[en:public:developer:template_system:tags:headelement:Textraheaders|ExtraHeaders]]>        | var ([[en:public:developer:template_system:tags:headelement:TExtraHeaders]])  | anywhere | Return the list of extra headers to add in the current document |

===== HTML input tags =====

^ Syntax                                                             ^ Type     ^ Context  ^ Description                             ^
| <#[[en:public:developer:template_system:tags:htmlinput:TButton|button]]>         | var ([[en:public:developer:template_system:tags:htmlinput:Tbutton]]) | anywhere | Create an HTML button |
| <#[[en:public:developer:template_system:tags:htmlinput:TCurrencyEdit|currencyedit]]>     | var ([[en:public:developer:template_system:tags:htmlinput:TCurrencyEdit]]) | anywhere | Create a currency input |
| <#[[en:public:developer:template_system:tags:htmlinput:TDateEdit|dateedit]]>     | var ([[en:public:developer:template_system:tags:htmlinput:TDateEdit]]) | anywhere | Create a date input |
| <#[[en:public:developer:template_system:tags:htmlinput:form]]>    | function | anywhere | The equivalent of the html <form> tag |
| <#[[en:public:developer:template_system:tags:htmlinput:input]]>  | function | anywhere | The equivalent of the html <input> tag  |
| <#[[en:public:developer:template_system:tags:htmlinput:Tminmaxdropdown|minmaxdropdown]]>     | var ([[en:public:developer:template_system:tags:htmlinput:Tminmaxdropdown]]) | anywhere | Create a min/max dropdown input |
| <#[[en:public:developer:template_system:tags:htmlinput:Tselectdropdown|selectdropdown]]>     | var ([[en:public:developer:template_system:tags:htmlinput:Tselectdropdown]]) | anywhere | Create a dropdown input |
| <#[[en:public:developer:template_system:tags:htmlinput:Tmultiselectdropdown|multiselectdropdown]]>     | var ([[en:public:developer:template_system:tags:htmlinput:Tmultiselectdropdown]]) | anywhere | Create a multiselect dropdown input |
| <#[[en:public:developer:template_system:tags:htmlinput:select]]>      | function | anywhere | The equivalent of the html <select> tag |
| <#[[en:public:developer:template_system:tags:htmlinput:textarea]]>     | function | anywhere | The equivalent of the html <textarea> tag |

===== Navigation tags =====

^ Syntax                                                                                         ^ Type          ^ Context                                                                ^ Description                                        ^
| <#[[en:public:developer:template_system:tags:navigation:tbreadcrumbs|Breadcrumbs]]>     | var ([[en:public:developer:template_system:tags:navigation:TBreadcrumbs]])      | anywhere                                                               | Create a breadcrumb trail navigation aid           |
| <#[[en:public:developer:template_system:tags:navigation:tmenu|Menu]]>                   | var ([[en:public:developer:template_system:tags:navigation:TMenu]])      | anywhere | Create a menu                                               |

===== Miscellaneous tags =====

^ Syntax                                                                       ^ Type     ^ Context  ^ Description ^
| <#[[en:public:developer:template_system:tags:miscellaneous:AMRequest]]>     | var ([[en:public:developer:template_system:tags:string:TStringList]])  | anywhere | The parsed values of the POST/GET data |
| <#[[en:public:developer:template_system:tags:miscellaneous:APPVersion]]>     | function | anywhere | Return the version of the template system |
| <#[[en:public:developer:template_system:tags:miscellaneous:Frame]]>          | function | anywhere | Return content from template or tag result |
| <#[[en:public:developer:template_system:tags:miscellaneous:Script]]>         | function | anywhere | Compress JavaScript |
| <#[[en:public:developer:template_system:tags:miscellaneous:Mobile]]>    | function  | anywhere | Return 1 if mobile version or 0 if desktop version |
| <#[[en:public:developer:template_system:tags:miscellaneous:Now]]>  | function  | anywhere | Return the current date with time |
| <#[[en:public:developer:template_system:tags:miscellaneous:Path_Templates]]>  | function  | anywhere | Return the templates directory path info |
| <#[[en:public:developer:template_system:tags:miscellaneous:Path_Cfg]]>  | function  | anywhere | Return the CFG directory path info  |
| <#[[en:public:developer:template_system:tags:miscellaneous:Random]]>  | function  | anywhere | Return a random number  |
===== Page related tags =====

^ Syntax                                                              ^ Type     ^ Context  ^ Description ^
| <#[[en:public:developer:template_system:tags:pagescfg:Page_Cfg]]>     | var (TXMLNode) | anywhere | Return the configuration xml of the current page |
| <#[[en:public:developer:template_system:tags:pagescfg:Page_Title]]>  | function | anywhere | Return the title of the current page |
| <#[[en:public:developer:template_system:tags:pagescfg:Page_Name]]>   | function | anywhere | Return the name of the current page |
| <#[[en:public:developer:template_system:tags:pagescfg:Page_Id]]>     | function | anywhere | Return the id of the current page |


===== Promotion related tags =====

^ Syntax                                                                      ^ Type                                                                     ^ Context      ^ Description ^
| <#[[en:public:developer:template_system:tags:promotion:TPromotions|Promotions]]>        | var ([[en:public:developer:template_system:tags:promotion:TPromotions]]) | anywhere     | To construct the list of promotional boxes for a given space |

===== Property related tags =====

^ Syntax                                                                     ^ Type                                                                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:property:property]]>          | var ([[en:public:developer:template_system:tags:property:TProperty]])   | anywhere     | Retrieve the details of one property|
| <#[[en:public:developer:template_system:tags:property:properties]]>        | var ([[en:public:developer:template_system:tags:property:TProperties]]) | anywhere     | Retrieve the details of several properties |

===== Property alert related tags =====

^ Syntax                                                                                ^ Type                                                                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:propertyalert:propertyalert]]>         | var ([[en:public:developer:template_system:tags:propertyalert:TPropertyalert]])   | anywhere   | Retrieve the details of one property alert |
| <#[[en:public:developer:template_system:tags:propertyalert:propertyalerts]]>        | var ([[en:public:developer:template_system:tags:propertyalert:TPropertyalerts]]) | anywhere     | Retrieve the details of several property alerts |

===== Prospect related tags =====

^ Syntax                                                                                ^ Type                                                                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:prospect:prospect]]>         | var ([[en:public:developer:template_system:tags:prospect:Tprospect]])   | anywhere   | Retrieve the details of one prospect |
| <#[[en:public:developer:template_system:tags:prospect:prospects]]>        | var ([[en:public:developer:template_system:tags:prospect:Tprospects]]) | anywhere     | Retrieve the details of several prospects |

===== Activity related tags =====

^ Syntax                                                                                ^ Type                                                                    ^ Context      ^ Description              ^
| <#[[en:public:developer:template_system:tags:activity:activity]]>         | var ([[en:public:developer:template_system:tags:activity:Tactivity]])   | anywhere   | Retrieve the details of one activity |
| <#[[en:public:developer:template_system:tags:activity:activities]]>       | var ([[en:public:developer:template_system:tags:activity:Tactivities]]) | anywhere     | Retrieve the details of several activities |
===== Repository tags =====

^ Syntax                                                                       ^ Type     ^ Context  ^ Description ^
| <#[[en:public:developer:template_system:tags:repository:const]]>          | function | anywhere | retrieve const value hard coded in the template system engine |
| <#[[en:public:developer:template_system:tags:repository:Language]]>       | function | anywhere | Return the current language |
| <#[[en:public:developer:template_system:tags:repository:tlanguages|Languages]]> | var ([[en:public:developer:template_system:tags:repository:TLanguages]]) | anywhere | list of all the available languages |
| <#[[en:public:developer:template_system:tags:repository:Currency_Code]]>  | function | anywhere | Return the currency code of the current session |
| <#[[en:public:developer:template_system:tags:repository:Currency_Symbol]]> | function  | anywhere | Return the currency symbol of the current session |
| <#[[en:public:developer:template_system:tags:repository:Currency_Label]]>  | function  | anywhere | Return the currency label of the current session  |
| <#[[en:public:developer:template_system:tags:repository:Currency_format]]>  | function  | anywhere | Return currency symbol placement and separation |
| <#[[en:public:developer:template_system:tags:repository:SurfaceUnit_label]]>  | function  | anywhere | Return the surface unit label (sqm of sqf) of the current session |
| <#[[en:public:developer:template_system:tags:repository:LengthUnit_label]]>  | function  | anywhere | Return the length unit label (meter of feet) of the current session |
| <#[[en:public:developer:template_system:tags:repository:ThousandSeparator]]>  | function  | anywhere | Return the current Thousand Separator |
| <#[[en:public:developer:template_system:tags:repository:DecimalSeparator]]>  | function  | anywhere | Return the current Decimal Separator |
| <#[[en:public:developer:template_system:tags:repository:MeasurementSystem]]>  | function  | anywhere | Return the Measurement System of the current session |
| <#[[en:public:developer:template_system:tags:repository:MeasurementSystem_label]]>  | function  | anywhere | Return the Measurement System label of the current session  |
| <#[[en:public:developer:template_system:tags:repository:Month_title]]>  | function  | anywhere | Return the title of the month  |
| <#[[en:public:developer:template_system:tags:repository:tlookupvalues|LookupValues]]>  | var ([[en:public:developer:template_system:tags:repository:TLookupValues]])  | anywhere | Return a values of some lookup values list |

===== Session related tags =====

^ Syntax                                                                ^ Type     ^ Context  ^ Description                             ^
| <#[[en:public:developer:template_system:tags:session:Client_Ip]]>      | function | anywhere | retrieve the ip of the current user |
| <#[[en:public:developer:template_system:tags:session:Client_id_Country]]>      | function | anywhere | retrieve the id of the country of the current user |
| <#[[en:public:developer:template_system:tags:session:Client_id_GeoPlace]]>      | function | anywhere | retrieve the id of the geoplace of the current user |

===== Forum related tags =====
^ Syntax                                                                ^ Type     ^ Context  ^ Description                             ^
| <#[[en:public:developer:template_system:tags:forums:forum_lastthreads]]>      | function | anywhere | returns the list of recently updated forum topics |


===== String manipulation tags =====

^ Syntax                                                                ^ Type     ^ Context  ^ Description                             ^
| <#[[en:public:developer:template_system:tags:string:datacache]]>      | function | anywhere | To cache data in memory |
| <#[[en:public:developer:template_system:tags:string:format]]>         | function | anywhere | to format values |
| <#[[en:public:developer:template_system:tags:string:frame]]>          | function | anywhere | to include the content of another templates |
| <#[[en:public:developer:template_system:tags:string:guid]]>           | function | anywhere | return a GUID |
| <#[[en:public:developer:template_system:tags:string:nullstr]]>        | function | anywhere | Return a null string |
| <#[[en:public:developer:template_system:tags:string:pos]]>            | function | anywhere | Returns the index of the first occurrence of a substring within a string |
| <#[[en:public:developer:template_system:tags:string:randomstr]]>      | function | anywhere | return a random string |
| <#[[en:public:developer:template_system:tags:string:section]]>        | function | anywhere | Define section inside the html |
| <#[[en:public:developer:template_system:tags:string:stringreplace]]>  | function | anywhere | Replaces occurrences of a substring within a string. |
===== Http protocol related tags =====

^ Syntax                                                                                    ^ Type     ^Contex        ^ Description ^
| <#[[en:public:developer:template_system:tags:httpprotocol:Http_Method]]>                         | function | anywhere     | Return the HTTP method (GET or POST) of the current request |
| <#[[en:public:developer:template_system:tags:httpprotocol:Https_On]]>                            | function | anywhere     | Return 1 if the current request is secure |
| <#[[en:public:developer:template_system:tags:httpprotocol:twebrequest|WebRequest]]>            | var ([[en:public:developer:template_system:tags:httpprotocol:twebrequest]]) | anywhere     | Return http web response object |
| <#[[en:public:developer:template_system:tags:httpprotocol:twebresponse|WebResponse]]>          | var ([[en:public:developer:template_system:tags:httpprotocol:twebresponse]]) | anywhere     | Return http web request object |


===== Url related tags =====

^ Syntax                                                                                    ^ Type     ^Contex        ^ Description ^
| <#[[en:public:developer:template_system:tags:url:BaseHref]]>                            | function | anywhere     | Return the base URL/target for all relative URLs |
| <#[[en:public:developer:template_system:tags:url:StaticBaseHref]]>                      | function | anywhere     | Return the base URL/target for all relative URLs that point to static documents |
| <#[[en:public:developer:template_system:tags:url:Url]]>                                 | function | anywhere     | Return the current url or the url assigned to a given ID  |
| <#[[en:public:developer:template_system:tags:url:TUrlInfos|UrlInfos]]>                            | var ([[en:public:developer:template_system:tags:url:TUrlInfos]]) | anywhere     | Return the infos extracted from the current url |
\\
\\

====== List of reserved variables ======

===== Reserved Get/Post Parameters =====

^ Name                                                                                          ^ Description ^
| [[en:public:developer:template_system:reserved_parameters:ak.Session_id]]                    | The current session ID |
| [[en:public:developer:template_system:reserved_parameters:ak.Currency_code]]                 | The currency code to use for the response |
| [[en:public:developer:template_system:reserved_parameters:ak.MeasurementSystem]]             | The measuremen system to use for the response |
| [[en:public:developer:template_system:reserved_parameters:ak.Login]]                          | Login of the user |
| [[en:public:developer:template_system:reserved_parameters:ak.Pwd]]                            | Password of the user |
| [[en:public:developer:template_system:reserved_parameters:ak.Stayconnected]]                  | Auto login the user |
| [[en:public:developer:template_system:reserved_parameters:ak.lpkey]]                          | Encrypted credential |
| [[en:public:developer:template_system:reserved_parameters:ak.Logout]]                         | Logout the user |
| [[en:public:developer:template_system:reserved_parameters:ak.version]]                        | The version of the Arkadia Script engine |
| [[en:public:developer:template_system:reserved_parameters:ak.no_datacache]]                   | ignore all datacache |

===== Reserved Cookie Names =====

^ Name                                                                               ^ Description ^
| [[en:public:developer:template_system:reserved_parameters:ak_Session_id]]         | The current session ID |
| [[en:public:developer:template_system:dedicatedparameters:ak_Currency_code]]      | The currency code to use for the response |
| [[en:public:developer:template_system:reserved_parameters:ak_MeasurementSystem]] | The measuremen system to use for the response |
| [[en:public:developer:template_system:reserved_parameters:ak_Language]]           | The language to use for the response |
| [[en:public:developer:template_system:reserved_parameters:ak_lpkey]]                          | Encrypted credential |
| [[en:public:developer:template_system:reserved_parameters:ak_Source]]             | The source of the user |

===== Reserved HTTP Headers =====

^ Name                                                                                  ^ Description ^
| [[en:public:developer:template_system:reserved_parameters:X-AK-Language]]             | The language to use for the response |
| [[en:public:developer:template_system:reserved_parameters:X-AK-Mobile]]               | Use mobile version for the response |
| [[en:public:developer:template_system:reserved_parameters:X-AK-Whitelabel-PartnerID]] | The ID of the whitelabel partner |
doc.arkadia.com

User Tools

Site Tools

Page Tools
