diff --git a/readme.html b/readme.html
index f8a13cea08..9c66f671d4 100644
--- a/readme.html
+++ b/readme.html
@@ -296,6 +296,11 @@ It will display a list of <option name="x">category-name
- 0 or 1, depending if you want to have an option to display all categories (default is 1)
- text to display for the option to show all categories (default is "All")
+ - sort by: possible values are 'name' and 'ID' (default is 'ID')
+ - sorting order: possible values are 'asc' for ascending or 'desc' for descending (default is 'asc')
+ - 0 or 1. 1 means to display the date of the last post in each category (default is 0)
+ - 0 or 1. 1 means to display a count of posts in each category (default is 0)
+ - 0 or 1. 1 means to hide empty categories (default is 1)
@@ -308,14 +313,18 @@ you can use it like this:
<?php list_cats() ?>
This tag is out of the WordPress loop.
-It will display a list of the categories, with links to them. like in b2archive.php, each category is on a line, the only way you can change this is by editing b2.template.functions.php
+It will display a list of the categories, with links to them.
Parameters:
- - 0 or 1, depending if you want to have an option to display all categories (default is 1)
+ - 0 or 1. 1 means to display all an extra 'all' category (default is 1)
- text to display for the option to show all categories (default is 'All')
- sort by: possible values are 'name' and 'ID' (default is 'ID')
- sorting order: possible values are 'asc' for ascending or 'desc' for descending (default is 'asc')
- filename, in case you want to display the categories' posts in another template (default is current template)
+ - 0 or 1. 1 means to generate the items inside <li> tags, to build an HTML list. 0 means to just follow each link with a <br /> tag. (default is 1)
+ - 0 or 1. 1 means to display the date of the last post in each category (default is 0)
+ - 0 or 1. 1 means to display a count of posts in each category (default is 0)
+ - 0 or 1. 1 means to hide empty categories (default is 1)
@@ -506,19 +515,29 @@ typically, under the post itself. don't worry, the comments only appear if the p
This tag is out of the b2 TrackBacks loop.
It will output the URL to TrackBack the post, that other people can copy and use in b2's posting interface to trackback this post.
In b2comments.php, like in the main template file, please keep the first PHP lines, the "while" lines, and the "}" lines.
-You can modify the form, but do not remove "<?php echo ... ?>" and all the name="..." attributes.
-
-To include your archives:
-
-<?php get_archives('archivetype') ?>
-"archivetype" can be any of the following:
-
- - postbypost
- - daily
- - weekly
- - monthly
-
-To include the calendar:
+You can modify the form, but do not remove "<?php echo ... ?>" and all the name="..." attributes.
+
+To include your archives:
+<?php get_archives() ?>
+Parameters for
get_archives():
+
+ - archivetype: 'postbypost', 'daily', 'weekly', or 'monthly' (default is to use the archive_mode setting from the admin interface)
+ - limit: how many archive links to display (default is to show all)
+ - format:
+
+ - 'html': create as <li> items for an HTML list (default)
+ - 'option': create option values for a <select> dropdown menu
+ - 'link': create <link> elements for the <head> section of a page
+ - 'custom': use before and after values to format links
+
+
+ - before: text to prepend to link
+ - after: text to append to link
+ - 0 or 1: 1 means to display link counts
+
+
+To include the calendar:
<?php include("b2calendar.php") ?>
this will include a table with the current month's calendar, each day when you posted shows a link to this day's posts. You can customise this table with CSS classes:
.b2calendarmonth {}