• View
• Edit
• History
• Attach
• Print
• Backlinks

ISO8859MakePageNamePatterns

(redirected from Cookbook.ISO8859PageNameConversionPatterns)

Questions answered by this recipe

How can I strip accents from characters for easier readable page names?
How can I convert existing page names to names without accents etc?

Description

To convert ISO 8859 character input to unaccented equivalents

Add the following to config.php for automatic creation of page names which have accents stripped from their characters. This adds a conversion mapping array to PmWiki's $MakePageNamePatterns.

Links like [[Español]], [[Français]], [[Überänderung]] will point to pages Espanol, Francais, Ueberaenderung instead of the valid url-encoded page names Espa%f1ol, Fran%e7ais, %dcber%e4nderung (using the ISO 8859-1 character set).

To convert existing pagenames you can use the script isorename.phpΔ. Read below!

For ISO 8859-1 (Latin-1 Western European)

NOTE: This cookbook is dependent on the encoding type of config.php. You need to make sure that config.php is saved with ISO8859-1 encoding. By default PmWiki ships with the encoding type set to Latin-1. For more information refer to page encoding.

# standard patterns from pmwiki.php
SDV($PageNameChars, '-[:alnum:]');
SDV($MakePageNamePatterns, array(
    "/'/" => '',			   # strip single-quotes
    "/[^$PageNameChars]+/" => ' ',         # convert everything else to space
    '/((^|[^-\\w])\\w)/' => PCCF("return strtoupper(\$m[1]);"),
    '/ /' => ''));
# additonal character conversion patterns for ISO 8859-1 character set
SDV($ISO88591MakePageNamePatterns, array(
	'/Á/' => 'A',	'/Â/' => 'A',	'/Ã/' => 'A',	'/Ä/' => 'Ae',	'/Å/' => 'Ao',	'/Æ/' => 'Ae',	'/Ç/' => 'C',
	'/È/' => 'E',	'/É/' => 'E',	'/Ê/' => 'E',	'/Ë/' => 'E',	'/Ì/' => 'I',	'/Í/' => 'I',	'/Î/' => 'I',	'/Ï/' => 'I',
	'/Ð/' => 'D',	'/Ñ/' => 'N',	'/Ú/' => 'U',	'/Ó/' => 'O',	'/Ô/' => 'O',	'/Õ/' => 'O',	'/Ö/' => 'Oe',	'/Ø/' => 'Oe',
	'/Ù/' => 'U',	'/Ú/' => 'U',	'/Û/' => 'U',	'/Ü/' => 'Ue',	'/Ý/' => 'Y',	'/Þ/' => 'Th',	'/ß/' => 'ss',
	'/à/' => 'a',	'/á/' => 'a',	'/â/' => 'a',	'/ã/' => 'a',	'/ä/' => 'ae',	'/å/' => 'ao',	'/æ/' => 'ae',	'/ç/' => 'c',
	'/è/' => 'e',	'/é/' => 'e',	'/ê/' => 'e',	'/ë/' => 'e',	'/ì/' => 'i',	'/í/' => 'i',	'/î/' => 'i',	'/ï/' => 'i',
	'/ð/' => 'd',	'/ñ/' => 'n',	'/ò/' => 'o',	'/ó/' => 'o',	'/ô/' => 'o',	'/õ/' => 'o',	'/ö/' => 'oe',	'/ø/' => 'oe',
	'/ù/' => 'u',	'/ú/' => 'u',	'/û/' => 'u',	'/ü/' => 'ue',	'/ý/' => 'y',	'/þ/' => 'th',	'/ÿ/' => 'y'
));
# join to standard patterns
$MakePageNamePatterns = array_merge($ISO88591MakePageNamePatterns, $MakePageNamePatterns);

For other ISO 8859 standards

Please add a suitable character conversion array

Converting existing pagenames to unaccented equivalents

You can use the script isorename.phpΔ. Install it as normally, than run it after you installed the character conversion patterns above, with the action: ?action=isorename added to a page url. This will look through all the files in all groups and rename automatically any page names which have accented etc characters, i.e. the new MakePageName patterns will be applied.

Admin permission is necessary to run this action.

You can do a test run without renaming anything with parameter test=1 (?action=isorename&test=1.
You can make a backup copy of original files with parameter backup=1.
You can use pagename wildcard patterns with parameter pattern=..., for instance to rename files in group Main: action=isorename&pattern=Main.*.

Preserving Original Characters in the Title

To preserve the original accented page name as a page title you may want to add it to the page with the (:title :) markup. This could be automated somewhat for new page creation by setting up a template page and setting the variable $EditTemplatesFmt in config.php (see EditTemplates), or using recipes like NewPageBox, NewPageBoxPlus or Fox or other form-processing scripts.

Avoiding CamelCase

by Roman, 2007-11-20

If you want to avoid CamelCase and convert spaces to hyphens (which is more SEO friendly), you can modify the recipe this way.

SDV($MakePageNamePatterns, array(
    "/'/" => '',
    "/[^$PageNameChars]+/" => '-',
    '/((^|[^-\\w])\\w)/e' => "strtoupper('$1')"
));

This will break the links in your local documentation (group PmWiki/). It may also cause important pages in Site/ and SiteAdmin/ groups to become unreachable and non-functional.

You could try this instead:

 $group = PageVar($pagename,'$Group');
 # callback helper
 function cb_strtoupper($m) { return strtoupper($m[1]); }
 $PageNameChars ='-[:alnum:]';
 if ($group=='PmWiki' || $group=='Site' || $group=='SiteAdmin') {
   $MakePageNamePatterns = array(
     "/'/" => '',			   //strip single-quotes
     "/[^$PageNameChars]+/" => ' ',         // convert everything else to space
     '/((^|[^-\\w])\\w)/' => "cb_strtoupper",  //make first letters upper case
     '/ /' => '', //remove any other spaces
   );
 } else {
   $MakePageNamePatterns = array(
      "/'/" => '',
      "/[^$PageNameChars]+/" => '-',
      '/((^|[^-\\w])\\w)/' => "cb_strtoupper",
   );
   $AsSpacedFunction = 'HyphenToSpace';
      function HyphenToSpace($x) { return ucfirst(str_replace('-',' ',$x)); }
 }

This excludes groups PmWiki, Site and SiteAdmin from hyphenated names. It also avoids regex with /e parameter, which is deprecated. It uses custom callback helper function "cb_strtoupper" instead. It also converts hyphens in link text to space, so your hyphenated page names will be displayed with spaces instead. But care needs to be taken to write correct links from some page to pages in group PmWiki etc, you should use the CamelCase words for those in your simple links. -- HansB June 20, 2017, at 06:07 AM

See also Router Router allows a website's url structure to be different from PmWiki's group/page structure..

Page Encoding

In order catch and convert characters to another encoding type, config.php must be saved using that encoding type, or PmWiki will be unable to find the characters to convert. See Character encoding of config.php.

Release Notes

If the recipe has multiple releases, then release notes can be placed here. Note that it's often easier for people to work with "release dates" instead of "version numbers".

See Also

Contributors

Comments

See discussion at ISO8859MakePageNamePatterns-Talk?