diff options
Diffstat (limited to 'modules/forum/forum-list.tpl.php')
-rw-r--r-- | modules/forum/forum-list.tpl.php | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/modules/forum/forum-list.tpl.php b/modules/forum/forum-list.tpl.php index 257cea947..01c74a34c 100644 --- a/modules/forum/forum-list.tpl.php +++ b/modules/forum/forum-list.tpl.php @@ -2,34 +2,35 @@ /** * @file - * Default theme implementation to display a list of forums and containers. + * Displays a list of forums and containers. * * Available variables: * - $forums: An array of forums and containers to display. It is keyed to the - * numeric id's of all child forums and containers. - * - $forum_id: Forum id for the current forum. Parent to all items within - * the $forums array. - * - * Each $forum in $forums contains: - * - $forum->is_container: Is TRUE if the forum can contain other forums. Is - * FALSE if the forum can contain only topics. - * - $forum->depth: How deep the forum is in the current hierarchy. - * - $forum->zebra: 'even' or 'odd' string used for row class. - * - $forum->icon_class: 'default' or 'new' string used for forum icon class. - * - $forum->icon_title: Text alternative for the forum icon. - * - $forum->name: The name of the forum. - * - $forum->link: The URL to link to this forum. - * - $forum->description: The description of this forum. - * - $forum->new_topics: True if the forum contains unread posts. - * - $forum->new_url: A URL to the forum's unread posts. - * - $forum->new_text: Text for the above URL which tells how many new posts. - * - $forum->old_topics: A count of posts that have already been read. - * - $forum->num_posts: The total number of posts in the forum. - * - $forum->last_reply: Text representing the last time a forum was posted or - * commented in. + * numeric IDs of all child forums and containers. Each $forum in $forums + * contains: + * - $forum->is_container: TRUE if the forum can contain other forums. FALSE + * if the forum can contain only topics. + * - $forum->depth: How deep the forum is in the current hierarchy. + * - $forum->zebra: 'even' or 'odd' string used for row class. + * - $forum->icon_class: 'default' or 'new' string used for forum icon class. + * - $forum->icon_title: Text alternative for the forum icon. + * - $forum->name: The name of the forum. + * - $forum->link: The URL to link to this forum. + * - $forum->description: The description of this forum. + * - $forum->new_topics: TRUE if the forum contains unread posts. + * - $forum->new_url: A URL to the forum's unread posts. + * - $forum->new_text: Text for the above URL, which tells how many new posts. + * - $forum->old_topics: A count of posts that have already been read. + * - $forum->num_posts: The total number of posts in the forum. + * - $forum->last_reply: Text representing the last time a forum was posted or + * commented in. + * - $forum_id: Forum ID for the current forum. Parent to all items within the + * $forums array. * * @see template_preprocess_forum_list() * @see theme_forum_list() + * + * @ingroup themeable */ ?> <table id="forum-<?php print $forum_id; ?>"> |