Changeset 5259


Ignore:
Timestamp:
10/12/09 03:21:16 (3 years ago)
Author:
PaulHarvey
Message:

Item2237: Fixed DBRECURSE not honouring limit param properly; spelling
mistakes in System topic

Location:
trunk/DBCachePlugin
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/DBCachePlugin/data/System/DBCachePlugin.txt

    r4416 r5259  
    5959the lookup mechanism will try to find the methods =VideoRenderMethod=, =MediaTypeRenderMethod= 
    6060and =ClassifiedTopicRenderMethod= in the given order and use the one found first. The web 
    61 these types are defined in is infered on the base of the !DataForm definitions of each of  
     61these types are defined in is inferred on the base of the !DataForm definitions of each of  
    6262these types. If none of these type-specific methods is found the method call will fallback 
    6363to a normal non-specific function call. The !TopicMethod itself is called with an implicit 
     
    6868 
    6969*DBRECURSE* iterates over topics in a web following a certain topic-to-topic relation, like 
    70 the partent-child relation among topics. You can define arbitrary relations using filters. 
     70the parent-child relation among topics. You can define arbitrary relations using filters. 
    7171 
    7272 
     
    8787| =maxsize="..."= | specify biggest attachment | 
    8888| =mindate="..."= | specify earliest attachment | 
    89 | =minsize="..."= | specify smalles attachment | 
     89| =minsize="..."= | specify smallest attachment | 
    9090| =names="..."= | match the name of attachments to be include in the list | 
    9191| =user="..."= | match the attachments' user who uploaded it | 
     
    9595| =separator="..."= | format string put between each formatted attachment  | 
    9696| =hidenull="on,off"= | hide/display the empty result; only the header and the footer are included \ 
    97                 of set to "off" and there's no attachment at the given topic | 
    98 | =sort="name,date,size,user,comment,commet:name"= | sortion of result | 
     97                if set to "off" and there's no attachment at the given topic | 
     98| =sort="name,date,size,user,comment,comment:name"= | sort results by specified field | 
    9999| =reverse="on/off"= | enable reverse sorting | 
    100100| =limit="..."= | limit the number of attachments to the given number; by default show all | 
     
    150150| =section="..."= | optional named section; without this parameter the "default" section is used | 
    151151| =<key>="<value>"= | topic arguments to be substituted within the included text; that is \ 
    152             every occurence of <key> is substituted with <value> | 
     152            every occurrence of <key> is substituted with <value> | 
    153153| =warn="on,off"= | enable/suppress error warnings | 
    154154| =remote="on,off"= | switch fixing !WikiWords in transcluded content; \ 
    155155                     =on= means "don't touch, this is remote content" \ 
    156                      defaults to "off" because that's the default behavior of \ 
     156                     defaults to "off" because that's the default behaviour of \ 
    157157                     =%<nop>INCLUDE{}%= (note, DBQUERY defaults to "on" \ 
    158158                     aka do-not-touch-mode) | 
    159159 
    160160---+++ DBDUMP 
    161 Display the database record of a topic (usefull for debugging). 
     161Display the database record of a topic (useful for debugging). 
    162162 
    163163*Syntax:* 
     
    226226will expand to the value of the formfield "Name" if it exists and is non-empty and to the value  
    227227of the formfield "Author" otherwise. More valid examples: 
    228    * =$expand(@Ref.Headline)=: headline of the refered topic 
     228   * =$expand(@Ref.Headline)=: headline of the referred topic 
    229229   * =$expand(Nr and '.')=: append a dot to the formfield value "Nr" if it exists 
    230230   * =$expand(Name or Author)=: expand to "Name" or "Author" 
     
    251251| =singlefooter="..."= | format string to be used when only one topic is found | 
    252252| =hidenull="..."= | flag to indicate that an empty hit set should not be displayed | 
    253 | =filter="..."= | search expression that is used in earch recursion step; \ 
     253| =filter="..."= | search expression that is used in each recursion step; \ 
    254254                   the current topic name is inserted into the filter expression by replacing the ='$ref'= string; \ 
    255255                   the default filter is ='parent='$name'=; this will search for topics of which the current topic \ 
    256256                   is a parent | 
    257 | =sort="..."= | determines the sortion of topics in each itteration step | 
     257| =sort="..."= | determines the sorting order of topics in each iteration step | 
    258258| =reverse="on,off"= | reverse sorting order | 
    259 | =limit="..."= | maximum itterations, default is =0= (unlimitted) | 
     259| =limit="..."= | maximum iterations, default is =0= (unlimited) | 
    260260| =skip="..."= | skips the first =n= hits when formatting the output, defaults to =0= (no skip) | 
    261 | =depth="..."= | only recurse to a given depth, defaults to =0= (unlimitted) | 
     261| =depth="..."= | only recurse to a given depth, defaults to =0= (unlimited) | 
    262262| =include="..."= | regular expression topics must match to be included in the search | 
    263263| =exclude="..."= | regular expression that excludes matching topics from the search | 
     
    307307| =sort="alpha,created"= | order of keys in the output | 
    308308| =reverse="on,off"= | sort keys descending or ascending | 
    309 | =limit="..."= | maximum number of keys to be formated in the output | 
     309| =limit="..."= | maximum number of keys to be formatted in the output | 
    310310| =hidenull="..."= | flag to indicate that an empty hit set should not be displayed | 
    311311 
     
    320320   * $key, $key1: the found key, this must match the first group in the pattern argument 
    321321   * $key2, $key3, $key4,$key5: second, third, etc grouping in the =pattern= argument 
    322    * $count: the number of occurences of the key 
     322   * $count: the number of occurrences of the key 
    323323   * $index: index of the key within the sorted result set 
    324324   * $min: minimum count found in the search 
    325325   * $max: maximum count found in the search 
    326    * $mean: mean occurence of a key in the result set 
     326   * $mean: mean occurrence of a key in the result set 
    327327   * $keys: total number of keys found 
    328328   * $web: the web we search in 
  • trunk/DBCachePlugin/lib/Foswiki/Plugins/DBCachePlugin/Core.pm

    r4358 r5259  
    10781078 
    10791079  return if $params->{depth} && $depth >= $params->{depth}; 
     1080  return if $params->{limit} && $params->{_count} >= $params->{limit}; 
    10801081 
    10811082  #writeDebug("called formatRecursive($theWeb, $theTopic)"); 
Note: See TracChangeset for help on using the changeset viewer.