From c5fcdd31946dcd7359a67f105a1b9e359bbaea22 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Mon, 25 Feb 2002 20:26:38 +0000
Subject: - Included the documentation contributed by Moshe.

---
 modules/story.module | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

(limited to 'modules/story.module')

diff --git a/modules/story.module b/modules/story.module
index fcffb42ab..0d1094591 100644
--- a/modules/story.module
+++ b/modules/story.module
@@ -1,6 +1,12 @@
 <?php
 // $Id$
 
+function story_help() {
+  $output .= "<p>The story module enables to users to submit thoughful, cohesive posts for consideration by the rest of the community.  Stories usually follow a specific content flow: <i>submit -&gt; moderate -&gt; post to home page -&gt; comment</i>.  Administrators are able to shortcut this flow as desired.</p>";
+  $output .= "<p>Administrators may \"pin\" an important story or announcement to the front page using the <i>static on front page</i> setting while creating or editing a story (this is true for other nodes as well). In addition, administrators may provide helpful introductory text for story authors in the <i>settings</i> page.  There, administrators might also choose to set a floor on the number of words which may be included in a story.  This is designed to help discourage the submission of trvially short stories.</p>";
+  return $output;
+}
+
 function story_conf_options() {
  $output .= form_textarea("Explanation or submission guidelines", "story_help", variable_get("story_help", ""), 55, 4, "This text will be displayed at the top of the story submission form.  Useful for helping or instructing your users.");
  $output .= form_select(t("Minimum number of words"), "minimum_story_size", variable_get("minimum_story_size", 0), array(0 => "0 words", 10 => "10 words", 25 => "25 words",  50 => "50 words", 75 => "75 words", 100 => "100 words", 125 => "125 words",  150 => "150 words", 175 => "175 words", 200 => "200 words"), t("The minimum number of words a personal story entry should consist of.  This can be useful to rule out submissions that do not meet the site's standards, such as short test posts."));
@@ -57,16 +63,6 @@ function story_link($type) {
   return $links ? $links : array();
 }
 
-function story_help() {
- ?>
-  // TODO: update documentation, outdated
-
-  //<p>Queued stories: user-contributed stories are automatically whisked away to a submission queue for moderators (i.e. registered user) to frown at.  Moderators vote whether or not a story should be posted to the front page for discussion.</p>
-  //<p>Posted stories: published stories accessible to all visitors.</p>
-  //<p>Dumped stories: rejected stories that are no longer available to visitors.</p>
- <?php
-}
-
 function story_form(&$node, &$help, &$error) {
 
   if (isset($node->body)) {
-- 
cgit v1.2.3