[c6551d9] | 1 | Please read this file and also the INSTALL.txt. |
---|
| 2 | They contain answers to many common questions. |
---|
| 3 | If you are developing for this module, the API.txt may be interesting. |
---|
| 4 | If you are upgrading, check the CHANGELOG.txt for major changes. |
---|
| 5 | |
---|
| 6 | **Description: |
---|
| 7 | The Pathauto module provides support functions for other modules to |
---|
| 8 | automatically generate aliases based on appropriate criteria, with a |
---|
| 9 | central settings path for site administrators. |
---|
| 10 | |
---|
| 11 | Implementations are provided for core content types: nodes, taxonomy |
---|
| 12 | terms, and users (including blogs and tracker pages). |
---|
| 13 | |
---|
| 14 | Pathauto also provides a way to delete large numbers of aliases. This feature |
---|
| 15 | is available at Administer > Site building > URL aliases > Delete aliases |
---|
| 16 | |
---|
| 17 | **Benefits: |
---|
| 18 | Besides making the page address more reflective of its content than |
---|
| 19 | "node/138", it's important to know that modern search engines give |
---|
| 20 | heavy weight to search terms which appear in a page's URL. By |
---|
| 21 | automatically using keywords based directly on the page content in the URL, |
---|
| 22 | relevant search engine hits for your page can be significantly |
---|
| 23 | enhanced. |
---|
| 24 | |
---|
| 25 | **Installation AND Upgrades: |
---|
| 26 | See the INSTALL.txt file. |
---|
| 27 | |
---|
| 28 | **Notices: |
---|
| 29 | Pathauto just adds URL aliases to nodes, users, and taxonomy terms. Because |
---|
| 30 | it's an alias, the standard Drupal URL (for example node/123 or |
---|
| 31 | taxonomy/term/1) will still function as normal. If you have external links |
---|
| 32 | to your site pointing to standard Drupal URLs, or hardcoded links in a module, |
---|
| 33 | template, node or menu which point to standard Drupal URLs it will bypass the |
---|
| 34 | alias set by Pathauto. |
---|
| 35 | |
---|
| 36 | There are reasons you might not want two URLs for the same content on your |
---|
| 37 | site. If this applies to you, please note that you will need to update any |
---|
| 38 | hard coded links in your nodes or blocks. |
---|
| 39 | |
---|
| 40 | If you use the "system path" (i.e. node/10) for menu items and settings like |
---|
| 41 | that, Drupal will replace it with the url_alias. |
---|
| 42 | |
---|
| 43 | For external links, you might want to consider the Path Redirect or |
---|
| 44 | Global Redirect modules, which allow you to set forwarding either per item or |
---|
| 45 | across the site to your aliased URLs. |
---|
| 46 | |
---|
| 47 | URLs (not) Getting Replaced With Aliases: |
---|
| 48 | Please bear in mind that only URLs passed through Drupal's l() or url() |
---|
| 49 | functions will be replaced with their aliases during page output. If a module |
---|
| 50 | or your template contains hardcoded links, such as 'href="node/$node->nid"' |
---|
| 51 | those won't get replaced with their corresponding aliases. Use the |
---|
| 52 | Drupal API instead: |
---|
| 53 | |
---|
| 54 | * 'href="'. url("node/$node->nid") .'"' or |
---|
| 55 | * l("Your link title", "node/$node->nid") |
---|
| 56 | |
---|
| 57 | See http://api.drupal.org/api/HEAD/function/url and |
---|
| 58 | http://api.drupal.org/api/HEAD/function/l for more information. |
---|
| 59 | |
---|
| 60 | ** Disabling Pathauto for a specific node type (or taxonomy) |
---|
| 61 | When the pattern for a node type is left blank, the default pattern will be |
---|
| 62 | used. But if the default pattern is also blank, Pathauto will be disabled |
---|
| 63 | for that node type. |
---|
| 64 | |
---|
| 65 | ** Bulk Updates Must be Run Multiple Times: |
---|
| 66 | As of 5.x-2.x Pathauto now performs bulk updates in a manner which is more |
---|
| 67 | likely to succeed on large sites. The drawback is that it needs to be run |
---|
| 68 | multiple times. If you want to reduce the number of times that you need to |
---|
| 69 | run Pathauto you can increase the "Maximum number of objects to alias in a |
---|
| 70 | bulk update:" setting under General Settings. |
---|
| 71 | |
---|
| 72 | **WYSIWYG Conflicts - FCKEditor, TinyMCE, etc. |
---|
| 73 | If you use a WYSIWYG editor, please disable it for the Pathauto admin page. |
---|
| 74 | Failure to do so may cause errors about "preg_replace" problems due to the <p> |
---|
| 75 | tag being added to the "strings to replace". See http://drupal.org/node/175772 |
---|
| 76 | |
---|
| 77 | **Credits: |
---|
| 78 | The original module combined the functionality of Mike Ryan's autopath with |
---|
| 79 | Tommy Sundstrom's path_automatic. |
---|
| 80 | |
---|
| 81 | Significant enhancements were contributed by jdmquin @ www.bcdems.net. |
---|
| 82 | |
---|
| 83 | Matt England added the tracker support. |
---|
| 84 | |
---|
| 85 | Other suggestions and patches contributed by the Drupal community. |
---|
| 86 | |
---|
| 87 | Current maintainers: |
---|
| 88 | Greg Knaddison - http://growingventuresolutions.com |
---|
| 89 | Mike Ryan - http://mikeryan.name |
---|
| 90 | Frederik 'Freso' S. Olesen - http://freso.dk |
---|
| 91 | |
---|
| 92 | **Changes: |
---|
| 93 | See the CHANGELOG.txt file. |
---|
| 94 | |
---|
| 95 | $Id: README.txt,v 1.16 2008/06/21 18:20:38 greggles Exp $ |
---|