You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@roller.apache.org by sn...@apache.org on 2006/12/16 16:54:59 UTC
svn commit: r487818 - in /incubator/roller/trunk/docs: installguide/
installguide/generated/ templateguide/ templateguide/generated/
templateguide/generated/html/
Author: snoopdave
Date: Sat Dec 16 07:54:58 2006
New Revision: 487818
URL: http://svn.apache.org/viewvc?view=rev&rev=487818
Log:
Added note about using Oracle 10g
Added:
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_25f9ab6e.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_34787221.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4729f1a5.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4b949c80.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4cf7f533.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m40391650.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4dbd3550.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4f60519c.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m667c4c30.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m75262f7.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7881d7c5.gif (with props)
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7ef36857.gif (with props)
Modified:
incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html
incubator/roller/trunk/docs/installguide/generated/roller-install-guide.pdf
incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt
incubator/roller/trunk/docs/installguide/roller-install-guide.odt
incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide.html
incubator/roller/trunk/docs/templateguide/generated/roller-template-guide.pdf
incubator/roller/trunk/docs/templateguide/roller-template-guide.odt
Modified: incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
--- incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html (original)
+++ incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html Sat Dec 16 07:54:58 2006
@@ -7,7 +7,7 @@
<META NAME="AUTHOR" CONTENT="Dave Johnson">
<META NAME="CREATED" CONTENT="20060123;11164600">
<META NAME="CHANGEDBY" CONTENT="Dave Johnson">
- <META NAME="CHANGED" CONTENT="20061207;11580200">
+ <META NAME="CHANGED" CONTENT="20061216;10482600">
<STYLE>
<!--
@page { size: 8.5in 11in; margin: 0.5in }
@@ -364,17 +364,17 @@
<P CLASS="western">Copy the following files from Hibernate into the
Roller WEB-INF/lib directory:</P>
<UL>
- <LI><P CLASS="western">hibernate3.jar</P>
- <LI><P CLASS="western">asm-attrs.jar</P>
-</UL>
-<UL>
- <LI><P CLASS="western">asm.jar</P>
- <LI><P CLASS="western">cglib-2.1.3.jar</P>
- <LI><P CLASS="western">dom4j.1.6.1.jar</P>
- <LI><P CLASS="western">ehcache-1.1.jar</P>
- <LI><P CLASS="western">jdbc2_0-stdext.jar</P>
- <LI><P CLASS="western">jta.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">hibernate3.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">asm-attrs.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">asm.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">cglib-2.1.3.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">dom4j.1.6.1.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">ehcache-1.1.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">jdbc2_0-stdext.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">jta.jar</P>
</UL>
+<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
+</P>
<P CLASS="western">The Roller Support project at Java.Net offers some
bundles that might make this part of the installation easier. Visit
<A HREF="http://roller.dev.java.net/">http://roller.dev.java.net</A>
@@ -403,6 +403,10 @@
instead of the newer 3.1.X series, you'll also need to change the
Hibernate configuration file to use the MySQL5 dialect (see Section
8.3 for details on that).</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in"><A NAME="st"></A>For
+ Oracle users, we recommend that you use the 10g (<A HREF="http://10.1.0.2/" TARGET="_blank" ONCLICK="return top.js.OpenExtLink(window,event,this)">10.1.0.2</A>
+ or higher) drivers which should<BR>be packaged as ojdbc14.jar --
+ even if operating on Oracle 9 server.</P>
</UL>
<P CLASS="western"><BR><BR>
</P>
@@ -1058,7 +1062,7 @@
<PRE> <FONT FACE="Courier New"><FONT SIZE=3>% cd $CATALINA_HOME/webapps</FONT></FONT>
<FONT FACE="Courier New"><FONT SIZE=3>% mkdir /somewhere/safe/roller-old</FONT></FONT>
<FONT FACE="Courier New"><FONT SIZE=3>% mv roller /somewhere/safe/roller-old</FONT></FONT></PRE><H3 CLASS="western">
-<A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller11"></A><A NAME="section-UpgradeGuide_2.1-STEP2InstallTheNewRoller2"></A><A NAME="ref-UpgradeGuide_2.1-2"></A>
+<A NAME="section-UpgradeGuide_2.1-STEP2InstallTheNewRoller2"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller11"></A><A NAME="ref-UpgradeGuide_2.1-2"></A>
UPGRADE STEP 2: Install the new Roller
</H3>
<P CLASS="western">Follow the normal installation instructions to
@@ -1073,7 +1077,7 @@
the installation, we'll do that later
</P>
</UL>
-<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller12"></A><A NAME="section-UpgradeGuide_2.1-STEP3CopyResourcesAndUpdateConfigs3"></A><A NAME="ref-UpgradeGuide_2.1-3"></A>
+<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP3CopyResourcesAndUpdateConfigs3"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller12"></A><A NAME="ref-UpgradeGuide_2.1-3"></A>
UPGRADE STEP 3: Copy resources and update configs
</H3>
<H4 CLASS="western"><A NAME="section-UpgradeGuide_2.1-3.1CopyYourOldResourcesAndOtherFilesYouveAdded"></A>
@@ -1114,7 +1118,7 @@
visit the Roller Support project on Java.Net
(http://roller.dev.java.net).</B></P>
</UL>
-<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller13"></A><A NAME="section-UpgradeGuide_2.1-STEP4UpgradeTheDatabase4"></A><A NAME="ref-UpgradeGuide_2.1-4"></A>
+<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP4UpgradeTheDatabase4"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller13"></A><A NAME="ref-UpgradeGuide_2.1-4"></A>
UPGRADE STEP 4: Upgrade the database
</H3>
<P CLASS="western">Use the appropriate database upgrade script to
@@ -1161,7 +1165,7 @@
<P CLASS="western">If you're upgrading from an earlier release you'll
have to run each of the older scripts in order to upgrade your
database.</P>
-<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller14"></A><A NAME="section-UpgradeGuide_2.1-STEP5StartupTomcat5"></A><A NAME="ref-UpgradeGuide_2.1-5"></A>
+<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP5StartupTomcat5"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller14"></A><A NAME="ref-UpgradeGuide_2.1-5"></A>
UPGRADE STEP 5: Startup your app server
</H3>
<P CLASS="western">Use the standard Tomcat <FONT FACE="Courier New">startup.sh</FONT>
Modified: incubator/roller/trunk/docs/installguide/generated/roller-install-guide.pdf
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/installguide/generated/roller-install-guide.pdf?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
Binary files - no diff available.
Modified: incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
--- incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt (original)
+++ incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt Sat Dec 16 07:54:58 2006
@@ -7,7 +7,7 @@
Apache Roller
(incubating)
-Version 3.1
+Version 3.2
@@ -162,6 +162,7 @@
ehcache-1.1.jar
jdbc2_0-stdext.jar
jta.jar
+
The Roller Support project at Java.Net offers some bundles that might make this part of the installation easier. Visit http://roller.dev.java.net for more information.
STEP 3.2: Install JDBC driver jar(s)
Download the JDBC driver jar for your database and put it in the classpath of your application server. For example, assuming Tomcat and MySQL, you'd download the J/Connector JDBC driver from mysql.com and you'd place it in the Tomcat common/lib directory.
@@ -172,6 +173,8 @@
NOTES
For MySQL 4.1.X users, we recommend that you use the J/Connector 3.0.X JDBC drivers instead of the newer 3.1.X series. If you must use J/Connector/J 3.1.X then please read Installation FAQ page item #13 on the Roller wiki.
For MySQL 5.X users, we recommend that you use the J/Connector 3.1.X JDBC drivers instead of the newer 3.1.X series, you'll also need to change the Hibernate configuration file to use the MySQL5 dialect (see Section 8.3 for details on that).
+For Oracle users, we recommend that you use the 10g (10.1.0.2 or higher) drivers which should
+be packaged as ojdbc14.jar -- even if operating on Oracle 9 server.
STEP 3.3: Install JavaMail and Activation jars
If you like to use Roller's e-mail notification features, you'll need to add the JavaMail and Activation jars to your application server's classpath. Currently, we ship these jars with Roller, but you will need to move them from the Roller WEB-INF/lib directory and into the Tomcat common/lib directory, or your server's equivalent location.
@@ -355,13 +358,15 @@
What properties you should set
We are going to assume you have defined a roller-custom.properties file and placed it in your classpath somewhere. To override any of the default Roller properties you simply add a line with the proper key and the new value you wish to use.
-Here is a sample roller-custom.properties with the few properties that should be overridden
+Here is a sample roller-custom.properties with the few properties that should be overridden.
uploads.dir=/app/roller/roller_data/uploads
search.index.dir=/app/roller/roller_data/search-index
+ passwds.encryption.enabled=true
# etc, etc, etc ... any other properties you want to override
+NOTE: Setting password encryption to true is a very good idea for new Roller sites, but if you are upgrading an existing Roller site you'll need to come up with a strategy for converting your old unencrypted passwords before you turn encryption on.
STEP 8.2: Change keys in the WEB-INF/security.xml file
Starting with version 2.1, Roller uses the Acegi security infrastructure. Several of the security features rely on keys that are intended to be site-specific. These keys are used to compute HMAC (hash-based message authentication code) values for Remember Me cookies. Knowledge of these keys could allow an attacker to forge invalid cookies, and thereby gain unauthorized access to your Roller installation (at the application level).
Roller ships with default values, and these should assumed to be widely known. You should change your keys to be secret values specific to your own site.
@@ -539,6 +544,12 @@
# RollerConfig.getProperty("propname");
#---------------------------------
+# Database configuration settings
+
+# Hibernate dialect: You must override this to use a database other than MySQL4
+hibernate.dialect=org.hibernate.dialect.MySQLDialect
+
+#---------------------------------
# User management settings
# True to enable group blogging. False to prevent users from creating more
@@ -562,6 +573,12 @@
uploads.url=/resources
#----------------------------------
+# Themes settings
+
+# The directory in which Roller will look for themes
+themes.dir=${webapp.context}
+
+#----------------------------------
# Search index settings
# Enables indexing of weblog entries and comments and enables search servlet
@@ -599,7 +616,7 @@
# each represents a url at the application root, i.e. /<elem>/*
rendering.weblogMapper.rollerProtectedUrls=\
roller-ui,images,theme,themes,CommentAuthenticatorServlet,\
-index.jsp,favicon.ico,robots.txt,taglibs.jsp,\
+index.jsp,favicon.ico,robots.txt,\
page,flavor,rss,atom,language,search,comments,rsd,resource,xmlrpc,planetrss
# Set of user defined protected urls. These are added to the set above.
@@ -633,6 +650,17 @@
org.apache.roller.ui.rendering.model.CalendarModel,\
org.apache.roller.ui.rendering.model.MenuModel
+# Set of models to be made available for weblog page *preview* rendering
+# NOTE: this *does* have some differences between the pageModels
+rendering.previewModels=\
+org.apache.roller.ui.rendering.model.PreviewPageModel,\
+org.apache.roller.ui.rendering.model.ConfigModel,\
+org.apache.roller.ui.rendering.model.UtilitiesModel,\
+org.apache.roller.ui.rendering.model.PreviewURLModel,\
+org.apache.roller.ui.rendering.model.MessageModel,\
+org.apache.roller.ui.rendering.model.CalendarModel,\
+org.apache.roller.ui.rendering.model.MenuModel
+
# Set of page models specifically for site-wide rendering
rendering.siteModels=\
org.apache.roller.ui.rendering.model.SiteModel
@@ -725,24 +753,62 @@
#,org.apache.roller.ui.rendering.plugins.AcronymsPlugin \
#,org.apache.roller.ui.rendering.plugins.BookmarkPlugin
+# The list of configured WeblogEntryEditors available to users
+plugins.weblogEntryEditors=\
+org.apache.roller.ui.core.plugins.TextEditor,\
+org.apache.roller.ui.core.plugins.XinhaEditor
-#----------------------------------
-# scheduled tasks, each is comma separated list of classes
-
-# Comma separated list of task classnames to be executed once per day
-tasks.daily=org.apache.roller.ui.core.tasks.TurnoverReferersTask\
+# The "id" of the default editor to use. NOT the class name
+plugins.defaultEditor=editor-text.jsp
-# Needed to enable nightly fetching of blacklist
-#,org.apache.roller.ui.core.tasks.BlacklistUpdateTask\
+#----------------------------------
+# Scheduled Background Tasks ... all times are in minutes.
+#
+# Task properties should follow the given format ...
+# tasks.<taskname>.<prop>=<value>
+#
+# The *enabled* tasks are defined by tasks.enabled=<taskname>[,<taskname>]
+#-----------------------------------
-# Daily Planet task: syncs weblog list with Roller, refreshes Technorati stats
-#,org.apache.roller.ui.core.tasks.SyncWebsitesTask
+# Tasks which are enabled. Only tasks listed here will be run.
+tasks.enabled=ResetHitCountsTask,TurnoverReferersTask,PingQueueTask
-# Comma separated list of task classnames to be executed hourly
-tasks.hourly=\
+# Reset hit counts
+tasks.ResetHitCountsTask.class=org.apache.roller.business.runnable.ResetHitCountsTask
+tasks.ResetHitCountsTask.startTime=startOfDay
+tasks.ResetHitCountsTask.interval=1440
+tasks.ResetHitCountsTask.leaseTime=30
+
+# Reset referer counts
+tasks.TurnoverReferersTask.class=org.apache.roller.business.runnable.TurnoverReferersTask
+tasks.TurnoverReferersTask.startTime=startOfDay
+tasks.TurnoverReferersTask.interval=1440
+tasks.TurnoverReferersTask.leaseTime=30
+
+# Ping processor, does sending of pings
+tasks.PingQueueTask.class=org.apache.roller.business.pings.PingQueueTask
+tasks.PingQueueTask.startTime=immediate
+tasks.PingQueueTask.interval=5
+tasks.PingQueueTask.leaseTime=30
+
+# Sync Roller weblogs with planet
+tasks.SyncWebsitesTask.class=org.apache.roller.planet.tasks.SyncWebsitesTask
+tasks.SyncWebsitesTask.startTime=startOfDay
+tasks.SyncWebsitesTask.interval=1440
+tasks.SyncWebsitesTask.leaseTime=30
+
+# Refresh entries for planet feeds
+tasks.RefreshEntriesTask.class=org.apache.roller.planet.tasks.RefreshEntriesTask
+tasks.RefreshEntriesTask.startTime=startOfHour
+tasks.RefreshEntriesTask.interval=60
+tasks.RefreshEntriesTask.leaseTime=30
+
+# Technorati rankings for planet feeds
+tasks.TechnoratiRankingsTask.class=org.apache.roller.planet.tasks.TechnoratiRankingsTask
+tasks.TechnoratiRankingsTask.startTime=startOfDay
+tasks.TechnoratiRankingsTask.interval=1440
+tasks.TechnoratiRankingsTask.leaseTime=30
-# Hourly Planet task: refresh latest entry list from all weblogs in list
-#org.apache.roller.ui.core.tasks.RefreshEntriesTask
#----------------------------------
# Persistence settings
@@ -753,9 +819,6 @@
#----------------------------------
# comment, referrer and trackback settings
-# comment authenticator settings (experimental)
-authenticator.classname=org.apache.roller.ui.core.DefaultAuthenticator
-
comment.authenticator.classname=org.apache.roller.ui.rendering.util.MathCommentAuthenticator
comment.notification.separateOwnerMessage=false
comment.notification.hideCommenterAddresses=false
@@ -863,14 +926,16 @@
# Planet Aggregator settings
# Set to true to enable the Planet aggregator. This will cause:
-# - The main page of Roller will become an aggregated view of all blogs in the
-# Roller database, plus those defined in the Planet group 'external'.
# - A new menu tab will appear for Roller admin users. This allows admins to
# add/remove newsfeed subscriptions in the 'external' group.
# - Users can then subscribe to several newsfeeds:
# - http://localhost:8080/roller/rss
# - http://localhost:8080/roller/planetrss
# - http://localhost:8080/roller/planetrss?group=external
+# - You'll be able to add the $planet model to the list of page models available
+# to blogs (rendering.pageModels) or to only site-wide blogs (rendering.siteModels)
+# (classname org.apache.roller.ui.rendering.model.SiteModel)
+#
planet.aggregator.enabled=false
# Planet cache must exist and must be writable by Roller process
@@ -927,16 +992,6 @@
users.sso.autoProvision.enabled=false
users.sso.autoProvision.className=org.apache.roller.ui.core.security.BasicUserAutoProvision
-#----------------------------------
-# misc settings
-
-rememberme.enabled=true
-debug.memory.enabled=false
-compression.gzipResponse.enabled=true
-
-# editor theme to be used (corresponds to directory name under /theme)
-editor.theme=tan
-
#---------------------------------
# settings for various plugins
@@ -952,6 +1007,38 @@
# Set to true to allow only default topic tag site (and avoid costly bookmark queries)
plugins.topictag.ignoreBookmarks=true
+#----------------------------------
+# misc settings
+
+# Some folks consider remember-me type functionality to be a security
+rememberme.enabled=true
+
+# You might want to disable GZIP if your app server already supports it
+compression.gzipResponse.enabled=true
+
+# specifies the max number of tags allowed in URL ( /feed?tags=foo+bar+baz )
+tags.queries.maxIntersectionSize=3
+
+# Characters to be allowed in user names (change at your own risk)
+username.allowedChars=A-Za-z0-9
+
+# editor theme to be used (corresponds to directory name under /theme)
+editor.theme=tan
+
+# Hibernate config resource (a classpath-based path)
+# NO NEED TO OVERRIDE this unless you are customizing Roller
+hibernate.configResource=/hibernate.cfg.xml
+
+# JDBC configuration parameters for standalone tasks
+# Don't override these in the roller-custom.properties file you use with the
+# Roller webapp, but for the standalone tasks that you run outside of Roller
+# (e.g. refresh entries) you'll need to override these properties. Do it in a
+# separate roller-custom.properties file.
+jdbc.driverClass=
+jdbc.connectionURL=
+jdbc.username=
+jdbc.password=
+
#---------------------------------
# Experimental settings
@@ -971,5 +1058,4 @@
# settings for old #showNewseeds macro (not related to Planet stuff)
aggregator.enabled=false
aggregator.cache.enabled=
-aggregator.cache.timeout=14400
-
+aggregator.cache.timeout=14400
\ No newline at end of file
Modified: incubator/roller/trunk/docs/installguide/roller-install-guide.odt
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/installguide/roller-install-guide.odt?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
Binary files - no diff available.
Modified: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide.html
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide.html?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
--- incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide.html (original)
+++ incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide.html Sat Dec 16 07:54:58 2006
@@ -1,12 +1,13 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
- <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
<TITLE></TITLE>
- <META NAME="GENERATOR" CONTENT="NeoOffice 2.0 Aqua Beta 3 (Unix)">
+ <META NAME="GENERATOR" CONTENT="OpenOffice.org 2.0 (Solaris x86)">
<META NAME="AUTHOR" CONTENT="Dave Johnson">
<META NAME="CREATED" CONTENT="20051209;11500200">
- <META NAME="CHANGED" CONTENT="20061120;14402000">
+ <META NAME="CHANGEDBY" CONTENT="Dave Johnson">
+ <META NAME="CHANGED" CONTENT="20061216;10014500">
<META NAME="SDFOOTNOTE" CONTENT=";;;;P">
<META NAME="SDENDNOTE" CONTENT="ARABIC">
<STYLE>
@@ -53,8 +54,7 @@
<BR>
</P>
<P CLASS="western" ALIGN=CENTER STYLE="margin-bottom: 0in; background: transparent">
- <FONT SIZE=7 STYLE="font-size: 40pt"><B>Template Guide </B></FONT>
- </P>
+ <FONT SIZE=7 STYLE="font-size: 40pt"><B>Template Guide</B></FONT></P>
<P CLASS="western" ALIGN=CENTER STYLE="margin-bottom: 0in; background: transparent">
<BR>
</P>
@@ -751,7 +751,7 @@
<P CLASS="western"><BR><BR>
</P>
<OL>
- <LI><P CLASS="western"><IMG SRC="roller-template-guide_html_m4016f15a.png" NAME="graphics1" ALIGN=LEFT WIDTH=582 HEIGHT=340 BORDER=0><BR CLEAR=LEFT><FONT SIZE=2><B>Go
+ <LI><P CLASS="western"><IMG SRC="roller-template-guide_html_5dc2a3fd.png" NAME="graphics1" ALIGN=LEFT WIDTH=582 HEIGHT=340 BORDER=0><BR CLEAR=LEFT><FONT SIZE=2><B>Go
to the Preferences->Theme page.</B><BR>Login to Roller and go
to your weblog's <B>Preferences->Themes</B> page. Shown below.<BR></FONT><BR><BR>
</P>
@@ -762,25 +762,25 @@
to pick the theme that you'd like to use as your starting point.
Once you've picked your theme, click the Save button to save it as
your current theme.</FONT></P>
- <LI><P CLASS="western"><IMG SRC="roller-template-guide_html_m71a47e4a.png" NAME="graphics2" ALIGN=LEFT WIDTH=370 HEIGHT=94 BORDER=0><BR CLEAR=LEFT><FONT SIZE=2><B>Click
+ <LI><P CLASS="western"><IMG SRC="roller-template-guide_html_2de01e50.png" NAME="graphics2" ALIGN=LEFT WIDTH=370 HEIGHT=94 BORDER=0><BR CLEAR=LEFT><FONT SIZE=2><B>Click
the Customize button.</B><BR>Click the Customize button to
customize your theme. When you do this, copies of the themes page
templates will be copied into your weblog so you can edit them.</FONT></P>
<LI><P CLASS="western"><FONT SIZE=2><B>Customize your theme by
editing and creating page templates.</B><BR>Go to the
Preferences->Templates page, edit your page templates and add
- new ones as needed â as described in the next section.</FONT></P>
+ new ones as needed – as described in the next section.</FONT></P>
</OL>
<P CLASS="western">And if you get tired of your customized theme,
just use the <B>Preferences->Theme</B> page to switch back to a
- shared theme â or pick another one to customize. Now let's
+ shared theme – or pick another one to customize. Now let's
discuss editing and creating templates.</P>
<H2 CLASS="western">3.4 - Editing and creating page templates</H2>
<P CLASS="western">Once you've got the page templates copied into
your weblog, you can do just about anything you want to your theme.
You can use the <B>Preferences->Templates</B> page, shown below,
to create a new page, delete a page or choose a page to edit.</P>
- <P CLASS="western"><IMG SRC="roller-template-guide_html_3be4c6e2.png" NAME="graphics3" ALIGN=LEFT WIDTH=634 HEIGHT=352 BORDER=0><BR CLEAR=LEFT><BR><BR>
+ <P CLASS="western"><IMG SRC="roller-template-guide_html_m7503a72a.png" NAME="graphics3" ALIGN=LEFT WIDTH=634 HEIGHT=352 BORDER=0><BR CLEAR=LEFT><BR><BR>
</P>
<P CLASS="western">Now might be a good time to describe the <I>page
template properties</I> since you can see them in the table above.
@@ -797,9 +797,9 @@
yourself as to the purpose of the page.</P>
<LI><P CLASS="western"><B>Link</B>: Each page template has a link
property, which is used to form the URL for the page. For example,
- if the page's name is âsimpleâ then the page will be available
- at the URL â/page/simpleâ within the weblog.
- </P>
+ if the page's name is “simple” then the page will be
+ available at the URL “/page/simple” within the weblog.
+ </P>
<LI><P CLASS="western"><B>Navbar</B>: This is a flag that
indicates whether the page is to be shown in the weblog navigation
bar that is produced by the <FONT FACE="Courier New">#showPageMenu()</FONT>
@@ -816,7 +816,7 @@
below).</P>
<P CLASS="western"><BR><BR>
</P>
- <P CLASS="western"><IMG SRC="roller-template-guide_html_m48cd7d3.png" NAME="graphics4" ALIGN=LEFT WIDTH=633 HEIGHT=437 BORDER=0><BR CLEAR=LEFT><BR><BR>
+ <P CLASS="western"><IMG SRC="roller-template-guide_html_m68e6eb1e.png" NAME="graphics4" ALIGN=LEFT WIDTH=633 HEIGHT=437 BORDER=0><BR CLEAR=LEFT><BR><BR>
</P>
<P CLASS="western">But the rules for <I>required pages</I> are
different. The weblog pages named Weblog, _day and _css are
@@ -888,8 +888,8 @@
dot-notation, but you must end the expression with a list of
parameters in parentheses. For example, if you'd like to display an
image from within your theme, you can use the $url model like so:</P>
- <P STYLE="margin-bottom: 0in; background: transparent"><FONT FACE="Courier New"><FONT SIZE=2> <img='<B>$url.themeResource(âbasicâ,
- âbackground.gifâ)</B>'></a></FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent"><FONT FACE="Courier New"><FONT SIZE=2> <img='<B>$url.themeResource(“basic”,
+ “background.gif”)</B>'></a></FONT></FONT></P>
<P STYLE="margin-bottom: 0in; background: transparent"><BR>
</P>
<P CLASS="western">Argument one is the name of the theme and
@@ -912,13 +912,14 @@
<P STYLE="margin-bottom: 0in; background: transparent"><BR>
</P>
<P CLASS="western">Argument one is the weblog for the calendar and
- argument two is the category, where ânilâ indicates that no
- category is specified. Note that the arguments for a macro are
- separated by a space and NOT a comma as was the case for methods.</P>
+ argument two is the category, where “nil” indicates
+ that no category is specified. Note that the arguments for a macro
+ are separated by a space and NOT a comma as was the case for
+ methods.</P>
<H2 CLASS="western">4.3 - A word about pagers</H2>
<P CLASS="western">There are many cases in a weblog when we want to
display a large collection of values and we want that collection to
- be page-able â that is, we want a Next link to go to the next
+ be page-able – that is, we want a Next link to go to the next
page of results and possibly a Previous link to go to the previous
page. So in Roller, we've introduced the concept of a <SPAN STYLE="font-style: normal">pager</SPAN>.
A <I>pager</I> is a special type of object that makes it easy to
@@ -930,26 +931,26 @@
what a pager looks like:</P>
<UL>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.homeLink â URL of the first page of
+ <FONT SIZE=2>$pager.homeLink – URL of the first page of
results</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.homeName â Name to be displayed for that
- URL</FONT></P>
+ <FONT SIZE=2>$pager.homeName – Name to be displayed for
+ that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.nextLink â URL of the next page of
+ <FONT SIZE=2>$pager.nextLink – URL of the next page of
results</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.nextName â Name to be displayed for that
- URL</FONT></P>
+ <FONT SIZE=2>$pager.nextName – Name to be displayed for
+ that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.prevLink â URL of the previous page of
- results</FONT></P>
+ <FONT SIZE=2>$pager.prevLink – URL of the previous page
+ of results</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.prevName â Name to be displayed for that
- URL</FONT></P>
+ <FONT SIZE=2>$pager.prevName – Name to be displayed for
+ that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.items â Collection of data objects; the
- current page of results</FONT></P>
+ <FONT SIZE=2>$pager.items – Collection of data objects;
+ the current page of results</FONT></P>
</UL>
<P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium"><A NAME="DDE_LINK6"></A>
<BR>
@@ -963,38 +964,38 @@
to the next months entries.</P>
<UL>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.homeLink â URL of the first page of
+ <FONT SIZE=2>$pager.homeLink – URL of the first page of
results</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.homeName â Name to be displayed for that
- URL</FONT></P>
+ <FONT SIZE=2>$pager.homeName – Name to be displayed for
+ that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.nextLink â URL of the next page of
+ <FONT SIZE=2>$pager.nextLink – URL of the next page of
results</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.nextName â Name to be displayed for that
- URL</FONT></P>
+ <FONT SIZE=2>$pager.nextName – Name to be displayed for
+ that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.prevLink â URL of the previous page of
- results</FONT></P>
+ <FONT SIZE=2>$pager.prevLink – URL of the previous page
+ of results</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.prevName â Name to be displayed for that
- URL</FONT></P>
+ <FONT SIZE=2>$pager.prevName – Name to be displayed for
+ that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.nextCollectionLink â URL of next collection
- in sequence</FONT></P>
+ <FONT SIZE=2>$pager.nextCollectionLink – URL of next
+ collection in sequence</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.nextCollectionName â Name to be displayed
- for that URL</FONT></P>
+ <FONT SIZE=2>$pager.nextCollectionName – Name to be
+ displayed for that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.prevCollectionLink â URL of previous
+ <FONT SIZE=2>$pager.prevCollectionLink – URL of previous
collection in sequence</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.prevCollectionName â Name to be displayed
- for that URL</FONT></P>
+ <FONT SIZE=2>$pager.prevCollectionName – Name to be
+ displayed for that URL</FONT></P>
<LI><P CLASS="western" STYLE="margin-bottom: 0in; background: transparent; font-weight: medium">
- <FONT SIZE=2>$pager.items â Collection of data objects; the
- current page of results</FONT></P>
+ <FONT SIZE=2>$pager.items – Collection of data objects;
+ the current page of results</FONT></P>
</UL>
<P CLASS="western"><BR><BR>
</P>
@@ -1004,13 +1005,13 @@
<P CLASS="western">This section covers the standard model objects
available in all page templates:</P>
<UL>
- <LI><P CLASS="western"><FONT SIZE=2>$config â provides access to
- the Roller site configuration parameters</FONT></P>
- <LI><P CLASS="western"><FONT SIZE=2>$model â provides access to
- data for one specific weblog</FONT></P>
- <LI><P CLASS="western"><FONT SIZE=2>$url â for creating Roller
- URLs and URLs within one specific weblog</FONT></P>
- <LI><P CLASS="western"><FONT SIZE=2>$utils â utility methods
+ <LI><P CLASS="western"><FONT SIZE=2>$config – provides
+ access to the Roller site configuration parameters</FONT></P>
+ <LI><P CLASS="western"><FONT SIZE=2>$model – provides access
+ to data for one specific weblog</FONT></P>
+ <LI><P CLASS="western"><FONT SIZE=2>$url – for creating
+ Roller URLs and URLs within one specific weblog</FONT></P>
+ <LI><P CLASS="western"><FONT SIZE=2>$utils – utility methods
needed within page templates</FONT></P>
</UL>
<P CLASS="western">For each model, we'll cover properties and
@@ -1211,7 +1212,7 @@
get from those. See Section 6 for a complete reference to the data
objects and their properties.</P>
<P CLASS="western"><SPAN ID="Frame1" DIR="LTR" STYLE="float: left; width: 7.06in; height: 3.96in; border: none; padding: 0in; background: #ffffff">
- <P CLASS="frame-contents-western"><IMG SRC="roller-template-guide_html_m511689ba.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_1eba02e4.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m46b36671.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_30c3e854.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m46b36671.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_3b1590ae.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m46b36671.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mc6db489.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m46b36671.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m5549e0bf.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m46b36671.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_1b9c380d.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m46b36671.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m309473a9.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m2be1d0df.gif" ALIGN=LEFT><IMG SRC="ro
ller-template-guide_html_m3107805d.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_245ede7d.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_13d4503d.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mef06a86.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m24b6c41b.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m621ff2d2.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m71b0dc19.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m25e81f83.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m5306fce6.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m4359b92f.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m1f390da8.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_797b2131.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_6a9c40d8.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_46d84e54.gif" ALIGN=LEFT><BR><BR>
+ <P CLASS="frame-contents-western"><IMG SRC="roller-template-guide_html_m7ef36857.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_25f9ab6e.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m4dbd3550.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_4cf7f533.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m4f60519c.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m75262f7.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m667c4c30.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_4b949c80.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m610b5f75.gif" ALIGN=LEFT><IMG SRC="roller-
template-guide_html_m452b7d95.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m3add420.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_6d3d7e5b.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_4b83d79d.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_7b24c4cc.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_a408ed3.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m7027fa92.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m8246857.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m4f869ae1.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_dac7346.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_34787221.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m7881d7c5.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_4729f1a5.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m40391650.gif" ALIGN=LEFT><BR><BR>
</P>
</SPAN><BR CLEAR=LEFT><BR><BR>
</P>
@@ -2786,6 +2787,18 @@
</TR>
<TR VALIGN=TOP>
<TD WIDTH=190>
+ <P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">$weblog.commentCount</FONT></P>
+ </TD>
+ <TH WIDTH=172>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">Long</FONT></P>
+ </TH>
+ <TD WIDTH=333>
+ <P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">Total
+ number of comments of approved in weblog</FONT></P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=190>
<P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">$weblog.creator</FONT></P>
</TD>
<TH WIDTH=172>
@@ -2885,6 +2898,18 @@
</TR>
<TR VALIGN=TOP>
<TD WIDTH=190>
+ <P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">$weblog.entryCount</FONT></P>
+ </TD>
+ <TH WIDTH=172>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">Long</FONT></P>
+ </TH>
+ <TD WIDTH=333>
+ <P CLASS="western"><FONT SIZE=2 STYLE="font-size: 10pt">Total
+ number of entries in weblog</FONT></P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=190>
<P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">$weblog.entryDisplayCount</FONT></P>
</TD>
<TH WIDTH=172>
@@ -3034,7 +3059,7 @@
getRecentWeblogEntries(String cat, int max)</B><BR>Get most
recent WeblogEntries in the weblog up to the number max. You can
specify a category name if you'd liike only entries from one
- category (or ânilâ for all categories).
+ category (or “nil” for all categories).
</P>
<LI><P CLASS="western" STYLE="font-weight: medium"><B>List
getRecentComments(int max)</B><BR>Get most recent Comments in the
@@ -3559,65 +3584,6 @@
<P CLASS="western">Weblog entry attributes are name/value pairs
that can be assigned to weblog entries. Currently, they're only
used to add podcasts to blog entries.</P>
- <TABLE WIDTH=721 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0>
- <COL WIDTH=149>
- <COL WIDTH=96>
- <COL WIDTH=450>
- <THEAD>
- <TR VALIGN=TOP>
- <TD WIDTH=149 BGCOLOR="#e6e6e6">
- <P CLASS="western"><B>Name</B></P>
- </TD>
- <TH WIDTH=96 BGCOLOR="#e6e6e6">
- <P CLASS="western" ALIGN=LEFT>Type</P>
- </TH>
- <TH WIDTH=450 BGCOLOR="#e6e6e6">
- <P CLASS="western">Description</P>
- </TH>
- </TR>
- </THEAD>
- <TBODY>
- <TR VALIGN=TOP>
- <TD WIDTH=149>
- <P CLASS="western"><FONT SIZE=2 STYLE="font-size: 10pt">$att.entry</FONT></P>
- </TD>
- <TH WIDTH=96>
- <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><A NAME="DDE_LINK117"></A>
- <FONT SIZE=2 STYLE="font-size: 10pt">WeblogEntry</FONT></P>
- </TH>
- <TH WIDTH=450>
- <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">Weblog
- entry associated with this attribute</FONT></P>
- </TH>
- </TR>
- <TR VALIGN=TOP>
- <TD WIDTH=149>
- <P CLASS="western"><FONT SIZE=2 STYLE="font-size: 10pt">$att.name</FONT></P>
- </TD>
- <TH WIDTH=96>
- <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">String</FONT></P>
- </TH>
- <TD WIDTH=450>
- <P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">Name
- of the attribute</FONT></P>
- </TD>
- </TR>
- <TR VALIGN=TOP>
- <TD WIDTH=149>
- <P CLASS="western"><FONT SIZE=2 STYLE="font-size: 10pt">$att.value</FONT></P>
- </TD>
- <TH WIDTH=96>
- <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">String</FONT></P>
- </TH>
- <TD WIDTH=450>
- <P CLASS="western" STYLE="font-weight: medium"><FONT SIZE=2 STYLE="font-size: 10pt">Value
- of the attribute </FONT>
- </P>
- </TD>
- </TR>
- </TBODY>
- </TABLE>
- <H3 CLASS="western"></H3>
<H1 CLASS="western" STYLE="page-break-before: always">7 - Macro
Reference</H1>
<P CLASS="western">This section lists the macros that are available
@@ -3679,7 +3645,7 @@
<UL>
<LI><P CLASS="western"><B>#showWeblogEntryCalendar($weblog
$category)</B><BR>Show weblog entry calendar, optionally
- restricted by category name (ânilâ for no category)</P>
+ restricted by category name (“nil” for no category)</P>
<LI><P CLASS="western"><B>#includeTemplate($weblog
$pageName)</B><BR>Parse and include a page template into the
current page tempate.</P>
@@ -3759,6 +3725,77 @@
-- in short, everything you need to build an interesting community
front page for Roller.</P>
<H3 CLASS="western">8.1.1 - $site Objects</H3>
+ <P CLASS="western"><B>Site object</B></P>
+ <TABLE WIDTH=721 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0>
+ <COL WIDTH=149>
+ <COL WIDTH=96>
+ <COL WIDTH=450>
+ <THEAD>
+ <TR VALIGN=TOP>
+ <TD WIDTH=149 BGCOLOR="#e6e6e6">
+ <P CLASS="western"><B>Name</B></P>
+ </TD>
+ <TH WIDTH=96 BGCOLOR="#e6e6e6">
+ <P CLASS="western" ALIGN=LEFT>Type</P>
+ </TH>
+ <TH WIDTH=450 BGCOLOR="#e6e6e6">
+ <P CLASS="western">Description</P>
+ </TH>
+ </TR>
+ </THEAD>
+ <TBODY>
+ <TR VALIGN=TOP>
+ <TD WIDTH=149>
+ <P CLASS="western"><FONT SIZE=2>$site.commentCount</FONT></P>
+ </TD>
+ <TH WIDTH=96>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Long</FONT></P>
+ </TH>
+ <TH WIDTH=450>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Total
+ number of comments in entire site</FONT></P>
+ </TH>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=149>
+ <P CLASS="western"><FONT SIZE=2>$site.entryCount</FONT></P>
+ </TD>
+ <TH WIDTH=96>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Long</FONT></P>
+ </TH>
+ <TH WIDTH=450>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Total
+ number of entries in entire site</FONT></P>
+ </TH>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=149>
+ <P CLASS="western"><FONT SIZE=2>$site.userCount</FONT></P>
+ </TD>
+ <TH WIDTH=96>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Long</FONT></P>
+ </TH>
+ <TH WIDTH=450>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Total
+ number of users in entire site</FONT></P>
+ </TH>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=149>
+ <P CLASS="western"><FONT SIZE=2>$site.weblogCount</FONT></P>
+ </TD>
+ <TH WIDTH=96>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Long</FONT></P>
+ </TH>
+ <TH WIDTH=450>
+ <P CLASS="western" ALIGN=LEFT STYLE="font-weight: medium"><FONT SIZE=2>Total
+ number of weblogs in entire site</FONT></P>
+ </TH>
+ </TR>
+ </TBODY>
+ </TABLE>
+ <P CLASS="western"><BR><BR>
+ </P>
<P CLASS="western">For some SiteModel methods (e.g. hot-blogs, most
commented, etc.) return a special type of object use to expressing
a count with a short name, a long name and an internationalized
@@ -3900,9 +3937,65 @@
<H2 CLASS="western">8.2 - $planet</H2>
<P CLASS="western">The <B>$planet</B> model makes Planet Roller
data available to weblog pages. It allows you to display the main
- aggregation (i.e. the one named âexternalâ), any custom group
- aggregation, a feed and ranked subscriptions.</P>
- <H3 CLASS="western">8.2.1 - $planet Objects</H3>
+ aggregation (i.e. the one named “external”), any custom
+ group aggregation, a feed and ranked subscriptions.</P>
+ <H3 CLASS="western">8.2.1 - Configuring the planet model</H3>
+ <P CLASS="western">The PlanetModel is not enabled by default in
+ Roller, so before you can use it in your weblogs you'll need to
+ enable it. To do that, you need to define some properties in your
+ Roller configuration and specifically, in your
+ <FONT FACE="Courier New, monospace">roller-custom.properties</FONT>
+ override file, which is explained in STEP 8 and Appendix B of the
+ Roller Installation Guide.</P>
+ <P CLASS="western">If you want to make the Planet model available
+ in weblog pages then add the Planet model to the list of models
+ specified by the <FONT FACE="Courier New, monospace">rendering.pageModels</FONT>
+ property by overriding the property in your
+ <FONT FACE="Courier New, monospace">roller-custom.properties</FONT>
+ file like so:</P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>rendering.pageModels=\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.PageModel,\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.ConfigModel,\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.UtilitiesModel,\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.URLModel,\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.MessageModel,\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.CalendarModel,\</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.ui.rendering.model.MenuModel,
+ \</FONT></FONT></P>
+ <P STYLE="margin-bottom: 0in; background: transparent">
+ <FONT FACE="Courier New"><FONT SIZE=2><B>org.apache.roller.ui.rendering.model.PlanetModel</B></FONT></FONT></P>
+ <P CLASS="western"><BR><BR>
+ </P>
+ <P CLASS="western">That's just a copy of the property setting from
+ the default Roller properties file, plus the Planet model (shown in
+ bold). Actually, depending on where want to use the Planet Model in
+ Roller, you'll need to add the Planet model to a couple of
+ different properties.</P>
+ <P CLASS="western">To make Planet model available in all blogs,
+ you'll want to add it to these model list properties:</P>
+ <UL>
+ <LI><P CLASS="western">rendering.pageModels: to make it available
+ in blog pages.</P>
+ <LI><P CLASS="western">rendering.previewModels: to make it
+ available when entries are previewed in the blog editor</P>
+ </UL>
+ <P CLASS="western">To make Planet model available in the front page
+ blog only:</P>
+ <UL>
+ <LI><P CLASS="western">rendering.siteModels: to make the model
+ available in site-wide blogs</P>
+ </UL>
+ <P CLASS="western">Now let's discuss the objects available from the
+ Planet model.</P>
+ <H3 CLASS="western">8.2.2 - $planet Objects</H3>
<P CLASS="western">The $planet model returns two types of objects
that we haven't seen before: the PlanetSubscription object, which
represents a feed subscription, and PlanetEntry, which represents
@@ -4187,7 +4280,7 @@
</TABLE>
<P CLASS="western"><BR><BR>
</P>
- <H3 CLASS="western">8.2.2 - $planet Methods</H3>
+ <H3 CLASS="western">8.2.3 - $planet Methods</H3>
<UL>
<LI><P CLASS="western"><B>Pager getAggregationPager(int sinceDays,
int max)</B><BR>Get pager that returns PlanetEntry objects from
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_25f9ab6e.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_25f9ab6e.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_25f9ab6e.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_34787221.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_34787221.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_34787221.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4729f1a5.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4729f1a5.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4729f1a5.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4b949c80.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4b949c80.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4b949c80.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4cf7f533.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4cf7f533.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_4cf7f533.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m40391650.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m40391650.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m40391650.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4dbd3550.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4dbd3550.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4dbd3550.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4f60519c.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4f60519c.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m4f60519c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m667c4c30.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m667c4c30.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m667c4c30.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m75262f7.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m75262f7.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m75262f7.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7881d7c5.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7881d7c5.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7881d7c5.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7ef36857.gif
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7ef36857.gif?view=auto&rev=487818
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/templateguide/generated/html/roller-template-guide_html_m7ef36857.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/roller/trunk/docs/templateguide/generated/roller-template-guide.pdf
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/generated/roller-template-guide.pdf?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
Binary files - no diff available.
Modified: incubator/roller/trunk/docs/templateguide/roller-template-guide.odt
URL: http://svn.apache.org/viewvc/incubator/roller/trunk/docs/templateguide/roller-template-guide.odt?view=diff&rev=487818&r1=487817&r2=487818
==============================================================================
Binary files - no diff available.