{"id":481252,"date":"2008-07-18T15:16:34","date_gmt":"2008-07-18T19:16:34","guid":{"rendered":"https:\/\/segue.middlebury.edu\/view\/html\/node\/481252"},"modified":"2008-07-18T15:16:34","modified_gmt":"2008-07-18T19:16:34","slug":"text-templates","status":"publish","type":"page","link":"https:\/\/segueproject.org\/segue-documentation\/segue-v2\/documentation\/extending-segue\/text-templates\/","title":{"rendered":"Text-Templates"},"content":{"rendered":"

About Text-Templates<\/h3>\n
\n

Text-templates are simple systems for creating dynamic text similar to MediaWiki templates.
\nAccess to text-templates is done by adding the following markup to text:
\n   
\n    {{template_name}}<\/font>
\n   
\nAdditionally, optional named parameters can also be passed to text-templates:
\n   
\n    {{template_name|paramName=value|param2Name=value2}}<\/font><\/p>\n

Text-templates can be useful for inserting predefined scripts or objects into HTML
\nwithout allowing cross-site scripting attacks. They can also be used to make common
\nhtml blocks easier to display or change.<\/p>\n

For a listing of Text-Templates that come with Segue, see the Features page on Text-Templates<\/a>.<\/p>\n

Text templates other than those that come with Segue must be installed by the Segue administrator with access to the Segue installation directory. They cannot be installed by end-users.\n<\/p><\/div>\n

Writing Text-Templates<\/h3>\n
\n

Name:<\/strong>
\nText-template names should be lowercase letters, numbers, and underscore characters.
\n
\nLocation:<\/strong>
\nText-templates that you write should go in the following directory.
\n    segue\/text_templates-local\/<\/font><\/p>\n

File Name:<\/strong>
\nName you template file with the template name plus ‘.class.php’. For the following examples
\nwill will use the name ‘video’ for the template described. This means the template file
\nwould be:
\n    segue\/text_templates-local\/video.class.php<\/font>
\n   
\nClass:<\/strong>
\nText-templates must contain a class that implements the Segue_Wiki_TextTemplate interface
\nwhich defines two methods: generate($paramList) and getHtmlMatches($text).
\nIt must be named with its name prepended by ‘Segue_TextTemplates_’.
\nUsing our video example:<\/p>\n

<?php

class Segue_TextTemplates_video
\timplements Segue_Wiki_TextTemplate 
{
\t
\t....
\t
\t\/**
\t * Generate HTML given a set of parameters.
\t * 
\t * @param array $paramList
\t * @return string The HTML markup
\t * @access public
\t *\/
\tpublic function generate (array $paramList) {
\t\t....
\t}
\t
\t\/**
\t * Answer an array of strings in the HTML that look like this 
\t * template's output and list of parameters that the HTML 
\t * corresponds to. e.g:
\t *   
\t * array(
\t *\t"<img src='http:\/\/www.example.net\/test.jpg' width='350px'\/>" 
\t *\t\t=> array (\t'server'\t=> 'www.example.net',
\t *\t\t\t\t'file'\t\t=> 'test.jp',
\t * \t\t\t\t'width'\t\t=> '350px'))
\t * 
\t * This method may throw an UnimplementedException if this is not
\t * supported.
\t *
\t * @param string $text
\t * @return array
\t * @access public
\t *\/
\tpublic function getHtmlMatches ($text) {
\t\t....
\t}
\t
\t....
}

?><\/pre>\n
\nConfiguration:<\/strong>
\nDefault configuration files are to be placed in the main Segue configuration directory
\nnamed ‘text_template-‘ followed by their name followed by ‘_default.conf.php’. Custom
\nconfiguration files are named the same, but followed by ‘.conf.php’.
\nUsing our video example the default config file is located at:
\n    segue\/config\/text_template-video_default.conf.php<\/font><\/p>\n
and a custom config with different settings would live at:
\n    segue\/config\/text_template-video.conf.php<\/font><\/p>\n
You can access the instance of you template in the config file using the getTextTemplate()
\nmethod on the WikiResolver object. e.g.:<\/p>\n
    $video = WikiResolver::instance()->getTextTemplate(‘video’);<\/font>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
About Text-Templates Text-templates are simple systems for creating dynamic text similar to MediaWiki templates. Access to text-templates is done by adding the following markup to text:         {{template_name}}     Additionally, optional named parameters can also be passed to text-templates:… More →<\/a><\/p>\n","protected":false},"author":29,"featured_media":0,"parent":481179,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-481252","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/pages\/481252","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/users\/29"}],"replies":[{"embeddable":true,"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/comments?post=481252"}],"version-history":[{"count":0,"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/pages\/481252\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/pages\/481179"}],"wp:attachment":[{"href":"https:\/\/segueproject.org\/segue-documentation\/wp-json\/wp\/v2\/media?parent=481252"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}