Changeset 416

Show
Ignore:
Timestamp:
10/06/03 18:51:41 (5 years ago)
Author:
emc3
Message:

Changed version to 0.72; added get_links_list() doc; updated XML-RPC API info

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/readme.html

    r267 r416  
     1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    12<html> 
    23<head> 
    3 <title>WordPress &gt; ReadMe</title> 
    4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 
    5 <style> 
     4  <title>WordPress &gt; ReadMe</title> 
     5  <meta content="text/html; charset=iso-8859-1" 
     6 http-equiv="Content-Type"> 
     7  <style> 
    68<!-- 
    79    body { 
     
    3537    ul, ol { margin: 0px; padding: 0px; padding-left: 20px; padding-top: 5px; padding-right: 5px; padding-bottom: 5px; } 
    3638--> 
    37 </style> 
    38  
     39  </style> 
    3940</head> 
    40  
    41 <body bgcolor="#FFFFFF" text="#000000"> 
    42 <table width="600" border="0" cellspacing="0" cellpadding="0" align="center"> 
    43   <tr>  
    44     <td> <p align="center"><img src="http://wordpress.org/images/wordpress.gif" alt="WordPress" /><br /> 
    45         <font size="2" face="Georgia, Times New Roman, Times, serif">0.71</font></p> 
     41<body style="background-color: rgb(255, 255, 255); color: rgb(0, 0, 0);"> 
     42<table align="center" cellpadding="0" cellspacing="0" border="0" 
     43 width="600"> 
     44  <tbody> 
     45    <tr> 
     46      <td> 
     47      <p align="center"><img alt="WordPress" 
     48 src="http://wordpress.org/images/wordpress.gif"><br> 
     49      <font face="Georgia, Times New Roman, Times, serif" size="2">0.72</font></p> 
    4650      <p align="center">Weblog / News Publishing Tool</p> 
    47       <p align="center"><a href="#requirements">Requirements</a> - <a href="#installation">Installation</a>  
    48         - <a href="#templates">Template(s)</a> - <a href="#usage">Query String  
    49         Usage</a> - <a href="#xmlrpc">XML-RPC (Blogger API)</a> - <a href="#postviaemail">Post  
    50         Via Email</a> - <a href="#notes">Notes</a></p> 
    51       <a name="requirements"></a> <h1>Requirements:</h1> 
     51      <p align="center"><a href="#requirements">Requirements</a> - <a 
     52 href="#installation">Installation</a> - <a href="#templates">Template(s)</a> 
     53- <a href="#usage">Query String Usage</a> - <a href="#xmlrpc">XML-RPC 
     54(Blogging APIs)</a> - <a href="#postviaemail">Post Via Email</a> - <a 
     55 href="#notes">Notes</a></p> 
     56      <a name="requirements"></a> 
     57      <h1>Requirements:</h1> 
    5258      <ul> 
    5359        <li><strong>PHP4</strong> (version 4.0.6 or higher)</li> 
    5460        <li><strong>MySQL</strong> (version 3.23.23 or higher)</li> 
    5561        <li>Perl (optional - only for the spellchecker)</li> 
    56         <li>... and a link to <a href="http://wordpress.org" target="_blank">http://wordpress.org</a>  
    57          on your site.</li> 
     62        <li>... and a link to <a target="_blank" 
     63 href="http://wordpress.org">http://wordpress.org</a> on your site.</li> 
    5864      </ul> 
    59       <p>The link will help promote <a href="http://wordpress.org">WordPress</a>  
    60         and is its only mean of promotion. </p> 
    61       <p>WordPress is built from b2, which comes from Michel V. We wouldn't be  
    62         here without him, so why don't you grab him something from his <a href="http://www.amazon.com/exec/obidos/registry-address-select-done/1XKLC38KDUPXR/103-8901342-4908609">wishlist</a>?</p> 
    63       <p>This document is currently beta stage, we'll be updating it extensively  
    64         as WordPress matures.</p> 
     65      <p>The link will help promote <a href="http://wordpress.org">WordPress</a> 
     66and is its only mean of promotion. </p> 
     67      <p>WordPress is built from b2, which comes from Michel V. We 
     68wouldn't be here without him, so why don't you grab him something from 
     69his <a 
     70 href="http://www.amazon.com/exec/obidos/registry-address-select-done/1XKLC38KDUPXR/103-8901342-4908609">wishlist</a>?</p> 
     71      <p>This document is currently beta stage, we'll be updating it 
     72extensively as WordPress matures.</p> 
    6573      <h1 id="installation">Installation:</h1> 
    6674      <h2>New users: 5-minute install.</h2> 
    6775      <ol> 
    6876        <li>Unzip the package in an empty directory.</li> 
    69         <li>Copy wp-config.sample.php to wp-config.php. Open wp-config.php in a text editor 
    70             and modify the variables as explained in the comments. Comments are lines 
    71             that start with # or /* or //</li> 
    72         <li>Upload everything. This release is designed to sit in your root folder,  
    73           IE the folder where your WordPress-powered page will reside.</li> 
     77        <li>Copy wp-config.sample.php to wp-config.php. Open 
     78wp-config.php in a text editor and modify the variables as explained in 
     79the comments. Comments are lines that start with # or /* or //</li> 
     80        <li>Upload everything. This release is designed to sit in your 
     81root folder, IE the folder where your WordPress-powered page will 
     82reside.</li> 
    7483        <li>CHMOD 666 the <code>weblogs.com.changes.cache</code> file.</li> 
    75         <li> Launch <a href="wp-admin/wp-install.php">wp-install.php</a> in your  
    76           browser. This should setup the MySQL database for your blog. If there  
    77           is an error, double check your wp-config.php file, and try again. If  
    78           it fails again, please go to the <a href="http://wordpress.org/support/">support  
    79           forums</a> and make a post with all the information about the failure  
    80           (error messages, etc), and your setup (the PHP and MySQL versions on  
    81           your server, and the browser you were using). <strong>Note the password  
    82           given to you.</strong></li> 
    83         <li> Go to <a href="b2login.php">b2login.php</a> and sign in with the  
    84           login &quot;admin&quot; and the password given to you by the install  
    85           script. Then click on the menu 'My Profile', and change the password.  
    86           Note: you need javascript enabled to launch the profile popup window.</li> 
     84        <li> Launch <a href="wp-admin/wp-install.php">wp-install.php</a> 
     85in your browser. This should setup the MySQL database for your blog. If 
     86there is an error, double check your wp-config.php file, and try again. 
     87If it fails again, please go to the <a 
     88 href="http://wordpress.org/support/">support forums</a> and make a 
     89post with all the information about the failure (error messages, etc), 
     90and your setup (the PHP and MySQL versions on your server, and the 
     91browser you were using). <strong>Note the password given to you.</strong></li> 
     92        <li> Go to <a href="b2login.php">b2login.php</a> and sign in 
     93with the login "admin" and the password given to you by the install 
     94script. Then click on the menu 'My Profile', and change the password. 
     95Note: you need javascript enabled to launch the profile popup window.</li> 
    8796      </ol> 
    8897      <h2>Some notes:</h2> 
    8998      <ul> 
    90         <li>Whenever you want to post something, just open a browser and go to  
    91           b2login.php to log in and post.</li> 
    92         <li>You can also use a bookmarklet and/or a sidebar (IE5+/NS6+) to post.</li> 
    93         <li> You can also post through the Blogger API, <a href="#xmlrpc">click  
    94           here</a> for more info.</li> 
    95         <li> Your site's blog is on b2.php (simple template) and index.php (CSS  
    96           template), you can rename this file to index.php or any other name you  
    97           fancy (provided it bears the php extension or is interpreted as a php  
    98           file by your server).</li> 
    99         <li> You can also copy b2.php into a new file and modify that new file,  
    100           it will work too ;)</li> 
     99        <li>Whenever you want to post something, just open a browser 
     100and go to b2login.php to log in and post.</li> 
     101        <li>You can also use a bookmarklet and/or a sidebar (IE5+/NS6+) 
     102to post.</li> 
     103        <li> You can also post through the Blogger API, <a 
     104 href="#xmlrpc">click here</a> for more info.</li> 
     105        <li> Your site's blog is on b2.php (simple template) and 
     106index.php (CSS template), you can rename this file to index.php or any 
     107other name you fancy (provided it bears the php extension or is 
     108interpreted as a php file by your server).</li> 
     109        <li> You can also copy b2.php into a new file and modify that 
     110new file, it will work too ;)</li> 
    101111      </ul> 
    102112      <h2>Users upgrading from b2 v0.6.1 to WordPress v0.7:</h2> 
    103113      <ul> 
    104         <li>All you <em>really</em> have to do is replace all the files with newer  
    105           versions and run <a href="javascript:window.close()">b2-2-wp.php</a>  
    106           and you should be ready to go.</li> 
    107         <li>If you're using an older version of b2, it's probably a good idea  
    108           to upgrade to at least .6.1 before making the leap to WordPress.</li> 
    109         <li>The templates are so much better, and there is so much more going  
    110           on than before it's probably worth it to start from scratch and work  
    111           back to your design.</li> 
    112         <li>You <em>must</em> update your <code>wp-config.php</code>. There's all  
    113           sort of new stuff in there.</li> 
    114         <li>WordPress issues should be discussed in our <a href="http://wordpress.org/support/">support  
    115           forums</a>.</li> 
    116         <li><strong>Back up</strong> your database before you do anything. Yes,  
    117           you. Right now.</li> 
     114        <li>All you <em>really</em> have to do is replace all the 
     115files with newer versions and run <a href="javascript:window.close()">b2-2-wp.php</a> 
     116and you should be ready to go.</li> 
     117        <li>If you're using an older version of b2, it's probably a 
     118good idea to upgrade to at least .6.1 before making the leap to 
     119WordPress.</li> 
     120        <li>The templates are so much better, and there is so much more 
     121going on than before it's probably worth it to start from scratch and 
     122work back to your design.</li> 
     123        <li>You <em>must</em> update your <code>wp-config.php</code>. 
     124There's all sort of new stuff in there.</li> 
     125        <li>WordPress issues should be discussed in our <a 
     126 href="http://wordpress.org/support/">support forums</a>.</li> 
     127        <li><strong>Back up</strong> your database before you do 
     128anything. Yes, you. Right now.</li> 
    118129      </ul> 
    119130      <h1 id="templates">Template(s):</h1> 
    120131      <h2>First notes:</h2> 
    121132      <ul> 
    122         <li>Enclosed is an example of a template, in the file b2.php. You can  
    123           rename this file to &quot;index.php&quot;or something else (recent b2  
    124           versions have a default index.php, which is an elaborate CSS-based template).</li> 
    125         <li>You can have any number of template files, since all they do is extract  
    126           the posts from the database.</li> 
    127         <li>Pseudo-template for the comments is in b2comments.php. You needn't  
    128           rename this file, but you can edit it.</li> 
    129         <li>The only thing to remember is that it's not actually a template, but  
    130           a PHP file that you're manipulating. So when you see &quot;don't delete  
    131           this line&quot;, you know you mustn't, unless you want to have a broken  
    132           page.</li> 
    133         <li>Required lines are: the first lines that call blog.header.php, the  
    134           lines with the &quot;while&quot; statement, and the ones with just &quot;}&quot;  
    135           (it ends the while loop).</li> 
    136         <li>Between the &quot;while&quot; line and the &quot;}&quot;, is the template  
    137           for your posts.</li> 
     133        <li>Enclosed is an example of a template, in the file b2.php. 
     134You can rename this file to "index.php"or something else (recent b2 
     135versions have a default index.php, which is an elaborate CSS-based 
     136template).</li> 
     137        <li>You can have any number of template files, since all they 
     138do is extract the posts from the database.</li> 
     139        <li>Pseudo-template for the comments is in b2comments.php. You 
     140needn't rename this file, but you can edit it.</li> 
     141        <li>The only thing to remember is that it's not actually a 
     142template, but a PHP file that you're manipulating. So when you see 
     143"don't delete this line", you know you mustn't, unless you want to have 
     144a broken page.</li> 
     145        <li>Required lines are: the first lines that call 
     146blog.header.php, the lines with the "while" statement, and the ones 
     147with just "}" (it ends the while loop).</li> 
     148        <li>Between the "while" line and the "}", is the template for 
     149your posts.</li> 
    138150      </ul> 
    139151      <h2>Notes about parameters:</h2> 
    140152      <ol> 
    141         <li> Some template tags can accept optional parameters between the parenthesis  
    142           <strong>()</strong>.</li> 
    143         <li>To add a parameter to a tag, enclose it between quotes and put it  
    144           between the <strong>()</strong>.<br /> 
    145           Example: <code>&lt;?php my_tag("my parameter"); ?></code></li> 
    146         <li>You may have to put several parameters, for that you separate them  
    147           with commas.<br /> 
    148           Example: <code>&lt;?php my_tag("first param","second param"); ?></code></li> 
    149         <li>The order of parameters is important. If a function accepts 2 parameters  
    150           and you only want to set the second one, you still have to provide the  
    151           first one, and so on for any number of parameters.<br /> 
    152           Example: <code>&lt;?php my_tag("","second param"); ?></code></li> 
    153         <li>Some template tags, like the_date(), display something only if in  
    154           some conditions. They generally accept parameters to display something  
    155           before and after them only when they display something.<br /> 
    156           Example: <code>&lt;?php the_title("&lt;h1>","&lt;/h1>"); ?></code> would  
    157           display &lt;h1>title of the post&lt;/h1> only if the post has a title<br /> 
    158           <br /> 
     153        <li> Some template tags can accept optional parameters between 
     154the parenthesis <strong>()</strong>.</li> 
     155        <li>To add a parameter to a tag, enclose it between quotes and 
     156put it between the <strong>()</strong>.<br> 
     157Example: <code>&lt;?php my_tag("my parameter"); ?&gt;</code></li> 
     158        <li>You may have to put several parameters, for that you 
     159separate them with commas.<br> 
     160Example: <code>&lt;?php my_tag("first param","second param"); ?&gt;</code></li> 
     161        <li>The order of parameters is important. If a function accepts 
     1622 parameters and you only want to set the second one, you still have to 
     163provide the first one, and so on for any number of parameters.<br> 
     164Example: <code>&lt;?php my_tag("","second param"); ?&gt;</code></li> 
     165        <li>Some template tags, like the_date(), display something only 
     166if in some conditions. They generally accept parameters to display 
     167something before and after them only when they display something.<br> 
     168Example: <code>&lt;?php the_title("&lt;h1&gt;","&lt;/h1&gt;"); ?&gt;</code> 
     169would display &lt;h1&gt;title of the post&lt;/h1&gt; only if the post 
     170has a title<br> 
     171          <br> 
    159172        </li> 
    160173      </ol> 
    161174      <h1>Template tags:</h1> 
    162       <blockquote> <strong>&lt;?php the_date() ?&gt;</strong> <span style="font-family: 'Courier New',Courrier,mono; color: #ff9900; font-weight: bold;">*</span><br /> 
    163         the date of the post. example: 03.07.01 (default is dd.mm.yy).<br /> 
    164         the date is displayed only on new days. for example if you got 10 posts  
    165         on the same day, the date for this day is displayed only once.<br /> 
    166         <div class="params">Parameters:  
    167           <ul> 
    168             <li>format string (default: "d.m.y")</li> 
    169             <li>string to display before the date (default is blank)</li> 
    170             <li>string to display after the date (default is blank)</li> 
    171           </ul> 
    172         </div> 
    173         <br /> 
    174         <strong>&lt;?php the_time() ?&gt;</strong><br /> 
    175         the time of the post. example: 18:37:00 (default is hh:mm:ss)<br /> 
    176         <div class="params">Parameters:  
    177           <ul> 
    178             <li>format string (default: "H:i:s")</li> 
    179           </ul> 
    180         </div> 
    181         <br /> 
    182         <strong>Note:</strong> you can change the way the date &amp; time are  
    183         displayed in the Options page.<br /> 
    184         once you understand the format strings for the date &amp; time (explained  
    185         in the Options page), you can change the display right on the template:  
    186         for example, <strong>the_date(</strong><em>&quot;d.m.Y&quot;</em><strong>)</strong>  
    187         to have dates like 25.12.2001, <strong>the_time(</strong><em>&quot;B&quot;</em><strong>)</strong>  
    188         to have Swatch Internet Time.<br /> 
    189         If you change the display of the date on the template, changing it from  
    190         the options page won't have any effect.br /> <br /> 
    191         <strong>Note about the_date():</strong> if you want all your posts to  
    192         bear the date, you'll have to use the_time() instead, with a date format  
    193         string. for example, to have all your posts show like &quot;25.12.2001  
    194         @ 8:04:50 AM&quot; you'll have the_time(&quot;d.m.Y @ g:i:s A&quot;).  
    195         you can also repeat this template tag 2 times with 2 different formats:  
    196         the_time(&quot;d.m.Y&quot;) for the date, and then later the_time(&quot;g:i:s  
    197         A&quot;) for the time of the day.<br /> 
    198         <br /> 
    199         <strong>&lt;?php the_weekday() ?&gt;</strong><br /> 
    200         This displays the day of the week when the post was made. It works like  
    201         the_time(), in that it would appear at every post. Weekdays can be obtained  
    202         with a custom date format string in the_time() or the_date(), but for  
    203         non-english weekdays you have to edit day-month-trans.php<br /> 
    204         <strong>Note: this tag is OBSOLETE, the_time() and the_date() now use  
    205         weekdays/months from day-month-trans.php</strong><br /> 
    206         <br /> 
    207         <strong>&lt;?php the_weekday_date() ?&gt;</strong> <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    208         Like the_weekday(), but works like the_date(), in that it would appear  
    209         only on new days.<br /> 
    210         <strong>Note: this tag is OBSOLETE, the_time() and the_date() now use  
    211         weekdays/months from day-month-trans.php</strong><br /> 
    212         <div class="params">Parameters:  
    213           <ul> 
    214             <li>string to display before the weekday_date (default is blank)</li> 
    215             <li>string to display after the weekday_date (default is blank)</li> 
    216           </ul> 
    217         </div> 
    218         <br /> 
    219         <br /> 
    220         <strong>&lt;?php the_ID() ?&gt;<br /> 
    221         </strong>the ID (number) of the post.<br /> 
    222         <br /> 
    223         <strong>&lt;?php the_title() ?&gt;<br /> 
    224         </strong>The title of the post.<br /> 
    225         <div class="params">Parameters:  
    226           <ul> 
    227             <li>string to display before the title (default is blank)</li> 
    228             <li>string to display after the title (default is blank)</li> 
    229           </ul> 
    230         </div> 
    231         <br /> 
    232         <br /> 
    233         <strong>&lt;?php the_content() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    234         </strong>The text of the post.<br /> 
    235         <div class="params">Parameters:  
    236           <ul> 
    237             <li>text to display for the link to the complete entry (default is  
    238               <em>'(more...)'</em>)</li> 
    239             <li>0 or 1, whether you want to show the teaser message or not, when  
    240               showing the complete text (default is 1)</li> 
    241             <li>a filename of another template, if you want the 'more' link to  
    242               link to a different template for the complete text of the extended  
    243               entry (default is the current template)</li> 
    244           </ul> 
    245         </div> 
    246         <br /> 
    247         For example <em>&lt;?php the_content(&quot;read more&quot;,&quot;0&quot;,&quot;blah.php&quot;)  
    248         ?&gt;</em> would display a link to <em>blah.php</em>, with the link text  
    249         <em>read more</em>, and won't display the teaser message.<br /> 
    250         <br /> 
    251         <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span>  
    252         To enter an extended entry, just type <em>&lt;!--more--&gt;</em> in your  
    253         entry. The part before that comment is the teaser, the part after it is  
    254         the extended entry. To force the extended entry not to show the teaser  
    255         message, type <em>&lt;!--noteaser--&gt;</em> somewhere in your entry.<br /> 
    256         <br /> 
    257         <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span>  
    258         To enter an entry with several pages, just type <em>&lt;!--nextpage--&gt;</em>  
    259         in your entry to start a new page.<br /> 
    260         <br /> 
    261         <br /> 
    262         <strong>&lt;?php next_post() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    263         </strong>Displays a link to the next post(s). (Generally you might want  
    264         to use that tag only in single-post templates)<br /> 
    265         <div class="params">Parameters:  
    266           <ul> 
    267             <li>format string for the link (default is "%", where % is replaced  
    268               with the title of the next post)</li> 
    269             <li>text to display to announce the link (default is "next post: ")</li> 
    270             <li>"yes" or "no": display the title of the post, or no (default is  
    271               "yes")</li> 
    272             <li>"yes" or "no": display a link to the next post only if the next  
    273               post is in the same category (default is "no")</li> 
    274             <li>number: which next post ? if you make it '2', the 2nd next post  
    275               is linked instead of the 1st next one (default is "1", which means  
    276               first next post)</li> 
    277           </ul> 
    278         </div> 
    279         <br /> 
    280         <br /> 
    281         <strong>&lt;?php previous_post() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    282         </strong>Displays a link to the previous post(s). (Generally you might  
    283         want to use that tag only in single-post templates)<br /> 
    284         <div class="params">Parameters:  
    285           <ul> 
    286             <li>format string for the link (default is "%", where % is replaced  
    287               with the title of the previous post)</li> 
    288             <li>text to display to announce the link (default is "previous post:  
    289               ")</li> 
    290             <li>"yes" or "no": display the title of the post, or no (default is  
    291               "yes")</li> 
    292             <li>"yes" or "no": display a link to the next post only if the previous  
    293               post is in the same category (default is "no")</li> 
    294             <li>number: which previous post ? if you make it '2', the 2nd previous  
    295               post is linked instead of the 1st previous post (default is "1",  
    296               which means first previous post)</li> 
    297           </ul> 
    298         </div> 
    299         <br /> 
    300         <br /> 
    301         <strong>&lt;?php next_posts() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    302         </strong>Display the URL portion of a link to the next set of posts. <br /> 
    303         Generally you would use this in a template to navigate to the next "set"  
    304         of posts when the "Show Options" settings for the site is set to "posts  
    305         paged". The displayed string can be used to construct a link. When the  
    306         site options are not set to 'posts paged", the next and previous functions  
    307         will display nothing.<br /> 
    308         <div class="params">Parameters:  
    309           <ul> 
    310             <li>Max page number to use. Default "0"; no limit</li> 
    311           </ul> 
    312         </div> 
    313         <br /> 
    314         <br /> 
    315         <strong>&lt;?php next_posts_link() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    316         </strong> Displays a full link to the next "set" of posts only if show  
    317         options set to "posts paged" and only if there is another page or partial  
    318         page of data.<br /> 
    319         <div class="params">Parameters:  
    320           <ul> 
    321             <li>A user supplied string. Default "Next Page &gt;&gt;"</li> 
    322           </ul> 
    323         </div> 
    324         <br /> 
    325         <br /> 
    326         <strong>&lt;?php previous_posts() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    327         </strong>Displays the URL portion of a link to the previous posts.<br /> 
    328         Generally you would use this in a template to navigate to the previous  
    329         "set" of posts when the "Show Options" settings for the site is set to  
    330         "posts paged". The displayed string can then be used to construct a link.  
    331         When the site options are not set to 'posts paged", the next and previous  
    332         functions will display nothing.<br /> 
    333         <div class="params">Parameters:  
    334           <ul> 
    335             <li>No parameters.</li> 
    336           </ul> 
    337         </div> 
    338         <br /> 
    339         <br /> 
    340         <strong>&lt;?php previous_posts_link() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    341         </strong> Displays a full link to the previous "set" of posts only if  
    342         show options set to "posts paged" and if there is a previous set, otherwise  
    343         nothing is displayed.<br /> 
    344         <div class="params">Parameters:  
    345           <ul> 
    346             <li>A user supplied string. Default "&lt;&lt; Previous Page"</li> 
    347           </ul> 
    348         </div> 
    349         <br /> 
    350         <br /> 
    351         <strong>&lt;?php posts_nav_link() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    352         </strong>The function displays a complete navigation set of links including  
    353         a user definable "separator" with the ability to supply a the text string  
    354         to be used for the "previous" and "next" links.<br /> 
    355         The default result will produce the following string:<br /> 
     175      <blockquote> <strong>&lt;?php the_date() ?&gt;</strong> <span 
     176 style="font-family: 'Courier New',Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     177the date of the post. example: 03.07.01 (default is dd.mm.yy).<br> 
     178the date is displayed only on new days. for example if you got 10 posts 
     179on the same day, the date for this day is displayed only once.<br> 
     180        <div class="params">Parameters: 
     181        <ul> 
     182          <li>format string (default: "d.m.y")</li> 
     183          <li>string to display before the date (default is blank)</li> 
     184          <li>string to display after the date (default is blank)</li> 
     185        </ul> 
     186        </div> 
     187        <br> 
     188        <strong>&lt;?php the_time() ?&gt;</strong><br> 
     189the time of the post. example: 18:37:00 (default is hh:mm:ss)<br> 
     190        <div class="params">Parameters: 
     191        <ul> 
     192          <li>format string (default: "H:i:s")</li> 
     193        </ul> 
     194        </div> 
     195        <br> 
     196        <strong>Note:</strong> you can change the way the date &amp; 
     197time are displayed in the Options page.<br> 
     198once you understand the format strings for the date &amp; time 
     199(explained in the Options page), you can change the display right on 
     200the template: for example, <strong>the_date(</strong><em>"d.m.Y"</em><strong>)</strong> 
     201to have dates like 25.12.2001, <strong>the_time(</strong><em>"B"</em><strong>)</strong> 
     202to have Swatch Internet Time.<br> 
     203If you change the display of the date on the template, changing it from 
     204the options page won't have any effect.br /&gt; <br> 
     205        <strong>Note about the_date():</strong> if you want all your 
     206posts to bear the date, you'll have to use the_time() instead, with a 
     207date format string. for example, to have all your posts show like 
     208"25.12.2001 @ 8:04:50 AM" you'll have the_time("d.m.Y @ g:i:s A"). you 
     209can also repeat this template tag 2 times with 2 different formats: 
     210the_time("d.m.Y") for the date, and then later the_time("g:i:s A") for 
     211the time of the day.<br> 
     212        <br> 
     213        <strong>&lt;?php the_weekday() ?&gt;</strong><br> 
     214This displays the day of the week when the post was made. It works like 
     215the_time(), in that it would appear at every post. Weekdays can be 
     216obtained with a custom date format string in the_time() or the_date(), 
     217but for non-english weekdays you have to edit day-month-trans.php<br> 
     218        <strong>Note: this tag is OBSOLETE, the_time() and the_date() 
     219now use weekdays/months from day-month-trans.php</strong><br> 
     220        <br> 
     221        <strong>&lt;?php the_weekday_date() ?&gt;</strong> <span 
     222 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     223Like the_weekday(), but works like the_date(), in that it would appear 
     224only on new days.<br> 
     225        <strong>Note: this tag is OBSOLETE, the_time() and the_date() 
     226now use weekdays/months from day-month-trans.php</strong><br> 
     227        <div class="params">Parameters: 
     228        <ul> 
     229          <li>string to display before the weekday_date (default is 
     230blank)</li> 
     231          <li>string to display after the weekday_date (default is 
     232blank)</li> 
     233        </ul> 
     234        </div> 
     235        <br> 
     236        <br> 
     237        <strong>&lt;?php the_ID() ?&gt;<br> 
     238        </strong>the ID (number) of the post.<br> 
     239        <br> 
     240        <strong>&lt;?php the_title() ?&gt;<br> 
     241        </strong>The title of the post.<br> 
     242        <div class="params">Parameters: 
     243        <ul> 
     244          <li>string to display before the title (default is blank)</li> 
     245          <li>string to display after the title (default is blank)</li> 
     246        </ul> 
     247        </div> 
     248        <br> 
     249        <br> 
     250        <strong>&lt;?php the_content() ?&gt; <span 
     251 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     252        </strong>The text of the post.<br> 
     253        <div class="params">Parameters: 
     254        <ul> 
     255          <li>text to display for the link to the complete entry 
     256(default is <em>'(more...)'</em>)</li> 
     257          <li>0 or 1, whether you want to show the teaser message or 
     258not, when showing the complete text (default is 1)</li> 
     259          <li>a filename of another template, if you want the 'more' 
     260link to link to a different template for the complete text of the 
     261extended entry (default is the current template)</li> 
     262        </ul> 
     263        </div> 
     264        <br> 
     265For example <em>&lt;?php the_content("read more","0","blah.php") ?&gt;</em> 
     266would display a link to <em>blah.php</em>, with the link text <em>read 
     267more</em>, and won't display the teaser message.<br> 
     268        <br> 
     269        <span 
     270 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span> 
     271To enter an extended entry, just type <em>&lt;!--more--&gt;</em> in 
     272your entry. The part before that comment is the teaser, the part after 
     273it is the extended entry. To force the extended entry not to show the 
     274teaser message, type <em>&lt;!--noteaser--&gt;</em> somewhere in your 
     275entry.<br> 
     276        <br> 
     277        <span 
     278 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span> 
     279To enter an entry with several pages, just type <em>&lt;!--nextpage--&gt;</em> 
     280in your entry to start a new page.<br> 
     281        <br> 
     282        <br> 
     283        <strong>&lt;?php next_post() ?&gt; <span 
     284 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     285        </strong>Displays a link to the next post(s). (Generally you 
     286might want to use that tag only in single-post templates)<br> 
     287        <div class="params">Parameters: 
     288        <ul> 
     289          <li>format string for the link (default is "%", where % is 
     290replaced with the title of the next post)</li> 
     291          <li>text to display to announce the link (default is "next 
     292post: ")</li> 
     293          <li>"yes" or "no": display the title of the post, or no 
     294(default is "yes")</li> 
     295          <li>"yes" or "no": display a link to the next post only if 
     296the next post is in the same category (default is "no")</li> 
     297          <li>number: which next post ? if you make it '2', the 2nd 
     298next post is linked instead of the 1st next one (default is "1", which 
     299means first next post)</li> 
     300        </ul> 
     301        </div> 
     302        <br> 
     303        <br> 
     304        <strong>&lt;?php previous_post() ?&gt; <span 
     305 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     306        </strong>Displays a link to the previous post(s). (Generally 
     307you might want to use that tag only in single-post templates)<br> 
     308        <div class="params">Parameters: 
     309        <ul> 
     310          <li>format string for the link (default is "%", where % is 
     311replaced with the title of the previous post)</li> 
     312          <li>text to display to announce the link (default is 
     313"previous post: ")</li> 
     314          <li>"yes" or "no": display the title of the post, or no 
     315(default is "yes")</li> 
     316          <li>"yes" or "no": display a link to the next post only if 
     317the previous post is in the same category (default is "no")</li> 
     318          <li>number: which previous post ? if you make it '2', the 2nd 
     319previous post is linked instead of the 1st previous post (default is 
     320"1", which means first previous post)</li> 
     321        </ul> 
     322        </div> 
     323        <br> 
     324        <br> 
     325        <strong>&lt;?php next_posts() ?&gt; <span 
     326 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     327        </strong>Display the URL portion of a link to the next set of 
     328posts. <br> 
     329Generally you would use this in a template to navigate to the next 
     330"set" of posts when the "Show Options" settings for the site is set to 
     331"posts paged". The displayed string can be used to construct a link. 
     332When the site options are not set to 'posts paged", the next and 
     333previous functions will display nothing.<br> 
     334        <div class="params">Parameters: 
     335        <ul> 
     336          <li>Max page number to use. Default "0"; no limit</li> 
     337        </ul> 
     338        </div> 
     339        <br> 
     340        <br> 
     341        <strong>&lt;?php next_posts_link() ?&gt; <span 
     342 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     343        </strong> Displays a full link to the next "set" of posts only 
     344if show options set to "posts paged" and only if there is another page 
     345or partial page of data.<br> 
     346        <div class="params">Parameters: 
     347        <ul> 
     348          <li>A user supplied string. Default "Next Page &gt;&gt;"</li> 
     349        </ul> 
     350        </div> 
     351        <br> 
     352        <br> 
     353        <strong>&lt;?php previous_posts() ?&gt; <span 
     354 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     355        </strong>Displays the URL portion of a link to the previous 
     356posts.<br> 
     357Generally you would use this in a template to navigate to the previous 
     358"set" of posts when the "Show Options" settings for the site is set to 
     359"posts paged". The displayed string can then be used to construct a 
     360link. When the site options are not set to 'posts paged", the next and 
     361previous functions will display nothing.<br> 
     362        <div class="params">Parameters: 
     363        <ul> 
     364          <li>No parameters.</li> 
     365        </ul> 
     366        </div> 
     367        <br> 
     368        <br> 
     369        <strong>&lt;?php previous_posts_link() ?&gt; <span 
     370 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     371        </strong> Displays a full link to the previous "set" of posts 
     372only if show options set to "posts paged" and if there is a previous 
     373set, otherwise nothing is displayed.<br> 
     374        <div class="params">Parameters: 
     375        <ul> 
     376          <li>A user supplied string. Default "&lt;&lt; Previous Page"</li> 
     377        </ul> 
     378        </div> 
     379        <br> 
     380        <br> 
     381        <strong>&lt;?php posts_nav_link() ?&gt; <span 
     382 style="font-family: Courier New,Courrier,mono; color: rgb(255, 153, 0); font-weight: bold;">*</span><br> 
     383        </strong>The function displays a complete navigation set of 
     384links including a user definable "separator" with the ability to supply 
     385a the text string to be used for the "previous" and "next" links.<br> 
     386The default result will produce the following string:<br> 
    356387        <p align="center">&lt;&lt; Previous Page :: Next Page &gt;&gt;</p> 
    357         <div class="params">Parameters:  
    358           <ul> 
    359             <li>A user supplied "separator" string. Default " :: "</li> 
    360             <li>A user supplied "previous" string. Default "&lt;&lt; Previous  
    361               Page"</li> 
    362             <li>A user supplied "next" string. Default "Next Page &gt;&gt;"</li> 
    363           </ul> 
    364         </div> 
    365         <br /> 
    366         <br /> 
    367         <strong>&lt;?php link_pages() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    368         </strong>Displays links to the pages of the post if it's a multiple pages  
    369         post.<br /> 
    370         <div class="params">Parameters:  
    371           <ul> 
    372             <li>string to display before the tag (default is "&lt;br />", a newline)</li> 
    373             <li>string to display after the tag (default is "&lt;br />", a newline)</li> 
    374             <li>"next" or "number": display links like "next/previous page" or  
    375               links to each page with the number of the page "1 2 3 4 etc" (default  
    376               is "number")</li> 
    377             <li>string to display the "next page" link (default is "next page")</li> 
    378             <li>string to display the "previous page" link (default is "previous  
    379               page")</li> 
    380             <li>format string for the "number of page" link (default is "%", where  
    381               % is replaced by the number of the page)</li> 
    382             <li>file name, in case you want to load the posts with multiple pages  
    383               in a different template (default is the current template)</li> 
    384           </ul> 
    385         </div> 
    386         <br /> 
    387         <br /> 
    388         <strong>&lt;?php the_author() ?&gt;</strong><br /> 
    389         The author of the post.<br /> 
    390         Depending on the user's profile settings, it can display whether their  
    391         nickname, login name, first name, last name, both first&amp; last name,  
    392         or last &amp; first name. look below for more author-related template  
    393         tags. <br /> 
    394         <br /> 
    395         <strong>&lt;?php the_category() ?&gt;<br /> 
    396         </strong>the name of the category the post belongs to. you can as an admin  
    397         add categories, and rename them if needed. default category is 'General',  
    398         you can rename it too.<br /> 
    399         <br /> 
    400         <strong>&lt;?php the_category_ID() ?&gt;<br /> 
    401         </strong>The ID (number) of the category the post belongs to. This is  
    402         static data thatyou can use, for example to associate a category to an  
    403         image, or a css style.<br /> 
    404         <br /> 
    405         <strong>&lt;?php trackback_rdf() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span></strong><br /> 
    406         This will include the RDF data that can be used by some weblog tools to  
    407         locate your posts' trackback URLs.<br /> 
    408         You should put this tag after the &lt;?php the_content() ?&gt; tag in  
    409         your template, or just before the end of the loop.<br /> 
    410         <br /> 
    411         <strong>&lt;?php dropdown_cats() ?&gt;<br /> 
    412         </strong>this is a special tag, meant to be used in the template, but  
    413         outside of the b2 loop. it will display a list of &lt;option name="<em>x</em>"><em>category-name</em>&lt;/option>,  
    414         where <em>x</em> is the number of the category and <em>category-name</em>  
    415         is the name of it.<br /> 
    416         <div class="params">Parameters:  
    417           <ul> 
    418             <li>0 or 1, depending if you want to have an option to display all  
    419               categories (default is 1)</li> 
    420             <li>text to display for the option to show all categories (default  
    421               is "All")</li> 
    422           </ul> 
    423         </div> 
    424         <br /> 
    425         you can use it like this: <br /> 
    426         <br /> 
    427         <code>&lt;form action="&lt;?php echo $PHP_SELF ?>" method="get"><br /> 
    428         &lt;?php dropdown_cats() ?><br /> 
    429         &lt;input type="submit" name="submit" value="view" /><br /> 
    430         &lt;/form></code> <br /> 
    431         <br /> 
    432         <strong>&lt;?php list_cats() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    433         </strong>this is a special tag, meant to be used in the template, but  
    434         outside of the b2 loop. it will display a list of the categories, with  
    435         links to them. like in b2archive.php, each category is on a line, the  
    436         only way you can change this is by editing b2.template.functions.php<br /> 
    437         <div class="params">Parameters:  
    438           <ul> 
    439             <li>0 or 1, depending if you want to have an option to display all  
    440               categories (default is 1)</li> 
    441             <li>text to display for the option to show all categories (default  
    442               is 'All')</li> 
    443             <li>sort by: possible values are 'name' and 'ID' (default is 'ID')</li> 
    444             <li>sorting order: possible values are 'asc' for ascending or 'desc'  
    445               for descending (default is 'asc')</li> 
    446             <li>filename, in case you want to display the categories' posts in  
    447               another template (default is current template)</li> 
    448           </ul> 
    449         </div> 
    450         <br /> 
    451         <strong>&lt;?php bloginfo() ?&gt;</strong> <span style="font-family: 'Courier New',Courrier,mono; color: #ff9900; font-weight: bold;">*</span><br /> 
    452         This tag is out of the b2 loop.<br /> 
    453         It outputs info about your weblog.<br /> 
    454         <div class="params">Parameters:  
    455           <ul> 
    456             <li>string: can be 'name' to display the name of your weblog (you  
    457               set it in the options page), 'url', 'description', 'admin_email', 'rss_url'  
    458               to display the URL of your b2rss.xml file, 'pingback_url' to display  
    459               the URL of your xmlrpc.php file<br /> 
    460               (default string is 'name')</li> 
    461           </ul> 
    462         </div> 
    463         <br /> 
    464         <strong>&lt;?php single_post_title() ?&gt;</strong> <span style="font-family: 'Courier New',Courrier,mono; color: #ff9900; font-weight: bold;">*</span><br /> 
    465         This tag is out of the b2 loop.<br /> 
    466         It outputs the title of the post when you load the page with ?p= (see  
    467         'Usage' section for explanation). When the weblog page is loaded without  
    468         ?p=, this tag doesn't display anything. Generally, you could use it like  
    469         this:<br /> 
    470         &nbsp; &nbsp;&lt;title&gt;&lt;?php bloginfo('name') ?&gt;&lt;?php single_post_title()  
    471         ?&gt;&lt;/title&gt;<br /> 
    472         <div class="params">Parameters:  
    473           <ul> 
    474             <li>prefix string that will appear before the post's title (default  
    475               is ' :: ')</li> 
    476           </ul> 
    477         </div> 
    478         <br /> 
    479         <strong>&lt;?php single_cat_title() ?&gt;</strong> <span style="font-family: 'Courier New',Courrier,mono; color: #ff9900; font-weight: bold;">*</span><br /> 
    480         This tag is out of the b2 loop.<br /> 
    481         It outputs the title of the category when you load the page with ?cat=  
    482         (see 'Usage' section for explanation). When the weblog page is loaded  
    483         without ?cat=, this tag doesn't display anything. Generally, you could  
    484         use it like this:<br /> 
    485         &nbsp; &nbsp;&lt;title&gt;&lt;?php bloginfo('name') ?&gt;&lt;?php single_cat_title()  
    486         ?&gt;&lt;/title&gt;<br /> 
    487         <div class="params">Parameters:  
    488           <ul> 
    489             <li>prefix string that will appear before the category's title (default  
    490               is ' :: ')</li> 
    491           </ul> 
    492         </div> 
    493         <br /> 
    494         <strong>&lt;?php single_month_title() ?&gt;</strong> <span style="font-family: 'Courier New',Courrier,mono; color: #ff9900; font-weight: bold;">*</span><br /> 
    495         This tag is out of the b2 loop.<br /> 
    496         It outputs the name of the month when you load the page with ?m= (see  
    497         'Usage' section for explanation). When the weblog page is loaded without  
    498         ?m=, this tag doesn't display anything. Generally, you could use it like  
    499         this:<br /> 
    500         &nbsp; &nbsp;&lt;title&gt;&lt;?php bloginfo('name') ?&gt;&lt;?php single_month_title()  
    501         ?&gt;&lt;/title&gt;<br /> 
    502         <div class="params">Parameters:  
    503           <ul> 
    504             <li>prefix string that will appear before the month's name (default  
    505               is ' :: ')</li> 
    506           </ul> 
    507         </div> 
    508         <br /> 
    509         <strong>Note:</strong> The above three functions can be used together  
    510         to produce the Title of the page:<br> 
    511         &nbsp; &nbsp;&lt;title&gt;&lt;?php bloginfo('name') ?&gt;&lt;?php single_post_title('  
    512         :: ') ?&gt;&lt;?php single_cat_title(' :: ') ?&gt;&lt;?php single_month_title('  
    513         :: ') ?&gt;&lt;/title&gt;<br /> 
    514         Only one, if any, of these functions will produce output, thus the page  
    515         Title can be customize to the task being done. <br /> 
    516         <br /> 
    517         <br /> 
    518         <strong>More about the author</strong> of the post ? Here goes:<br /> 
    519         <br /> 
    520         <strong>&lt;?php the_author_email() ?&gt; - </strong> the author's email.<br /> 
    521         <strong>&lt;?php the_author_url() ?&gt;</strong> - the author's url.<br /> 
    522         <strong>&lt;?php the_author_email() ?&gt;</strong> - the author's number  
    523         of posts.<br /> 
    524         <strong>&lt;?php the_author_icq() ?&gt;</strong> - the author's ICQ number.<br /> 
    525         <strong>&lt;?php the_author_aim() ?&gt;</strong> - the author's AIM handle.<br /> 
    526         <strong>&lt;?php the_author_yim() ?&gt;</strong> - the author's Yahoo  
    527         Messenger handle.<br /> 
    528         <strong>&lt;?php the_author_msn() ?&gt;</strong> - the author's MSN Messenger  
    529         handle.<br /> 
    530         <strong>&lt;?php the_author_posts() ?&gt;</strong> - the author's post  
    531         count.<br /> 
    532         <strong>&lt;?php the_author_login() ?&gt;</strong> - the author's login  
    533         name in b2. If you want some static data about the author, this is what  
    534         you're searching for. You can, for example, associate a picture with an  
    535         author, like this: <em>&lt;img src=&quot;pictures/&lt;?php the_author_login()  
    536         ?&gt;.jpg&quot; border=&quot;0&quot;&gt;</em><br /> 
    537         <strong>&lt;?php the_author_ID() ?&gt;</strong> - the author's ID number  
    538         in b2. This number is automatically set when the user registers: to see  
    539         the ID of an user, go to the Team page. This is static data too, so you  
    540         can use it like the_author_login() in associating stuff with authors.<br /> 
    541         <br /> 
    542         <strong><br /> 
    543         Tags for permalinks</strong> are:<br /> 
    544         <br /> 
    545         <strong>&lt;?php permalink_anchor() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span></strong><br /> 
    546         this will display &lt;a name=&quot;...&quot;&gt;&lt;/a&gt;, replacing  
    547         &quot;...&quot; with the ID or the title of the post in the database.<br /> 
    548         <br /> 
    549         <div class="params">Parameters:  
    550           <ul> 
    551             <li>string for kind of anchor: either 'id' that displays '50', or  
    552               'title' that displays 'title_of_post_50' (default is 'id')</li> 
    553           </ul> 
    554         </div> 
    555         <br /> 
    556         <strong>&lt;?php permalink_link() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    557         </strong>this will display the name of the file followed by #ID to link  
    558         to the post, in the month archive if archive-mode is "monthly".<br /> 
    559         note: this tag does not display the link, for this you've got to type  
    560         &lt;a href=&quot;&lt;?php permalink_link() ?&gt;&quot;&gt;text of the  
    561         link&lt;/a&gt;.<br /> 
    562         <div class="params">Parameters:  
    563           <ul> 
    564             <li>file name, in case you want to link the archive to a different  
    565               template (default is the current template)</li> 
    566             <li>string for kind of link: either 'id' that appends '#50' to the  
    567               link, or 'title' that appends '#title_of_post_50' (default is 'id')</li> 
    568           </ul> 
    569         </div> 
    570         <br /> 
    571         <br /> 
    572         <strong>&lt;?php permalink_single() ?&gt; <span style="font-family: Courier New, Courrier, mono; color: #ff9900; font-weight:bold;">*</span><br /> 
    573         </strong>this will display the name of the file followed by #ID to link  
    574         to the entire