From 18ac1f03a558b12467d7810a157845c7228ca3a0 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Fri, 9 Jun 2006 05:16:11 +0000 Subject: [PATCH] template variable breakout --- lib/WebGUI/Help/Asset_Post.pm | 125 +++++++++ lib/WebGUI/i18n/English/Asset_Post.pm | 371 ++++++++++++++------------ 2 files changed, 330 insertions(+), 166 deletions(-) diff --git a/lib/WebGUI/Help/Asset_Post.pm b/lib/WebGUI/Help/Asset_Post.pm index 80fb91fce..ee88bbe31 100644 --- a/lib/WebGUI/Help/Asset_Post.pm +++ b/lib/WebGUI/Help/Asset_Post.pm @@ -6,6 +6,122 @@ our $HELP = { body => 'add/edit post template body', fields => [ ], + variables => [ + { + 'required' => 1, + 'name' => 'form.header' + }, + { + 'name' => 'isNewPost' + }, + { + 'name' => 'isReply' + }, + { + 'name' => 'reply.title' + }, + { + 'name' => 'reply.synopsis' + }, + { + 'name' => 'reply.content' + }, + { + 'name' => 'reply.userDefinedN' + }, + { + 'name' => 'subscribe.form' + }, + { + 'name' => 'isNewThread' + }, + { + 'name' => 'sticky.form' + }, + { + 'name' => 'lock.form' + }, + { + 'name' => 'isThread' + }, + { + 'name' => 'isEdit' + }, + { + 'name' => 'preview.title' + }, + { + 'name' => 'preview.synopsis' + }, + { + 'name' => 'preview.content' + }, + { + 'name' => 'preview.userDefinedN' + }, + { + 'required' => 1, + 'name' => 'form.footer' + }, + { + 'required' => 1, + 'name' => 'usePreview' + }, + { + 'name' => 'user.isModerator' + }, + { + 'name' => 'user.isVisitor' + }, + { + 'name' => 'visitorName.form' + }, + { + 'name' => 'userDefinedN.form' + }, + { + 'name' => 'userDefinedN.form.yesNo' + }, + { + 'name' => 'userDefinedN.form.textarea' + }, + { + 'name' => 'userDefinedN.form.htmlarea' + }, + { + 'name' => 'userDefinedN.form.float' + }, + { + 'name' => 'title.form' + }, + { + 'name' => 'title.form.textarea' + }, + { + 'name' => 'synopsis.form' + }, + { + 'name' => 'content.form' + }, + { + 'name' => 'form.submit' + }, + { + 'name' => 'karmaScale.form' + }, + { + 'name' => 'karmaIsEnabled' + }, + { + 'name' => 'form.preview' + }, + { + 'name' => 'attachment.form' + }, + { + 'name' => 'contentType.form' + } + ], related => [ { tag => 'template language', @@ -40,6 +156,15 @@ our $HELP = { body => 'notification template body', fields => [ ], + variables => [ + { + 'name' => 'url', + 'description' => 'notify url' + }, + { + 'name' => 'notification.subscription.message' + } + ], related => [ { tag => 'template language', diff --git a/lib/WebGUI/i18n/English/Asset_Post.pm b/lib/WebGUI/i18n/English/Asset_Post.pm index 3c54f3f9f..e39f4e1de 100644 --- a/lib/WebGUI/i18n/English/Asset_Post.pm +++ b/lib/WebGUI/i18n/English/Asset_Post.pm @@ -6,155 +6,203 @@ our $I18N = { lastUpdated => 1111253044, }, + 'form.header' => { + message => q|Code required to start the form for the Post.|, + lastUpdated => 1149829706, + }, + + 'isNewPost' => { + message => q|A conditional that is true if the user is adding a new Post, as opposed to +editing an existing Post.|, + lastUpdated => 1149829706, + }, + + 'isReply' => { + message => q|A conditional that is true if the user is replying to an existing Post.|, + lastUpdated => 1149829706, + }, + + 'reply.title' => { + message => q|The title of the Post that is being replied to.|, + lastUpdated => 1149829706, + }, + + 'reply.synopsis' => { + message => q|The synopsis of the Post that is being replied to.|, + lastUpdated => 1149829706, + }, + + 'reply.content' => { + message => q|The content of the Post that is being replied to.|, + lastUpdated => 1149829706, + }, + + 'reply.userDefinedN' => { + message => q|The contents of user defined fields for the Post that is being replied to, where N is from 1 to 5.|, + lastUpdated => 1149829706, + }, + + 'subscribe.form' => { + message => q|A yes/no button to allow the user to subscribe to the thread this post belongs to.|, + lastUpdated => 1149829706, + }, + + 'isNewThread' => { + message => q|A conditional that is true if the user is adding a new thread.|, + lastUpdated => 1149829706, + }, + + 'sticky.form' => { + message => q|A yes/no button to set the thread to be sticky, so that it stays at the top of the forum listing.|, + lastUpdated => 1149829706, + }, + + 'lock.form' => { + message => q|A yes/no button to lock the thread, so that no posts can be added or edited.|, + lastUpdated => 1149829706, + }, + + 'isThread' => { + message => q|A conditional that is true if the user is editing the main post for a thread, as opposed to +a reply in the thread.|, + lastUpdated => 1149829706, + }, + + 'isEdit' => { + message => q|A conditional that is true if the user is editing an existing post.|, + lastUpdated => 1149829706, + }, + + 'preview.title' => { + message => q|The web safe title for previewing a post.|, + lastUpdated => 1149829706, + }, + + 'preview.synopsis' => { + message => q|The synopsis when previewing a post.|, + lastUpdated => 1149829706, + }, + + 'preview.content' => { + message => q|The content when previewing a post.|, + lastUpdated => 1149829706, + }, + + 'preview.userDefinedN' => { + message => q|The contents of user defined fields for the Post without WebGUI Macros being processed, where N is from 1 to 5.|, + lastUpdated => 1149829706, + }, + + 'form.footer' => { + message => q|Code for the end of the form.|, + lastUpdated => 1149829706, + }, + + 'usePreview' => { + message => q|A conditional indicating that posts to the thread will be previewed before being submitted.|, + lastUpdated => 1149829706, + }, + + 'user.isModerator' => { + message => q|A conditional indicating if the current user is a moderator.|, + lastUpdated => 1149829706, + }, + + 'user.isVisitor' => { + message => q|A conditional indicating if the current user is a visitor.|, + lastUpdated => 1149829706, + }, + + 'visitorName.form' => { + message => q|A form where the user can enter their name, even if they are a visitor.|, + lastUpdated => 1149829706, + }, + + 'userDefinedN.form' => { + message => q|For each of the 5 User Defined fields, a form widget for a single line of text.|, + lastUpdated => 1149829706, + }, + + 'userDefinedN.form.yesNo' => { + message => q|For each of the 5 User Defined fields, a form widget for a a yes/no field.|, + lastUpdated => 1149829706, + }, + + 'userDefinedN.form.textarea' => { + message => q|For each of the 5 User Defined fields, a form widget for a text area.|, + lastUpdated => 1149829706, + }, + + 'userDefinedN.form.htmlarea' => { + message => q|For each of the 5 User Defined fields, a form widget for a WYSIWIG HTML area.|, + lastUpdated => 1149829706, + }, + + 'userDefinedN.form.float' => { + message => q|For each of the 5 User Defined fields, a form widget for a float.|, + lastUpdated => 1149829706, + }, + + 'title.form' => { + message => q|A 1-line text form field to enter or edit the title, stripped of all HTML and macros disabled. +Use this OR title.form.textarea.|, + lastUpdated => 1149829706, + }, + + 'title.form.textarea' => { + message => q|A text area field to enter or edit the title, stripped of all HTML and macros disabled. +Use this OR title.form.|, + lastUpdated => 1149829706, + }, + + 'synopsis.form' => { + message => q|A form field to enter or edit the synopsis.|, + lastUpdated => 1149829706, + }, + + 'content.form' => { + message => q|A field to enter or edit the content, with all macros disabled. If the discussion +board allows rich content, then this will be a WYSIWIG HTML area. Otherwise it +will be a plain text area.|, + lastUpdated => 1149829706, + }, + + 'form.submit' => { + message => q|A button to submit the post.|, + lastUpdated => 1149829706, + }, + + 'karmaScale.form' => { + message => q|A form element that allows moderators to set the scale of an individual thread. This is only available for threads.|, + lastUpdated => 1149829706, + }, + + 'karmaIsEnabled' => { + message => q|A conditional that is true if karma has been enabled in the WebGUI settings in the Admin Console for this site.|, + lastUpdated => 1149829706, + }, + + 'form.preview' => { + message => q|A button to preview the post.|, + lastUpdated => 1149829706, + }, + + 'attachment.form' => { + message => q|Code to allow an attachment to be added to the post.|, + lastUpdated => 1149829706, + }, + + 'contentType.form' => { + message => q|A form field that will describe how the content of the post is formatted, HTML, text, code or mixed. +Defaults to mixed.|, + lastUpdated => 1149829706, + }, + 'add/edit post template body' => { message => q|

In addition to the common Post Template variables, the Add/Edit Post Template has these variables:

-

-! : This variable is required for the Post to function correctly. -

- -

form.header !
-Code required to start the form for the Post. -

- -

isNewPost
-A conditional that is true if the user is adding a new Post, as opposed to -editing an existing Post. -

- -

isReply
-A conditional that is true if the user is replying to an existing Post. -

- -

reply.title
-The title of the Post that is being replied to. -

- -

reply.synopsis
-The synopsis of the Post that is being replied to. -

- -

reply.content
-The content of the Post that is being replied to. -

- -

reply.userDefinedN
-The contents of user defined fields for the Post that is being replied to, where N is from 1 to 5. -

- -

subscribe.form
-A yes/no button to allow the user to subscribe to the thread this post belongs to. -

- -

isNewThread
-A conditional that is true if the user is adding a new thread. -

- -

sticky.form
-A yes/no button to set the thread to be sticky, so that it stays at the top of the forum listing. -

- -

lock.form
-A yes/no button to lock the thread, so that no posts can be added or edited. -

- -

isThread
-A conditional that is true if the user is editing the main post for a thread, as opposed to -a reply in the thread. -

- -

isEdit
-A conditional that is true if the user is editing an existing post. -

- -

preview.title
-The web safe title for previewing a post. -

- -

preview.synopsis
-The synopsis when previewing a post. -

- -

preview.content
-The content when previewing a post. -

- -

preview.userDefinedN
-The contents of user defined fields for the Post without WebGUI Macros being processed, where N is from 1 to 5. -

- -

form.footer !
-Code for the end of the form. -

- -

usePreview !
-A conditional indicating that posts to the thread will be previewed before being submitted. -

- -

user.isModerator
-A conditional indicating if the current user is a moderator. -

- -

user.isVisitor
-A conditional indicating if the current user is a visitor. -

- -

visitorName.form
-A form where the user can enter their name, even if they are a visitor. -

- -

userDefinedN.{form,form.yesNo,form.textarea,form.htmlarea,form.float}
-For each of the 5 User Defined fields, which can be form widgets for a single line of text, a yes/no -field, a text area, a WYSIWIG HTML area, or a float. -

- -

title.form
-A 1-line text form field to enter or edit the title, stripped of all HTML and macros disabled. -Use this OR title.form.textarea. -

- -

title.form.textarea
-A text area field to enter or edit the title, stripped of all HTML and macros disabled. -Use this OR title.form. -

- -

synopsis.form
-A form field to enter or edit the synopsis. -

- -

content.form
-A field to enter or edit the content, with all macros disabled. If the discussion -board allows rich content, then this will be a WYSIWIG HTML area. Otherwise it -will be a plain text area. -

- -

form.submit
-A button to submit the post. -

- -

karmaScale.form
-A form element that allows moderators to set the scale of an individual thread. This is only available for threads. -

- -

karmaIsEnabled
-A conditional that is true if karma has been enabled in the WebGUI settings in the Admin Console for this site. -

- -

form.preview
-A button to preview the post. -

- -

attachment.form
-Code to allow an attachment to be added to the post. -

- -

contentType.form
-A form field that will describe how the content of the post is formatted, HTML, text, code or mixed. -Defaults to mixed. -

- |, - lastUpdated => 1146785107, + lastUpdated => 1149829733, }, 'post template variables title' => { @@ -383,20 +431,13 @@ called "userDefined1" through "userDefined5". In the Post Form template you can use those 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>.

@@ -440,24 +481,22 @@ back the data with a simple <tmpl_var userDefined1>.

lastUpdated => 1111253044, }, + 'notify url' => { + message => q|The URL to the post that triggered the notification.|, + lastUpdated => 1149829885, + }, + + 'notification.subscription.message' => { + message => q|Internationalized message that a new message has been posted to a thread that the +user subscribed to.|, + lastUpdated => 1149829885, + }, + 'notification template body' => { message => q|

In addition to the common Post Template variables, the Notification Template has these variables:

- -

All variables from the Post Template Variables. -

- -

url
-The URL to the post that triggered the notification. -

- -

notification.subscription.message
-Internationalized message that a new message has been posted to a thread that the -user subscribed to. -

- |, - lastUpdated => 1146785190, + lastUpdated => 1149829939, }, '875' => {