Commit a3e9b35a authored by Dries's avatar Dries

- Patch #19451 by JonBob: improved consistency of module descriptions. We...

- Patch #19451 by JonBob: improved consistency of module descriptions.  We should write guidelines for this -- maybe in the PHPDoc code of the _help hook.
parent 71c021c6
......@@ -58,7 +58,7 @@ function aggregator_help($section) {
<p>When fetching feeds Drupal supports conditional GETs, this reduces the bandwidth usage for feeds that have not been updated since the last check.</p>
<p>If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.</p>', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
case 'admin/modules#description':
return t('Used to aggregate syndicated content (RSS and RDF).');
return t('Aggregates syndicated content (RSS and RDF feeds).');
case 'admin/aggregator':
return t('<p>Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an <a href="http://blogs.law.harvard.edu/tech/rss">RSS</a> feed (which is an XML-based syndication standard). To display the feed or category in a block you must decide how many items to show by editing the feed or block and turning on the <a href="%block">feed\'s block</a>.</p>', array('%block' => url('admin/block')));
case 'admin/aggregator/add/feed':
......
......@@ -58,7 +58,7 @@ function aggregator_help($section) {
<p>When fetching feeds Drupal supports conditional GETs, this reduces the bandwidth usage for feeds that have not been updated since the last check.</p>
<p>If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.</p>', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
case 'admin/modules#description':
return t('Used to aggregate syndicated content (RSS and RDF).');
return t('Aggregates syndicated content (RSS and RDF feeds).');
case 'admin/aggregator':
return t('<p>Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an <a href="http://blogs.law.harvard.edu/tech/rss">RSS</a> feed (which is an XML-based syndication standard). To display the feed or category in a block you must decide how many items to show by editing the feed or block and turning on the <a href="%block">feed\'s block</a>.</p>', array('%block' => url('admin/block')));
case 'admin/aggregator/add/feed':
......
......@@ -12,7 +12,7 @@
function archive_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Displays a calendar to navigate old content.');
return t('Displays a calendar for navigating older content.');
}
}
......
......@@ -12,7 +12,7 @@
function archive_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Displays a calendar to navigate old content.');
return t('Displays a calendar for navigating older content.');
}
}
......
......@@ -14,7 +14,7 @@ function blogapi_help($section) {
case 'admin/help#blogapi':
return t('<p>This module adds support for several XML-RPC based blogging APIs. Specifically, it currently implements the %bloggerAPI, %metaweblogAPI, and most of the %moveabletype extensions. This allows users to contribute to Drupal using external GUI applications, which can often offer richer functionality that online forms based editing.</p><p>This module also allows site administrators to configure which node types can be posted via the external applications. So, for instance, users can post forum topics as well as blog posts. Where supported, the external applications will display each node type as a separate "blog".</p>', array('%bloggerAPI' => '<a href="http://www.blogger.com/developers/api/1_docs/">Blogger API</a>', '%metaweblogAPI' => '<a href="http://www.xmlrpc.com/metaWeblogApi">MetaWeblog API</a>', '%moveabletype' => '<a href="http://www.movabletype.org/docs/mtmanual_programmatic.html">Movable Type API</a>. '));
case 'admin/modules#description':
return t('Enable users to post using applications that support XML-RPC blog APIs.');
return t('Allows users to post content using applications that support XML-RPC blog APIs.');
}
}
......
......@@ -14,7 +14,7 @@ function blogapi_help($section) {
case 'admin/help#blogapi':
return t('<p>This module adds support for several XML-RPC based blogging APIs. Specifically, it currently implements the %bloggerAPI, %metaweblogAPI, and most of the %moveabletype extensions. This allows users to contribute to Drupal using external GUI applications, which can often offer richer functionality that online forms based editing.</p><p>This module also allows site administrators to configure which node types can be posted via the external applications. So, for instance, users can post forum topics as well as blog posts. Where supported, the external applications will display each node type as a separate "blog".</p>', array('%bloggerAPI' => '<a href="http://www.blogger.com/developers/api/1_docs/">Blogger API</a>', '%metaweblogAPI' => '<a href="http://www.xmlrpc.com/metaWeblogApi">MetaWeblog API</a>', '%moveabletype' => '<a href="http://www.movabletype.org/docs/mtmanual_programmatic.html">Movable Type API</a>. '));
case 'admin/modules#description':
return t('Enable users to post using applications that support XML-RPC blog APIs.');
return t('Allows users to post content using applications that support XML-RPC blog APIs.');
}
}
......
......@@ -75,7 +75,7 @@ function comment_help($section = "admin/help#comment") {
case 'admin/comment/configure/votes':
return t('<p>Create and control the possible comment moderation votes here. "Weight" lets you set the order of the drop down menu. Click "edit" to edit a current vote weight. To delete a name/weight combination go to the "edit" area. To delete a setting, "edit" it first, and then choose "delete vote".</p>');
case 'admin/modules#description':
return t('Enables user to comment on published content.');
return t('Allows users to comment on and discuss published content.');
}
}
......
......@@ -75,7 +75,7 @@ function comment_help($section = "admin/help#comment") {
case 'admin/comment/configure/votes':
return t('<p>Create and control the possible comment moderation votes here. "Weight" lets you set the order of the drop down menu. Click "edit" to edit a current vote weight. To delete a name/weight combination go to the "edit" area. To delete a setting, "edit" it first, and then choose "delete vote".</p>');
case 'admin/modules#description':
return t('Enables user to comment on published content.');
return t('Allows users to comment on and discuss published content.');
}
}
......
......@@ -23,7 +23,7 @@
function filter_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Framework for handling filtering of content.');
return t('Handles the filtering of content in preparation for display.');
case 'admin/filters':
return t('
......
......@@ -23,7 +23,7 @@
function filter_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Framework for handling filtering of content.');
return t('Handles the filtering of content in preparation for display.');
case 'admin/filters':
return t('
......
......@@ -18,7 +18,7 @@ function forum_help($section) {
case 'admin/forum/add/forum':
return t('<p>A forum holds threaded topic discussions that are related. For example, a forum named "Fruit" might contain topic discussions titled "Apples" and "Bananas". You can place a forum into a container, another forum, or at the top (root) level of your forum.</p>');
case 'admin/modules#description':
return t('Enable threaded discussions about general topics.');
return t('Enables threaded discussions about general topics.');
case 'node/add#forum':
return t('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
}
......
......@@ -18,7 +18,7 @@ function forum_help($section) {
case 'admin/forum/add/forum':
return t('<p>A forum holds threaded topic discussions that are related. For example, a forum named "Fruit" might contain topic discussions titled "Apples" and "Bananas". You can place a forum into a container, another forum, or at the top (root) level of your forum.</p>');
case 'admin/modules#description':
return t('Enable threaded discussions about general topics.');
return t('Enables threaded discussions about general topics.');
case 'node/add#forum':
return t('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
}
......
......@@ -85,7 +85,7 @@ function help_links_as_list() {
function help_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Manages displaying online help.');
return t('Manages the display of online help.');
}
}
......
......@@ -85,7 +85,7 @@ function help_links_as_list() {
function help_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Manages displaying online help.');
return t('Manages the display of online help.');
}
}
......
......@@ -40,7 +40,7 @@ function node_help($section) {
return $output;
case 'admin/modules#description':
return t('The core that allows content to be submitted to the site.');
return t('Allows content to be submitted to the site and displayed on pages.');
case 'admin/node/configure':
case 'admin/node/configure/settings':
return t('<p>Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.</p>');
......
......@@ -40,7 +40,7 @@ function node_help($section) {
return $output;
case 'admin/modules#description':
return t('The core that allows content to be submitted to the site.');
return t('Allows content to be submitted to the site and displayed on pages.');
case 'admin/node/configure':
case 'admin/node/configure/settings':
return t('<p>Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.</p>');
......
......@@ -12,7 +12,7 @@
function path_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Enables users to rename URLs.');
return t('Allows users to rename URLs.');
case 'admin/path':
return t("<p>Drupal provides users complete control over URLs through aliasing. This feature is typically used to make URLs human-readable or easy to remember. For example, one could map the relative URL 'node/1' onto 'about'. Each system path can have multiple aliases.</p>");
case 'admin/path/add':
......
......@@ -12,7 +12,7 @@
function path_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Enables users to rename URLs.');
return t('Allows users to rename URLs.');
case 'admin/path':
return t("<p>Drupal provides users complete control over URLs through aliasing. This feature is typically used to make URLs human-readable or easy to remember. For example, one could map the relative URL 'node/1' onto 'about'. Each system path can have multiple aliases.</p>");
case 'admin/path/add':
......
......@@ -18,7 +18,7 @@ function ping_help($section) {
break;
case 'admin/modules#description':
$output = t('Alerts other sites that your site has been updated.');
$output = t('Alerts other sites when your site has been updated.');
break;
}
......
......@@ -18,7 +18,7 @@ function ping_help($section) {
break;
case 'admin/modules#description':
$output = t('Alerts other sites that your site has been updated.');
$output = t('Alerts other sites when your site has been updated.');
break;
}
......
......@@ -23,7 +23,7 @@ function poll_help($section) {
</ul>
<p>Creating a poll is much like creating any other node. Click \"create poll\" in your user box. The title of the poll should be the question, then enter the answers and the \"base\" vote counts. You can also choose the time period over which the vote will run.</p><p>The <a href=\"%poll\">Poll</a> item in the navigation links will take you to a page where you can see all the current polls, vote on them (if you haven't already) and view the results.</p>", array("%permissions" => url("admin/access/permissions"), "%poll" => url("poll")));
case 'admin/modules#description':
return t("Enables your site to capture votes on different topics in the form of multiple choice questions.");
return t("Allows your site to capture votes on different topics in the form of multiple choice questions.");
case 'node/add#poll':
return t("A poll is a multiple-choice question which visitors can vote on.");
}
......
......@@ -23,7 +23,7 @@ function poll_help($section) {
</ul>
<p>Creating a poll is much like creating any other node. Click \"create poll\" in your user box. The title of the poll should be the question, then enter the answers and the \"base\" vote counts. You can also choose the time period over which the vote will run.</p><p>The <a href=\"%poll\">Poll</a> item in the navigation links will take you to a page where you can see all the current polls, vote on them (if you haven't already) and view the results.</p>", array("%permissions" => url("admin/access/permissions"), "%poll" => url("poll")));
case 'admin/modules#description':
return t("Enables your site to capture votes on different topics in the form of multiple choice questions.");
return t("Allows your site to capture votes on different topics in the form of multiple choice questions.");
case 'node/add#poll':
return t("A poll is a multiple-choice question which visitors can vote on.");
}
......
......@@ -19,7 +19,7 @@
function profile_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Support for configurable user profiles.');
return t('Supports configurable user profiles.');
case 'admin/settings/profile':
return t('<p>Here you can define custom fields that users can fill in in their user profile (such as <em>country</em>, <em>real name</em>, <em>age</em>, ...).</p>');
}
......
......@@ -19,7 +19,7 @@
function profile_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Support for configurable user profiles.');
return t('Supports configurable user profiles.');
case 'admin/settings/profile':
return t('<p>Here you can define custom fields that users can fill in in their user profile (such as <em>country</em>, <em>real name</em>, <em>age</em>, ...).</p>');
}
......
......@@ -12,7 +12,7 @@
function queue_help($section) {
switch ($section) {
case 'admin/modules#description':
return t("Enables content to be moderated by the community.");
return t('Allows content to be moderated by the community.');
case 'admin/settings/queue':
return t("<p>The queue provides a way for your users to vote on submitted content. This is called <strong>moderation</strong>. Users can moderate a post up (give it a point), or down (subtract a point). The settings below give you control over how many points are required for the status of a post to be automatically changed. See individual items for details.</p>");
}
......
......@@ -12,7 +12,7 @@
function story_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Enables users to submit stories, articles or similar content.');
return t('Allows users to submit stories, articles or similar content.');
case 'node/add#story':
return t('Stories are articles in their simplest form: they have a title, a teaser and a body, but can be extended by other modules. The teaser is part of the body too. Stories may be used as a personal blog or for news articles.');
}
......
......@@ -12,7 +12,7 @@
function story_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Enables users to submit stories, articles or similar content.');
return t('Allows users to submit stories, articles or similar content.');
case 'node/add#story':
return t('Stories are articles in their simplest form: they have a title, a teaser and a body, but can be extended by other modules. The teaser is part of the body too. Stories may be used as a personal blog or for news articles.');
}
......
......@@ -39,7 +39,7 @@ function system_help($section) {
<h3><a id=\"cache\">Cache</a></h3>
<p>Drupal has a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, Drupal does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load. Only pages requested by \"anonymous\" users are cached. In order to reduce server load and save bandwidth, Drupal stores and sends cached pages compressed.</p>", array('%base_url' => $base_url, '%cron-link' => "<a href=\"$base_url/cron.php\">$base_url/cron.php</a>", '%lynx' => 'http://lynx.browser.org', '%wget' => 'http://www.gnu.org/software/wget/wget.html' ));
case 'admin/modules#description':
return t('Configuration system that lets administrators modify the workings of the site.');
return t('Handles general site configuration for administrators.');
}
}
......
......@@ -39,7 +39,7 @@ function system_help($section) {
<h3><a id=\"cache\">Cache</a></h3>
<p>Drupal has a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, Drupal does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load. Only pages requested by \"anonymous\" users are cached. In order to reduce server load and save bandwidth, Drupal stores and sends cached pages compressed.</p>", array('%base_url' => $base_url, '%cron-link' => "<a href=\"$base_url/cron.php\">$base_url/cron.php</a>", '%lynx' => 'http://lynx.browser.org', '%wget' => 'http://www.gnu.org/software/wget/wget.html' ));
case 'admin/modules#description':
return t('Configuration system that lets administrators modify the workings of the site.');
return t('Handles general site configuration for administrators.');
}
}
......
......@@ -1049,7 +1049,7 @@ function taxonomy_rss_item($node) {
function taxonomy_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Enables the organization of content into categories.');
return t('Enables the categorization of content.');
case 'admin/taxonomy':
return t('<p>The taxonomy module allows you to classify content into categories and subcategories; it allows multiple lists of categories for classification (controlled vocabularies) and offers the possibility of creating thesauri (controlled vocabularies that indicate the relationship of terms) and taxonomies (controlled vocabularies where relationships are indicated hierarchically). To delete a term choose "edit term". To delete a vocabulary, and all its terms, choose "edit vocabulary".</p>');
case 'admin/taxonomy/add/vocabulary':
......
......@@ -1049,7 +1049,7 @@ function taxonomy_rss_item($node) {
function taxonomy_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Enables the organization of content into categories.');
return t('Enables the categorization of content.');
case 'admin/taxonomy':
return t('<p>The taxonomy module allows you to classify content into categories and subcategories; it allows multiple lists of categories for classification (controlled vocabularies) and offers the possibility of creating thesauri (controlled vocabularies that indicate the relationship of terms) and taxonomies (controlled vocabularies where relationships are indicated hierarchically). To delete a term choose "edit term". To delete a vocabulary, and all its terms, choose "edit vocabulary".</p>');
case 'admin/taxonomy/add/vocabulary':
......
......@@ -101,7 +101,7 @@ function _throttle_validate($value, $form) {
function throttle_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Allows configuration of congestion control auto-throttle mechanism.');
return t('Handles the auto-throttling mechanism, to control site congestion.');
case 'admin/settings/throttle':
return t('If your site gets linked to by a popular website, or otherwise comes under a "Denial of Service" (DoS) attack, your webserver might become overwhelmed. This module provides a congestion control throttling mechanism for automatically detecting a surge in incoming traffic. This mechanism is utilized by other Drupal models to automatically optimize their performance by temporarily disabling CPU-intensive functionality.');
}
......
......@@ -101,7 +101,7 @@ function _throttle_validate($value, $form) {
function throttle_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('Allows configuration of congestion control auto-throttle mechanism.');
return t('Handles the auto-throttling mechanism, to control site congestion.');
case 'admin/settings/throttle':
return t('If your site gets linked to by a popular website, or otherwise comes under a "Denial of Service" (DoS) attack, your webserver might become overwhelmed. This module provides a congestion control throttling mechanism for automatically detecting a surge in incoming traffic. This mechanism is utilized by other Drupal models to automatically optimize their performance by temporarily disabling CPU-intensive functionality.');
}
......
......@@ -12,7 +12,7 @@
function upload_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('File-handling and attaching files to nodes.');
return t('Allows users to upload and attach files to content.');
case 'admin/settings/upload':
return t('<p>Users with the <a href="%permissions">upload files permission</a> can upload attachments. You can choose which post types can take attachments on the <a href="%types">content types settings</a> page.</p>', array('%permissions' => url('admin/access'), '%types' => url('admin/node/configure/types')));
}
......
......@@ -12,7 +12,7 @@
function upload_help($section) {
switch ($section) {
case 'admin/modules#description':
return t('File-handling and attaching files to nodes.');
return t('Allows users to upload and attach files to content.');
case 'admin/settings/upload':
return t('<p>Users with the <a href="%permissions">upload files permission</a> can upload attachments. You can choose which post types can take attachments on the <a href="%types">content types settings</a> page.</p>', array('%permissions' => url('admin/access'), '%types' => url('admin/node/configure/types')));
}
......
......@@ -1706,7 +1706,7 @@ function user_help($section) {
case 'admin/user/search':
return t('<p>Enter a simple pattern ("*" may be user as a wildcard match) to search for a username. For example, one may search for "br" and Drupal might return "brian", "brad", and "brenda".</p>');
case 'admin/modules#description':
return t('Enables the user registration and login system.');
return t('Manages the user registration and login system.');
case 'admin/user/configure':
case 'admin/user/configure/settings':
return t('<p>In order to use the full power of Drupal a visitor must sign up for an account. This page lets you setup how a user signs up, logs out, the guidelines from the system about user subscriptions, and the e-mails the system will send to the user.</p>');
......
......@@ -1706,7 +1706,7 @@ function user_help($section) {
case 'admin/user/search':
return t('<p>Enter a simple pattern ("*" may be user as a wildcard match) to search for a username. For example, one may search for "br" and Drupal might return "brian", "brad", and "brenda".</p>');
case 'admin/modules#description':
return t('Enables the user registration and login system.');
return t('Manages the user registration and login system.');
case 'admin/user/configure':
case 'admin/user/configure/settings':
return t('<p>In order to use the full power of Drupal a visitor must sign up for an account. This page lets you setup how a user signs up, logs out, the guidelines from the system about user subscriptions, and the e-mails the system will send to the user.</p>');
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment