glFusion Wiki

Site Tools


glfusion:autotags:usage

album:

The album auto tag will create a thumbnail image using the album cover. This auto tag can only use the thumbnail image.

[album:album_id {options}]

Parameters

width:##
Sets the width of the thumbnail image to ## px wide.
height:##
Sets the height of the thumbnail image to ## px high.
align:left, right, auto or none
Determines the alignment for the auto tag, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the thumbnail image).
linkid:##
If linkid: is specified, the album autotag will link to the media item specified with the linkid: parameter. Omit the linkid: parameter to have the album autotag link to the album view.
border:0/1
  • 1 places a border (frame) around the thumbnail.
  • 0 will disable the border.
link:0/1
  • 1 enables the thumbnail having a link to the album.
  • 0 disables the hot-link, instead the album cover thumbnail will be displayed with no link.
caption
Any text before the closing ] in the autotag will be used as the caption for the thumbnail image.

Example:

[album:1 width:200 height:200 align:auto border:1 link:1 A sample album auto tag]

This example will place the album cover thumbnail in the story using a height/width of approximately 200×200 pixels. Media Gallery will preserve the aspect ratio of the image, so the size may not be exactly 200×200 but it will not be any larger than 200×200. The alignment of the thumbnail will be automatically alternated between right and left depending on the other autotags in the story, and it will have a small border around it and will be hyperlinked to the album view. The caption will display below the thumbnail.


alink:

Places a text link to an album - No thumbnail is used.

[alink:album_id {link_text}]

Parameters

href text
Any text before the closing ] in the autotag will be used as the href text.

audio:

Places a small (15×200 no thumbnail or 200×200 with thumbnail) audio player in your story. If there is an attached thumbnail to the audio item, it will be displayed above the player controls.

[audio:media_id {options}]

Parameters

align:left, right, auto or none
Specifies the alignment of the audio player in the content, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the audio player).
autoplay:0/1
If set to 1 the audio will automatically begin playing, if set to 0, the user will need to press the play button to begin playing.

calendar:

Returns a link to a calendar event.

[calendar:event_id {link_text}]

Parameters

event_id
Must be immediately following the colon (:). This is the calendar event id to link to.
link text
Text of the link

Example:

  [calendar:123456 Next Event]

This will produce a link to the calendar event ID of 123456 with the link text of Next Event


cipher:

Text: substitution cipher. Usage example is ROT13:

[cipher:nopqrstuvwxyzabcdefghijklm text_to_encode]


download:

Allows for media items or any item stored in an album to be downloaded by the user.

[download:media_id {link_text}]

Parameters

caption
Any text before the closing ] in the autotag will be used as the caption for the download.

file:

Returns a link: to a File download detail page. link_text defaults to the file title.

[file:file_id {link_text}]

Parameters

file_id
The FileMgmt file id to link to
caption
Any text before the closing ] in the auto tag will be used as the caption for the download.

Example:

  [file:12345 latest glFusion Release]

This will produce a link to file ID 12345 with the link text of latest glFusion Release.


file_download:

Returns a link to a direct File download. link_text defaults to the file title if not specified on the auto tag.

[file_download:file_id {link_text}]

Parameters

file_id
The FileMgmt file ID to link to.

forum:

Returns a link to a Forum post. link_text defaults to the post topic if not specified on the auto tag.

[forum:post_id {link_text}]

Parameters

post_id
The ID of the topic to link to
link_text
Optional text to place in the link - for example Click here to see cool stuff would make Click here to see cool stuff the link text.

fslideshow:

Places a Flash slideshow applet in the story.

[fslideshow:album_id {options}]

Parameters

title:bottom/top
If specified, the image title will be displayed in a banner along the top or the bottom of the slideshow.
delay:#
Number of seconds to display each image.
link:0/1
Provide a hyperlink to the image: 0=no link 1=link
width:##
Sets the width of the Flash slideshow to ## px wide.
height:##
Sets the height of the Flash slideshow to ## px high.
align:left, right, auto, or none
Specifies the alignment of the slideshow in the content, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the Flash slideshow).
caption
Any text before the closing ] in the autotag will be used as the caption for the Flash slideshow.

glfwiki

Returns a link to the glfusion.org wiki search result for the text specified.

[glfwiki:wiki_page_id]

Parameters

wiki_page_id
The wiki page ID to link to - for example, to link to the Quick Start Guide page the page id is glfusion:quickstart

headlines:

Returns HTML embeds article headlines.

[headlines:topic_name or all display:## meta:0/1 titlelink:0/1 featured:0/1 frontpage:0/1 cols:# template:template_name]

Parameters

topic_name
Specify the topic_id to pull articles from, or use all to pull from all topics
display:##
The number of articles to pull - if not specified, default is 10
meta:0/1
Use 1 to include meta data (i.e.; name, date, comments) or 0 to turn off meta data
titlelink:0/1
Use 1 to have the title a link to the full article, 0 only shows the title
featured:0/1/2
  • 0 = show all (default)
  • 1 = only featured
  • 2 = all except featured
frontpage:0/1
Use 1 to only pull articles that have the front page attribute, 0 pull from all articles
cols#:
The number of columns to use when displaying articles - defaults to 3 if not provided
truncate:##
Truncates the story introtext to ## characters
template:_name_
You can pass which template to use, or specify a template you have created. Included template are listed below - see the description below the parameters:
  • headlines.thtml
  • headlines-overlay.thtml
  • headlines-panels.thtml
  • headlines-slider.thtml
  • headlines-slideshow.thtml You can create your own custom template if you wish.
storyimage:0/1/2
  • 0 = Only pull articles without an attached story image.
  • 1 = Only pull articles with an attached story image.
  • 2 = Pull all articles, with or without an attached story image.

The templates will display the following:

headlines.thtml
This is the default, if no template is given, this will be used. This template will show the standard article display with the Story Image on top, the article title, meta data (if meta:1) and the article intro text.
headlines-overlay.thtml
This will only display stories with a Story Image. They are displayed in a dynamic grid with an hover effect during mouseover.
headlines-panels.thtml
Will display the stories with Story Image (if set on the story) in a small grid of panels. If no story image is set for the story, it will display the story title and a small excerpt of the story text.
headlines-slider.thtml
This will display the story image of each story in a slider, with overlay of the title and sub-title
headlines-slideshow.thtml
This will only display stories with a story image. Presents a slide show of story images with an overlay of the story title and sub-title.

An In-depth Look at headlines with Customization Tutorial and Hack Tips


img:

Creates a raw <img> tag of the media item with an optional link to that media item. The img: auto tag does not support any formatting beyond the thumbnail size and alignment. The purpose of this auto tag is to give you the ability to place a raw HTML <img> tag in your story. Also, the img: auto tag does not provide a link to the original image.

[image:## width:### height:### align:right/left/center src:orig/disp/tn]

Parameters

## - media ID
The media ID of the image from Media Gallery to display.
width:##
Sets the width of the thumbnail image to ## px wide.
height:##
Sets the height of the thumbnail image to ## px high.
align:left, right, auto, or none
Specifies the alignment of the thumbnail in the content, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the thumbnail).
src:orig, disp, or tn
Specifies which image to use as the source. The original image (full size), the display image, or the thumbnail. If no src: is given, the thumbnail image is used by default.

link:

Creates an HTML link to the detail page to a link from the Links Plugin.

[link:### {optional link text}]

Parameters

## - Link ID
The first parameter following the : is the ID of the link.
link text
If left blank (not included) the auto tag will default to the name of the link. If provided, the auto tag will use this as the text of the link

media:

The media autotag is the general purpose autotag, it will work with any media. For audio and video media, it will display the attached thumbnail or the generic media thumbnail if there is no attached thumbnail. For image media, it will display the media item's thumbnail.

[media:### width:### height:### border:0/1 align:left/right/center src:orig/disp/tn alt:0/1 {optional caption}]

Parameters

### -media ID
The media ID from Media Gallery of the media item to display.
width:##
Sets the width of the thumbnail image to ## px wide.
height:##
Sets the height of the thumbnail image to ## px high.
border:0/1
1 places a border (frame) around the thumbnail. 0 will disable the border.
align:left, right, auto, or none
Sets the alignment for the thumbnail, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the thumbnail image).
src:orig, disp or tn
Specifies which image to use as the source, the original image (full size), the display image, or the thumbnail. If no src: is given, the thumbnail image is used by default.
alt:0/1
1 will use the alternate URL of the media item for the href link. 0 will link directly to the media item (set the alternate URL in the Media Edit screen).
caption
Any text before the closing ] in the autotag will be used as the caption for the image.

For example

[media:200706012342 What a pretty flower] will become:


menu:

Returns the HTML to display a JavaScript-enhanced menu. usage :

[menu:menu_id]

Generally, this would be used in a template to display a specific menu you have defined in Menu Builder.

This auto tag is used in the standard header.thtml to display the top navigation menu:

{!!autotag menu:navigation !!}

mgslider:

Displays a UIKIT based slideshow of images from the specified album.

[mgslider:## kenburns:0/1 autoplay:0/1 template:_template_name]

Parameters

##
Album ID - the first parameter following mgslider:## is the album id where the images are stored.
kenburns:0/1
If set to 1, apply the Ken Burns effect
autoplay:0/1
|If set to 1, begin playing the slideshow and automatically advance through the slides. If set to 0, the user will have to scroll through the images manually.
template:_templatename_
Allows you to specify a custom template to use for building the HTML. Custom auto tag templates are stored in the public_html/layout/THEMENAME/autotags/ directory. You can use the default template, /private/system/autotags/mgslider.thtml, as a starting point for your custom template.

Notes: When creating a slider, it is always a good idea to use images with the same orientation and size. For example, landscape images display much better than portrait images in a slider.


mlink:

Places a text link to a media item - No thumbnail is used.

[mlink:media_id alt:0/1 optional text for link]

Parameters

alt:0/1
1 will use the alternate URL of the media item for the href link. 0 will link directly to the media item (set the alternate URL in the Media Edit screen).
href text
Any text before the closing ] in the autotag will be used as the href text.

newimage:

Displays a flexible grid of all new images from Media Gallery up to the number specified.

[newimage:## truncate:0/1 caption:0/1]

Parameters

##
The first parameter, immediately following the newimage: is the number of new images to display.
truncate:0/1
If this is set to 1, newimage will reduce the number of new images to show to ensure the bottom row is always full. For example, if you set the number of images to show to 20, and newimage is able to fit 6 images on each row, only 18 will show to prevent the last row from having only 2 images shown.
caption:0/1
If this is set to 1, the Media Title data will be shown on the image, setting to 0, no title information is shown.

Sample


playall:

This places a MP3 jukebox into your story. It will contain a playlist of all the MP3 media in the album.

[playall:album_id align:left autoplay:#]

Parameters

album id
The album id of the album that contains the audio media
align:left, right, auto, or none
Sets the alignment for the audio player, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the audio player).
autoplay:#
If set to 1 the audio will automatically begin playing, if set to 0, the user will need to press the play button to begin playing.

Example


poll:

Displays a link to a poll, designed by Poll ID.

[poll:poll_id {link text}]

Parameters

##
The Poll ID of the poll to link to.
link text
Any text after the Poll ID will be used as the link text

Example

  [poll:features Click Here to take our poll on New Features]

This will provide a link to the Poll features with the link text of Click Here to take our poll on New Features


poll_result:

Returns the poll results view for a specific poll.

[poll_result:##]

Parameters

##
The Poll ID of the poll to show results for.

Example

  [poll_results:features]

This will provide a link to the Poll Results for poll features.


poll_vote:

Displays the poll questions for a specific poll. If the user has already voted, the polls results are displayed.

Parameters

##
The Poll ID of the poll to link to.

Example

  [poll_vote:features]

This will display the poll vote questions for Poll ID features.


showblock:

This will display a glFusion block. This is generally used in a static page to display a glFusion block.

Parameters

##
The block id of the block to display

slideshow:

Places a JavaScript slideshow applet in the story.

Parameters

width:##
Sets the width of the thumbnail image to ## px wide.
height:##
Sets the height of the thumbnail image to ## px high.
border:0/1
1 places a border (frame) around the thumbnail. 0 will disable the border.
align:left, right, auto, or none
Sets the alignment for the slideshow, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the slideshow).
src:orig, disp or tn
Specifies which image to use as the source, the original image (full size), the display image or the thumbnail. If no src: is given, the thumbnail image is used by default.
caption
Any text before the closing ] in the auto tag will be used as the caption for the slideshow.
link
0/1 - If 0 - no link to the album, if set to 1, the slideshow will link to the album

staticpage:

Displays a link to a static page. The link text will be the static page title if not specified with the auto tag.

Parameters

##
The static page ID to provide a link to
link text
Any text before the closing ] in the auto tag will be used as the link text for the link.

staticpage_content:

Displays the content of a static page. Use this auto tag to embed a static page into other content.

Parameters

##
The static page ID to embed

Example

  [staticpage_content:disclaimer]

This will display the contents of the static page with an ID of disclaimer in the content where the auto tag was entered.


story:

Displays a link to a story. The link text will be the story title if not specified with the auto tag.

[story:story_id_here Link text]

Parameters

story_id
The ID of the story to link to.
Link Text
Any text before the closing ] in the autotag will be used as the link text to the story. If omitted, the story title will be used.

Example:

[story:glfusion-165 glFusion v1.6.5 Released]

This example will display a link to the story with an ID of glfusion-165 with the link text being glFusion v1.6.5 Released


story_introtext:

Displays the intro text portion of a story.

[story_introtext:story_id]

Parameters

story_id
The story ID of the story to display

Example:

[story_introtext:glfusion-165]

This example will replace the auto tag with the introtext from the story glfusion-165.


topic:

Displays a link to a topic. The link text will be the topic name if not specified with the auto tag.

[topic:topic_id Link Text]

Parameters

topic_id
The ID of the topic to link to
Link Text
Any text before the closing ] in the autotag will be used as the link text for the topic.

Example:

[topic:glfusion glFusion News]

This example will display a link to the topic glfusion with the link text of glFusion News.


uikitlogin:

This is a special auto tag used in the navigation menu. If the user is not logged in, it displays the login button. If the user is logged in, it will show a dropdown menu containing the User menu options.


url:

Creates a URL link with text

[url:#URL# Link Text]

Parameters

#URL#
The URL which should include the http:// or https:// prefix. For example: https://www.glfusion.org
Link Text
Any text before the closing ] will be used as the link text for the URL.

Example:

[url:https://www.glfusion.org glFusion Web Site]

This example would return a link to https://www.glfusion.org with “glFusion Web Site” as the text, e.g.; glFusion Web Site. Links will open in a new window.


video:

Places a video player in the story and auto starts the video playing. The video auto tag can be used to embed any video item from Media Gallery into a story. This includes remote video such as YouTube videos.

Parameters

width:##
Sets the width of the video player in pixels.
height:##
Sets the height of the video player in pixels.
align:left, right, auto, or none
Sets the alignment for the video player, valid options are left, right, auto (to have Media Gallery alternate alignment right/left), and none for no alignment (the text content will not wrap around the video player).
autoplay:0/1
If set to 1 the video will automatically begin playing, if set to 0, the user will need to press the play button to begin playing.

NOTE: You cannot change the width / height of embedded remote video files, the size is controlled by the embed string you specified when the video was added to Media Gallery. In this case, the width / height parameters are ignored.


vimeo:

Embed a Vimeo video into the content.

[vimeo:video_id width:## height:## align:left/right pad:## responsive:0/1]

Parameters

video_id
The video id from Vimeo. Generally this is found in the share link. For example, the Vimeo share link might be https://vimeo.com/204916363 - in this case the video_id is 204916363.
width:##
Sets the width of the video player to ## pixels wide. Default value if not specified is 560 px.
height:##
Sets the height of the video player to ## pixels high. Default value if not specified is 315 px.
align:left / right
Sets the alignment to either left or right aligned. If omitted, the video will center.
responsive:0/1
Determines if the video will be displayed responsively, meaning it will take the full width of the available space and scale appropriately as the window changes size.

Example:

[vimeo:204916363 width:500 height:300 align:left responsive:0]

This example will display the Vimeo video with an ID of 204916363, with the player sized at 500px wide and 300px high, aligned to the left and it will be fixed size (not responsive).


wikipedia:

Displays a link to a specific Wikipedia page.

[wikipedia:page_name]

Parameters

page_name
The Wikipedia page name to link to.

Example:

[wikipedia:Star]

This example will link to the Wikipedia page named Star


youtube:

Embeds a YouTube video into the content.

[youtube:video_id width:## height:## align:left/right pad:## responsive:0/1]

Parameters

video_id
The video id from YouTube. Generally this is found in the share link. For example, the Vimeo share link might be https://youtu.be/ss7EJ-PW2Uk - in this case the video_id is ss7EJ-PW2Uk.
width:##
Sets the width of the video player to ## pixels wide. Default value if not specified is 560 px.
height:##
Sets the height of the video player to ## pixels high. Default value if not specified is 315 px.
align:left / right
Sets the alignment to either left or right aligned. If omitted, the video will center.
pad:##
The number of pixels to pad the video on each side.

Example:

[youtube:ss7EJ-PW2Uk width:500 height:300 align:left pad:5]

This example will display the YouTube video with an ID of ss7EJ-PW2Uk, with the player sized at 500px wide and 300px high, aligned to the left with 5px padding on all sides.


glfusion/autotags/usage.txt · Last modified: 2017/04/12 21:11 (external edit)

Page Tools