Commit fc353712 authored by peschmae's avatar peschmae Committed by Sascha Grossenbacher
Browse files

Issue #2657376 by pguillard, peschmae: Document installation and usage

parent 1265795b

README.md

+6 −0
Changes for README.md: 6 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -57,6 +57,12 @@ 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.



## Installing Pathauto

1. Install the module as normal, note that there are two dependencies.

2. Configure the module at admin/config/search/path/patterns - add a new pattern by creating by clicking "Add Pathauto pattern".

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.

4. When you save new content from now on, it should automatically be assigned an alternative URL



##Credits:



The original module combined the functionality of Mike Ryan's autopath with

pathauto.module

+13 −0
Changes for pathauto.module: 13 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -49,6 +49,11 @@ function pathauto_help($route_name, RouteMatchInterface $route_match) { 
    case 'help.page.pathauto':

      $output = '<h3>' . t('About') . '</h3>';

      $output .= '<p>' . t('Provides a mechanism for modules to automatically generate aliases for the content they manage.') . '</p>';

      $output .= '<h3>' . t('Configuration') . '</h3>';

      $output .= '<ol>';

      $output .= '<li>' . t('Configure the module at admin/config/search/path/patterns.') . '</li>';

      $output .= '<li>' . t('When you save new content from now on, it should automatically be assigned an alternative URL.') . '</li>';

      $output .= '</ol>';

      $output .= '<h3>' . t('Settings') . '</h3>';

      $output .= '<dl>';

      $output .= '<dt>' . t('Maximum alias and component length') . '</dt>';
@@ -56,6 +61,14 @@ function pathauto_help($route_name, RouteMatchInterface $route_match) { 
      $output .= '</dl>';

      return $output;



    case 'entity.pathauto_pattern.collection':

      $output = '<p>' . t('This page provides a list of all patterns on the site and allows you to edit and reorder them.') . '</p>';

      return $output;



    case 'entity.pathauto_pattern.add_form':

      $output = '<p>' . t('You need to select a pattern type, then a pattern and filter, and a label.') . '</p>';

      return $output;



    case 'pathauto.bulk.update.form':

      $output = '<p>' . t('Bulk generation will only generate URL aliases for items that currently have no aliases. This is typically used when installing Pathauto on a site that has existing un-aliased content that needs to be aliased in bulk.') . '</p>';

      return $output;