You are here

README.txt in Pathauto 7

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 6.2 README.txt
  4. 6 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 entity types: content, taxonomy terms,
and users (including blogs and forum pages).

Pathauto also provides a way to delete large numbers of aliases.  This feature
is available at  Administer > Configuration > Search and metadata > 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 content, 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, content 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 content 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 content type (or taxonomy)
When the pattern for a content type is left blank, the default pattern will be
used. But if the default pattern is also blank, Pathauto will be disabled
for that content type.

** 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 (tracker support has been removed in
recent changes).

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 entity types: content, taxonomy terms,
  10. and users (including blogs and forum pages).
  11. Pathauto also provides a way to delete large numbers of aliases. This feature
  12. is available at Administer > Configuration > Search and metadata > URL aliases
  13. > Delete aliases.
  14. ** Benefits:
  15. Besides making the page address more reflective of its content than
  16. "node/138", it's important to know that modern search engines give
  17. heavy weight to search terms which appear in a page's URL. By
  18. automatically using keywords based directly on the page content in the URL,
  19. relevant search engine hits for your page can be significantly
  20. enhanced.
  21. ** Installation AND Upgrades:
  22. See the INSTALL.txt file.
  23. ** Notices:
  24. Pathauto just adds URL aliases to content, users, and taxonomy terms.
  25. Because it's an alias, the standard Drupal URL (for example node/123 or
  26. taxonomy/term/1) will still function as normal. If you have external links
  27. to your site pointing to standard Drupal URLs, or hardcoded links in a module,
  28. template, content or menu which point to standard Drupal URLs it will bypass
  29. the alias set by Pathauto.
  30. There are reasons you might not want two URLs for the same content on your
  31. site. If this applies to you, please note that you will need to update any
  32. hard coded links in your content or blocks.
  33. If you use the "system path" (i.e. node/10) for menu items and settings like
  34. that, Drupal will replace it with the url_alias.
  35. For external links, you might want to consider the Path Redirect or
  36. Global Redirect modules, which allow you to set forwarding either per item or
  37. across the site to your aliased URLs.
  38. URLs (not) Getting Replaced With Aliases:
  39. Please bear in mind that only URLs passed through Drupal's l() or url()
  40. functions will be replaced with their aliases during page output. If a module
  41. or your template contains hardcoded links, such as 'href="node/$node->nid"'
  42. those won't get replaced with their corresponding aliases. Use the
  43. Drupal API instead:
  44. * 'href="'. url("node/$node->nid") .'"' or
  45. * l("Your link title", "node/$node->nid")
  46. See http://api.drupal.org/api/HEAD/function/url and
  47. http://api.drupal.org/api/HEAD/function/l for more information.
  48. ** Disabling Pathauto for a specific content type (or taxonomy)
  49. When the pattern for a content type is left blank, the default pattern will be
  50. used. But if the default pattern is also blank, Pathauto will be disabled
  51. for that content type.
  52. ** Credits:
  53. The original module combined the functionality of Mike Ryan's autopath with
  54. Tommy Sundstrom's path_automatic.
  55. Significant enhancements were contributed by jdmquin @ www.bcdems.net.
  56. Matt England added the tracker support (tracker support has been removed in
  57. recent changes).
  58. Other suggestions and patches contributed by the Drupal community.
  59. Current maintainers:
  60. Dave Reid - http://www.davereid.net
  61. Greg Knaddison - http://www.knaddison.com
  62. Mike Ryan - http://mikeryan.name
  63. Frederik 'Freso' S. Olesen - http://freso.dk