You are here

README.txt in Pathauto 6.2

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 7 README.txt
Please read this file and also the INSTALL.txt.
They contain answers to many common questions.
If you are developing for this module, the API.txt may be interesting.
If you are upgrading, check the CHANGELOG.txt for major changes.

**Description:
The Pathauto module provides support functions for other modules to
automatically generate aliases based on appropriate criteria, with a
central settings path for site administrators.

Implementations are provided for core content types: nodes, taxonomy
terms, and users (including blogs and tracker pages).

Pathauto also provides a way to delete large numbers of aliases.  This feature
is available at  Administer > Site building > URL aliases > Delete aliases

**Benefits:
Besides making the page address more reflective of its content than
"node/138", it's important to know that modern search engines give
heavy weight to search terms which appear in a page's URL. By
automatically using keywords based directly on the page content in the URL,
relevant search engine hits for your page can be significantly
enhanced.

**Installation AND Upgrades:
See the INSTALL.txt file.

**Notices:
Pathauto just adds URL aliases to nodes, users, and taxonomy terms. Because
it's an alias, the standard Drupal URL (for example node/123 or
taxonomy/term/1) will still function as normal.  If you have external links
to your site pointing to standard Drupal URLs, or hardcoded links in a module,
template, node or menu which point to standard Drupal URLs it will bypass the
alias set by Pathauto.

There are reasons you might not want two URLs for the same content on your
site. If this applies to you, please note that you will need to update any
hard coded links in your nodes or blocks.

If you use the "system path" (i.e. node/10) for menu items and settings like
that, Drupal will replace it with the url_alias.

For external links, you might want to consider the Path Redirect or
Global Redirect modules, which allow you to set forwarding either per item or
across the site to your aliased URLs.

URLs (not) Getting Replaced With Aliases:
Please bear in mind that only URLs passed through Drupal's l() or url()
functions will be replaced with their aliases during page output. If a module
or your template contains hardcoded links, such as 'href="node/$node->nid"'
those won't get replaced with their corresponding aliases. Use the
Drupal API instead:

* 'href="'. url("node/$node->nid") .'"' or
* l("Your link title", "node/$node->nid")

See http://api.drupal.org/api/HEAD/function/url and
http://api.drupal.org/api/HEAD/function/l for more information.

** Disabling Pathauto for a specific node type (or taxonomy)
When the pattern for a node type is left blank, the default pattern will be
used. But if the default pattern is also blank, Pathauto will be disabled
for that node type.

** Bulk Updates Must be Run Multiple Times:
As of 5.x-2.x Pathauto now performs bulk updates in a manner which is more
likely to succeed on large sites.  The drawback is that it needs to be run
multiple times.  If you want to reduce the number of times that you need to
run Pathauto you can increase the "Maximum number of objects to alias in a
bulk update:" setting under General Settings.

**WYSIWYG Conflicts - FCKEditor, TinyMCE, etc.
If you use a WYSIWYG editor, please disable it for the Pathauto admin page.
Failure to do so may cause errors about "preg_replace" problems due to the <p>
tag being added to the "strings to replace".  See http://drupal.org/node/175772

**Credits:
The original module combined the functionality of Mike Ryan's autopath with
Tommy Sundstrom's path_automatic.

Significant enhancements were contributed by jdmquin @ www.bcdems.net.

Matt England added the tracker support.

Other suggestions and patches contributed by the Drupal community.

Current maintainers:
  Dave Reid - http://www.davereid.net
  Greg Knaddison - http://www.knaddison.com
  Mike Ryan - http://mikeryan.name
  Frederik 'Freso' S. Olesen - http://freso.dk

File

README.txt
View source
  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. **Description:
  6. The Pathauto module provides support functions for other modules to
  7. automatically generate aliases based on appropriate criteria, with a
  8. central settings path for site administrators.
  9. Implementations are provided for core content types: nodes, taxonomy
  10. terms, and users (including blogs and tracker pages).
  11. Pathauto also provides a way to delete large numbers of aliases. This feature
  12. is available at Administer > Site building > URL aliases > Delete aliases
  13. **Benefits:
  14. Besides making the page address more reflective of its content than
  15. "node/138", it's important to know that modern search engines give
  16. heavy weight to search terms which appear in a page's URL. By
  17. automatically using keywords based directly on the page content in the URL,
  18. relevant search engine hits for your page can be significantly
  19. enhanced.
  20. **Installation AND Upgrades:
  21. See the INSTALL.txt file.
  22. **Notices:
  23. Pathauto just adds URL aliases to nodes, users, and taxonomy terms. Because
  24. it's an alias, the standard Drupal URL (for example node/123 or
  25. taxonomy/term/1) will still function as normal. If you have external links
  26. to your site pointing to standard Drupal URLs, or hardcoded links in a module,
  27. template, node or menu which point to standard Drupal URLs it will bypass the
  28. alias set by Pathauto.
  29. There are reasons you might not want two URLs for the same content on your
  30. site. If this applies to you, please note that you will need to update any
  31. hard coded links in your nodes or blocks.
  32. If you use the "system path" (i.e. node/10) for menu items and settings like
  33. that, Drupal will replace it with the url_alias.
  34. For external links, you might want to consider the Path Redirect or
  35. Global Redirect modules, which allow you to set forwarding either per item or
  36. across the site to your aliased URLs.
  37. URLs (not) Getting Replaced With Aliases:
  38. Please bear in mind that only URLs passed through Drupal's l() or url()
  39. functions will be replaced with their aliases during page output. If a module
  40. or your template contains hardcoded links, such as 'href="node/$node->nid"'
  41. those won't get replaced with their corresponding aliases. Use the
  42. Drupal API instead:
  43. * 'href="'. url("node/$node->nid") .'"' or
  44. * l("Your link title", "node/$node->nid")
  45. See http://api.drupal.org/api/HEAD/function/url and
  46. http://api.drupal.org/api/HEAD/function/l for more information.
  47. ** Disabling Pathauto for a specific node type (or taxonomy)
  48. When the pattern for a node type is left blank, the default pattern will be
  49. used. But if the default pattern is also blank, Pathauto will be disabled
  50. for that node type.
  51. ** Bulk Updates Must be Run Multiple Times:
  52. As of 5.x-2.x Pathauto now performs bulk updates in a manner which is more
  53. likely to succeed on large sites. The drawback is that it needs to be run
  54. multiple times. If you want to reduce the number of times that you need to
  55. run Pathauto you can increase the "Maximum number of objects to alias in a
  56. bulk update:" setting under General Settings.
  57. **WYSIWYG Conflicts - FCKEditor, TinyMCE, etc.
  58. If you use a WYSIWYG editor, please disable it for the Pathauto admin page.
  59. Failure to do so may cause errors about "preg_replace" problems due to the

  60. tag being added to the "strings to replace". See http://drupal.org/node/175772
  61. **Credits:
  62. The original module combined the functionality of Mike Ryan's autopath with
  63. Tommy Sundstrom's path_automatic.
  64. Significant enhancements were contributed by jdmquin @ www.bcdems.net.
  65. Matt England added the tracker support.
  66. Other suggestions and patches contributed by the Drupal community.
  67. Current maintainers:
  68. Dave Reid - http://www.davereid.net
  69. Greg Knaddison - http://www.knaddison.com
  70. Mike Ryan - http://mikeryan.name
  71. Frederik 'Freso' S. Olesen - http://freso.dk