Mon, 28/02/2005 - 14:50 by openZpace

A. "smart-tags" are special commands that you can include in the body of content items that you post to your site and in various settings that you use to customise your site. When a smart-tag is displayed it is replaced with content generated as a result of the selected command. Note that the result of a smart-tag is always checked against any access permissions that you've set before being presented to the user viewing the smart-tag.

A smart-tag is typically of the form [command:option1|option2|...] and the currently available smart-tags are described below.

Note that when referring to specific values that may be used for the options they are shown here as "value" but the quotation marks should not be included in an actual smart-tag. To omit an option simply, leave it blank eg: [command:||value3] would set option3 to "value3" while option1 and option2 are omitted resulting in appropriate default behaviour.

Important: Except where explicitly noted below, you cannot include one smart-tag inside another.

Command Description

user

Displays the nick_name of the the current user as a link to their entry in the userlist.

There are no options.

date

Displays the current date and time.

option1 can be one of "small" "medium" or "large" indicating how the date and time should be displayed.

menu

Displays a list of the currently available menu items as clickable links.

There are no options.

login

If the current user is not logged on, displays a form allowing input of username and password together with a clickable login button. If the current user is logged in, displays their username and a Logout button.

option1 controls the display of additional information about a logged on user. If it has the value "1", the length of time that the user has been logged in is shown. A value of "2" causes the user's IP address to be shown and a value of "3" causes both the session duration and IP address.

Any value for option2 is simply presented as a title for the form.

secure

Displays a lock icon indicating whether the current connection is secures by ssl (https) or not. Clicking the icon will toggle the connection between normal and secure modes.

There are no options.

online

Displays the numbers of site members and vistors who are "online" (by which we mean have interacted with the site within the last few minutes). The nick_names of the most recently active site members can also be shown.

option1 defines the period in minutes within which an action must have occured for a user to be considered online thus a value of "15" means 15 minutes.

option2 controls the display of member nick_names. A value of "5" means that up to 5 nick_names will be shown. A value of "0" would mean that no nick_names are shown.

archives

Displays the small "archive" callendar that indicates on which days content was posted to the site.

There are no options.

events

Displays the small event calendar that indicates on which days events have been entered.

There are no options. 

create

Displays a small form allowing the user to create a new item of content of a chosen type.

There are no options.

search

Displays a clickable link that will trigger a pre-defined search for content on the site.

option1 is the text to search for.

option2 is a string of 1s and 0s that determine which types of site content will be searched. Possible value are:

"10000000"  - journals only
"01000000"  - photos only
"00100000"  - events only
"00010000"  - files only
"00000100"  - items with comments only
"00000010"  - news items only
"00000001"  - users only

You can of course combine these values so for example "11110000" would search journals, photos, events and files.

option3 is the text to be shown for the link.

For example [search:email|10000000|email faqs] produces this link : email faqs

searchbox

Displays a mini form allowing the user to search the site.

option1 seeds the form with the text to be searched for.

option2 provides a title for the form.

email

Displays the number of items in the current users email inbox.

There are no options.

alerts

Displays links allowing the user to review their current "alert" selection and enable/disable their alerts.

There are no options.

textbox

Displays a mini form allowing the user to send a text (SMS) from the site. Note that this requires separate purchase of message credits.

option1 sets the prompt for the message input field.

option2 sets the display width of the message field eg "20" would mean 20 characters in width.

option3 sets the prompt for the destination mobile number field

option4 sets the display width of the destination field.

option5 sets the prompt for originator field (ie where the text will appear to have come from.)

option6 sets the display width for the originator field

option7 sets a default value for the originator

Note that if options 5 - 7 are omitted, the originator value will be that set in the site wide "Messaging" settings. 

itemlist

Displays a summary list of items on your site.

option1 is a comma separated list of content types to include. To include all types of items you would set this value to "journal,photo,event,file,comment,news,users". To include just news and event items use: "event, news". The items in the list are sorted by their date of creation.

option2 can be used to restrict the list to only those items created by a specific author or (for news items) within a specific feed. The value is the numeric user_id or feed_id - these values are shown as the last part of the url from which you view the user or news feed details.

option3 can be used to restrict the list to only those items within a specific topic. The value is the numeric topic_id shown as the last part of the url from which you view the details of a topic.

option4 can be used to specify a search string that must also be matched by any item returned.

option5 is the maximum number of items to list before a "more..." link is displayed eg: "5" to show up to 5 items.

For example [itemlist:journal|10|9|itemlist|3] will produce up to 3 faqs from this site, written by "openZpace" in the "Setting up my site" topic, containing the word "itemlist" . Like this :

»Q 2. What are "smart-tags"?
01/03/2005 - 11:55

hotlist
toplist

These display a summary lists (like the itemlist above) but sorted by the items hot rating or total view count respectively.

option1 is a comma separated list of content types to include. Unlike itemlist, the possible types are limited to  "journal,photo,event,file".

option2 - the user_id as for an itemlist.

option3 - the topic_id as for an itemlist.

option4 is the maximum number of items in the list.

itemlistx
hotlistx
toplistx

These "x" variants of itemlist, hotlist and toplist are similar in use to the standard (non-x) command. They are different in that the output produced is:

  • Sorted alphabetically by the title of the item
  • Only the item title is shown

randpic

Displays a random photo thumbnail as a clickable link to the photo item in your gallery.

The options are the same as for an itemlist above. However, option1 and option5 are ignored and thus should be omitted.

photo

Displays a full size photo as a clickable link to the photo item in your gallery.

option1 is the numeric id of the photo on your site. The photo_id is shown in the title of the item in list and detail views of your photos. This option is required.

Additionally you can append further parameters to the photo_id as a comma separated list that control how the photo is displayed. The full form of option1 is "photo_id,alignment,hspace,vspace,border" where:

  • alignment can be one of "left", "right", "top", "middle", "bottom", "absmiddle", "texttop" or "baseline" - indicating how the photo should be aligned relative to other text on the same line.
  • hspace and vspace are numeric amounts of the horizontal and vertical space (pixels) that should surround the photo.
  • border is the numeric width (pixels) of any border that should be shown for the photo.

Note that smart-tags are highly recommended for embedding your photos in other content (such as journals) as opposed to inserting a traditional url. Firstly, they save space as they're much more compact than full urls but more importantly, when a photo smart-tag is processed, it automatically handles the case when the item is being viewed over WAP and will if required convert the image to a format that can be handled by the mobile phone.

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

picture

Displays a full size photo but not as a clickable link.

Options and behaviour are otherwise the same as photo above.

* This smart-tag can be included in other smart-tags (except other includable smart-tags). 

image

Displays a photo thumbnail as a clickable link to the full size photo item in your gallery.

Options and behaviour are otherwise the same as photo above.

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

files

Displays a clickable "file" icon that a enables a file item to be downloaded.

Options and behaviour are otherwise the same as photo above (use the file item id rather than a photo_id).

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

event

Displays a clickable "event" icon that enables an event to be downloaded.

Options and behaviour are otherwise the same as photo above (use the event item id rather than a photo_id).

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

ilink

Displays the url of a full size photo from your gallery.

Options and behaviour are otherwise the same as photo above except that any display parameters after the photo_id are ignored and so should be omitted.

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

ilinkx

Displays the url of a full size photo from your gallery.

This "x" variant is the same as ilink above except that all access rules relating to photos are bypassed. For example - if you have organised your site so that photos are not publically available but want to include a specific photo in say your page title then the html code <img src="[ilinkx:123]"> would do the job.

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

alink

Displays an arbitrary clickable link.

option1 is the text shown for the link.

option2 is the url.

rlink

Displays a clickable link to a url on your site.

option1 is the text shown for the link.

option2 is a relative url

option3 to optionN are attribute name/value pairs of the form name=value eg: title="my page"

Note: rlink is recommended for internal site links as it is WAP friendly.

rlinki

Displays an image from your site from a relative url.

option1 is a relative url

Note: rlinki is recommended for internal site links as it is WAP friendly.

* This smart-tag can be included in other smart-tags (except other includable smart-tags).

break

Does not display anything. break can be used to indicate exactly where the body text of an item should be truncated when displaying the item summary in list views. Otherwise the site wide length limit you specify in "content creation" settings will be applied.

There are no options.

private

The private smart-tag has a different format to all other smart-tags. Its form is:

[private:any text or other smart-tags:private]

Any content including any smart-tags contained between the opening [private: and the closing :private] will only be displayed to users who have logged on to the site.

There are no options.