- Patch #26139 by webchick / Kieran / documentation team: improved admin help of core modules! /

1 files changed, 23 insertions, 29 deletions

diff --git a/modules/path/path.module b/modules/path/path.module
index d240485d6..4d92a7e30 100644
--- a/modules/path/path.module
+++ b/modules/path/path.module
@@ -11,41 +11,35 @@
  */
 function path_help($section) {
   switch ($section) {
+    case 'admin/help#path':
+      $output = '<p>'. t('The path module allows you to specify aliases for Drupal URLs.  Such aliases improve readability of URLs for your users and may help internet search engines to index your content more effectively.  More than one alias may be created for a given page.') .'</p>';
+      $output .= t('<p>Some examples of URL aliases are:</p>
+<ul>
+<li>user/login =&gt; login</li>
+<li>image/tid/16 =&gt; store</li>
+<li>taxonomy/term/7+19+20+21 =&gt; store/products/whirlygigs</li>
+<li>node/3 =&gt; contact</li>
+</ul>
+');
+      $output .= '<p>'. t('The path module enables an extra field for aliases in all node input and editing forms (when users have the appropriate permissions).  It also provides an interface to view and edit all URL aliases.  The two permissions are related to URL aliasing are "administer a list of URL aliases" and "add url aliases".  ') .'</p>';
+      $output .= '<p>'. t('This module also comes with user-defined mass URL aliasing capabilities, which is useful if you wish to uniformly use URLs different from the default.  For example, you may want to have your URLs presented in a different language. Access to the Drupal source code on the web server is required to set up these kinds of aliases. ') .'</p>';
+      $output .= t('<p>You can</p>
+<ul>
+<li>set the path for a post with the path module.</li>
+<li>add a URL alias: <a href="%admin-path-add">administer &gt;&gt; url aliases &gt;&gt; add alias</a>.</li>
+<li>administer the list of URL aliases: <a href="%admin-path">administer &gt;&gt; url aliases</a>.</li>
+<li>read how to <a href="%external-http-drupal-org-node-15365">configure clean URLs</a> for your webserver.
+<li>enable clean url\'s to remove the =? at <a href="%admin-settings">administer &gt;&gt; settings</a>.</li>
+</ul>
+', array('%admin-path-add' => url('admin/path/add'), '%admin-path' => url('admin/path'), '%external-http-drupal-org-node-15365' => 'http://drupal.org/node/15365', '%admin-settings' => url('admin/settings')));
+      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%path">Path page</a>.', array('%path' => 'http://www.drupal.org/handbook/modules/path/')) .'</p>';
+      return $output;
     case 'admin/modules#description':
       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':
       return t('<p>Enter the path you wish to create the alias for, followed by the name of the new alias.</p>');
-    case 'admin/help#path':
-      return t('
-<h3>Background</h3>
-<p>A very powerful feature of Drupal is the ability to have control over all paths. The path module is the tool that provides this functionality and is part of the basic Drupal installation, although it is not enabled by default. Some examples of re-mapping paths are:</p>
-<pre>
-user/login => login
-
-image/tid/16 => store
-
-taxonomy/term/7+19+20+21 => store/products/whirlygigs
-
-node/3 => contact
-</pre>
-<p>This functionality integrates seamlessly into node forms and also provides the administrator an interface to view all aliases that have been created.</p>
-<p>Aliases have a many to one relationship with their original Drupal URLs. In other words you can have many different aliases map to a single path. An example of where a multiple aliases come in handy is creating a standard RSS feed URL:</p>
-
-<pre>
-node/feed => rss.xml
-node/feed => index.rdf
-</pre>
-
-<p>When Drupal generates links for a path with multiple aliases it will choose the first alias created per system URL.  So in our above example, Drupal would use rss.xml as the default alias rather than index.rdf. To change this behavior, delete the aliases for node/feed and create the index.rdf alias before rss.xml.</p>
-
-<h3>Permissions</h3>
-<p>Two permissions are related to URL aliasing: <em>create url aliases</em> and <em>administer url aliases</em>.</p>
-<ol><li><strong>create url aliases</strong> - Allows users to create aliases for nodes. Enabling this permission will display a path field to the user in any node form, allowing them to enter an alias for that node. They will be able to edit/delete the alias after it is created using the same form.</li><li><strong>administer url aliases</strong> - Allows users to access the alias administration interface. This interface displays all aliases and provides a way to create and modify them. This is also the location to build aliases for things other than nodes. For example, you can create an alias for a taxonomy URL or even re-map the admin path (although the original admin path will still be accessible since aliases do not cancel out original paths).</li></ol>
-
-<h3>Mass URL aliasing</h3>
-<p>Drupal also comes with user defined mass URL aliasing capabilities. You might like to see completely different URLs used by Drupal, or even URLs translated to the visitors\' native language, in which case this feature is handy. You need to have a working PHP programming knowledge to make use of this feature however. Read on in the <a href="%mass-alias-doc">Drupal Handbook about mass url aliasing.</a></p>', array("%mass-alias-doc" => "http://drupal.org/node/23708"));
   }
 }