{"id":481328,"date":"2008-08-19T17:06:14","date_gmt":"2008-08-19T17:06:14","guid":{"rendered":"https:\/\/segue.middlebury.edu\/view\/html\/node\/481328"},"modified":"2013-09-21T17:49:09","modified_gmt":"2013-09-21T17:49:09","slug":"text-templates","status":"publish","type":"page","link":"https:\/\/segueproject.org\/segue-documentation\/about-segue\/text-templates\/","title":{"rendered":"Shortcodes"},"content":{"rendered":"

Shortcodes are simple tags for creating dynamic text or embedding objects like is done in platforms such as WordPress. \u00a0Shortcode is adding using the following markup to text:<\/p>\n

\n

\u00a0\u00a0\u00a0 {{template_name}}<\/span><\/p>\n

Additionally, optional named parameters can also be passed to shortcodes:<\/p>\n

{{template_name|paramName=value|param2Name=value2}}<\/span><\/p>\n

Shortcodes\u00a0can 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

Below is a listing of shortcodes\u00a0that came with Segue.<\/p>\n<\/div>\n

Video Shortcode<\/h3>\n
\n

video<\/h4>\n

This template will allow the embedding of Flash Video from a variety of sources. These sources must be configured by the Segue administrator if they are not included in the default configuration.<\/p>\n

Parameters:<\/h4>\n
\n
service<\/strong><\/dt>\n
<\/dt>\n
The service at which this video is hosted — all lowercase. Examples: youtube, youtube_playlist, google, vimeo, hulu<\/dd>\n
id<\/strong><\/dt>\n
The Id of the video, the specific form of this dependent on the service, but generally this can be found in the URL for flash-video file. Example for YouTube: s13dLaTIHSg<\/dd>\n
width<\/strong><\/dt>\n
The integer width of the player in pixels. Example: 325<\/dd>\n
height<\/strong><\/dt>\n
The integer height of the player in pixels. Example: 250<\/dd>\n<\/dl>\n

Example Usage:<\/h4>\n

{{video|service=youtube|id=s13dLaTIHSg|width=425|height=344}}<\/span>
\n[youtube s13dLaTIHSg 425 344]<\/p>\n

Note:\u00a0If you paste the embed code from a supported service into a text block, it will automatically be converted into the template markup when saved.<\/p>\n<\/div>\n

Search Text-Template<\/h3>\n
\n
\n

search<\/h4>\n

This template will insert a search form that will open a new window with the search criteria supplied. The default search provider is Google, but other search providers can be used by specifying base_url<\/em> and search_param_name<\/em> options.<\/p>\n

Parameters:<\/h4>\n
\n
base_url<\/strong><\/dt>\n
The base url that the search form will submit to. If specified, the param_name must be specified as well.<\/dd>\n
search_param_name<\/strong><\/dt>\n
The name of the query parameter that will be added to the URL.<\/dd>\n
size<\/strong><\/dt>\n
Optional: The number of characters to show in the field<\/dd>\n
button_text<\/strong><\/dt>\n
Optional: The text to display in the button field, the default is ‘Search’<\/dd>\n
additional_params<\/strong><\/dt>\n
Optional: A url encoded string of paramName=parmValue&paramName2=paramValue2 to be added to the query string. Example ‘lang=en_US&go=true’<\/dd>\n
provider<\/strong><\/dt>\n
Optional: A preconfigured search. If used, all other options except size will be ignored. Allowed values: google, wikipedia, yahoo, youtube<\/dd>\n<\/dl>\n

Example Usage:<\/h4>\n