function pathauto_help in Pathauto 5

Same name and namespace in other branches

1. 8 pathauto.module \pathauto_help()
2. 5.2 pathauto.module \pathauto_help()
3. 6.2 pathauto.module \pathauto_help()
4. 6 pathauto.module \pathauto_help()
5. 7 pathauto.module \pathauto_help()

File

./pathauto.module, line 14

Code

function pathauto_help($section) {
  $output = '';
  switch ($section) {
    case 'admin/help#pathauto':
      $output = t("<p>Provides a mechanism for modules to automatically generate aliases for the content they manage.</p>\n                  <h2>Settings</h2>\n                  <p>The <strong>Maximum Alias Length</strong> and <strong>Maximum component length</strong> values\n                  default to 100 and have a limit of 128 from pathauto.  This length is limited by the length of the dst \n                  column of the url_alias database table. The default database schema for this column is 128. If you \n                  set a length that is equal to that of the one set in the dst column it will cause problems in situations \n                  where the system needs to append additional words to the aliased URL. For example... URLs generated\n                  for feeds will have '/feed' added to the end. You should enter a value that is the length of the dst\n                  column minus the length of any strings that might get added to the end of the URL. The length of \n                  strings that might get added to the end of your URLs depends on which modules you have enabled and \n                  on your Pathauto settings. The recommended and default value is 100.</p>");
      break;
  }
  return $output;
}