From 27e50e2ae4e0ee5446278506dd167d656763db8a Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Tue, 13 Jun 2006 02:53:23 +0000 Subject: [PATCH] finished post template variable breakout --- lib/WebGUI/Help/Asset_Post.pm | 172 +++++++++ lib/WebGUI/i18n/English/Asset_Post.pm | 510 ++++++++++++++------------ 2 files changed, 455 insertions(+), 227 deletions(-) diff --git a/lib/WebGUI/Help/Asset_Post.pm b/lib/WebGUI/Help/Asset_Post.pm index a51c6cef8..7abde8e7c 100644 --- a/lib/WebGUI/Help/Asset_Post.pm +++ b/lib/WebGUI/Help/Asset_Post.pm @@ -140,6 +140,178 @@ our $HELP = { 'post template variables' => { title => 'post template variables title', body => 'post template variables body', + variables => [ + { + 'name' => 'userId' + }, + { + 'name' => 'user.isPoster' + }, + { + 'name' => 'avatar.url' + }, + { + 'name' => 'userProfile.url' + }, + { + 'name' => 'dateSubmitted.human' + }, + { + 'name' => 'dateUpdated.human' + }, + { + 'name' => 'title.short' + }, + { + 'name' => 'content' + }, + { + 'name' => 'user.canEdit' + }, + { + 'name' => 'delete.url' + }, + { + 'name' => 'edit.url' + }, + { + 'name' => 'status' + }, + { + 'name' => 'reply.url' + }, + { + 'name' => 'reply.withQuote.url' + }, + { + 'name' => 'url' + }, + { + 'name' => 'rating.value' + }, + { + 'name' => 'rate.url.thumbsUp' + }, + { + 'name' => 'rate.url.thumbsDown' + }, + { + 'name' => 'hasRated' + }, + { + 'name' => 'image.url' + }, + { + 'name' => 'image.thumbnail' + }, + { + 'name' => 'attachment.url' + }, + { + 'name' => 'attachment.icon' + }, + { + 'name' => 'attachment.name' + }, + { + 'name' => 'attachment_loop', + 'variables' => [ + { + 'name' => 'url' + }, + { + 'name' => 'icon' + }, + { + 'name' => 'filename' + }, + { + 'name' => 'thumbnail' + }, + { + 'name' => 'isImage' + } + ] + }, + { + 'name' => 'storageId' + }, + { + 'name' => 'threadId' + }, + { + 'name' => 'dateSubmitted' + }, + { + 'name' => 'dateUpdated' + }, + { + 'name' => 'username' + }, + { + 'name' => 'rating' + }, + { + 'name' => 'views' + }, + { + 'name' => 'contentType' + }, + { + 'name' => 'content' + }, + { + 'name' => 'title' + }, + { + 'name' => 'menuTitle' + }, + { + 'name' => 'synopsis' + }, + { + 'name' => 'extraHeadTags' + }, + { + 'name' => 'groupIdEdit' + }, + { + 'name' => 'groupIdView' + }, + { + 'name' => 'ownerUserId' + }, + { + 'name' => 'assetSize' + }, + { + 'name' => 'isPackage' + }, + { + 'name' => 'isPrototype' + }, + { + 'name' => 'isHidden' + }, + { + 'name' => 'newWindow' + }, + { + 'name' => 'userDefined1' + }, + { + 'name' => 'userDefined2' + }, + { + 'name' => 'userDefined3' + }, + { + 'name' => 'userDefined4' + }, + { + 'name' => 'userDefined5' + } + ], fields => [ ], related => [ diff --git a/lib/WebGUI/i18n/English/Asset_Post.pm b/lib/WebGUI/i18n/English/Asset_Post.pm index 86a53a8c8..a2fda2ae5 100644 --- a/lib/WebGUI/i18n/English/Asset_Post.pm +++ b/lib/WebGUI/i18n/English/Asset_Post.pm @@ -215,238 +215,294 @@ Defaults to mixed.|, lastUpdated => 1111253044, }, + 'userId' => { + message => q|The User ID of the owner of the Post.|, + lastUpdated => 1150167057, + }, + + 'user.isPoster' => { + message => q|A conditional that is true if the current user is the owner of this Post.|, + lastUpdated => 1150167057, + }, + + 'avatar.url' => { + message => q|A URL to the avatar for the owner of the Post, if avatars are enabled in the parent +Collaboration System and the user has an avatar.|, + lastUpdated => 1150167057, + }, + + 'userProfile.url' => { + message => q|A URL to the profile of the owner of the Post.|, + lastUpdated => 1150167057, + }, + + 'dateSubmitted.human' => { + message => q|The date that the post was sumbitted, in a readable format.|, + lastUpdated => 1150167057, + }, + + 'dateUpdated.human' => { + message => q|The date that the post was last updated, in a readable format.|, + lastUpdated => 1150167057, + }, + + 'title.short' => { + message => q|The title of the Post, limited to 30 characters. |, + lastUpdated => 1150167057, + }, + + 'content' => { + message => q|The content of the post, if a thread containing the Post exists.|, + lastUpdated => 1150167057, + }, + + 'user.canEdit' => { + message => q|A conditional that is true if the user is adding a new Post, as opposed to +editing an existing Post, and a thread containing the Post exists.|, + lastUpdated => 1150167057, + }, + + 'delete.url' => { + message => q|A URL to delete this Post.|, + lastUpdated => 1150167057, + }, + + 'edit.url' => { + message => q|A URL to edit this Post.|, + lastUpdated => 1150167057, + }, + + 'status' => { + message => q|The status of this Post: "Approved", "Pending" or "Archived".|, + lastUpdated => 1150167057, + }, + + 'reply.url' => { + message => q|The URL to reply to this Post without quoting it.|, + lastUpdated => 1150167057, + }, + + 'reply.withQuote.url' => { + message => q|The URL to initiate a quoted reply to this Post.|, + lastUpdated => 1150167057, + }, + + 'url' => { + message => q|The URL for this Post.|, + lastUpdated => 1150167057, + }, + + 'rating.value' => { + message => q|The current rating for this Post.|, + lastUpdated => 1150167057, + }, + + 'rate.url.thumbsUp' => { + message => q|A positive rating.|, + lastUpdated => 1150167057, + }, + + 'rate.url.thumbsDown' => { + message => q|A negative rating.|, + lastUpdated => 1150167057, + }, + + 'hasRated' => { + message => q|A conditional that is true if the user has already rated this Post.|, + lastUpdated => 1150167057, + }, + + 'image.url' => { + message => q|The URL to the first image attached to the Post.|, + lastUpdated => 1150167057, + }, + + 'image.thumbnail' => { + message => q|A thumbnail for the image attached to the Post.|, + lastUpdated => 1150167057, + }, + + 'attachment.url' => { + message => q|The URL to download the first attachment attached to the Post.|, + lastUpdated => 1150167057, + }, + + 'attachment.icon' => { + message => q|An icon showing the file type of this attachment.|, + lastUpdated => 1150167057, + }, + + 'attachment.name' => { + message => q|The name of the first attachment found on the Post.|, + lastUpdated => 1150167057, + }, + + 'attachment_loop' => { + message => q|A loop containing all file and image attachments to this Post.|, + lastUpdated => 1150167057, + }, + + 'url' => { + message => q|The URL to download this attachment.|, + lastUpdated => 1150167057, + }, + + 'icon' => { + message => q|The icon representing the file type of this attachment.|, + lastUpdated => 1150167057, + }, + + 'filename' => { + message => q|The name of this attachment.|, + lastUpdated => 1150167057, + }, + + 'thumbnail' => { + message => q|A thumbnail of this attachment, if applicable.|, + lastUpdated => 1150167057, + }, + + 'isImage' => { + message => q|A conditional indicating whether this attachment is an image.|, + lastUpdated => 1150167057, + }, + + 'storageId' => { + message => q|The Asset ID of the storage node for the Post, where the attachments are kept.|, + lastUpdated => 1150167057, + }, + + 'threadId' => { + message => q|The ID of the thread that contains this Post.|, + lastUpdated => 1150167057, + }, + + 'dateSubmitted' => { + message => q|The date the Post was submitted, in epoch format.|, + lastUpdated => 1150167057, + }, + + 'dateUpdated' => { + message => q|The date the Post was last updated, in epoch format.|, + lastUpdated => 1150167057, + }, + + 'username' => { + message => q|The name of the user who last updated or submitted the Post.|, + lastUpdated => 1150167057, + }, + + 'rating' => { + message => q|Another name for rating.value|, + lastUpdated => 1150167057, + }, + + 'views' => { + message => q|The number of times that this post has been viewed.|, + lastUpdated => 1150167057, + }, + + 'contentType' => { + message => q|The type of content in the post, typically "code", "text", "HTML", "mixed".|, + lastUpdated => 1150167057, + }, + + 'content' => { + message => q|The content, or body, of the Post.|, + lastUpdated => 1150167057, + }, + + 'title' => { + message => q|The title of the Post.|, + lastUpdated => 1150167057, + }, + + 'menuTitle' => { + message => q|The menu title of the Post, often used in navigation.|, + lastUpdated => 1150167057, + }, + + 'synopsis' => { + message => q|The synopsis of the Post.|, + lastUpdated => 1150167057, + }, + + 'extraHeadTags' => { + message => q|Extra tags that the user requested by added to the HTML header.|, + lastUpdated => 1150167057, + }, + + 'groupIdEdit' => { + message => q|The ID of the group with permission to edit this Post.|, + lastUpdated => 1150167057, + }, + + 'groupIdView' => { + message => q|The ID of the group with permission to view this Post.|, + lastUpdated => 1150167057, + }, + + 'ownerUserId' => { + message => q|An alias for userId.|, + lastUpdated => 1150167057, + }, + + 'assetSize' => { + message => q|The formatted size of this Post.|, + lastUpdated => 1150167057, + }, + + 'isPackage' => { + message => q|A conditional indicating whether this Post is a package.|, + lastUpdated => 1150167057, + }, + + 'isPrototype' => { + message => q|A conditional indicating whether this Post is a Content Prototype.|, + lastUpdated => 1150167057, + }, + + 'isHidden' => { + message => q|A conditional indicating whether this Post should be hidden from navigation.|, + lastUpdated => 1150167057, + }, + + 'newWindow' => { + message => q|A conditional indicating whether this Post should be opened in a new window.|, + lastUpdated => 1150167057, + }, + + 'userDefined1' => { + message => q|The value contained in the first user defined variable.|, + lastUpdated => 1150167057, + }, + + 'userDefined2' => { + message => q|The value contained in the second user defined variable.|, + lastUpdated => 1150167057, + }, + + 'userDefined3' => { + message => q|The value contained in the first user defined variable.|, + lastUpdated => 1150167057, + }, + + 'userDefined4' => { + message => q|The value contained in the fourth user defined variable.|, + lastUpdated => 1150167057, + }, + + 'userDefined5' => { + message => q|The value contained in the fifth user defined variable.|, + lastUpdated => 1150167057, + }, + 'post template variables body' => { message => q|

The following variables are available in all Post templates. Internationalized labels for the action URLs (reply, delete, etc.) are provided in the set of Collaboration Template labels.

- -

userId
-The User ID of the owner of the Post. -

- -

user.isPoster
-A conditional that is true if the current user is the owner of this Post. -

- -

avatar.url
-A URL to the avatar for the owner of the Post, if avatars are enabled in the parent -Collaboration System and the user has an avatar. -

- -

userProfile.url
-A URL to the profile of the owner of the Post. -

- -

dateSubmitted.human
-The date that the post was sumbitted, in a readable format. -

- -

dateUpdated.human
-The date that the post was last updated, in a readable format. -

- -

title.short
-The title of the Post, limited to 30 characters. -

- -

content
-The content of the post, if a thread containing the Post exists. -

- -

user.canEdit
-A conditional that is true if the user is adding a new Post, as opposed to -editing an existing Post, and a thread containing the Post exists. -

- -

delete.url
-A URL to delete this Post. -

- -

edit.url
-A URL to edit this Post. -

- -

status
-The status of this Post: "Approved", "Pending" or "Archived". -

- -

reply.url
-The URL to reply to this Post without quoting it. -

- -

reply.withQuote.url
-The URL to initiate a quoted reply to this Post. -

- -

url
-The URL for this Post. -

- -

rating.value
-The current rating for this Post. -

- -

rate.url.thumbsUp
-A positive rating. -

- -

rate.url.thumbsDown
-A negative rating. -

- -

hasRated
-A conditional that is true if the user has already rated this Post. -

- -

image.url
-The URL to the first image attached to the Post. -

- -

image.thumbnail
-A thumbnail for the image attached to the Post. -

- -

attachment.url
-The URL to download the first attachment attached to the Post. -

- -

attachment.icon
-An icon showing the file type of this attachment. -

- -

attachment.name
-The name of the first attachment found on the Post. -

- -

attachment_loop
-A loop containing all file and image attachments to this Post. -

- -
- -

url
-The URL to download this attachment. -

- -

icon
-The icon representing the file type of this attachment. -

- -

filename
-The name of this attachment. -

- -

thumbnail
-A thumbnail of this attachment, if applicable. -

- -

isImage
-A conditional indicating whether this attachment is an image. -

- -
- -

storageId
-The Asset ID of the storage node for the Post, where the attachments are kept. -

- -

threadId
-The ID of the thread that contains this Post. -

- -

dateSubmitted
-The date the Post was submitted, in epoch format. -

- -

dateUpdated
-The date the Post was last updated, in epoch format. -

- -

username
-The name of the user who last updated or submitted the Post. -

- -

rating
-Another name for rating.value -

- -

views
-The number of times that this post has been viewed. -

- -

contentType
-The type of content in the post, typically "code", "text", "HTML", "mixed". -

- -

content
-The content, or body, of the Post. -

- -

title
-The title of the Post. -

- -

menuTitle
-The menu title of the Post, often used in navigation. -

- -

synopsis
-The synopsis of the Post. -

- -

extraHeadTags
-Extra tags that the user requested by added to the HTML header. -

- -

groupIdEdit
-The ID of the group with permission to edit this Post. -

- -

groupIdView
-The ID of the group with permission to view this Post. -

- -

ownerUserId
-An alias for userId. -

- -

assetSize
-The formatted size of this Post. -

- -

isPackage
-A conditional indicating whether this Post is a package. -

- -

isPrototype
-A conditional indicating whether this Post is a Content Prototype. -

- -

isHidden
-A conditional indicating whether this Post should be hidden from navigation. -

- -

newWindow
-A conditional indicating whether this Post should be opened in a new window. -

- -

userDefined1, userDefined2, userDefined3, userDefined4, userDefined5
-You can use up to 5 user defined fields. The fields are -called "userDefined1" through "userDefined5". In the -Post Form template you can use variables like this to collect data: -

-
-<tmpl_var userDefined1.form> (text)
-<tmpl_var userDefined1.form.yesNo> (yes / no)
-<tmpl_var userDefined1.form.textarea> (textarea)
-<tmpl_var userDefined1.form.htmlarea> (rich edit box)
-<tmpl_var userDefined1.form.float> (float field)
-
-

Then in the Thread and Main CS templates you can call -back the data with a simple <tmpl_var userDefined1>.

- |, - lastUpdated => 1146785175, + lastUpdated => 1150167094, }, 'post received' => {