[Sommaire] [Imprimer]

   1  *Title: Alphabetical navigation.
   2  
   3  *Documentation:
   4  
   5  Objects can be filtered by first letter.
   6  If content.ini[AlphabeticalFilterSettings].ContentFilterList[] is not empty
   7  alphabetical navigator will be enabled.
   8  Alphabetical navigation is used with google navigation in the children window of content/view,
   9  in content/browse and trash.
  10  
  11  The navigator uses any alphabets (see content.ini[AlphabeticalFilterSettings].AlphabetList[]).
  12  
  13  (Make sure that your alphabets in content.ini[AlphabeticalFilterSettings].ContentFilterList[]
  14  is supported by i18n.ini[CharsetSettings].Charset. All unsupported letters will be shown like question mark '?')
  15  
  16  * New settings:
  17  
  18  New INI settings in content.ini[AlphabeticalFilterSettings] have been added:
  19  
  20  - ContentFilterList[]
  21    List of alphabets that will be used in alphabetical navigation.
  22    Alphabets will be fetched from AlphabetList[<name of alphabet>]
  23    For example:
  24        ContentFilterList[]=<name of alphabet>
  25        ContentFilterList[]=eng-GB
  26        ContentFilterList[]=ger-DE
  27    If array is empty means the alphabetical navigation will be disabled.
  28  
  29  - AlphabetList[]
  30    Alphabet range in unicode (range of english alphabet is between 97 and 122).
  31    You can use range (e.g. 97-122) and/or sequence of letters (e.g. 248,249).
  32    For example:
  33        AlphabetList[eng-GB]=97-122
  34        AlphabetList[ger-DE]=97,228,98-111,246,112-115,223,116,117,252,118-122
  35        AlphabetList[rus-RU]=1072-1103
  36        AlphabetList[nor-NO]=97-122,230,248,229
  37  
  38  - EnableUnusedLetters=true/false
  39    If true unused letters in alphabetical navigation (when browsing or fetching subitems)
  40    will be disabled.
  41    For example:
  42        if there are no objects with 'a' first letter in the object name 'a' letter will be disabled in alphabetical navigation.
  43  
  44  *Implementation details:
  45  
  46  1) Added supporting of 'ObjectNameFilter' parameter to
  47  eZContentObjectTreeNode:subTree() and eZContentObjectTreeNode:subTreeCount()
  48  
  49  2) Added 'objectname_filter' parameter to next fetch functions:
  50  
  51  - list
  52  - list_count
  53  - tree
  54  - tree_count
  55  - trash_count
  56  - trash_object_list
  57  
  58  Usage:
  59        {let children_count=fetch( content, list_count, hash( parent_node_id, $node.node_id,
  60                                                              objectname_filter, $view_parameters.namefilter ) )
  61             children=fetch( content, list, hash( parent_node_id, $node.node_id,
  62                                                  sort_by, $node.sort_array,
  63                                                  limit, $number_of_items,
  64                                                  offset, $view_parameters.offset,
  65                                                  objectname_filter, $view_parameters.namefilter ) ) }
  66  
  67  Now you can use object name filtering by first letter like this:
  68  
  69        http://host/<site_access>/content/view/full/2/(namefilter)/a
  70  
  71  3) Also alphabet() tpl function has been added.
  72  Returns alphabets for alphabetical navigation.
  73  The function has no params.
  74  
  75  Usage:
  76        {alphabet()}
  77  
  78  =============
  79  
  80  If you want to use alphabetical navigator
  81  you should
  82  1. Add "hash( ... objectname_filter, $view_parameters.namefilter )" to fetch operations in tpls.
  83     (see 'Implementation details'[2])
  84  2. Change
  85        uri='design:navigator/google.tpl'
  86     to
  87        uri='design:navigator/alphabetical.tpl'
  88     in 'include' operation.
  89  
  90     For example:
  91       {include name=navigator
  92                uri='design:navigator/alphabetical.tpl'
  93                page_uri=$node.url_alias
  94                item_count=$children_count
  95                view_parameters=$view_parameters
  96                node_id=$node.node_id
  97                item_limit=$number_of_items}