|
Weblog 2.0 Internet groupware development platform Macro List |
This page should be kept up to date with the list of macros available in the new plugin.
There's so much work to do... I'll finish documenting these macros as I get a chance, but at least you have a complete list now!
Use in the <HEAD> Section of Page Template
- weblog.header
Use in Message Templates
- weblog.addToWeblogForm
-
Puts the checkboxes on the message editing form, the checkboxes and the "submit" button on the page when viewing a message, and puts a hidden element with the page's ID in the "New Item" form on weblog pages.
Can show a date field for controlling the date to which the item will be posted on the weblog:
<!--#weblog.addToWeblogForm showDate="true"-->
Anywhere on a Weblog Page
- weblog.channelName
- weblog.copyright
- weblog.pageWrapper
-
Can be used like the #insertTemplate macro to "insert" a weblog, anywhere.
Accepts parameter attributes which give you full control over the templates.
Not used anywhere on a regular Weblog II page.
- weblog.URL
-
Returns the URL of the weblog. Optional parameters allow it to return the url for specific dates, or the URL for the RSS format, or both.
Examples:
<!--#weblog.URL date="2003/04/23"-->
<!--#weblog.URL date="2003/04/23" format="RSS"--> - weblog.xmlrpcURL
Use Anywhere on Weblog Page, Intended for Weblog Wrapper Template
- weblog.calendar.wrapper
-
Inserts the weblog calendar into the page.
- weblog.description
-
Intended primarily for use in the RSS feed.
- weblog.editButton
- weblog.language
- weblog.newItemForm
-
Generally belongs in the weblog wrapper template. Puts a form, on the weblog page, for posting directly to that weblog.
- weblog.owner
- weblog.calendar.ctEmptySpaces
-
Sneaky little macro that knows where in the calendar it's being called (as long you put it somewhere that it belongs). It returns a number indicating the amount of empty "days" before the first of the month or after the last day of the month. Returns 0 if the week doesn't have any empty days.
Used solely in the weblog calendar's week templates.
- weblog.calendar.date
- weblog.calendar.dayCssClass
-
Returns a class name for a cell in the weblog calendar.
Only works in a Weblog Calendar Day Template.
There are different class names for different types of cells: weekday, saturday, sunday, and the "current day".
Also, a second class name is returned if the day contains any weblog items, which means this cell will contain a link. (So, the final result might be something like "calendarLinked calendarSunday".
The parameters allow you to override any of the default class names.
Note that the default template for calendar days, called "Weblog Calendar Day READONLY," appends "Cell" to the end of the class name returned by this macro. To change that, you must provide your own template for calendar days.
- weblog.calendar.daynum
-
Returns the date being referred to for your weblog archives.
The date is typically formatted as a number between 0 and 31, but can be formatted differently. See the format attribute, below.
If a |weblog channel| is being viewed, then the links point to that channel's archives.
See the outline of Weblog II macros for fuller documentation.
- weblog.calendar.days
- weblog.calendar.emptySpace
- weblog.calendar.monthLink
- weblog.calendar.weekDays
- weblog.day.date
- weblog.day.items
- weblog.day.link
- weblog.day.path
- weblog.days
Weblog Calendar Macros
Use in the Weblog Day Template
Use In Weblog Item Templates
- weblog.item.anchor
- weblog.item.body
- weblog.item.categories
- weblog.item.link
- weblog.item.permaLink
- weblog.item.postedTime
- weblog.item.subject
- weblog.item.summary
Last update: 5/27/2009; 6:16 PM