diff options
author | Dries Buytaert <dries@buytaert.net> | 2002-02-25 20:26:38 +0000 |
---|---|---|
committer | Dries Buytaert <dries@buytaert.net> | 2002-02-25 20:26:38 +0000 |
commit | c5fcdd31946dcd7359a67f105a1b9e359bbaea22 (patch) | |
tree | 8adb15d21bd20788a4cb412c01ebfeea123baed6 | |
parent | 460f0e54dfbf76abad5586b87f28bb0f5e044e33 (diff) | |
download | brdo-c5fcdd31946dcd7359a67f105a1b9e359bbaea22.tar.gz brdo-c5fcdd31946dcd7359a67f105a1b9e359bbaea22.tar.bz2 |
- Included the documentation contributed by Moshe.
-rw-r--r-- | modules/page.module | 6 | ||||
-rw-r--r-- | modules/page/page.module | 6 | ||||
-rw-r--r-- | modules/story.module | 16 | ||||
-rw-r--r-- | modules/story/story.module | 16 |
4 files changed, 24 insertions, 20 deletions
diff --git a/modules/page.module b/modules/page.module index 20cdcc2c7..00cf5b0af 100644 --- a/modules/page.module +++ b/modules/page.module @@ -1,6 +1,12 @@ <?php // $Id$ +function page_help() { + $output .= "<p>The page module is used to create a <i>site page</i>. Unlike a story, a site page is a persistent web page on your site which usually shortcuts the typical lifecycle of user generated content (i.e. submit -> moderate -> post -> comment). A site page is usually linked from the main navigation bar, using whatever text the author wishes. To create a site page without this navigation link, simply skip the form field which requests link text. Administrators are the exclusive authors of site pages (i.e. requires the <i>adinister nodes</i> in <a href=\"/admin.php?mod=user&op=permission\">permission</a>).</p>"; + $output .= "<p>Site pages, unlike many other forms of Drupal content, may be made of PHP code in addition to HTML and text. All Drupal objects and functions are available to the Site Page author.</p>"; + return $output; +} + function page_node($field) { $info["name"] = t("site page"); $info["description"] = t("If you just want to add a page with a link in the menu to your site, this would be the best choice. Unlike a story, a site page by-passes the submission queue."); diff --git a/modules/page/page.module b/modules/page/page.module index 20cdcc2c7..00cf5b0af 100644 --- a/modules/page/page.module +++ b/modules/page/page.module @@ -1,6 +1,12 @@ <?php // $Id$ +function page_help() { + $output .= "<p>The page module is used to create a <i>site page</i>. Unlike a story, a site page is a persistent web page on your site which usually shortcuts the typical lifecycle of user generated content (i.e. submit -> moderate -> post -> comment). A site page is usually linked from the main navigation bar, using whatever text the author wishes. To create a site page without this navigation link, simply skip the form field which requests link text. Administrators are the exclusive authors of site pages (i.e. requires the <i>adinister nodes</i> in <a href=\"/admin.php?mod=user&op=permission\">permission</a>).</p>"; + $output .= "<p>Site pages, unlike many other forms of Drupal content, may be made of PHP code in addition to HTML and text. All Drupal objects and functions are available to the Site Page author.</p>"; + return $output; +} + function page_node($field) { $info["name"] = t("site page"); $info["description"] = t("If you just want to add a page with a link in the menu to your site, this would be the best choice. Unlike a story, a site page by-passes the submission queue."); 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 -> moderate -> post to home page -> 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)) { diff --git a/modules/story/story.module b/modules/story/story.module index fcffb42ab..0d1094591 100644 --- a/modules/story/story.module +++ b/modules/story/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 -> moderate -> post to home page -> 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)) { |