From 8d2b1238b4d8ebd57848fde665b7f93c3a03cd90 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Thu, 29 May 2003 09:15:00 +0000 Subject: - Michael Frankowski's excellent help text improvements! --- modules/forum/forum.module | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) (limited to 'modules/forum/forum.module') diff --git a/modules/forum/forum.module b/modules/forum/forum.module index e5f2db09b..a1ea30a38 100644 --- a/modules/forum/forum.module +++ b/modules/forum/forum.module @@ -3,6 +3,7 @@ function forum_system($field){ $system["description"] = t("Enable threaded discussions about general topics."); + $system["admin_help"] = t("Forums are threaded discussions based on the taxonomy system so you must first define a taxonomy of type \"forum\" to place the forum tree in. Then add terms to this taxonomy. Each term becomes the name of a forum. If you define a term as a \"Container\" (See below) the term is not a forum itself, but rather holds forms. This lets you group your forums.", array("%taxonomy-create" => url("admin/taxonomy/add/vocabulary"), "%taxonomy" => url("admin/taxonomy"))); return $system[$field]; } @@ -710,24 +711,15 @@ function _forum_get_topic_order($sortby) { } function forum_help() { - ?> -

Creating a forum

-

Drupal lets you setup a countless number of forums by using the powerful taxonomy module. Therefore to create a forum you first have to create a taxonomy vocuabulary and add some terms to it, each term will be a forum. Creating a vocabulary is done by going the taxonomy page of the administration pages, then selecting the add new vocabulary link. Choose a name for the vocabulary (example: forum, message boards, or debates), and make sure under Types that forum is selected. Nothing else needs to be configured, so unless you have more advanced needs save the vocabulary. Now add a term to the vocabulary just added to create a forum. In the add term window enter the name of the forum (example: general, off topic, support), a description to make it clear to the users what the forum is about, and then save the term. You can now add a new forum by entering another term, repeat until all the forums are entered.

-

Once a vocabulary is entered go to site configuration in the administration pages and set the Forum vocabulary, don't forget to save! There will now be forums active on the site. For users to access them the proper user permissions must be given in the user management pages.

-

Containers

-

By designating a forum as a Container, users are not allowed to post into that forum. The forum will be visible on the forum listing page, so it acts as a section delimiter if you will. This is useful if you have a lots of forums which are nested. For example,

-

Marketing
- -- Market research
- -- Brand management
-
- Sales
- -- Closing the deal
- -- Avoiding ear and throat pain

-

If you don't want people posting into the Marketing or Sales folders, you designate them as Containers.

-

Icons

-

To disable icons, set the icon paths as blank in Admin -> Site Configuration -> Forum

-

All files in the icon directory are assumed to be images. Usually it is best to use GIF or JPG files as icons. You may use images of whatever size you wish, but it is customary to use 15x15 or 16x16.

- Creating a forum

Drupal lets you set up a countless number of forums by using the powerful taxonomy module. Therefore to create a forum you first have to create a ". l("taxonomy vocuabulary", "admin/taxonomy/add/vocabulary") ." and ". l("add some terms", "admin/taxonomy") ." to it; each term will become a forum. Choose a name for the vocabulary (examples: forum, message boards, or debates), and make sure under \"Types\" that forum is selected. Nothing else needs to be configured, so unless you have more advanced needs save the vocabulary. Now ". l("add a term", "admin/taxonomy") ." to the vocabulary just created (examples: general, off topic, support), and a description to make it clear to the users what the forum is about. Each term become a forum. Continue creating fora by adding terms until you are satisfied."; + $output .= "

Once a vocabulary is entered go to ". l("site configuration » modules » forum","admin/system/modules/forum") ." and set the Forum vocabulary (don't forget to save). There will now be fora active on the site. For users to access them they must have the \"access content\" permission and to create a topic they must have \"create forum topics\" permission. The permissions can be set in the ". l("user management", "admin/user/permission") ." pages.

"; + $output .= "

Containers

By designating a forum as a container, users are not allowed to post into that forum. The forum will be visible on the forum listing page, so it acts as a section delimiter if you will. This is useful if you have a lots of forums which are nested. For example,

"; + $output .= "

Marketing
-- Market research
-- Brand management

Sales
-- Closing the deal
-- Avoiding ear and throat pain

"; + $output .= "

If you don't want people posting into the Marketing or Sales folders, you designate them as Containers.

"; + $output .= "

Icons

To disable icons, set the icon path as blank in ". l("site configuration » modules » forums","admin/system/module/forum") ."

"; + $output .= "

All files in the icon directory are assumed to be images. You may use images of whatever size you wish, but it is customary to use 15x15 or 16x16.

"; + return t($output); + } ?> -- cgit v1.2.3