finish thread documentation

This commit is contained in:
Colin Kuskie 2005-03-25 16:20:06 +00:00
parent 6a495ac444
commit 42506531f8
2 changed files with 75 additions and 2 deletions

View file

@ -13,6 +13,14 @@ our $HELP = {
tag => 'post template variables',
namespace => 'Post'
},
{
tag => 'collaboration template labels',
namespace => 'Collaboration'
},
{
tag => 'pagination template variables',
namespace => 'WebGUI'
},
]
},

View file

@ -8,7 +8,7 @@ our $I18N = {
},
'thread template body' => {
message => q|The following variables are available in the Thread template.
message => q|The variables below are available in the Thread template. In addition, all variables from the Post Template can be used. Labels for URLs for actions like <b>unlock.url</b>, <b>stick.url</b>, etc. are provided by the Collaboration Labels. The Pagination Template variables are also available to display multiple pages of posts and threads.
<p>
<b>user.isVisitor</b><br>
@ -97,8 +97,73 @@ The URL to lock this thread.
The URL to unlock this thread.
<p>
<b>post_loop</b><br>
A loop containing all the posts for this thread. Each post in the loop
also contains a set of its own Post Template variables.
<p>
<blockquote>
<b>isCurrent</b><br>
A conditional indicating that this Post is the one currently being viewed in the Thread.
<p>
<b>isThreadRoot</b><br>
A conditional indicating that this Post is the start of the Thread.
<p>
<b>depth</b><br>
How far away this post is from the originating post (<b>ThreadRoot</b>).
<p>
<b>depthX10</b><br>
The <b>depth</b> times 10.
<p>
<b>indent_loop</b><br>
A loop that runs <b>depth</b> times.
<p>
<blockquote>
<b>depth</b><br>
A number indicating the loop count of the <b>indent_loop</b>.
<p>
</blockquote>
</blockquote>
<b>add.url</b><br>
The URL to add a new thread.
<p>
<b>previous.url</b><br>
The URL to take you to the previous thread.
<p>
<b>next.url</b><br>
The URL to take you to the next thread.
<p>
<b>search.url</b><br>
The URL to take you to a form to search the forum.
<p>
<b>collaboration.url</b><br>
The URL to take you back to the collaboration system that this post is a part of.
<p>
<b>collaboration.title</b><br>
The title of the collaboration system that this post is a part of.
<p>
<b>collaboration.description</b><br>
The description of the collaboration system that this post is a part of.
<p>
|,
lastUpdated => 1111709371,
lastUpdated => 1111768115,
},
};