0.7
Weblog / News Publishing Tool
-requirements - installation - - template(s) - querystring - usage - xmlrpc (Blogger API) - post - via email - notes
+Requirements - Installation + - Template(s) - Query String + Usage - XML-RPC (Blogger API) - Post + Via Email - Notes
Requirements:
- PHP4 (version 4.0.6 or higher) @@ -55,7 +63,7 @@
- Unzip the package in an empty directory.
- Open b2config.php in a text editor, and modify the variables as explained @@ -76,7 +84,7 @@ script. Then click on the menu 'My Profile', and change the password. Note: you need javascript enabled to launch the profile popup window.
- Whenever you want to post something, just open a browser and go to b2login.php to log in and post. @@ -90,7 +98,7 @@
- You can also copy b2.php into a new file and modify that new file, it will work too ;)
- All you really have to do is replace all the files with newer versions and run b2-2-wp.php @@ -108,7 +116,8 @@
- Back up your database before you do anything. Yes, you. Right now.
- Enclosed is an example of a template, in the file b2.php. You can rename this file to "index.php"or something else (recent b2 @@ -127,31 +136,29 @@
- Between the "while" line and the "}", is the template for your posts.
- Some template tags can accept optional parameters between the parenthesis + (). +
- To add a parameter to a tag, enclose it between quotes and put it
+ between the ().
+ Example:<?php my_tag("my parameter"); ?>
+ - You may have to put several parameters, for that you separate them
+ with commas.
+ Example:<?php my_tag("first param","second param"); ?>
+ - The order of parameters is important. If a function accepts 2 parameters
+ and you only want to set the second one, you still have to provide the
+ first one, and so on for any number of parameters.
+ Example:<?php my_tag("","second param"); ?>
+ - Some template tags, like the_date(), display something only if in
+ some conditions. They generally accept parameters to display something
+ before and after them only when they display something.
+ Example:<?php the_title("<h1>","</h1>"); ?>would + display <h1>title of the post</h1> only if the post has a title
+
+
+ - using blogger.getRecentPosts with the number 'zero' returns all posts in the blog @@ -849,23 +855,19 @@ and $blogname, since b2 supports only one blog as of now
- server: http://mydomain.com/me
- path: /me/xmlrpc.php @@ -881,34 +883,30 @@
This document is currently beta stage, we'll be updating it extensively as WordPress matures.
Installation:
-New users: 5-minute install.
+New users: 5-minute install.
Some notes:
+Some notes:
Users upgrading from b2 v0.6.1 to WordPress v0.7:
+Users upgrading from b2 v0.6.1 to WordPress v0.7:
Template(s):
First notes:
+Template(s):
+First notes:
Notes about parameters:
-1. Some template tags can accept optional parameters - between the parenthesis ().-
-
- 2. To add a parameter to a tag, enclose it between quotes - and put it between the ().
- Example: <?php my_tag("my parameter"); ?>
-
- 3. You may have to put several parameters, for that you - separate them with commas.
- Example: <?php my_tag("first param","second param"); ?>
-
- 4. The order of parameters is important. If a function - accepts 2 parameters and you only want to set the second one, you still - have to provide the first one, and so on for any number of parameters.
- Example: <?php my_tag("","second param"); ?>
-
- 5. Some template tags, like the_date(), display something - only if in some conditions. They generally accept parameters to display - something before and after them only when they display something.
- Example: <?php the_title("<h1>","</h1>"); ?> would display <h1>title - of the post</h1> only if the post has a title
-
-
Template tags are these:
+Notes about parameters:
+-
+
Template tags:
<?php the_date() ?> *-
the date of the post. example: 03.07.01 (default is dd.mm.yy).
the date is displayed only on new days. for example if you got 10 posts @@ -769,14 +776,14 @@ .b2calendartoday {}
the style of the day if it is today
Usage:
-WordPress relies a lot on the querystring, these variables passed with +
Query String Usage:
+WordPress relies a lot on the query string, these variables passed with the URL (note: to pass variables in the querystring, preceed the first variable name with a '?' question mark and every other variables with a '&' sign.)
Most of the time you won't have to do anything about it, but if you want to know how it works, it's here:
-How to use the QueryString:
+How to use the query string:
index.php?m=200107 will display the month of July 2001.
@@ -831,14 +838,13 @@ will display the posts that match the search request "hotdog", but only in July 2001.
-
XMLRPC Interface:
+XML-RPC Interface:
WordPress now has a XMLRPC interface. The only API available right now
is the Blogger API (complete specs here).
There are talks about a new API that would cover a lot of weblog/CMS systems
- in the future: when it's ready, WordPress will support it.
-
- The Blogger API has been completely
- emulated on WordPress, with some little differences:
The Blogger API has been + completely emulated on WordPress, with some little differences:
If you use blogger.newPost, your post is submitted without title and
- in category #1.
-
- However, you can type <title>my title</title> and/or <category>2<category>
+ in category #1.
However, you can type <title>my title</title> and/or <category>2<category>
in the body of your post to make its title be 'my title' and its category
be #2 (refer to your categories section to find out the ID numbers of
the categories). b2 would then delete that extra info from the body of
- your post once it is posted.
-
-
- You can now post to your b2 blog with tools like BlogBuddy,
+ your post once it is posted.
You can now post to your b2 blog with tools like BlogBuddy,
Bloggar, WapBlogger
(post from your Wap cellphone!), Radio
Userland (which means you can use Radio's email-to-blog feature),
- and other tools that support the Blogger API ! :)
-
- Your XMLRPC server/path are as described here: if you login to b2 on http://mydomain.com/me/b2login.php,
- then you have:
Your XMLRPC server/path are as described here: if you login to b2 on + http://mydomain.com/me/b2login.php, then you have:
You can post news from an email client!
But first you'll have to edit b2config.php, filling the appropriate values
for your POP3 email account (this interface doesn't support IMAP yet,
- only POP3, sorry).
-
- Once you have edited the config options, you can make your webserver execute
- b2mail.php every set amount of time (depending on your host's performance,
- this script can be resource intensive, so don't make it run every minute
- or you'll be kicked).
- You can do it with Cron-jobs, or if your host doesn't support it you can
- look into the various website-monitoring services, and make them check
- your b2mail.php URL.
-
- Preliminary advice:
- It is strongly advised to send your email as text-only (Outlook and Outlook
- Express default to 'html', which may cause problems), but HTML email could
- work (the script would strip all your html tags though...).
- It is also advised not to use your public email address, but create a
+ only POP3, sorry).
Once you have edited the config options, you can make your webserver + execute b2mail.php every set amount of time (depending on your host's + performance, this script can be resource intensive, so don't make it run + every minute or you'll be kicked).
+You can do it with Cron-jobs, or if your host doesn't support it you + can look into the various website-monitoring services, and make them check + your b2mail.php URL.
+Preliminary advice:
+It is strongly advised to send your email as text-only (Outlook and + Outlook Express default to 'html', which may cause problems), but HTML + email could work (the script would strip all your html tags though...).
+It is also advised not to use your public email address, but create a
new one especially for this script. If you use your public email address
and the script goes crazy posting every email on your blog and deleting
- all your emails, I can't take responsibility for this.
- Make sure you delete any email sent to your blog in your 'Sent' folder
+ all your emails, I can't take responsibility for this.
Make sure you delete any email sent to your blog in your 'Sent' folder
too, just in case (you don't want someone to find your login and password
- in the 'Sent' folder).
-
- The script will delete the emails that were used to post stuff
+ in the 'Sent' folder).
The script will delete the emails that were used to post stuff
on your weblog if it successfully posted your stuff. If it didn't manage
- to post, the email is not deleted.
-
- How to post:
- Now to post something, here's how your email should look like:
How to post:
+Now to post something, here's how your email should look like:
Subject: blog:the post's title (you can @@ -918,19 +916,18 @@ The content of the post, blah blah blah.
More blah blah. ___
Subject must start with 'blog:', or any string you set in the config
- file (so that the script doesn't check EVERY email in your mailbox).
- Body's first line must always be login:password, else the script will
+ file (so that the script doesn't check EVERY email in your mailbox).
Body's first line must always be login:password, else the script will
just skip the email.
If you don't use '___' (or any body terminator that you set in the config
file), the script will post the whole body, which is not what you want
if you send email with Yahoo or Hotmail (you don't want their ads on your
- blog, do you ?).
-
- Special cases for mobile phone email:
- Some mobile phone service providers may allow you to send email with your
- mobile phone or PDA, but on such devices you can't always include line
- breaks. In such case, you have to set $use_phoneemail = 1 in b2config.php,
- and then here's how you write the email:
Special cases for mobile phone email:
+Some mobile phone service providers may allow you to send email with + your mobile phone or PDA, but on such devices you can't always include + line breaks. In such case, you have to set $use_phoneemail = 1 + in b2config.php, and then here's how you write the email:
Subject: blog:the post's title :::
Body:
@@ -949,45 +946,48 @@
Notes:
On multi-user:
-You don't invite users, they can register on b2register.php.-
- Then you (as an admin) click the "+" next to their name in the - user-list, to upgrade their level to 1 or more, so they can post. If you +New users can register with
b2register.php. Then you (as + an admin) click the "+" next to their name on the Team page + in admin to upgrade their level to 1 or more, so they can post. If you don't want an user to post anymore, just click "-" until their - level is 0.
- Note: you can now disable users registration altogether from the config - file.
- Levels are these:
- 0 - new user: can't post.
- 1 - user: can post & edit/delete their own posts.
- 3 & more - admin: can post, edit/delete other people's posts, and - change the options.
- Any user whose level is higher than 1, can edit/delete the posts and change - the level of users whose level is inferior. Example: a level 2 user is - not an admin, but can edit the posts of level 1 users, and up the level - of a new user from 0 to 1.
-
- Usually, you'll want to have a team of only level 1 users except you. - ;)
- Note: you can modify a variable in b2config.php, to enable - new users to post once they've registered.
- If you don't want users to register on your blog at all, just delete b2register.php - once you've registered your user account.
- Final notes:
--WordPress is functionnal, but a lot of coding and code clean-up remain - to be done.
-If you've got suggestions, ideas, or comments, or if you found a bug, - why not joining us in the Forums?
-If you can code in PHP, you'll see the structure of b2 is flexible - enough to allow for more functions and sections to be added.
-
- Copyright notes:
- Wherever third party code has been used, credit has been given in the - code's comments.
- WordPress is released under the GPL (see license.txt).