www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/pathauto/README.md

   1 #Pathauto
   2
   3 If you are developing for this module, have a look at pathauto.api.php.
   4
   5 ##Description
   6
   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 entity types: content, taxonomy terms,
  12 and users (including blogs and forum pages).
  13
  14 Pathauto also provides a way to delete large numbers of aliases.  This feature
  15 is available at  Administer > Configuration > Search and metadata > URL aliases >
  16 Delete aliases.
  17
  18 ##Benefits
  19
  20 Besides making the page address more reflective of its content than
  21 "node/138", it's important to know that modern search engines give
  22 heavy weight to search terms which appear in a page's URL. By
  23 automatically using keywords based directly on the page content in the URL,
  24 relevant search engine hits for your page can be significantly
  25 enhanced.
  26
  27 ##Notices
  28
  29 Pathauto just adds URL aliases to content, users, and taxonomy terms.
  30 Because 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, content or menu which point to standard Drupal URLs it will bypass
  34 the 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 content 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 Drupal's URL and
  49 Link APIs will be replaced with their aliases during page output. If
  50 a module or your template contains hardcoded links, such as
  51 'href="node/$node->nid"', those won't get replaced with their corresponding
  52 aliases.
  53
  54 ## Disabling Pathauto for a specific content type (or taxonomy)
  55
  56 When the pattern for a content type is left blank, the default pattern will be
  57 used. But if the default pattern is also blank, Pathauto will be disabled
  58 for that content type.
  59
  60 ## Installing Pathauto
  61 1. Install the module as normal, note that there are two dependencies.
  62 2. Configure the module at admin/config/search/path/patterns - add a new pattern by creating by clicking "Add Pathauto pattern".
  63 3. Fill out "Path pattern" with fx [node:title], choose which content types this applies to, give it a label (the name) and save it.
  64 4. When you save new content from now on, it should automatically be assigned an alternative URL
  65
  66 ##Credits:
  67
  68 The original module combined the functionality of Mike Ryan's autopath with
  69 Tommy Sundstrom's path_automatic.
  70
  71 Significant enhancements were contributed by jdmquin @ www.bcdems.net.
  72
  73 Matt England added the tracker support (tracker support has been removed in
  74 recent changes).
  75
  76 Other suggestions and patches contributed by the Drupal community.
  77
  78 Current maintainers:
  79
  80 - Dave Reid - http://www.davereid.net
  81 - Greg Knaddison - http://www.knaddison.com
  82 - Mike Ryan - http://mikeryan.name
  83 - Frederik 'Freso' S. Olesen - http://freso.dk