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

CustomPagelistSortOrderFunctions

Description

Custom functions for creating custom page sort orders with pagelists.

Sorting pages by integer pagetextvar data:

Here is a custom PagelistSortOrder function for sorting pages by numerical PageTextVariable data.
The pagetextvariable $:Books is used as an example.

Add to local config (or recipe script):

# sorting pages by numerical integer pagetextvar data
function IntegerDataCompare($x, $y, $var) {
      # get integer value of the page text variable
      $xval = intval(PageTextVar($x, $var));
      $yval = intval(PageTextVar($y, $var));
      # compare integer values
      if($xval > $yval) $c = 1;
      elseif($xval < $yval) $c = -1;
      else $c = 0;
      return $c;
}

# defining order=books to sort integers numerical by pagetextvar $:Books
$PageListSortCmp['books'] = 'IntegerDataCompare($x, $y, "Books")';

Then use in your PageList directive with order=books (numerical sort smallest number first) or order=-books (largest number first)

For other integer page text variables just create another array item for $PageListSortCmp, as done above with "Books"

Sorting pages by integer numbers of pagename (Title)

Add to local config (or recipe script):

function IntegerNameCompare($x, $y) {
      # get integer value of the page name or title
      $xval = intval(PageVar($x, '$Title'));
      $yval = intval(PageVar($y, '$Title'));
      # compare integer values
      if($xval > $yval) $c = 1;
      elseif($xval < $yval) $c = -1;
      else $c = 0;
      return $c;
}
$PageListSortCmp['intname'] = 'IntegerNameCompare($x, $y)';

Then use in your PageList directive with order=intname (numerical sort smallest number first) or order=-intname (largest number first). To exclude other page names from the list and use only pagenames starting with a digit use in the pagelist directive: name=[0-9]*

Sorting pages using locale (sort 'é', 'è', 'ê', etc. with 'e' for example)

Add to local config (or recipe script):

$PageListSortCmp['namelocalesort'] = 'LocaleSort($x, $y)';
function LocaleSort($a, $b)
  {
  $x = array($a, $b);
  setlocale(LC_ALL, 'fr_FR');
  sort($x, SORT_LOCALE_STRING);
  return ($x[0]==$a)? -1:1;
}

Then use in your PageList directive with order=namelocalesort

(from Petko Yotov in pmwiki-users, 2009/05/23)

Sorting by title, disregarding leading A/An/The

Assumes pages named or titled as in "A Title" or "The Title" and you wish to disregard the leading A/An/The.

$FmtPV['$TitleNoArticle'] = 
   'preg_replace("/^ *(?:The|An?) /i", "", (@$page["title"] ? $page["title"] : $AsSpacedFunction($name)), 1)';

(:pagelist ... order=$TitleNoArticle ...:)

Sorting with last name first

Assumes pages named or titled as ZachAble, JohnSmith, AaronZimmerman and the desire is to have it sort in that order, by last name.
Note that McBain or other last names with an embedded capital will not work in this setup.

$FmtPV['$TitleLastFirst'] =
   'preg_replace("/^(.*?)([A-Z][a-z0-9_]*)$/", "\\\\2, \\\\1", (@$page["title"] ? $page["title"] : $AsSpacedFunction($name)))';

(:pagelist ... order=$TitleLastFirst ...:)

Notes

Wouldn't it be easier to just use strnatcasecmp()? http://us3.php.net/manual/en/function.strnatcasecmp.php

It can handle combinations of integers and text, so that Page11 < Page100, etc.

Ben Stallings March 15, 2007, at 01:08 PM

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

• PmWiki.CustomPagelistSortOrder
• Cookbook.PagelistTemplateSamples
• http://pmichaud.com/pipermail/pmwiki-users/2009-October/055928.html A (rough) example of sorting by title without leading A/An/The
• http://pmichaud.com/pipermail/pmwiki-users/2009-October/055929.html A (rough) example of sorting by last capitlized word in title (AaronZimmerman comes after ZachAble)

Contributors

• HansB

Comments

See discussion at CustomPagelistSortOrderFunctions-Talk