Help: Syndicated Content Template
For more help, visit the WebGUI Community Wiki.
- channel_title
- The title of this piece of syndicated content. This variable will be populated by the first feed in a multi-feed list.
- channel_description
- A description of the content available through this channel. This variable will be populated by the first feed in a multi-feed list.
- channel_link
- A URL back to the originating site of this channel. This variable will be populated by the first feed in a multi-feed list.
- channel_date
- The date this channel was updated. This variable will be populated by the first feed in a multi-feed list.
- channel_copyright
- Copyright holder information. This variable will be populated by the first feed in a multi-feed list.
- channel_image_url
- The URL of the image attached to this feed. This variable will be populated by the first feed in a multi-feed list.
- channel_image_title
- The title of the image attached to this feed. This variable will be populated by the first feed in a multi-feed list.
- channel_image_link
- The URL of the link that should wrap this feed's image. This variable will be populated by the first feed in a multi-feed list.
- channel_image_description
- The description of the image attached to this feed. This variable will be populated by the first feed in a multi-feed list.
- channel_image_width
- The width in pixels of this feed's image. This variable will be populated by the first feed in a multi-feed list.
- channel_image_height
- The height in pixels of this feed's image. This variable will be populated by the first feed in a multi-feed list.
- rss_url
- This is the URL to use to get the contents of this Syndicated Content asset as an RSS 2.0 feed. Additionally, you can specify RSS versions via the following template variables:
- rdf_url
- The contents of this asset as an RDF/RSS 1.0 feed.
- atom_url
- The contents of this asset as an Atom 0.3 feed.
- item_loop
- A loop containing the data from this channel.
- title
- The title of a piece of content. If you're filtering on terms, this field will be inspected.
- link
- A URL directly to the content of the item.
- date
- The publication date for this item.
- category
- A category this item belongs to.
- author
- The publisher of this item.
- guid
- A unique id for this item.
- media
- Any MediaRSS entries for this item: structure is directly copied from XML::FeedPP::MediaRSS
- description
- The description of the content. If you're filtering on terms, this field will be inspected as well.
- descriptionFirst100words
- The first 100 words of the description, with all HTML removed.
- descriptionFirst75words
- The first 75 words of the description, with all HTML removed.
- descriptionFirst50words
- The first 50 words of the description, with all HTML removed.
- descriptionFirst25words
- The first 25 words of the description, with all HTML removed.
- descriptionFirst10words
- The first 10 words of the description, with all HTML removed.
- descriptionFirst2paragraphs
- The first 2 paragraphs of the description, with all HTML removed.
- descriptionFirstParagraph
- The first paragraph of the description, with all HTML removed.
- descriptionFirst4sentences
- The first 4 sentences of the description, with all HTML removed.
- descriptionFirst3sentences
- The first 3 sentences of the description, with all HTML removed.
- descriptionFirst2sentences
- The first 2 sentences of the description, with all HTML removed.
- descriptionFirstSentence
- The first sentence of the description, with all HTML removed.
- cacheTimeout
- The amount of tie in seconds data from this Asset will be cached.
- templateId
- The ID of the template used to display this Asset.
- rssUrl
- A newline separated list of all RSS URLs.
- processMacrosInRssUrl
- A conditional that indicates whether or not this Asset was set to process Macros in the RSS Url field.
- maxHeadlines
- The maximum number of headlines that will be displayed.
- hasTerms
- Terms used to filter RSS items.
- displayTitle
- A conditional variable for whether or not the title should be displayed.
- description
- The description of this wobject.
- styleTemplateId
- The assetId of the template for displaying the Asset.
- printableStyleTemplateId
- The assetId of the template for displaying the Asset for printing.
- assetId
- The unique identifier for this Asset, in base64 encoding.
- assetIdHex
- The unique identifier for this Asset, in hexadecimal format.
- title
- The title of the Asset
- menuTitle
- The title of the Asset used in Navigations.
- url
- The Asset's URL.
- isHidden
- A boolean that will be true if this Asset is set not be displayed in Navigations.
- newWindow
- A boolean that will be true if this Asset is set open in a new browser window.
- encryptPage
- A boolean that will be true if this Asset is set to be served over SSL.
- ownerUserId
- The ID of the user who owns this Asset.
- groupIdView
- The ID of the group that is allowed to view this Asset.
- groupIdEdit
- The ID of the group that is allowed to edit this Asset.
- synopsis
- A short description of the contents of the Asset.
- extraHeadTags
- Extra tags that will be added to the header of the page containing the Asset. These will be included by default so you do not need to add them youself, unless you want them to be in there twice.
- isPackage
- A boolean that will be true if this Asset is set to be a Package.
- isPrototype
- A boolean that will be true if this Asset is set to be a prototype.
- status
- With respect to version control, the status of this Asset. Typically these are the English strings "approved", "pending", "committed".
- assetSize
- How big this asset is in bytes. The sum of all database fields and attachments.
- keywords
- This will be a string with the keywords for this asset. Individual keywords will be joined with spaces, unless the keyword contains spaces, in which case it will be quoted.
- webgui.version
- The version of WebGUI on your site.
- webgui.status
- The release status for this version of WebGUI (stable, beta, gamma, etc.)
- session.user.username
- The current user's username.
- session.user.firstDayOfWeek
- From the current user's profile, the day they selected to be the first day of the week.
- session.config.extrasurl
- From the WebGUI config, the URL for the extras directory.
- session.var.adminOn
- This variable will be true if the user is in Admin mode.
- session.setting.companyName
- From the WebGUI settings, the company name.
- session.setting.anonymousRegistration
- From the WebGUI settings, whether or not anonymous registration has been enabled.
- session form variables
- Session Form Variables
Any form variables will be available in the template with this syntax:
<tmpl_var session.form.variable>
If there is more than 1 value in a form variable, only the last will be returned.
- session scratch variables
- Session Scratch Variables
Any scratch variables will be available in the template with this syntax:
<tmpl_var session.scratch.variable>
- controls
- These are the icons and URLs that allow editing, cutting, copying, deleting and reordering the Asset.
Admin Console