From b5998af9610779bf8ea7b990778285ee6a41145e Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Mon, 25 Apr 2005 22:24:49 +0000 Subject: [PATCH] finish collaboration documentation --- lib/WebGUI/Help/Asset_Collaboration.pm | 26 +++ .../i18n/English/Asset_Collaboration.pm | 156 ++++++++++++++++++ 2 files changed, 182 insertions(+) diff --git a/lib/WebGUI/Help/Asset_Collaboration.pm b/lib/WebGUI/Help/Asset_Collaboration.pm index a1d6305c4..8e2343652 100644 --- a/lib/WebGUI/Help/Asset_Collaboration.pm +++ b/lib/WebGUI/Help/Asset_Collaboration.pm @@ -30,6 +30,32 @@ our $HELP = { ] }, + 'collaboration template' => { + title => 'collaboration template title', + body => 'collaboration template body', + related => [ + { + tag => 'collaboration template labels', + namespace => 'Asset_Collaboration', + }, + { + tag => 'collaboration post list template variables', + namespace => 'Asset_Collaboration', + }, + ] + }, + + 'collaboration search template' => { + title => 'collaboration search template title', + body => 'collaboration search template body', + related => [ + { + tag => 'collaboration post list template variables', + namespace => 'Asset_Collaboration', + }, + ] + }, + }; 1; diff --git a/lib/WebGUI/i18n/English/Asset_Collaboration.pm b/lib/WebGUI/i18n/English/Asset_Collaboration.pm index 537c54e21..e30356033 100644 --- a/lib/WebGUI/i18n/English/Asset_Collaboration.pm +++ b/lib/WebGUI/i18n/English/Asset_Collaboration.pm @@ -1056,6 +1056,162 @@ The time the last reply was submitted, in a human readable format. lastUpdated => 1114148028, }, + 'collaboration template title' => { + message => q|Collaboration Template|, + lastUpdated => 1114466567, + }, + + 'collaboration template body' => { + message => q|These variables are available in the Collaboration Template:

+ +

+user.canPost
+A conditional that is true if the current user can add posts to this Collaboration Asset. + +

+user.isModerator
+A conditional that is true if the current user is a moderator for this Asset. + +

+user.isVisitor
+A conditional that is true if the current user is a Visitor. + +

+user.isSubscribed
+A conditional that is true if the current user is subscribed to this Collaboration Asset. + +

+add.url
+A URL for adding a new thread. + +

+rss.url
+A URL for downloading the RSS summary of this Asset. + +

+search.url
+A URL for accessing the search form for this Collaboration Asset. + +

+subscribe.url
+A URL for subscribing the current user to this Collaboration Asset. When new content is submitted to +the Collaboration Asset, the user will be notified. + +

+unsubscribe.url
+A URL for unsubscribing the current user from this Asset. + +

+sortby.title.url
+A URL for sorting and displaying the list of posts by title. + +

+sortby.username.url
+A URL for sorting and displaying the list of posts by username. + +

+sortby.date.url
+A URL for sorting and displaying the list of posts by the date they were submitted. + +

+sortby.lastreply.url
+A URL for sorting and displaying the list of posts by the date they were last updated. + +

+sortby.views.url
+A URL for sorting and displaying the list of posts by the number of times each has been read. + +

+sortby.replies.url
+A URL for sorting and displaying the list of posts by the number of replies to the post. + +

+sortby.rating.url
+A URL for sorting and displaying the list of posts by their ratings. + + |, + lastUpdated => 1114466583, + }, + + 'collaboration search template title' => { + message => q|Collaboration Search Template|, + lastUpdated => 1114467745, + }, + + 'collaboration search template body' => { + message => q|These variables are available in the Collaboration Search Template:

+ +

+form.header
+HTML and javascript required to make the form work. + +

+all.form
+HTML form for adding a field where all input has to be in matched pages. + +

+exactphrase.form
+An HTML form to enter in a phrase to search for. + +

+atleastone.form
+An HTML form to enter in a list of words. Search results will always contain at least one of +these. + +

+without.form
+An HTML form to enter in a list of words. If any word is found on a page it will not be included +in the search results, even if other fields match. + +

+results.form
+An HTML form for picking how many results are returned. + +

+form.search
+A button to add to the form to begin searching. + +

+back.url
+A URL for returning to the main view for this Collaboration Asset. + +

+unsubscribe.url
+A URL for unsubscribing the current user from this Asset. + +

+sortby.title.url
+A URL for sorting and displaying the list of posts by title. + +

+sortby.username.url
+A URL for sorting and displaying the list of posts by username. + +

+sortby.date.url
+A URL for sorting and displaying the list of posts by the date they were submitted. + +

+sortby.lastreply.url
+A URL for sorting and displaying the list of posts by the date they were last updated. + +

+sortby.views.url
+A URL for sorting and displaying the list of posts by the number of times each has been read. + +

+sortby.replies.url
+A URL for sorting and displaying the list of posts by the number of replies to the post. + +

+sortby.rating.url
+A URL for sorting and displaying the list of posts by their ratings. + + |, + lastUpdated => 1114467741, + }, + + }; 1;