Changeset 2742

Show
Ignore:
Timestamp:
07/09/08 20:16:36 (16 months ago)
Author:
bchoate
Message:

Updated POD for template tags; added test for template tag doc coverage.

Location:
branches/release-41
Files:
1 added
2 modified

Legend:

Unmodified
Added
Removed
  • branches/release-41/lib/MT/Template/Context/Search.pm

    r2420 r2742  
    3939########################################################################### 
    4040 
     41=head2 IfStraightSearch 
     42 
     43A conditional block which outputs its contents if the search in progress 
     44is a regular (or "straight") search. 
     45 
     46=for tags search 
     47 
     48=cut 
     49 
     50########################################################################### 
     51 
     52=head2 IfTagSearch 
     53 
     54A conditional block which outputs its contents if the search in progress 
     55is a search of entries by tag. 
     56 
     57=for tags search 
     58 
     59=cut 
     60 
     61########################################################################### 
     62 
     63=head2 NoSearch 
     64 
     65A container tag whose contents are displayed only if there is no search 
     66performed. 
     67 
     68This tag is only recognized in search templates. 
     69 
     70=for tags search 
     71 
     72=cut 
     73 
     74########################################################################### 
     75 
     76=head2 NoSearchResults 
     77 
     78A container tag whose contents are displayed if a search is performed 
     79but no results are found. 
     80 
     81This tag is only recognized in search templates. 
     82 
     83=for tags search 
     84 
     85=cut 
     86 
     87########################################################################### 
     88 
    4189=head2 SearchResultsHeader 
    4290 
     
    4896This tag is only recognized in SearchResults block. 
    4997 
     98B<Example:> 
     99 
     100    <mt:SearchResultsHeader> 
     101    <h3>Look what we found!</h3> 
     102    </mt:SearchResultsHeader> 
     103 
    50104=for tags search 
    51105 
     
    61115 
    62116This tag is only recognized in SearchResults block. 
     117 
     118B<Example:> 
     119 
     120    <mt:SearchResultsFooter> 
     121    <p>If you didn't find what you were looking for, you can also peruse 
     122    the <a href="<mt:Link identifier="archive_index">">site archives</a>.</p> 
     123    </mt:SearchResultsFooter> 
    63124 
    64125=for tags search 
     
    110171This tag is only recognized in search templates. 
    111172 
     173=for tags search 
     174 
    112175=cut 
    113176 
     
    124187=cut 
    125188 
     189########################################################################### 
     190 
     191=head2 SearchIncludeBlogs 
     192 
     193Used in the search result template to pass the IncludeBlogs parameters 
     194through from the search form keeping the context of any followup search 
     195the same as the initial search. 
     196 
     197B<Example:> 
     198 
     199    <input type="hidden" name="IncludeBlogs" value="<$mt:SearchIncludeBlogs$>" /> 
     200 
     201=cut 
     202 
    126203sub _hdlr_include_blogs { $_[0]->stash('include_blogs') || '' } 
     204 
     205########################################################################### 
     206 
     207=head2 SearchString 
     208 
     209An HTML-encoded search query. This tag is only recognized in search templates. 
     210 
     211B<Example:> 
     212 
     213    <$mt:SearchString$> 
     214 
     215=for tags search 
     216 
     217=cut 
     218 
    127219sub _hdlr_search_string { $_[0]->stash('search_string') || '' } 
     220 
     221########################################################################### 
     222 
     223=head2 SearchTemplateID 
     224 
     225Returns the identifier of the search template (ie, "feed" or 
     226"nomorepizzaplease"). 
     227 
     228B<Example:> 
     229 
     230    <$mt:SearchTemplateID$> 
     231 
     232=for tags search 
     233 
     234=cut 
     235 
    128236sub _hdlr_template_id { $_[0]->stash('template_id') || '' } 
    129237sub _hdlr_max_results { $_[0]->stash('maxresults') || '' } 
     238 
     239########################################################################### 
     240 
     241=head2 SearchResultCount 
     242 
     243The number of results found across all of the blogs searched. This tag 
     244is only recognized in search templates. 
     245 
     246B<Example:> 
     247 
     248    <$mt:SearchResultCount$> 
     249 
     250=for tags search, count 
     251 
     252=cut 
    130253 
    131254sub _hdlr_result_count { 
     
    133256    $results ? $results : 0; 
    134257} 
     258 
     259########################################################################### 
     260 
     261=head2 SearchResults 
     262 
     263A container tag that creates a list of search results. This tag 
     264creates an entry and blog context that all Entry* and Blog* tags 
     265can be used. 
     266 
     267This tag is only recognized in search templates. 
     268 
     269=for tags search 
     270 
     271=cut 
    135272 
    136273sub _hdlr_results { 
  • branches/release-41/lib/MT/Template/ContextHandlers.pm

    r2728 r2742  
    10751075########################################################################### 
    10761076 
     1077=head2 string_format 
     1078 
     1079An alias for the 'sprintf' modifier. 
     1080 
     1081=cut 
     1082 
     1083########################################################################### 
     1084 
    10771085=head2 sprintf 
    10781086 
     
    12281236=over 4 
    12291237 
    1230 =item html 
     1238=item * html 
    12311239 
    12321240Similar to the 'encode_html' modifier. Escapes special characters as 
    12331241HTML entities. 
    12341242 
    1235 =item url 
     1243=item * url 
    12361244 
    12371245Similar to the 'encode_url' modifier. Escapes special characters using 
    12381246a URL-encoded format (ie, " " becomes "%20"). 
    12391247 
    1240 =item javascript or js 
     1248=item * javascript or js 
    12411249 
    12421250Similar to the 'encode_js' modifier. Escapes special characters such 
     
    12441252in a JavaScript string. 
    12451253 
    1246 =item mail 
     1254=item * mail 
    12471255 
    12481256A very simple email obfuscation technique. 
     
    14551463########################################################################### 
    14561464 
     1465=head2 TemplateNote 
     1466 
     1467A function tag that always returns an empty string. This tag is useful 
     1468for placing simple notes in your templates, since it produces nothing. 
     1469 
     1470B<Example:> 
     1471 
     1472    <$mt:TemplateNote note="Hi, mom!"$> 
     1473 
     1474=for tags templating 
     1475 
     1476=cut 
     1477 
     1478########################################################################### 
     1479 
     1480=head2 Ignore 
     1481 
     1482A block tag that always produces an empty string. This tag is useful 
     1483for wrapping template code you wish to disable, or perhaps annotating 
     1484sections of your template. 
     1485 
     1486B<Example:> 
     1487 
     1488    <mt:Ignore> 
     1489        The API key for the following tag is D3ADB33F. 
     1490    </mt:Ignore> 
     1491 
     1492=for tags templating 
     1493 
     1494=cut 
     1495 
     1496########################################################################### 
     1497 
     1498=head2 IfStatic 
     1499 
     1500Returns true if the current publishing context is static publishing, 
     1501and false otherwise. 
     1502 
     1503=for tags templating, utility 
     1504 
     1505=cut 
     1506 
     1507########################################################################### 
     1508 
     1509=head2 IfDynamic 
     1510 
     1511Returns true if the current publishing context is dynamic publishing, 
     1512and false otherwise. 
     1513 
     1514=for tags templating, utility 
     1515 
     1516=cut 
     1517 
     1518########################################################################### 
     1519 
    14571520=head2 App:Listing 
    14581521 
     
    15261589=over 4 
    15271590 
    1528 =item type (optional) 
     1591=item * type (optional) 
    15291592 
    15301593The C<MT::Object> object type the listing is processing. If unset, 
    15311594will use the contents of the C<object_type> variable. 
    15321595 
    1533 =item loop (optional) 
     1596=item * loop (optional) 
    15341597 
    15351598The source of data to process. This is an array of hashes, similar 
     
    15371600variable is used instead. 
    15381601 
    1539 =item empty_message (optional) 
     1602=item * empty_message (optional) 
    15401603 
    15411604Used when there are no rows to output for the listing. If not set, 
     
    15441607found. 
    15451608 
    1546 =item id (optional) 
     1609=item * id (optional) 
    15471610 
    15481611Used to construct the DOM id for the listing. The outer C<div> tag 
     
    15511614attribute). 
    15521615 
    1553 =item listing_class (optional) 
     1616=item * listing_class (optional) 
    15541617 
    15551618Provides a custom class name that can be applied to the main 
     
    15571620that is always applied). 
    15581621 
    1559 =item action (optional; default 'script_url' variable) 
     1622=item * action (optional; default 'script_url' variable) 
    15601623 
    15611624Supplies the 'action' attribute of the C<form> tag produced. 
    15621625 
    1563 =item hide_pager (optional; default '0') 
     1626=item * hide_pager (optional; default '0') 
    15641627 
    15651628Controls whether the pagination controls are shown or not. 
    15661629If unspecified, pagination is shown. 
    15671630 
    1568 =item show_actions (optional; default '1') 
     1631=item * show_actions (optional; default '1') 
    15691632 
    15701633Controls whether the actions associated with the object type 
     
    16771740=over 4 
    16781741 
    1679 =item mode 
     1742=item * mode 
    16801743 
    16811744Maps to a '__mode' argument. 
    16821745 
    1683 =item type 
     1746=item * type 
    16841747 
    16851748Maps to a '_type' argument. 
     
    17411804=over 4 
    17421805 
    1743 =item bar_position (optional; default "top") 
     1806=item * bar_position (optional; default "top") 
    17441807 
    17451808Assigns a CSS class name indicating whether the control is above or 
    17461809below the listing or edit form it is associated with. 
    17471810 
    1748 =item hide_pager 
     1811=item * hide_pager 
    17491812 
    17501813Assign either 1 or 0 to control whether the pagination controls are 
    17511814displayed or not. 
    17521815 
    1753 =item form_id 
     1816=item * form_id 
    17541817 
    17551818Associates the pagition controls and item action widget with the 
     
    17931856=over 4 
    17941857 
    1795 =item id (optional) 
     1858=item * id (optional) 
    17961859 
    17971860If specified, will be used as the 'id' attribute for the outermost C<div> 
     
    17991862variable instead. 
    18001863 
    1801 =item label (required) 
     1864=item * label (required) 
    18021865 
    18031866The label to display above the widget. 
    18041867 
    1805 =item label_link (optional) 
     1868=item * label_link (optional) 
    18061869 
    18071870If specified, this link will wrap the label for the widget. 
    18081871 
    1809 =item label_onclick 
     1872=item * label_onclick 
    18101873 
    18111874If specified, this JavaScript code will be assigned to the 'onclick' 
    18121875attribute of a link tag wrapping the widget label. 
    18131876 
    1814 =item class (optional) 
     1877=item * class (optional) 
    18151878 
    18161879If unspecified, will use the id of the widget. This class is included in the 
    18171880'class' attribute of the outermost C<div> tag for the widget. 
    18181881 
    1819 =item header_action 
    1820  
    1821 =item can_close (optional; default "0") 
     1882=item * header_action 
     1883 
     1884=item * can_close (optional; default "0") 
    18221885 
    18231886Identifies whether widget may be closed or not. 
    18241887 
    1825 =item tabbed (optional; default "0") 
     1888=item * tabbed (optional; default "0") 
    18261889 
    18271890If specified, the widget will be assigned an attribute that gives it 
     
    19321995=over 4 
    19331996 
    1934 =item id (optional) 
    1935  
    1936 =item class (optional; default "info") 
    1937  
    1938 =item rebuild (optional) 
     1997=item * id (optional) 
     1998 
     1999=item * class (optional; default "info") 
     2000 
     2001=item * rebuild (optional) 
    19392002 
    19402003Accepted values: "all", "index". 
    19412004 
    1942 =item can_close (optional; default "1") 
     2005=item * can_close (optional; default "1") 
    19432006 
    19442007=back 
     
    20632126=over 4 
    20642127 
    2065 =item action (optional) 
     2128=item * action (optional) 
    20662129 
    20672130Identifies the URL to submit the form to. If not given, will use 
    20682131the current application URI. 
    20692132 
    2070 =item method (optional; default "POST") 
     2133=item * method (optional; default "POST") 
    20712134 
    20722135Supplies the C<form> method. "GET" or "POST" are the typical values 
    20732136for this, but will accept any HTTP-compatible method (ie: "PUT", "DELETE"). 
    20742137 
    2075 =item object_id (optional) 
     2138=item * object_id (optional) 
    20762139 
    20772140Populates a hidden 'id' field in the form. If not given, will also use any 
    20782141'id' template variable defined. 
    20792142 
    2080 =item blog_id (optional) 
     2143=item * blog_id (optional) 
    20812144 
    20822145Populates a hidden 'blog_id' field in the form. If not given, will also use 
    20832146any 'blog_id' template variable defined. 
    20842147 
    2085 =item object_type (optional) 
     2148=item * object_type (optional) 
    20862149 
    20872150Populates a hidden '_type' field in the form. If not given, will also use 
    20882151any 'type' template variable defined. 
    20892152 
    2090 =item id (optional) 
     2153=item * id (optional) 
    20912154 
    20922155Used to form the 'id' element of the HTML C<form> tag. If not specified, 
     
    20942157determined object_type. 
    20952158 
    2096 =item name (optional) 
     2159=item * name (optional) 
    20972160 
    20982161Supplies the C<form> name attribute. If unspecified, will use the C<id> 
    20992162attribute, if available. 
    21002163 
    2101 =item enctype (optional) 
     2164=item * enctype (optional) 
    21022165 
    21032166If assigned, sets an 'enctype' attribute on the C<form> tag using the value 
     
    21752238=over 4 
    21762239 
    2177 =item id (required) 
     2240=item * id (required) 
    21782241 
    21792242A unique identifier for this group of settings. 
    21802243 
    2181 =item class (optional) 
     2244=item * class (optional) 
    21822245 
    21832246If specified, applies this CSS class to the C<fieldset> tag produced. 
    21842247 
    2185 =item shown (optional; default "1") 
     2248=item * shown (optional; default "1") 
    21862249 
    21872250Controls whether the C<fieldset> is initially shown or not. If hidden, 
     
    22302293=over 4 
    22312294 
    2232 =item id (required) 
     2295=item * id (required) 
    22332296 
    22342297Each application setting tag requires a unique 'id' attribute. This id 
    22352298should not be re-used within the template. 
    22362299 
    2237 =item required (optional; default "0") 
     2300=item * required (optional; default "0") 
    22382301 
    22392302Controls whether the field is displayed with visual cues that the 
    22402303field is a required field or not. 
    22412304 
    2242 =item label 
     2305=item * label 
    22432306 
    22442307Supplies the label phrase for the setting. 
    22452308 
    2246 =item show_label (optional; default "1") 
     2309=item * show_label (optional; default "1") 
    22472310 
    22482311Controls whether the label portion of the setting is shown or not. 
    22492312 
    2250 =item shown (optional; default "1") 
     2313=item * shown (optional; default "1") 
    22512314 
    22522315Controls whether the setting is visible or not. If specified, adds 
     
    22542317setting. 
    22552318 
    2256 =item label_class (optional) 
     2319=item * label_class (optional) 
    22572320 
    22582321Allows an additional CSS class to be applied to the label of the 
    22592322setting. 
    22602323 
    2261 =item content_class (optional) 
     2324=item * content_class (optional) 
    22622325 
    22632326Allows an addtional CSS class to be applied to the contents of the 
    22642327setting. 
    22652328 
    2266 =item hint (optional) 
     2329=item * hint (optional) 
    22672330 
    22682331Supplies a "hint" phrase that provides inline instruction to the user. 
     
    22702333forces it to display. 
    22712334 
    2272 =item show_hint (optional; default "0") 
     2335=item * show_hint (optional; default "0") 
    22732336 
    22742337Controls whether the inline help 'hint' label is shown or not. 
    22752338 
    2276 =item warning 
     2339=item * warning 
    22772340 
    22782341Supplies a warning message to the user regarding the use of this setting. 
    22792342 
    2280 =item show_warning 
     2343=item * show_warning 
    22812344 
    22822345Controls whether the warning message is shown or not. 
    22832346 
    2284 =item help_page 
     2347=item * help_page 
    22852348 
    22862349Identifies a specific page of the MT help documentation for this setting. 
    22872350 
    2288 =item help_section 
     2351=item * help_section 
    22892352 
    22902353Identifies a section name of the MT help documentation for this setting. 
     
    24082471=over 4 
    24092472 
    2410 =item var (optional) 
     2473=item * var (optional) 
    24112474 
    24122475If assigned, the current 'index' of the loop is assigned to this template 
    24132476variable. 
    24142477 
    2415 =item from (optional; default "0") 
    2416  
    2417 =item start 
     2478=item * from (optional; default "0") 
     2479 
     2480=item * start 
    24182481 
    24192482Identifies the starting number for the loop. 
    24202483 
    2421 =item to 
    2422  
    2423 =item end 
     2484=item * to 
     2485 
     2486=item * end 
    24242487 
    24252488Identifies the ending number for the loop. Either 'to' or 'end' must 
    24262489be specified. 
    24272490 
    2428 =item step (optional; default "1") 
    2429  
    2430 =item increment 
     2491=item * step (optional; default "1") 
     2492 
     2493=item * increment 
    24312494 
    24322495Provides the amount to increment the loop counter. 
    24332496 
    2434 =item glue (optional) 
     2497=item * glue (optional) 
    24352498 
    24362499If specified, this string is added inbetween each block of the loop. 
     
    24422505=over 4 
    24432506 
    2444 =item __first__ 
     2507=item * __first__ 
    24452508 
    24462509Assigned 1 when the loop is in the first iteration. 
    24472510 
    2448 =item __last__ 
     2511=item * __last__ 
    24492512 
    24502513Assigned 1 when the loop is in the last iteration. 
    24512514 
    2452 =item __odd__ 
     2515=item * __odd__ 
    24532516 
    24542517Assigned 1 when the loop index is odd, 0 when it is even. 
    24552518 
    2456 =item __even__ 
     2519=item * __even__ 
    24572520 
    24582521Assigned 1 when the loop index is even, 0 when it is odd. 
    24592522 
    2460 =item __index__ 
     2523=item * __index__ 
    24612524 
    24622525Holds the current loop index value, even if the 'var' attribute has 
    24632526been given. 
    24642527 
    2465 =item __counter__ 
     2528=item * __counter__ 
    24662529 
    24672530Tracks the number of times the loop has run (starts at 1). 
     
    25972660=over 4 
    25982661 
    2599 =item name 
    2600  
    2601 =item var 
     2662=item * name 
     2663 
     2664=item * var 
    26022665 
    26032666Declares a variable to test. When none of the comparison attributes are 
     
    26052668a "true" value, meaning if it is assigned a non-empty, non-zero value. 
    26062669 
    2607 =item tag 
     2670=item * tag 
    26082671 
    26092672Declares a MT tag to execute; the value of which is used for testing. 
     
    26132676If tag passes through the logical result of that conditional tag. 
    26142677 
    2615 =item op 
     2678=item * op 
    26162679 
    26172680If specified, applies the specified mathematical operator to the value 
     
    26212684=over 4 
    26222685 
    2623 =item + or add 
     2686=item * + or add 
    26242687 
    26252688Addition. 
    26262689 
    2627 =item - or sub 
     2690=item * - or sub 
    26282691 
    26292692Subtraction. 
    26302693 
    2631 =item ++ or inc 
     2694=item * ++ or inc 
    26322695 
    26332696Adds 1 to the given value. 
    26342697 
    2635 =item -- or dec 
     2698=item * -- or dec 
    26362699 
    26372700Subtracts 1 from the given value. 
    26382701 
    2639 =item * or mul 
     2702=item * * or mul 
    26402703 
    26412704Multiplication. 
    26422705 
    2643 =item / or div 
     2706=item * / or div 
    26442707 
    26452708Division. 
    26462709 
    2647 =item % or mod 
     2710=item * % or mod 
    26482711 
    26492712Issues a modulus operator. 
     
    26512714=back 
    26522715 
    2653 =item value 
     2716=item * value 
    26542717 
    26552718Used in conjunction with the 'op' attribute. 
    26562719 
    2657 =item eq 
     2720=item * eq 
    26582721 
    26592722Tests whether the given value is equal to the value of the 'eq' attribute. 
    26602723 
    2661 =item ne 
     2724=item * ne 
    26622725 
    26632726Tests whether the given value is not equal to the value of the 'ne' attribute. 
    26642727 
    2665 =item gt 
     2728=item * gt 
    26662729 
    26672730Tests whether the given value is greater than the value of the 'gt' attribute. 
    26682731 
    2669 =item lt 
     2732=item * lt 
    26702733 
    26712734Tests whether the given value is less than the value of the 'lt' attribute. 
    26722735 
    2673 =item ge 
     2736=item * ge 
    26742737 
    26752738Tests whether the given value is greater than or equal to the value of the 
    26762739'ge' attribute. 
    26772740 
    2678 =item le 
     2741=item * le 
    26792742 
    26802743Tests whether the given value is less than or equal to the value of the 
    26812744'le' attribute. 
    26822745 
    2683 =item like 
     2746=item * like 
    26842747 
    26852748Tests whether the given value matches the regex pattern in the 'like' 
    26862749attribute. 
    26872750 
    2688 =item test 
     2751=item * test 
    26892752 
    26902753Uses a Perl (or PHP under Dynamic Publishing) expression. For Perl, this 
     
    29693032########################################################################### 
    29703033 
     3034=head2 Unless 
     3035 
     3036A conditional tag that is the logical opposite of the L<If> tag. All 
     3037attributes supported by the L<If> tag are also supported for this tag. 
     3038 
     3039=for tags templating 
     3040 
     3041=cut 
     3042 
     3043########################################################################### 
     3044 
    29713045=head2 Loop 
    29723046 
     
    29813055=over 4 
    29823056 
    2983 =item name 
    2984  
    2985 =item var 
     3057=item * name 
     3058 
     3059=item * var 
    29863060 
    29873061The template variable that contains the array of hashref data to 
    29883062process. 
    29893063 
    2990 =item sort_by (optional) 
     3064=item * sort_by (optional) 
    29913065 
    29923066Causes the data in the given array to be resorted in the manner 
     
    30003074    sort_by="key reverse"; sort_by="value numeric" 
    30013075 
    3002 =item glue (optional) 
     3076=item * glue (optional) 
    30033077 
    30043078If specified, this string will be placed inbetween each "row" 
     
    30123086=over 4 
    30133087 
    3014 =item __first__ 
     3088=item * __first__ 
    30153089 
    30163090Assigned when the loop is in the first iteration. 
    30173091 
    3018 =item __last__ 
     3092=item * __last__ 
    30193093 
    30203094Assigned when the loop is in the last iteration. 
    30213095 
    3022 =item __odd__ 
     3096=item * __odd__ 
    30233097 
    30243098Assigned 1 when the loop is on odd numbered rows, 0 when even. 
    30253099 
    3026 =item __even__ 
     3100=item * __even__ 
    30273101 
    30283102Assigned 1 when the loop is on even numbered rows, 0 when odd. 
    30293103 
    3030 =item __key__ 
     3104=item * __key__ 
    30313105 
    30323106When looping over a hashref template variable, this variable is 
    30333107assigned the key currently in context. 
    30343108 
    3035 =item __value__ 
     3109=item * __value__ 
    30363110 
    30373111This variable holds the value of the array or hashref element 
     
    31383212An alias for the 'Var' tag, and considered deprecated in favor of 'Var'. 
    31393213 
     3214=for tags deprecated 
     3215 
    31403216=cut 
    31413217 
     
    31503226=over 4 
    31513227 
    3152 =item name (or var) 
     3228=item * name (or var) 
    31533229 
    31543230Identifies the template variable. The 'name' attribute supports a variety 
     
    31753251    <mt:Var name="count(foo)"> 
    31763252 
    3177 =item op 
     3253=item * op 
    31783254 
    31793255Along with the 'value' attribute, this allows the application of 
     
    31813257are supported). 
    31823258 
    3183 =item value 
     3259=item * value 
    31843260 
    31853261If provided with the 'op' attribute, provides the operand for the 
     
    31903266is useful for setting variables as well. 
    31913267 
    3192 =item function 
     3268=item * function 
    31933269 
    31943270For array template variables, this attribute supports: 
     
    31963272=over 4 
    31973273 
    3198 =item pop 
     3274=item * pop 
    31993275 
    32003276Takes an element from the end of the array (last element). 
    32013277 
    3202 =item shift 
     3278=item * shift 
    32033279 
    32043280Takes an element from the front of the array (index 0). 
    32053281 
    3206 =item count 
     3282=item * count 
    32073283 
    32083284Returns the number of elements in the array template variable. 
     
    32143290=over 4 
    32153291 
    3216 =item delete 
     3292=item * delete 
    32173293 
    32183294Only valid when used with the 'key' attribute, or if a key is present 
    32193295in the variable name. 
    32203296 
    3221 =item count 
     3297=item * count 
    32223298 
    32233299Returns the number of keys present in the hash template variable. 
     
    32253301=back 
    32263302 
    3227 =item index 
     3303=item * index 
    32283304 
    32293305Identifies an element of an array template variable. 
    32303306 
    3231 =item key 
     3307=item * key 
    32323308 
    32333309Identifies a key of a hash template variable. 
    32343310 
    3235 =item default 
     3311=item * default 
    32363312 
    32373313If the variable is undefined or empty, this value will be output instead. 
    32383314 
    3239 =item to_json 
     3315=item * to_json 
    32403316 
    32413317Formats the variable in JSON notation. 
    32423318 
    3243 =item glue 
     3319=item * glue 
    32443320 
    32453321For array template variables, this attribute is used in joining the 
     
    34373513=over 4 
    34383514 
    3439 =item tag or name 
     3515=item * tag or name 
    34403516 
    34413517If either 'name' or 'tag' are specified, tests the entry in context 
     
    35533629=over 4 
    35543630 
    3555 =item glue 
     3631=item * glue 
    35563632 
    35573633A text string that is used to join each of the items together. For example 
     
    35613637would print out each tag name separated by a comma and a space. 
    35623638 
    3563 =item type 
     3639=item * type 
    35643640 
    35653641The kind of object for which to show tags. By default the entry tags are shown. 
    35663642 
    3567 =item sort_by 
     3643=item * sort_by 
    35683644 
    35693645The tag object column on which to order the tags. Common values are name and 
    35703646rank. By default tags are sorted by name. 
    35713647 
    3572 =item sort_order 
     3648=item * sort_order 
    35733649 
    35743650The direction in which to sort tags by the sort_by field. Possible values 
     
    35763652when sorted by name and descending order when sorted by other columns. 
    35773653 
    3578 =item limit 
     3654=item * limit 
    35793655 
    35803656A number of tags to show. If given, only the first tags as ordered by 
    35813657sort_by and sort_order are shown. 
    35823658 
    3583 =item top 
     3659=item * top 
    35843660 
    35853661A number of tags to show. If given, only the given number of tags with 
     
    38173893=over 4 
    38183894 
    3819 =item max (optional; default "6") 
     3895=item * max (optional; default "6") 
    38203896 
    38213897Allows a user to specify the upper bound of the scale. 
     
    39314007 
    39324008To avoid printing out the leading text when no entry tags are assigned you 
    3933 can use the EntryIfTagged conditional block to first test for entry tags 
    3934 on the entry. You can also use the EntryIfTagged conditional block with 
     4009can use the L<EntryIfTagged> conditional block to first test for entry tags 
     4010on the entry. You can also use the L<EntryIfTagged> conditional block with 
    39354011the tag attribute to test for the assignment of a particular entry tag. 
    39364012 
     
    39394015=over 4 
    39404016 
    3941 =item glue 
     4017=item * glue 
    39424018 
    39434019A text string that is used to join each of the items together. For example: 
    39444020 
    3945     <mt:EntryTags glue=", "><$MTTagName$></mt:EntryTags> 
     4021    <mt:EntryTags glue=", "><$mt:TagName$></mt:EntryTags> 
    39464022 
    39474023would print out each tag name separated by a comma and a space. 
     
    39514027B<Example:> 
    39524028 
    3953 The following code can be used anywhere MTEntries can be used. It prints 
     4029The following code can be used anywhere L<Entries> can be used. It prints 
    39544030a list of all of the tags assigned to each entry returned by L<Entries> 
    39554031glued together by a comma and a space. 
     
    39954071########################################################################### 
    39964072 
     4073=head2 TagLabel 
     4074 
     4075An alias for the 'TagName' tag. 
     4076 
     4077=cut 
     4078 
     4079########################################################################### 
     4080 
    39974081=head2 TagName 
    39984082 
     
    40034087=over 4 
    40044088 
    4005 =item normalize (optional; default "0") 
     4089=item * normalize (optional; default "0") 
    40064090 
    40074091If specified, outputs the "normalized" form of the tag. A normalized 
     
    40114095=over 4 
    40124096 
    4013 =item quote (optional; default "0") 
     4097=item * quote (optional; default "0") 
    40144098 
    40154099If specified, causes any tag with spaces in it to be wrapped in quote 
     
    42294313=over 4 
    42304314 
    4231 =item type 
    4232  
    4233 =item archive_type 
     4315=item * type 
     4316 
     4317=item * archive_type 
    42344318 
    42354319The archive type to test for, case-insensitively. See L<ArchiveType> for 
     
    42764360=over 4 
    42774361 
    4278 =item type or archive_type 
     4362=item * type or archive_type 
    42794363 
    42804364Specifies the name of the archive type you wish to check to see if it is enabled. 
     
    43544438=over 4 
    43554439 
    4356 =item var (optional) 
     4440=item * var (optional) 
    43574441 
    43584442Supplies a variable name to use for assigning the contents of the 
     
    43874471=over 4 
    43884472 
    4389 =item module 
     4473=item * module 
    43904474 
    43914475The name of a template module in the current blog. 
    43924476 
    4393 =item widget 
     4477=item * widget 
    43944478 
    43954479The name of the widget in the current blog to include. 
    43964480 
    4397 =item file 
     4481=item * file 
    43984482 
    43994483The path to an external file on the system. The path can be absolute or 
     
    44024486includes like that found in PHP. 
    44034487 
    4404 =item identifier 
     4488=item * identifier 
    44054489 
    44064490For selecting Index templates by their unique identifier. 
     
    44114495filename to load. 
    44124496 
    4413 =item blog_id (optional) 
     4497=item * blog_id (optional) 
    44144498 
    44154499Used to include a template from another blog in the system. Use in 
    44164500conjunction with the module, widget or identifier attributes. 
    44174501 
    4418 =item global (optional; default "0") 
     4502=item * global (optional; default "0") 
    44194503 
    44204504Forces an Include of a globally defined template even if the 
     
    44224506(For module, widget and identifier includes.) 
    44234507 
    4424 =item ssi (optional; default "0") 
     4508=item * ssi (optional; default "0") 
    44254509 
    44264510If specified, causes the include to be handled as a server-side 
     
    44434527Suitable for module, widget or identifier includes. 
    44444528 
    4445 =item cache (optional; default "0") 
     4529=item * cache (optional; default "0") 
    44464530 
    44474531Enables caching of the contents of the include. Suitable for module, 
    44484532widget or identifier includes. 
    44494533 
    4450 =item key or cache_key (optional) 
     4534=item * key or cache_key (optional) 
    44514535 
    44524536Used to cache the template module. Used in conjunction with the 'cache' 
    44534537attribute. Suitable for module, widget or identifier includes. 
    44544538 
    4455 =item ttl (optional) 
     4539=item * ttl (optional) 
    44564540 
    44574541Specifies the lifetime in seconds of a cached template module. Suitable 
     
    47914875=over 4 
    47924876 
    4793 =item format 
     4877=item * format 
    47944878 
    47954879A required attribute that defines the template with a string of specifiers. 
     
    48014885=over 4 
    48024886 
    4803 =item %a 
     4887=item * %a 
    48044888 
    48054889The entry's author's display name passed through the dirify global filter. Example: melody_nelson 
    48064890 
    4807 =item %-a 
     4891=item * %-a 
    48084892 
    48094893The same as above except using dashes. Example: melody-nelson 
    48104894 
    4811 =item %b 
     4895=item * %b 
    48124896 
    48134897For individual archive mappings, this returns the basename of the entry. By 
     
    48164900entry screen. Example: my_summer_vacation 
    48174901 
    4818 =item %-b 
     4902=item * %-b 
    48194903 
    48204904Same as above but using dashes. Example: my-summer-vacation 
    48214905 
    4822 =item %c 
     4906=item * %c 
    48234907 
    48244908The entry's primary category/subcategory path, built using the category 
    48254909basename field. Example: arts_and_entertainment/tv_and_movies 
    48264910 
    4827 =item %-c 
     4911=item * %-c 
    48284912 
    48294913Same as above but using dashes. Example: arts-and-entertainment/tv-and-movies 
    48304914 
    4831 =item %C 
     4915=item * %C 
    48324916 
    48334917The entry's primary category label passed through the dirify global filter. Example: arts_and_entertainment 
    48344918 
    4835 =item %-C 
     4919=item * %-C 
    48364920 
    48374921Same as above but using dashes. Example: arts-and-entertainment 
    48384922 
    4839 =item %d 
     4923=item * %d 
    48404924 
    484149252-digit day of the month. Example: 09 
    48424926 
    4843 =item %D 
     4927=item * %D 
    48444928 
    484549293-letter language-dependent abbreviation of the week day. Example: Tue 
    48464930 
    4847 =item %e 
     4931=item * %e 
    48484932 
    48494933A numeric entry ID padded with leading zeroes to six digits. Example: 000040 
    48504934 
    4851 =item %E 
     4935=item * %E 
    48524936 
    48534937The entry's numeric ID. Example: 40 
    48544938 
    4855 =item %f 
     4939=item * %f 
    48564940 
    48574941Archive filename with the specified extension. This can be used instead of 
     
    48594943Example: entry_basename.html or index.html 
    48604944 
    4861 =item %F 
     4945=item * %F 
    48624946 
    48634947Same as above but without the file extension. Example: filename 
    48644948 
    4865 =item %h 
     4949=item * %h 
    48664950 
    486749512-digit hour on a 24-hour clock with a leading zero if applicable. 
    48684952Example: 09 for 9am, 16 for 4pm 
    48694953 
    4870 =item %H 
     4954=item * %H 
    48714955 
    487249562-digit hour on a 24-hour clock without a leading zero if applicable. 
    48734957Example: 9 for 9am, 16 for 4pm 
    48744958 
    4875 =item %i 
     4959=item * %i 
    48764960 
    48774961The setting of the IndexBasename configuration directive with the default 
    48784962file extension appended. Example: index.html 
    48794963 
    4880 =item %I 
     4964=item * %I 
    48814965 
    48824966Same as above but without the file extension. Example: index 
    48834967 
    4884 =item %j 
     4968=item * %j 
    48854969 
    488649703-digit day of year, zero-padded. Example: 040 
    48874971 
    4888 =item %m 
     4972=item * %m 
    48894973 
    489049742-digit month, zero-padded. Example: 07 
    48914975 
    4892 =item %M 
     4976=item * %M 
    48934977 
    489449783-letter language-dependent abbreviation of the month. Example: Sep 
    48954979 
    4896 =item %n 
     4980=item * %n 
    48974981 
    489849822-digit minute, zero-padded. Example: 04 
    48994983 
    4900 =item %s 
     4984=item * %s 
    49014985 
    490249862-digit second, zero-padded. Example: 01 
    49034987 
    4904 =item %x 
     4988=item * %x 
    49054989 
    49064990File extension with a leading dot (.). If a file extension has not 
    49074991been specified a blank string is returned. Example: .html 
    49084992 
    4909 =item %y 
     4993=item * %y 
    49104994 
    491149954-digit year. Example: 2005 
    49124996 
    4913 =item %Y 
     4997=item * %Y 
    49144998 
    491549992-digit year with zero-padding. Example: 05 
     
    50285112B<Attributes:> 
    50295113 
    5030 =item template 
     5114=item * template 
    50315115 
    50325116The name of the index template. 
    50335117 
    5034 =item identifier 
     5118=item * identifier 
    50355119 
    50365120A template identifier. 
    50375121 
    5038 =item entry_id 
     5122=item * entry_id 
    50395123 
    50405124The numeric system ID of the entry. 
    50415125 
    5042 =item with_index (optional; default "0") 
     5126=item * with_index (optional; default "0") 
    50435127 
    50445128If not set to 1, remove index filenames (by default, index.html) 
     
    51185202=over 4 
    51195203 
    5120 =item version (optional; default "0") 
     5204=item * version (optional; default "0") 
    51215205 
    51225206If specified, also outputs the version (same as L<Version>). 
     
    52145298=over 4 
    52155299 
    5216 =item tag 
     5300=item * tag 
    52175301 
    52185302A tag which is evaluated and tested for non-emptiness. 
    52195303 
    5220 =item name or var 
     5304=item * name or var 
    52215305 
    52225306A variable whose contents are tested for non-emptiness. 
     
    52645348=over 4 
    52655349 
    5266 =item tag 
     5350=item * tag 
    52675351 
    52685352A tag which is evaluated and tested for non-zeroness. 
    52695353 
    5270 =item name or var 
     5354=item * name or var 
    52715355 
    52725356A variable whose contents are tested for non-zeroness. 
     
    54255509=over 4 
    54265510 
    5427 =item var or name 
     5511=item * var or name 
    54285512 
    54295513Identifies the name of the template variable. See L<Var> for more 
    54305514information on the format of this attribute. 
    54315515 
    5432 =item value 
     5516=item * value 
    54335517 
    54345518The value to assign to the variable. 
    54355519 
    5436 =item op (optional) 
     5520=item * op (optional) 
    54375521 
    54385522See the L<Var> tag for more information about this attribute. 
    54395523 
    5440 =item prepend (optional) 
     5524=item * prepend (optional) 
    54415525 
    54425526If specified, places the contents at the front of any existing value 
    54435527for the template variable. 
    54445528 
    5445 =item append (optional) 
     5529=item * append (optional) 
    54465530 
    54475531If specified, places the contents at the end of any existing value 
     
    54505534=back 
    54515535 
    5452 =for tags templating 
     5536=for tags deprecated 
    54535537 
    54545538=cut 
     
    54665550=over 4 
    54675551 
    5468 =item var or name (required) 
     5552=item * var or name (required) 
    54695553 
    54705554Identifies the name of the template variable. See L<Var> for more 
    54715555information on the format of this attribute. 
    54725556 
    5473 =item op (optional) 
     5557=item * op (optional) 
    54745558 
    54755559See the L<Var> tag for more information about this attribute. 
    54765560 
    5477 =item prepend (optional) 
     5561=item * prepend (optional) 
    54785562 
    54795563If specified, places the contents at the front of any existing value 
    54805564for the template variable. 
    54815565 
    5482 =item append (optional) 
     5566=item * append (optional) 
    54835567 
    54845568If specified, places the contents at the end of any existing value 
     
    55045588=over 4 
    55055589 
    5506 =item var or name (required) 
     5590=item * var or name (required) 
    55075591 
    55085592Identifies the name of the template variable. See L<Var> for more 
     
    58965980} 
    58975981 
    5898 =for tags search 
     5982########################################################################### 
     5983 
     5984=head2 MaxResults 
     5985 
     5986Deprecated in favor of L<SearchMaxResults>. 
     5987 
     5988=for tags deprecated 
     5989 
     5990=cut 
    58995991 
    59005992########################################################################### 
     
    59035995 
    59045996Returns the value of the C<SearchMaxResults> or C<MaxResults> configuration 
    5905 setting.  Use C<SearchMaxResults> because MaxResults is considered deprecated. 
     5997setting. Use C<SearchMaxResults> because MaxResults is considered deprecated. 
    59065998 
    59075999=for tags search, configuration 
     
    60486140=over 4 
    60496141 
    6050 =item display_name 
     6142=item * display_name 
    60516143 
    60526144Specifies a particular author to select. 
    60536145 
    6054 =item lastn 
     6146=item * lastn 
    60556147 
    60566148Limits the selection of authors to the specified number. 
    60576149 
    6058 =item sort_by (optional) 
     6150=item * sort_by (optional) 
    60596151 
    60606152Supported values: display_name, name, created_on. 
    60616153 
    6062 =item sort_order (optional; default "ascend") 
     6154=item * sort_order (optional; default "ascend") 
    60636155 
    60646156Supported values: ascend, descend. 
    60656157 
    6066 =item roles 
     6158=item * roles 
    60676159 
    60686160A comma separated list of roles used to select users by. 
    60696161eg: "Author, Commenter". 
    60706162 
    6071 =item need_entry (optional; default "1") 
     6163=item * need_entry (optional; default "1") 
    60726164 
    60736165Identifies whether the author(s) must have published an entry 
    60746166to be included or not. 
    60756167 
    6076 =item status (optional; default "enabled") 
     6168=item * status (optional; default "enabled") 
    60776169 
    60786170Supported values: enabled, disabled. 
    60796171 
    6080 =item namespace 
     6172=item * namespace 
    60816173 
    60826174Used in conjunction with the "min*", "max*" attributes to 
    60836175select authors based on a particular scoring mechanism. 
    60846176 
    6085 =item min_score 
     6177=item * min_score 
    60866178 
    60876179If 'namespace' is also specified, filters the authors based on 
     
    60896181to consider the author for inclusion. 
    60906182 
    6091 =item max_score 
     6183=item * max_score 
    60926184 
    60936185If 'namespace' is also specified, filters the authors based on 
     
    60956187to consider the author for inclusion. 
    60966188 
    6097 =item min_rank 
     6189=item * min_rank 
    60986190 
    60996191If 'namespace' is also specified, filters the authors based on 
     
    61016193to consider the author for inclusion. 
    61026194 
    6103 =item max_rate 
     6195=item * max_rate 
    61046196 
    61056197If 'namespace' is also specified, filters the authors based on 
     
    61076199to consider the author for inclusion. 
    61086200 
    6109 =item min_count 
     6201=item * min_count 
    61106202 
    61116203If 'namespace' is also specified, filters the authors based on 
     
    61136205to consider the author for inclusion. 
    61146206 
    6115 =item max_count 
     6207=item * max_count 
    61166208 
    61176209If 'namespace' is also specified, filters the authors based on 
     
    65046596########################################################################### 
    65056597 
    6506 =head2 AuthorIconURL 
     6598=head2 AuthorAuthIconURL 
    65076599 
    65086600Returns URL to a small (16x16) image represents in what authentication 
     
    65166608=over 4 
    65176609 
    6518 =item size (optional; default "logo_small") 
     6610=item * size (optional; default "logo_small") 
    65196611 
    65206612Identifies the requested size of the logo. This is an identifier, 
     
    66766768=over 4 
    66776769 
    6678 =item blog_ids 
     6770=item * blog_ids 
    66796771 
    66806772This attribute allows you to limit the set of blogs iterated over by 
     
    67416833########################################################################### 
    67426834 
     6835=head2 IfBlog 
     6836 
     6837A conditional tag that produces its contents when there is a blog in 
     6838context. This tag is useful for situations where a blog may or may not 
     6839be in context, such as the search template, when a search is conducted 
     6840across all blogs. 
     6841 
     6842B<Example:> 
     6843 
     6844    <mt:IfBlog> 
     6845        <h1>Search results for <$mt:BlogName$>:</h1> 
     6846    <mt:Else> 
     6847        <h1>Search results from all blogs:</h1> 
     6848    </mt:IfBlog> 
     6849 
     6850=for tags blogs 
     6851 
     6852=cut 
     6853 
     6854########################################################################### 
     6855 
    67436856=head2 BlogID 
    67446857 
     
    68897002=over 4 
    68907003 
    6891 =item no_colon (optional; default "0") 
     7004=item * no_colon (optional; default "0") 
    68927005 
    68937006If specified, will produce the timezone without the ":" character 
     
    69257038=over 4 
    69267039 
    6927 =item locale (optional; default "0") 
     7040=item * locale (optional; default "0") 
    69287041 
    69297042If assigned, will format the language in the style "language_LOCALE" (ie: "en_US", "de_DE", etc). 
    69307043 
    6931 =item ietf (optional; default "0") 
     7044=item * ietf (optional; default "0") 
    69327045 
    69337046If assigned, will change any '_' in the language code to a '-', conforming 
     
    69657078=over 4 
    69667079 
    6967 =item exclude_port (optional; default "0") 
     7080=item * exclude_port (optional; default "0") 
    69687081 
    69697082Removes any specified port number if this attribute is set to true (1), 
     
    69717084www.somedomain.com:8080). 
    69727085 
    6973 =item signature (optional; default "0") 
     7086=item * signature (optional; default "0") 
    69747087 
    69757088If set to 1, then this template tag will instead return a unique signature 
     
    70147127=over 4 
    70157128 
    7016 =item exclude_port (optional; default "0") 
     7129=item * exclude_port (optional; default "0") 
    70177130 
    70187131If set, exclude the port number from the CGIHost. 
     
    70387151=head2 BlogCategoryCount 
    70397152 
    7040 =for tags multiblog, count, blogs 
     7153Returns the number of categories associated with a blog. This 
     7154template tag supports the multiblog template tags. 
     7155 
     7156This template tag also supports all of the same filtering mechanisms 
     7157defined by the mt:Categories tag allowing users to retrieve a count 
     7158of the number of comments on a blog that meet a certain criteria. 
     7159 
     7160B<Example:> 
     7161 
     7162    <$mt:BlogCategoryCount$> 
     7163 
     7164=for tags multiblog, count, blogs, categories 
    70417165 
    70427166=cut 
     
    71797303=over 4 
    71807304 
    7181 =item with_index (optional; default "0") 
     7305=item * with_index (optional; default "0") 
    71827306 
    71837307If specified, forces the trailing "index" filename to be left on any 
     
    73097433=over 4 
    73107434 
    7311 =item lastn (optional) 
     7435=item * lastn (optional) 
    73127436 
    73137437Allows you to limit the number of entries output. This attribute 
     
    73197443This would publish the 5 most recent entries, ordered by their titles. 
    73207444 
    7321 =item limit (optional) 
     7445=item * limit (optional) 
    73227446 
    73237447Similar to the C<lastn> attribute, but limits output based on whichever 
    73247448sort order is in use. 
    73257449 
    7326 =item sort_by (optional; default "authored_on") 
     7450=item * sort_by (optional; default "authored_on") 
    73277451 
    73287452Accepted values are: C<authored_on>, C<title>, C<ping_count>, 
     
    73357459field basename you wish to sort on). 
    73367460 
    7337 =item sort_order (optional) 
     7461=item * sort_order (optional) 
    73387462 
    73397463Accepted values are 'ascend' and 'descend'. The default is the order 
     
    73417465screen. 
    73427466 
    7343 =item field:I<basename> 
     7467=item * field:I<basename> 
    73447468 
    73457469Permits filtering entries based on a custom field defined (available 
     
    73547478(checkbox field) checked. 
    73557479 
    7356 =item namespace (optional) 
     7480=item * namespace (optional) 
    73577481 
    73587482The namespace attribute is used to specify which scoring namespace 
     
    73647488of recommend/favorite votes that have been made. 
    73657489 
    7366 =item class_type (optional; default 'entry') 
     7490=item * class_type (optional; default 'entry') 
    73677491 
    73687492Accepted values are 'entry' and 'page'. 
    73697493 
    7370 =item offset (optional) 
     7494=item * offset (optional) 
    73717495 
    73727496Accepted values are any non-zero positive integers, or the keyword 
     
    73757499the request. 
    73767500 
    7377 =item category or categories (optional) 
     7501=item * category or categories (optional) 
    73787502 
    73797503This attribute allows you to filter the entries based on category 
     
    74017525    <mt:Entries categories="NOT Family"> 
    74027526 
    7403 =item include_subcategories (optional) 
     7527=item * include_subcategories (optional) 
    74047528 
    74057529If this attribute is specified in conjunction with the category (or 
     
    74077531of the identified category/categories to be included as well. 
    74087532 
    7409 =item tag or tags (optional) 
     7533=item * tag or tags (optional) 
    74107534 
    74117535This attribute functions similarly to the C<category> attribute, but 
     
    74137537described for category selection. 
    74147538 
    7415 =item author (optional) 
     7539=item * author (optional) 
    74167540 
    74177541Accepts an author's username to filter entry selection. 
     
    74217545    <mt:Entries author="Melody"> 
    74227546 
    7423 =item id (optional) 
     7547=item * id (optional) 
    74247548 
    74257549If specified, selects a single entry matching the given entry ID. 
     
    74277551    <mt:Entries id="10"> 
    74287552 
    7429 =item min_score (optional) 
    7430  
    7431 =item max_score (optional) 
    7432  
    7433 =item min_rate (optional) 
    7434  
    7435 =item max_rate (optional) 
    7436  
    7437 =item min_count (optional) 
    7438  
    7439 =item max_count (optional) 
     7553=item * min_score (optional) 
     7554 
     7555=item * max_score (optional) 
     7556 
     7557=item * min_rate (optional) 
     7558 
     7559=item * max_rate (optional) 
     7560 
     7561=item * min_count (optional) 
     7562 
     7563=item * max_count (optional) 
    74407564 
    74417565Allows filtering of entries based on score, rating or count. Each of 
    74427566the attributes require the C<namespace> attribute. 
    74437567 
    7444 =item scored_by (optional) 
     7568=item * scored_by (optional) 
    74457569 
    74467570Allows filtering of entries that were scored by a particular user, 
    74477571specified by username. Requires the C<namespace> attribute. 
    74487572 
    7449 =item days (optional) 
     7573=item * days (optional) 
    74507574 
    74517575Limits the selection of entries to a specified number of days, 
     
    74577581published. 
    74587582 
    7459 =item recently_commented_on (optional) 
     7583=item * recently_commented_on (optional) 
    74607584 
    74617585Selects the list of entries that have received published comments 
     
    74697593received comment. 
    74707594 
    7471 =item unique 
     7595=item * unique 
    74727596 
    74737597If specified, this flag will cause MT to keep track of which entries 
     
    74917615from the first Entries tag. 
    74927616 
    7493 =item glue (optional) 
     7617=item * glue (optional) 
    74947618 
    74957619Specifies a string that is output inbetween published entries. 
     
    76527776                } else { 
    76537777                    my @cats = cat_path_to_category($category_arg, [ \%blog_terms, \%blog_args ], $class_type); 
     7778use Data::Dumper; die Dumper({ terms => \%blog_terms, args => \%blog_args, cats => \@cats, arg => $category_arg }); 
    76547779                    if (@cats) { 
    76557780                        $cats = \@cats; 
     
    82018326} 
    82028327 
     8328########################################################################### 
     8329 
     8330=head2 DateHeader 
     8331 
     8332A container tag whose contents will be displayed if the entry in context 
     8333was posted on a new day in the list. 
     8334 
     8335B<Example:> 
     8336 
     8337    <mt:Entries> 
     8338        <mt:DateHeader> 
     8339            <h2><$mt:EntryDate format="%A, %B %e, %Y"$></h2> 
     8340        </mt:DateHeader> 
     8341        <!-- display entry here --> 
     8342    </mt:Entries> 
     8343 
     8344=for tags entries 
     8345 
     8346=cut 
     8347 
     8348########################################################################### 
     8349 
     8350=head2 DateFooter 
     8351 
     8352A container tag whose contents will be displayed if the entry in context 
     8353is the last entry in the group of entries for a given day. 
     8354 
     8355B<Example:> 
     8356 
     8357    <mt:Entries> 
     8358        <!-- display entry here --> 
     8359        <mt:DateFooter> 
     8360            <hr /> 
     8361        </mt:DateFooter> 
     8362    </mt:Entries> 
     8363 
     8364=for tags entries 
     8365 
     8366=cut 
     8367 
     8368########################################################################### 
     8369 
     8370=head2 EntriesHeader 
     8371 
     8372The contents of this container tag will be displayed when the first 
     8373entry listed by a L<Entries> tag is reached. 
     8374 
     8375=for tags entries 
     8376 
     8377=cut 
     8378 
     8379########################################################################### 
     8380 
     8381=head2 EntriesFooter 
     8382 
     8383The contents of this container tag will be displayed when the last 
     8384entry listed by a L<Entries> tag is reached. 
     8385 
     8386=for tags entries 
     8387 
     8388=cut 
     8389 
     8390########################################################################### 
     8391 
     8392=head2 PagesHeader 
     8393 
     8394The contents of this container tag will be displayed when the first page 
     8395listed by a L<Pages> tag is reached. 
     8396 
     8397B<Example:> 
     8398 
     8399    <mt:Pages glue=", "> 
     8400        <mt:PagesHeader> 
     8401            The following pages are available: 
     8402        </mt:PagesHeader> 
     8403        <a href="<$mt:PagePermalink$>"><$mt:PageTitle$></a> 
     8404    </mt:Pages> 
     8405 
     8406=for tags pages 
     8407 
     8408=cut 
     8409 
     8410########################################################################### 
     8411 
     8412=head2 PagesFooter 
     8413 
     8414The contents of this container tag will be displayed when the last page 
     8415listed by a L<Pages> tag is reached. 
     8416 
     8417=for tags pages 
     8418 
     8419=cut 
     8420 
    82038421# returns an iterator that supplies entries, in the order of last comment 
    82048422# date (descending) 
     
    83268544=over 4 
    83278545 
    8328 =item convert_breaks (optional; default "1") 
     8546=item * convert_breaks (optional; default "1") 
    83298547 
    83308548Accepted values are '0' and '1'. Typically, this attribute is 
     
    83328550text based on the text formatting option for the entry. 
    83338551 
    8334 =item words (optional) 
     8552=item * words (optional) 
    83358553 
    83368554Accepts any positive integer to limit the number of words 
     
    84148632=over 4 
    84158633 
    8416 =item generate (optional) 
     8634=item * generate (optional) 
    84178635 
    84188636If specified, will draw content from the "main" text field of 
     
    85188736=over 4 
    85198737 
    8520 =item flag (required) 
     8738=item * flag (required) 
    85218739 
    85228740Accepts one of: 'allow_pings', 'allow_comments'. 
     
    85608778=over 4 
    85618779 
    8562 =item no_generate (optional) 
     8780=item * no_generate (optional) 
    85638781 
    85648782If the excerpt field is empty, this flag will prevent the generation 
    85658783of an excerpt using the main text of the entry. 
    85668784 
    8567 =item words (optional; default "40") 
     8785=item * words (optional; default "40") 
    85688786 
    85698787Controls the length of the auto-generated entry excerpt. Does B<not> 
    85708788limit the content when the excerpt field contains content. 
    85718789 
    8572 =item convert_breaks (optional; default "0") 
     8790=item * convert_breaks (optional; default "0") 
    85738791 
    85748792When set to '1', applies the text formatting filters on the excerpt 
     
    86228840usernames.> 
    86238841 
     8842=for tags deprecated 
     8843 
    86248844=cut 
    86258845 
     
    86598879favor of L<EntryAuthorDisplayName>.> 
    86608880 
     8881=for tags deprecated 
     8882 
    86618883=cut 
    86628884 
     
    86978919=over 4 
    86988920 
    8699 =item spam_protect (optional; default "0") 
     8921=item * spam_protect (optional; default "0") 
    87008922 
    87018923If specified, this will apply a light obfuscation of the email address, 
     
    87448966=over 4 
    87458967 
    8746 =item new_window 
     8968=item * new_window 
    87478969 
    87488970If specified, the published link is given a C<target> attribute of '_blank'. 
    87498971 
    8750 =item show_email (optional; default "0") 
     8972=item * show_email (optional; default "0") 
    87518973 
    87528974If set, will allow publishing of an email address if the URL field 
    87538975for the author is empty. 
    87548976 
    8755 =item spam_protect (optional) 
     8977=item * spam_protect (optional) 
    87568978 
    87578979If specified, this will apply a light obfuscation of any email address 
     
    87598981address (C<:>, C<@>, and C<.>) into HTML entities. 
    87608982 
    8761 =item type (optional) 
     8983=item * type (optional) 
    87628984 
    87638985Accepted values: C<url>, C<email>, C<archive>. Note: an 'archive' type 
    87648986requires publishing of "Author" archives. 
    87658987 
    8766 =item show_hcard (optional; default "0") 
     8988=item * show_hcard (optional; default "0") 
    87678989 
    87688990If present, adds additional CSS class names to the link tag published, 
     
    89359157########################################################################### 
    89369158 
    8937 =head2 EntryTrackbackLink 
     9159=head2 EntryTrackbackData 
    89389160 
    89399161Outputs the TrackBack RDF block that allows for TrackBack 
     
    89459167=over 4 
    89469168 
    8947 =item comment_wrap (optional; default "1") 
     9169=item * comment_wrap (optional; default "1") 
    89489170 
    89499171If enabled, will enclose the RDF markup inside an HTML 
    89509172comment tag. 
    89519173 
    8952 =item with_index (optional; default "0") 
     9174=item * with_index (optional; default "0") 
    89539175 
    89549176If specified, will leave any "index.html" (or appropriate index 
     
    90419263=over 4 
    90429264 
    9043 =item type (optional) 
    9044  
    9045 =item archive_type (optional) 
     9265=item * type (optional) 
     9266 
     9267=item * archive_type (optional) 
    90469268 
    90479269Identifies the archive type to use when creating the link. For instance, 
     
    90949316=over 4 
    90959317 
    9096 =item separator (optional) 
     9318=item * separator (optional) 
    90979319 
    90989320Accepts either "-" or "_". If unspecified, the raw basename value is 
     
    91509372=over 4 
    91519373 
    9152 =item type or archive_type (optional) 
     9374=item * type or archive_type (optional) 
    91539375 
    91549376Specifies an alternative archive type to use instead of the individual 
    91559377archive. 
    91569378 
    9157 =item valid_html (optional; default "0") 
     9379=item * valid_html (optional; default "0") 
    91589380 
    91599381When publishing entry permalinks for non-individual archive templates, an 
     
    91649386valid HTML. 
    91659387 
    9166 =item with_index (optional; default "0") 
     9388=item * with_index (optional; default "0") 
    91679389 
    91689390If assigned, will retain any index filename at the end of the permalink. 
     
    92709492=over 4 
    92719493 
    9272 =item glue (optional) 
     9494=item * glue (optional) 
    92739495 
    92749496If specified, this string is placed in between each result from the loop. 
     
    93819603Outputs a link to the MT Comment script to allow signing in to a TypeKey 
    93829604configured blog. B<NOTE: This is deprecated in favor of L<SignInLink>.> 
     9605 
     9606=for tags deprecated 
    93839607 
    93849608=cut 
     
    94179641a blog. B<NOTE: This tag is deprecated in favor of L<SignOutLink>.> 
    94189642 
     9643=for tags deprecated 
     9644 
    94199645=cut 
    94209646 
     
    94429668} 
    94439669 
     9670########################################################################### 
     9671 
     9672=head2 CommentFields 
     9673 
     9674A deprecated tag that formerly published an entry comment form. 
     9675 
     9676=for tags deprecated 
     9677 
     9678=cut 
     9679 
    94449680sub _hdlr_comment_fields { 
    94459681    my ($ctx, $args, $cond) = @_; 
     
    95659801=over 4 
    95669802 
    9567 =item ts (optional) 
     9803=item * ts (optional) 
    95689804 
    95699805If specified, will use the given date as the date to publish. Must be 
    95709806in the format of "YYYYMMDDhhmmss". 
    95719807 
    9572 =item relative (optional) 
     9808=item * relative (optional) 
    95739809 
    95749810If specified, will publish the date using a phrase, if the date is 
     
    95789814=over 4 
    95799815 
    9580 =item relative="1" 
     9816=item * relative="1" 
    95819817 
    95829818Supports display of one duration: moments ago; N minutes ago; N hours ago; N days ago. For older dates in the same year, the date is shown as the abbreviated month and day of the month ("Jan 3"). For older dates, the year is added to that ("Jan 3 2005"). 
    95839819 
    9584 =item relative="2" 
     9820=item * relative="2" 
    95859821 
    95869822Supports display of two durations: less than 1 minute ago; N seconds, N minutes ago; N minutes ago; N hours, N minutes ago; N hours ago; N days, N hours ago; N days ago. 
    95879823 
    9588 =item relative="3" 
     9824=item * relative="3" 
    95899825 
    95909826Supports display of two durations: N seconds ago; N seconds, N minutes ago; 
    95919827N minutes ago; N hours, N minutes ago; N hours ago; N days, N hours ago; N days ago. 
    95929828 
    9593 =item relative="js" 
     9829=item * relative="js" 
    95949830 
    95959831When specified, publishes the date using JavaScript, which relies on a 
     
    95989834=back 
    95999835 
    9600 =item format (optional) 
     9836=item * format (optional) 
    96019837 
    96029838A string that provides the format in which to publish the date. If 
     
    96079843=over 4 
    96089844 
    9609 =item %Y 
     9845=item * %Y 
    96109846 
    96119847The 4-digit year. Example: "1999". 
    96129848 
    9613 =item %m 
     9849=item * %m 
    96149850 
    96159851The 2-digit month (zero-padded). Example: for a date in September, this would output "09". 
    96169852 
    9617 =item %d 
     9853=item * %d 
    96189854 
    96199855The 2-digit day of the month (zero-padded). Example: "05". 
    96209856 
    9621 =item %H 
     9857=item * %H 
    96229858 
    96239859The 2-digit hour of the day (24-hour clock, zero-padded). Example: "18". 
    96249860 
    9625 =item %M 
     9861=item * %M 
    96269862 
    96279863The 2-digit minute of the hour (zero-padded). Example: "09". 
    96289864 
    9629 =item %S 
     9865=item * %S 
    96309866 
    96319867The 2-digit second of the minute (zero-padded). Example: "04". 
    96329868 
    9633 =item %w 
     9869=item * %w 
    96349870 
    96359871The numeric day of the week, in the range C<0>-C<6>, where C<0> is 
    96369872C<Sunday>. Example: "3". 
    96379873 
    9638 =item %j 
     9874=item * %j 
    96399875 
    96409876The numeric day of the year, in the range C<0>-C<365>. Zero-padded to 
    96419877three digits. Example: "040". 
    96429878 
    9643 =item %y 
     9879=item * %y 
    96449880 
    96459881The two-digit year, zero-padded. Example: %y for a date in 2008 would 
    96469882output "08". 
    96479883 
    9648 =item %b 
     9884=item * %b 
    96499885 
    96509886The abbreviated month name. Example: %b for a date in January would 
    96519887output "Jan". 
    96529888 
    9653 =item %B 
     9889=item * %B 
    96549890 
    96559891The full month name. Example: "January". 
    96569892 
    9657 =item %a 
     9893=item * %a 
    96589894 
    96599895The abbreviated day of the week. Example: %a for a date on a Monday would 
    96609896output "Mon". 
    96619897 
    9662 =item %A 
     9898=item * %A 
    96639899 
    96649900The full day of the week. Example: "Friday". 
    96659901 
    9666 =item %e 
    9667  
    9668 The numeric day of the month (space-padded). Example: "08". 
    9669  
    9670 =item %I 
     9902=item * %e 
     9903 
     9904The numeric day of the month (space-padded). Example: " 8". 
     9905 
     9906=item * %I 
    96719907 
    96729908The two-digit hour on a 12-hour clock padded with a zero if applicable. 
    96739909Example: "04". 
    96749910 
    9675 =item %k 
     9911=item * %k 
    96769912 
    96779913The two-digit military time hour padded with a space if applicable. 
    96789914Example: " 9". 
    96799915 
    9680 =item %l 
     9916=item * %l 
    96819917 
    96829918The hour on a 12-hour clock padded with a space if applicable. 
     
    96859921=back 
    96869922 
    9687 =item format_name (optional) 
     9923=item * format_name (optional) 
    96889924 
    96899925Supports date formatting for particular standards. 
     
    96919927=over 4 
    96929928 
    9693 =item rfc822 
     9929=item * rfc822 
    96949930 
    96959931Outputs the date in the format: "%a, %d %b %Y %H:%M:%S Z". 
    96969932 
    9697 =item iso8601 
     9933=item * iso8601 
    96989934 
    96999935Outputs the date in the format: "%Y-%m-%dT%H:%M:%SZ". 
     
    97019937=back 
    97029938 
    9703 =item utc (optional) 
     9939=item * utc (optional) 
    97049940 
    97059941Converts the date into UTC time. 
    97069942 
    9707 =item offset_blog_id (optional) 
     9943=item * offset_blog_id (optional) 
    97089944 
    97099945Identifies the ID of the blog to use for adjusting the time to 
    97109946blog time. Will default to the current blog in context if unset. 
    97119947 
    9712 =item language (optional) 
     9948=item * language (optional) 
    97139949 
    97149950Used to force localization of the date to a specific language. 
     
    985110087########################################################################### 
    985210088 
    9853 =head2 Comments TBD 
     10089=head2 Comments 
    985410090 
    985510091A container tag which iterates over a list of comments on an entry or for a 
    9856 blog. By default, all comments in context (e.g on an entry or in a blog) are 
     10092blog. By default, all comments in context (e.g. on an entry or in a blog) are 
    985710093returned. When used in a blog context, only comments on published entries are 
    985810094returned. 
     
    986210098=over 4 
    986310099 
    9864 =item lastn 
     10100=item * lastn 
    986510101 
    986610102Display the last N comments in context where N is a positive integer. 
    986710103B<NOTE: lastn required in a blog context.> 
    986810104 
    9869 =item offset 
    9870  
    9871 =item sort_by 
    9872  
    9873 =item sort_order 
     10105=item * offset (optional; default "0") 
     10106 
     10107Specifies a number of comments to skip. 
     10108 
     10109=item * sort_by (optional) 
     10110 
     10111Specifies a sort column. 
     10112 
     10113=item * sort_order (optional) 
    987410114 
    987510115Specifies the sort order and overrides the General Settings. Recognized 
    987610116values are "ascend" and "descend." 
    987710117 
    9878 =item namespace 
    9879  
    9880 =item min_score 
    9881  
    9882 =item max_score 
    9883  
    9884 =item min_rate 
    9885  
    9886 =item max_rate 
    9887  
    9888 =item min_count 
    9889  
    9890 =item max_count 
    9891  
    9892 =item scored_by 
     10118=item * namespace 
     10119 
     10120Used in conjunction with the "min*", "max*" attributes to 
     10121select comments based on a particular scoring mechanism. 
     10122 
     10123=item * min_score 
     10124 
     10125If 'namespace' is also specified, filters the comments based on 
     10126the score within that namespace. This specifies the minimum score 
     10127to consider the comment for inclusion. 
     10128 
     10129=item * max_score 
     10130 
     10131If 'namespace' is also specified, filters the comments based on 
     10132the score within that namespace. This specifies the maximum score 
     10133to consider the comment for inclusion. 
     10134 
     10135=item * min_rank 
     10136 
     10137If 'namespace' is also specified, filters the comments based on 
     10138the rank within that namespace. This specifies the minimum rank 
     10139to consider the comment for inclusion. 
     10140 
     10141=item * max_rate 
     10142 
     10143If 'namespace' is also specified, filters the comments based on 
     10144the rank within that namespace. This specifies the maximum rank 
     10145to consider the comment for inclusion. 
     10146 
     10147=item * min_count 
     10148 
     10149If 'namespace' is also specified, filters the comments based on 
     10150the count within that namespace. This specifies the minimum count 
     10151to consider the comment for inclusion. 
     10152 
     10153=item * max_count 
     10154 
     10155If 'namespace' is also specified, filters the comments based on 
     10156the count within that namespace. This specifies the maximum count 
     10157to consider the comment for inclusion. 
    989310158 
    989410159=back 
     
    1026910534########################################################################### 
    1027010535 
     10536=head2 CommentName 
     10537 
     10538Deprecated in favor of the L<CommentAuthor> tag. 
     10539 
     10540=for tags deprecated 
     10541 
     10542=cut 
     10543 
     10544########################################################################### 
     10545 
    1027110546=head2 CommentAuthor 
    1027210547 
     
    1032110596=over 4 
    1032210597 
    10323 =item show_email (optional; default "0") 
     10598=item * show_email (optional; default "0") 
    1032410599 
    1032510600Specifies if the comment author's email can be displayed. 
    1032610601 
    10327 =item show_url (optional; default "1") 
     10602=item * show_url (optional; default "1") 
    1032810603 
    1032910604Specifies if the comment author's URL can be displayed. 
    1033010605 
    10331 =item new_window (optional; default "0") 
     10606=item * new_window (optional; default "0") 
    1033210607 
    1033310608Specifies to open the link in a new window by adding C<target="_blank"> 
    1033410609to the anchor tag. See example below. 
    1033510610 
    10336 =item default_name (optional; default "Anonymous") 
     10611=item * default_name (optional; default "Anonymous") 
    1033710612 
    1033810613Used in the event that the commenter did not provide a value for their 
    1033910614name. 
    1034010615 
    10341 =item no_redirect (optional; default "0") 
     10616=item * no_redirect (optional; default "0") 
    1034210617 
    1034310618Prevents use of the mt-comments.cgi script to handle the comment author 
    1034410619link. 
    1034510620 
    10346 =item nofollowfy (optional) 
     10621=item * nofollowfy (optional) 
    1034710622 
    1034810623If assigned, applies a C<rel="nofollow"> link relation to the link. 
     
    1041610691=over 4 
    1041710692 
    10418 =item spam_protect (optional; default "0") 
     10693=item * spam_protect (optional; default "0") 
    1041910694 
    1042010695=back 
     
    1052810803########################################################################### 
    1052910804 
     10805=head2 CommentPreviewEmail 
     10806 
     10807A deprecated tag, replaced with L<CommentEmail>. 
     10808 
     10809=for tags deprecated 
     10810 
     10811=cut 
     10812 
     10813########################################################################### 
     10814 
     10815=head2 CommentPreviewBody 
     10816 
     10817A deprecated tag, replaced with L<CommentBody>. 
     10818 
     10819=for tags deprecated 
     10820 
     10821=cut 
     10822 
     10823########################################################################### 
     10824 
     10825=head2 CommentPreviewAuthorLink 
     10826 
     10827A deprecated tag, replaced with L<CommentAuthorLink>. 
     10828 
     10829=for tags deprecated 
     10830 
     10831=cut 
     10832 
     10833########################################################################### 
     10834 
     10835=head2 CommentPreviewURL 
     10836 
     10837A deprecated tag, replaced with L<CommentURL>. 
     10838 
     10839=for tags deprecated 
     10840 
     10841=cut 
     10842 
     10843########################################################################### 
     10844 
     10845=head2 CommentPreviewDate 
     10846 
     10847A deprecated tag, replaced with L<CommentDate>. 
     10848 
     10849=for tags deprecated 
     10850 
     10851=cut 
     10852 
     10853########################################################################### 
     10854 
     10855=head2 CommentPreviewAuthor 
     10856 
     10857A deprecated tag, replaced with L<CommentAuthor>. 
     10858 
     10859=for tags deprecated 
     10860 
     10861=cut 
     10862 
     10863########################################################################### 
     10864 
     10865=head2 CommentPreviewIP 
     10866 
     10867A deprecated tag, replaced with L<CommentIP>. 
     10868 
     10869=for tags deprecated 
     10870 
     10871=cut 
     10872 
     10873########################################################################### 
     10874 
    1053010875=head2 CommentBody 
    1053110876 
     
    1053410879=over 4 
    1053510880 
    10536 =item autolink (optional) 
     10881=item * autolink (optional) 
    1053710882 
    1053810883If unspecified, any plaintext links in the comment body will be 
     
    1054110886override the blog preference. 
    1054210887 
    10543 =item convert_breaks (optional) 
     10888=item * convert_breaks (optional) 
    1054410889 
    1054510890By default, the comment text is formatted according to the comment text 
     
    1054810893applied. 
    1054910894 
    10550 =item words (optional) 
     10895=item * words (optional) 
    1055110896 
    1055210897Limits the length of the comment body to the specified number of words. 
     
    1070411049=over 4 
    1070511050 
    10706 =item label or text (optional) 
     11051=item * label or text (optional) 
    1070711052 
    1070811053A custom phrase for the link (default is "Reply"). 
    1070911054 
    10710 =item onclick (optional) 
     11055=item * onclick (optional) 
    1071111056 
    1071211057Custom JavaScript code for the onclick attribute. By default, this 
     
    1074411089=over 4 
    1074511090 
    10746 =item pad 
     11091=item * pad 
    1074711092 
    1074811093If specified, zero-pads the ID to 6 digits. Example: 001234. 
     
    1076411109 
    1076511110=head2 CommentReplies 
     11111 
     11112A block tag which iterates over a list of reply comments to the  
     11113in context. 
     11114 
     11115B<Example:> 
     11116 
     11117    <mt:Comment> 
     11118      <mt:CommentReplies> 
     11119        <mt:CommentsHeader>Replies to the comment:</mt:CommentsHeader> 
     11120        <$mt:CommentBody$> 
     11121      </mt:CommentReplies> 
     11122    </mt:Comment> 
    1076611123 
    1076711124=for tags comments, loop 
     
    1084211199=head2 CommentRepliesRecurse 
    1084311200 
     11201Recursively call the block with the replies to the comment in context. This 
     11202tag, when placed at the end of loop controlled by MTCommentReplies tag will 
     11203cause them to recursively descend into any replies to comments that exist 
     11204during the loop. 
     11205 
     11206B<Example:> 
     11207 
     11208    <mt:Comments> 
     11209      <$mt:CommentBody$> 
     11210      <mt:CommentReplies> 
     11211        <mt:CommentsHeader><ul></MTCommentsHeader> 
     11212        <li><$mt:CommentID$> 
     11213        <$mt:CommentRepliesRecurse$> 
     11214        </li> 
     11215        <mt:CommentsFooter></ul></mt:CommentsFooter> 
     11216      </mt:CommentReplies> 
     11217    </mt:Comments> 
     11218 
    1084411219=for tags comments 
    1084511220 
     
    1091511290########################################################################### 
    1091611291 
     11292=head2 CommentsHeader 
     11293 
     11294The contents of this container tag will be displayed when the first 
     11295comment listed by a L<Comments> or L<CommentReplies> tag is reached. 
     11296 
     11297=for tags comments 
     11298 
     11299=cut 
     11300 
     11301########################################################################### 
     11302 
     11303=head2 CommentsFooter 
     11304 
     11305The contents of this container tag will be displayed when the last 
     11306comment listed by a L<Comments> or L<CommentReplies> tag is reached. 
     11307 
     11308=for tags comments 
     11309 
     11310=cut 
     11311 
     11312########################################################################### 
     11313 
    1091711314=head2 IfCommentParent 
    1091811315 
     
    1096711364=head2 CommenterNameThunk 
    1096811365 
    10969 =for tags comments 
     11366Used to populate the commenter_name Javascript variable. Deprecated in 
     11367favor of the L<UserSessionState> tag. 
     11368 
     11369=for tags deprecated 
    1097011370 
    1097111371=cut 
     
    1099211392=head2 CommenterUsername 
    1099311393 
     11394This template tag returns the username of the current commenter in context. 
     11395If no name exists, then it returns an empty string. 
     11396 
     11397B<Example:> 
     11398 
     11399    <mt:Entries> 
     11400        <h1><$mt:EntryTitle$></h1> 
     11401        <mt:Comments> 
     11402            <a name="comment-<$mt:CommentID$>"></a> 
     11403            <p><$mt:CommentBody$></p> 
     11404            <cite><a href="/profiles/<$mt:CommenterID$>"><$mt:CommenterUsername$></a></cite> 
     11405        </mt:Comments> 
     11406    </mt:Entries> 
     11407 
    1099411408=for tags comments 
    1099511409 
     
    1100411418########################################################################### 
    1100511419 
    11006 =head2 UserSessionCookieTimeout 
     11420=head2 UserSessionState 
    1100711421 
    1100811422Returns a JSON-formatted data structure that represents the user that is 
    1100911423currently logged in. 
    1101011424 
    11011 =for tags comments 
     11425=for tags comments, authentication 
    1101211426 
    1101311427=cut 
     
    1102811442=head2 UserSessionCookieTimeout 
    1102911443 
    11030 =for tags comments 
     11444Returns the value of the C<UserSessionCookieTimeout> configuration setting. 
     11445 
     11446=for tags comments, configuration, authentication 
    1103111447 
    1103211448=cut 
     
    1104111457=head2 UserSessionCookiePath 
    1104211458 
    11043 =for tags comments 
     11459Returns the value of the C<UserSessionCookiePath> configuration setting. 
     11460 
     11461The C<UserSessionCookiePath> may also use MT tags. If it does, they will 
     11462be evaluated for the blog in context. 
     11463 
     11464=for tags comments, configuration, authentication 
    1104411465 
    1104511466=cut 
     
    1106811489=head2 UserSessionCookieDomain 
    1106911490 
    11070 =for tags comments 
     11491Returns the value of the C<UserSessionCookieDomain> configuration setting, 
     11492or the domain name of the blog currently in context. Any "www" subdomain 
     11493will be ignored (ie, "www.sixapart.com" becomes ".sixapart.com"). 
     11494 
     11495The C<UserSessionCookieDomain> may also use MT tags. If it does, they will 
     11496be evaluated for the blog in context. 
     11497 
     11498=for tags comments, configuration, authentication 
    1107111499 
    1107211500=cut 
     
    1109611524########################################################################### 
    1109711525 
    11098 =head2 UserSessionCookie 
    11099  
    11100 =for tags comments 
     11526=head2 UserSessionCookieName 
     11527 
     11528Returns the value of the C<UserSessionCookieName> configuration setting. 
     11529If the setting contains the C<%b> string, it will replaced with the blog ID 
     11530of the blog currently in context. 
     11531 
     11532B<Example:> 
     11533 
     11534    <$mt:UserSessionCookieName$> 
     11535 
     11536=for tags comments, configuration 
    1110111537 
    1110211538=cut 
     
    1111911555=head2 CommenterName 
    1112011556 
     11557The name of the commenter for the comment currently in context. 
     11558 
     11559B<Example:> 
     11560 
     11561    <$mt:CommenterName$> 
     11562 
    1112111563=for tags comments 
    1112211564 
     
    1113511577=head2 CommenterEmail 
    1113611578 
     11579The email address of the commenter. The spam_protect global filter may 
     11580be used. 
     11581 
     11582B<Example:> 
     11583 
     11584    <$mt:CommenterEmail$> 
     11585 
    1113711586=for tags comments 
    1113811587 
     
    1115011599=head2 CommenterAuthType 
    1115111600 
    11152 =for tags comments 
     11601Returns a string which identifies what authentication provider the commenter 
     11602in context used to authenticate him/herself. Commenter context is created by 
     11603either MTComments or MTCommentReplies template tag. For example, 'MT' will be 
     11604returned when the commenter in context is authenticated by Movable Type. When 
     11605the commenter in context is authenticated by Vox, 'Vox' will be returned. 
     11606 
     11607B<Example:> 
     11608 
     11609    <mt:Comments> 
     11610      <$mt:CommenterName$> (<$mt:CommenterAuthType$>) said: 
     11611      <$mt:CommentBody$> 
     11612    </mt:Comments> 
     11613 
     11614=for tags comments, authentication 
    1115311615 
    1115411616=cut 
     
    1116411626=head2 CommenterAuthIconURL 
    1116511627 
    11166 =for tags comments 
     11628Returns URL to a small (16x16) image represents in what authentication 
     11629provider the commenter in context is authenticated. Commenter context 
     11630is created by either a L<Comments> or L<CommentReplies> block tag. For 
     11631commenters authenticated by Movable Type, it will be a small spanner 
     11632logo of Movable Type. Otherwise, icon image is provided by each of 
     11633authentication provider. Movable Type provides images for Vox, 
     11634LiveJournal and OpenID out of the box. 
     11635 
     11636B<Example:> 
     11637 
     11638    <mt:Comments> 
     11639        <$mt:CommenterName$><$mt:CommenterAuthIconURL$>: 
     11640        <$mt:CommentBody$> 
     11641    </mt:Comments> 
     11642 
     11643=for tags comments, authentication 
    1116711644 
    1116811645=cut 
     
    1118711664########################################################################### 
    1118811665 
     11666=head2 CommenterIfTrusted 
     11667 
     11668Deprecated in favor of the L<IfCommenterTrusted> tag. 
     11669 
     11670=for tags deprecated 
     11671 
     11672=cut 
     11673 
     11674########################################################################### 
     11675 
    1118911676=head2 IfCommenterTrusted 
    1119011677 
    11191 =for tags comments 
     11678A conditional tag that displays its contents if the commenter in context 
     11679has been marked as trusted. 
     11680 
     11681=for tags comments, authentication 
    1119211682 
    1119311683=cut 
     
    1128511775=head2 CommenterUserpic 
    1128611776 
     11777This template tag returns a complete HTML C<img> tag for the current 
     11778commenter's userpic. For example: 
     11779 
     11780    <img src="http://yourblog.com/userpics/1.jpg" width="100" height="100" /> 
     11781 
     11782B<Example:> 
     11783 
     11784    <h2>Recent Commenters</h2> 
     11785    <mt:Entries recently_commented_on="10"> 
     11786        <div class="userpic" style="float: left; padding: 5px;"><$mt:CommenterUserpic$></div> 
     11787    </mt:Entries> 
     11788 
    1128711789=for tags comments 
    1128811790 
     
    1130111803=head2 CommenterUserpicURL 
    1130211804 
     11805This template tag returns the URL to the image of the current 
     11806commenter's userpic. 
     11807 
     11808B<Example:> 
     11809 
     11810    <img src="<$mt:CommenterUserpicURL$>" /> 
     11811 
    1130311812=for tags comments 
    1130411813 
     
    1131511824=head2 CommenterUserpicAsset 
    1131611825 
    11317 =for tags comments 
     11826This template tag is a container tag that puts the current commenter's 
     11827userpic asset in context. Because userpics are stored as assets within 
     11828Movable Type, this allows you to utilize all of the asset-related 
     11829template tags when displaying a user's userpic. 
     11830 
     11831B<Example:> 
     11832 
     11833     <mt:CommenterUserpicAsset> 
     11834        <img src="<$mt:AssetThumbnailURL width="20" height="20"$>" 
     11835            width="20" height="20"  /> 
     11836     </mt:CommenterUserpicAsset> 
     11837 
     11838=for tags comments, assets 
    1131811839 
    1131911840=cut 
     
    1135711878=head2 ArchivePrevious 
    1135811879 
    11359  
    11360 =cut 
     11880A container tag that creates a context to the "previous" archive 
     11881relative to the current archive context. 
     11882 
     11883This tag also works with the else tag to produce content if there is no 
     11884"previous" archive. 
     11885 
     11886B<Attributes:> 
     11887 
     11888=over 4 
     11889 
     11890=item * type or archive_type (optional) 
     11891 
     11892Specifies the "previous" archive type the context is for. See 
     11893the L<ArchiveList> tag for supported values for this attribute. 
     11894 
     11895=back 
     11896 
     11897B<Example:> 
     11898 
     11899    <mt:ArchivePrevious> 
     11900      <a href="<$mt:ArchiveLink$>" 
     11901        title="<$mt:ArchiveTitle escape="html"$>">Next</a> 
     11902    <mt:Else> 
     11903       <!-- output when no previous archive is available --> 
     11904    </mt:ArchivePrevious> 
     11905 
     11906=for tags archiving 
     11907 
     11908=cut 
     11909 
     11910########################################################################### 
    1136111911 
    1136211912=head2 ArchiveNext 
     
    1136611916 
    1136711917This tag also works with the else tag to produce content if there is no 
    11368 "previous" archive. 
     11918"next" archive. 
    1136911919 
    1137011920B<Attributes:> 
     
    1137211922=over 4 
    1137311923 
    11374 =item type or archive_type (optional) 
     11924=item * type or archive_type (optional) 
    1137511925 
    1137611926Specifies the "next" archive type the context is for. See the L<ArchiveList> 
     
    1138411934      <a href="<$mt:ArchiveLink$>" 
    1138511935        title="<$mt:ArchiveTitle escape="html"$>">Next</a> 
    11386     <mt:else> 
    11387        <!-- output when no previous archive is available --> 
     11936