Help: Wiki, Front Page Template Variables
For more help, visit the WebGUI Community Wiki.
- searchLabel
- An internationalized label to go with searchUrl
- mostPopularUrl
- A URL to take the user to the screen where the most popular Wiki pages are listed.
- mostPopularLabel variable
- An internationalized label to go with mostPopularUrl.
- recentChangesUrl
- A URL to take the user to the screen where all changes to the the pages in this Wiki are listed.
- recentChangesLabel variable
- An internationalized label to go with recentChangesUrl.
- addPageUrl
- A URL to allow the user to add a page.
- addPageLabel
- Add a new page.
- mostPopular
- This loop contains information about wiki pages that are the most popular. The number of pages displayed is determined in the Wiki Add/Edit screen.
- title
- The title of a page from the set of most popular pages.
- url
- The url of a page from the set of most popular pages.
- recentChanges
- This loop contains information about wiki pages that have been recently changed. The number of recently changed pages is determined in the Wiki Add/Edit screen.
- title
- An internationalized title for the Recent Changes Template.
- url
- The url of the recently changed page.
- actionTaken
- What happened to this recently changed page, typically this is either "Edited" or "Created".
- username
- The name of the user who changed the page, recently.
- date
- The date when the page was changed.
- restoreUrl
- The url to restore this page back to viewing status from the clipboard/trash.
- isAvailable
- A boolean indicating whether the page is available for viewing or in the trash/clipboard.
- canAdminister
- A boolean indicating whether the current user can administer the wiki.
- retoreLabel
- Restore
- searchFormHeader
- HTML code to start the form for the search box.
- searchQuery
- HTML code for a text box to enter in search terms.
- searchSubmit
- A submit button with an internationalized label to perform the search.
- searchFormFooter
- HTML code to end the form for the search box.
- groupToEditPages
- The id of the group that can edit pages.
- groupToAdminister
- The id of the group that is allowed to administer the Wiki or to edit pages.
- richEditor
- The id of the Rich Editor that will be used to edit Wiki pages.
- frontPageTemplateId
- The id of the template used to display the front page of the Wiki.
- pageTemplateId
- The id of the template used to display the pages inside the Wiki.
- pageHistoryTemplateId
- The id of the template to display the list of all changes to any given page inside the Wiki.
- mostPopularTemplateId
- The id of the template to display the list most popular pages inside the Wiki.
- recentChangesTemplateId
- The id of the template to display the list of recent changes to pages inside the Wiki.
- searchTemplateId
- The id of the template to display a page to search pages inside the Wiki.
- recentChangesCount
- The Maximum number of changes to display on the recent changes page.
- recentChangesCountFront
- The maximum number of changes to display on the front page.
- mostPopularCount
- Maximum number of popular page links to display on the most popular page.
- mostPopularCountFront
- Maximum number of popular page links to display on the front page.
- approvalWorkflow
- The Id of the Workflow used to approve pages in the Wiki.
- thumbnailSize
- The size of the thumbnails set for this Wiki.
- useContentFilter
- Boolean value that is true when this Wiki has been set to filter content.
- filterCode
- Strings that indicate the level of content filtering.
- maxImageSize
- The size of the image attachments set for this Wiki.
- isSubscribed
- This variable is true if the user is subscribed to the entire wiki
- subscribeUrl
- The URL to subscribe to the entire wiki
- unsubscribeUrl
- The URL to unsubscribe from the entire wiki
- 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.
- controls
- These are the icons and URLs that allow editing, cutting, copying, deleting and reordering the Asset.
- keywords_loop
- A loop containing all the top level keywords for this page, links to their keyword pages, and all sub pages below them.
- title
- The name of a keyword.
- url
- The URL to the keyword page for that keyword. If no page exists, this variable will be empty.
- level
- The depth of this keyword. Top-level keywords for the wiki are level 0.
- descendants
- The number of wiki pages that are tagged with this keyword, and all sub-keywords of this keyword.
- isTopLevel
- Whether or not the keyword is one of the keywords for the page that was called. For the Wiki Front Page, it will only include top level keywords. For a keyword page, it would be true for any sub-keywords of this page.
- indent_loop
- A loop that runs 1 time for each level.
- indent
- The loop iterator for the indent_loop.
Admin Console
