Changeset 95

Show
Ignore:
Timestamp:
05/25/03 01:27:25 (5 years ago)
Author:
saxmatt
Message:

Some markup and grammar cleanups.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/readme.html

    r77 r95  
    1414        padding-bottom: 2px; 
    1515    } 
    16     h1 { font-family: georgia,times new roman,serif; font-size: 18px; font-weight: lighter; color: #006; } 
     16    h1 { 
     17    font-size: 18px; 
     18    font-weight: lighter; 
     19    color: #006; 
     20    } 
     21    h2 { 
     22        font-size: 16px; 
     23    } 
    1724    .params { 
    1825        border-color: #cccccc; 
    …… 
    2330        margin-left: 20px; 
    2431        margin-right: 80px; 
    25         font-family: arial,helvetica,sans-serif; font-size:12px; 
     32        font-family: arial,helvetica,sans-serif; 
     33        font-size:12px; 
    2634    } 
    2735    ul, ol { margin: 0px; padding: 0px; padding-left: 20px; padding-top: 5px; padding-right: 5px; padding-bottom: 5px; } 
    …… 
    3745        <font size="2" face="Georgia, Times New Roman, Times, serif">0.7</font></p> 
    3846      <p align="center">Weblog / News Publishing Tool</p> 
    39       <p align="center"><a href="#requirements">requirements</a> - <a href="#installation">installation</a>  
    40         - <a href="#templates">template(s)</a> - <a href="#usage">querystring  
    41         usage</a> - <a href="#xmlrpc">xmlrpc (Blogger API)</a> - <a href="#postviaemail">post  
    42         via email</a> - <a href="#notes">notes</a></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> 
    4351      <a name="requirements"></a> <h1>Requirements:</h1> 
    4452      <ul> 
    …… 
    5664        as WordPress matures.</p> 
    5765      <h1 id="installation">Installation:</h1> 
    58       <p>New users: 5-minute install.</p> 
     66      <h2>New users: 5-minute install.</h2> 
    5967      <ol> 
    6068        <li>Unzip the package in an empty directory.</li> 
    …… 
    7785          Note: you need javascript enabled to launch the profile popup window.</li> 
    7886      </ol> 
    79       <p>Some notes:</p> 
     87      <h2>Some notes:</h2> 
    8088      <ul> 
    8189        <li>Whenever you want to post something, just open a browser and go to  
    …… 
    9199          it will work too ;)</li> 
    92100      </ul> 
    93       <p>Users upgrading from b2 v0.6.1 to WordPress v0.7:</p> 
     101      <h2>Users upgrading from b2 v0.6.1 to WordPress v0.7:</h2> 
    94102      <ul> 
    95103        <li>All you <em>really</em> have to do is replace all the files with newer  
    …… 
    109117          you. Right now.</li> 
    110118      </ul> 
    111       <h1 id="templates">Template(s):</h1> <p>First notes:</p> 
     119      <h1 id="templates">Template(s):</h1> 
     120      <h2>First notes:</h2> 
    112121      <ul> 
    113122        <li>Enclosed is an example of a template, in the file b2.php. You can  
    …… 
    128137          for your posts.</li> 
    129138      </ul> 
    130       <p>Notes about parameters:</p> 
    131       <blockquote><strong>1.</strong> Some template tags can accept optional parameters  
    132         between the parenthesis <strong>()</strong>.<br /> 
    133         <br /> 
    134         <strong>2.</strong> To add a parameter to a tag, enclose it between quotes  
    135         and put it between the <strong>()</strong>.<br /> 
    136         Example: &lt;?php my_tag("my parameter"); ?><br /> 
    137         <br /> 
    138         <strong>3.</strong> You may have to put several parameters, for that you  
    139         separate them with commas.<br /> 
    140         Example: &lt;?php my_tag("first param","second param"); ?><br /> 
    141         <br /> 
    142         <strong>4.</strong> The order of parameters is important. If a function  
    143         accepts 2 parameters and you only want to set the second one, you still  
    144         have to provide the first one, and so on for any number of parameters.<br /> 
    145         Example: &lt;?php my_tag("","second param"); ?><br /> 
    146         <br /> 
    147         <strong>5.</strong> Some template tags, like the_date(), display something  
    148         only if in some conditions. They generally accept parameters to display  
    149         something before and after them only when they display something.<br /> 
    150         Example: &lt;?php the_title("&lt;h1>","&lt;/h1>"); ?> would display &lt;h1>title  
    151         of the post&lt;/h1> only if the post has a title<br /> 
    152         <br /> 
    153       </blockquote> 
    154       <p>Template tags are these:</p> 
     139      <h2>Notes about parameters:</h2> 
     140      <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 /> 
     159        </li> 
     160      </ol> 
     161      <h1>Template tags:</h1> 
    155162      <blockquote> <strong>&lt;?php the_date() ?&gt;</strong> <span style="font-family: 'Courier New',Courrier,mono; color: #ff9900; font-weight: bold;">*</span><br /> 
    156163        the date of the post. example: 03.07.01 (default is dd.mm.yy).<br /> 
    …… 
    770777          &nbsp; &nbsp; <i>the style of the day if it is today</i> </div> 
    771778      </blockquote> 
    772       <a name="usage"></a> <h1>Usage:</h1> 
    773       <p>WordPress relies a lot on the querystring, these variables passed with  
     779      <a name="usage"></a> <h1>Query String Usage:</h1> 
     780      <p>WordPress relies a lot on the query string, these variables passed with  
    774781        the URL (note: to pass variables in the querystring, preceed the first  
    775782        variable name with a '?' question mark and every other variables with  
    …… 
    777784      <p>Most of the time you won't have to do anything about it, but if you want  
    778785        to know how it works, it's here:</p> 
    779       <p>How to use the QueryString:</p> 
     786      <p>How to use the query string:</p> 
    780787      <blockquote> index.php<strong>?m=200107</strong> will display the month  
    781788        of July 2001.<br /> 
    …… 
    832839        but only in July 2001. </blockquote> 
    833840      <p>&nbsp;</p> 
    834       <a name="xmlrpc"></a> <h1>XMLRPC Interface:</h1> 
     841      <a name="xmlrpc"></a> <h1>XML-RPC Interface:</h1> 
    835842      <p>WordPress now has a XMLRPC interface. The only API available right now  
    836843        is the Blogger API (complete specs <a href="http://www.tswoam.co.uk/blogger_method_listing.html">here</a>).  
    837844        There are talks about a new API that would cover a lot of weblog/CMS systems  
    838         in the future: when it's ready, WordPress will support it.<br /> 
    839         <br /> 
    840         The <a href="http://plant.blogger.com/api">Blogger API</a> has been completely  
    841         emulated on WordPress, with some little differences:</p> 
     845        in the future: when it's ready, WordPress will support it.</p> 
     846      <p> The <a href="http://plant.blogger.com/api">Blogger API</a> has been  
     847        completely emulated on WordPress, with some little differences:</p> 
    842848      <ul> 
    843849        <li>using <em>blogger.getRecentPosts</em> with the number 'zero' returns  
    …… 
    850856      </ul> 
    851857      <p>If you use blogger.newPost, your post is submitted without title and  
    852         in category #1.<br /> 
    853         <br /> 
    854         However, you can type &lt;title>my title&lt;/title> and/or &lt;category>2&lt;category>  
     858        in category #1.</p> 
     859      <p> However, you can type &lt;title>my title&lt;/title> and/or &lt;category>2&lt;category>  
    855860        in the body of your post to make its title be 'my title' and its category  
    856861        be #2 (refer to your categories section to find out the ID numbers of  
    857862        the categories). b2 would then delete that extra info from the body of  
    858         your post once it is posted.<br /> 
    859         <br /> 
    860         <br /> 
    861         You can now post to your b2 blog with tools like <a href="http://blogbuddy.sourceforge.net">BlogBuddy</a>,  
     863        your post once it is posted.</p> 
     864      <p> You can now post to your b2 blog with tools like <a href="http://blogbuddy.sourceforge.net">BlogBuddy</a>,  
    862865        <a href="http://bloggar.cjb.net">Bloggar</a>, <a href="http://www.ubique.ch/wapblogger/">WapBlogger</a>  
    863866        (post from your Wap cellphone!), <a href="http://radio.userland.com">Radio  
    864867        Userland</a> (which means you can use Radio's email-to-blog feature),  
    865         and other tools that support the Blogger API ! :)<br /> 
    866         <br /> 
    867         Your XMLRPC server/path are as described here: if you login to b2 on http://mydomain.com/me/b2login.php,  
    868         then you have:</p> 
     868        and other tools that support the Blogger API ! :)</p> 
     869      <p>Your XMLRPC server/path are as described here: if you login to b2 on  
     870        http://mydomain.com/me/b2login.php, then you have:</p> 
    869871      <ul> 
    870872        <li>server: http://mydomain.com/me</li> 
    …… 
    882884        But first you'll have to edit b2config.php, filling the appropriate values  
    883885        for your POP3 email account (this interface doesn't support IMAP yet,  
    884         only POP3, sorry).<br /> 
    885         <br /> 
    886         Once you have edited the config options, you can make your webserver execute  
    887         b2mail.php every set amount of time (depending on your host's performance,  
    888         this script can be resource intensive, so don't make it run every minute  
    889         or you'll be kicked).<br /> 
    890         You can do it with Cron-jobs, or if your host doesn't support it you can  
    891         look into the various website-monitoring services, and make them check  
    892         your b2mail.php URL.<br /> 
    893         <br /> 
    894         <b>Preliminary advice:</b><br /> 
    895         It is strongly advised to send your email as text-only (Outlook and Outlook  
    896         Express default to 'html', which may cause problems), but HTML email could  
    897         work (the script would strip all your html tags though...).<br /> 
    898         It is also advised not to use your public email address, but create a  
     886        only POP3, sorry).</p> 
     887      <p> Once you have edited the config options, you can make your webserver  
     888        execute b2mail.php every set amount of time (depending on your host's  
     889        performance, this script can be resource intensive, so don't make it run  
     890        every minute or you'll be kicked).</p> 
     891      <p>You can do it with Cron-jobs, or if your host doesn't support it you  
     892        can look into the various website-monitoring services, and make them check  
     893        your b2mail.php URL.</p> 
     894      <h2> Preliminary advice:</h2> 
     895      <p> It is strongly advised to send your email as text-only (Outlook and  
     896        Outlook Express default to 'html', which may cause problems), but HTML  
     897        email could work (the script would strip all your html tags though...).</p> 
     898      <p>It is also advised not to use your public email address, but create a  
    899899        new one especially for this script. If you use your public email address  
    900900        and the script goes crazy posting every email on your blog and deleting  
    901         all your emails, I can't take responsibility for this.<br /> 
    902         Make sure you delete any email sent to your blog in your 'Sent' folder  
     901        all your emails, I can't take responsibility for this.</p> 
     902      <p>Make sure you delete any email sent to your blog in your 'Sent' folder  
    903903        too, just in case (you don't want someone to find your login and password  
    904         in the 'Sent' folder).<br /> 
    905         <br /> 
    906         The script will <i>delete</i> the emails that were used to post stuff  
     904        in the 'Sent' folder).</p> 
     905      <p> The script will <i>delete</i> the emails that were used to post stuff  
    907906        on your weblog if it successfully posted your stuff. If it didn't manage  
    908         to post, the email is not deleted.<br /> 
    909         <br /> 
    910         <b>How to post:</b><br /> 
    911         Now to post something, here's how your email should look like:</p> 
     907        to post, the email is not deleted.</p> 
     908      <h2>How to post:</h2> 
     909      <p>Now to post something, here's how your email should look like:</p> 
    912910      <div class="params"> <b>To:</b> address@domain.com <span style='color: #999'>(you  
    913911        set it in the config file)</span><br /> 
    …… 
    919917        More blah blah. ___ </div> 
    920918      <p> Subject must start with 'blog:', or any string you set in the config  
    921         file (so that the script doesn't check EVERY email in your mailbox).<br /> 
    922         Body's first line must always be login:password, else the script will  
     919        file (so that the script doesn't check EVERY email in your mailbox).</p> 
     920      <p>Body's first line must always be login:password, else the script will  
    923921        just skip the email.<br /> 
    924922        If you don't use '___' (or any body terminator that you set in the config  
    925923        file), the script will post the whole body, which is not what you want  
    926924        if you send email with Yahoo or Hotmail (you don't want their ads on your  
    927         blog, do you ?).<br /> 
    928         <br /> 
    929         <b>Special cases for mobile phone email:</b><br /> 
    930         Some mobile phone service providers may allow you to send email with your  
    931         mobile phone or PDA, but on such devices you can't always include line  
    932         breaks. In such case, you have to set <i>$use_phoneemail = 1</i> in b2config.php,  
    933         and then here's how you write the email:</p> 
     925        blog, do you ?).</p> 
     926      <h2>Special cases for mobile phone email:</h2> 
     927      <p> Some mobile phone service providers may allow you to send email with  
     928        your mobile phone or PDA, but on such devices you can't always include  
     929        line breaks. In such case, you have to set <i>$use_phoneemail = 1</i>  
     930        in b2config.php, and then here's how you write the email:</p> 
    934931      <div class="params"> <b>To:</b> address@domain.com<br /> 
    935932        <b>Subject:</b> blog:the post's title <b>:::</b><br /> 
    …… 
    950947      <a name="notes"></a> <h1>Notes: </h1> 
    951948      <p>On multi-user:</p> 
    952       <blockquote>You don't invite users, they can register on b2register.php.<br /> 
    953         Then you (as an admin) click the &quot;+&quot; next to their name in the  
    954         user-list, to upgrade their level to 1 or more, so they can post. If you  
     949      <p>New users can register with <code>b2register.php</code>. Then you (as  
     950        an admin) click the &quot;+&quot; next to their name on the Team page  
     951        in admin to upgrade their level to 1 or more, so they can post. If you  
    955952        don't want an user to post anymore, just click &quot;-&quot; until their  
    956         level is 0.<br /> 
    957         Note: you can now disable users registration altogether from the config  
    958         file.<br /> 
    959         <strong>Levels</strong> are these:<br /> 
    960         0 - new user: can't post.<br /> 
    961         1 - user: can post &amp; edit/delete their own posts.<br /> 
    962         3 &amp; more - admin: can post, edit/delete other people's posts, and  
    963         change the options.<br /> 
    964         Any user whose level is higher than 1, can edit/delete the posts and change  
    965         the level of users whose level is inferior. Example: a level 2 user is  
    966         not an admin, but can edit the posts of level 1 users, and up the level  
    967         of a new user from 0 to 1.<br /> 
    968         <br /> 
    969         Usually, you'll want to have a team of only level 1 users except you.  
    970         ;)<br /> 
    971         <strong>Note:</strong> you can modify a variable in b2config.php, to enable  
    972         new users to post once they've registered.<br /> 
    973         If you don't want users to register on your blog at all, just delete b2register.php  
    974         once you've registered your user account.</blockquote> 
    975       <p><br /> 
    976         Final notes:</p> 
    977       <blockquote>  
    978         <p>WordPress is functionnal, but a lot of coding and code clean-up remain  
    979           to be done.</p> 
    980         <p>If you've got suggestions, ideas, or comments, or if you found a bug,  
    981           why not joining us in the <a href="http://wordpress.org/support/">Forums</a>?</p> 
    982         <p>If you can code in PHP, you'll see the structure of b2 is flexible  
    983           enough to allow for more functions and sections to be added.</p> 
    984       </blockquote> 
    985       <p><br /> 
    986         Copyright notes:</p> 
    987       <blockquote><br /> 
    988         Wherever third party code has been used, credit has been given in the  
    989         code's comments.<br /> 
    990         WordPress is released under the GPL (see license.txt).</blockquote></td> 
     953        level is 0.</p> 
     954      <p>Note: you can now disable users registration altogether from the config  
     955        file.</p> 
     956      <p><strong>Levels</strong>:</p> 
     957      <ul> 
     958        <li> 0 - new user: can't post.</li> 
     959        <li>1 - user: can post &amp; edit/delete their own posts.</li> 
     960        <li>3 &amp; more - admin: can post, edit/delete other people's posts,  
     961          and change the options.</li> 
     962        <li>Any user whose level is higher than 1, can edit/delete the posts and  
     963          change the level of users whose level is inferior. Example: a level  
     964          2 user is not an admin, but can edit the posts of level 1 users, and  
     965          up the level of a new user from 0 to 1.</li> 
     966      </ul> 
     967      <p>Usually, you'll want to have a team of only level 1 users except you.  
     968        ;)</p> 
     969      <p><strong>Note:</strong> you can modify a variable in b2config.php, to  
     970        enable new users to post once they've registered.</p> 
     971      <p>If you don't want users to register on your blog at all, just delete  
     972        b2register.php once you've registered your user account. </p> 
     973      <h1><br /> 
     974        Final notes:</h1> 
     975      <ul> 
     976        <li>WordPress is functionnal, but a lot of coding and code clean-up remain  
     977          to be done.</li> 
     978        <li>If you've got suggestions, ideas, or comments, or if you found a bug,  
     979          why not joining us in the <a href="http://wordpress.org/support/">Support  
     980          Forums</a>?</li> 
     981        <li>If you can code in PHP, you'll see the structure of b2 is flexible  
     982          enough to allow for more functions and sections to be added.</li> 
     983      </ul> 
     984      <h1><br /> 
     985        Copyright notes:</h1> 
     986      <ul> 
     987        <li> Wherever third party code has been used, credit has been given in  
     988          the code's comments.</li> 
     989        <li>WordPress is released under the GPL (see license.txt).</li> 
     990      </ul></td> 
    991991  </tr> 
    992992</table>