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:52:43 UTC
svn commit: r487815 - in
/incubator/roller/branches/roller_3.1/docs/templateguide:
generated/html/roller-template-guide.html
generated/roller-template-guide.pdf roller-template-guide.odt
Author: snoopdave
Date: Sat Dec 16 07:52:42 2006
New Revision: 487815
URL: http://svn.apache.org/viewvc?view=rev&rev=487815
Log:
Adding planet model config info to template guide
Modified:
incubator/roller/branches/roller_3.1/docs/templateguide/generated/html/roller-template-guide.html
incubator/roller/branches/roller_3.1/docs/templateguide/generated/roller-template-guide.pdf
incubator/roller/branches/roller_3.1/docs/templateguide/roller-template-guide.odt
Modified: incubator/roller/branches/roller_3.1/docs/templateguide/generated/html/roller-template-guide.html
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/templateguide/generated/html/roller-template-guide.html?view=diff&rev=487815&r1=487814&r2=487815
==============================================================================
--- incubator/roller/branches/roller_3.1/docs/templateguide/generated/html/roller-template-guide.html (original)
+++ incubator/roller/branches/roller_3.1/docs/templateguide/generated/html/roller-template-guide.html Sat Dec 16 07:52:42 2006
@@ -7,7 +7,7 @@
<META NAME="AUTHOR" CONTENT="Dave Johnson">
<META NAME="CREATED" CONTENT="20051209;11500200">
<META NAME="CHANGEDBY" CONTENT="Dave Johnson">
- <META NAME="CHANGED" CONTENT="20061108;15394100">
+ <META NAME="CHANGED" CONTENT="20061216;10013600">
<META NAME="SDFOOTNOTE" CONTENT=";;;;P">
<META NAME="SDENDNOTE" CONTENT="ARABIC">
<STYLE>
@@ -54,7 +54,8 @@
<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>
@@ -1212,7 +1213,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_1e560987.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_34c19140.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m5695ffaf.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf8a9362.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m3f93234f.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m2b0639f5.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_745e10ce.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_mf2d7980.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_6e28811.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m610b5f75.gif" ALIGN=LEFT><IMG SRC="roller-te
mplate-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_731c768.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_m4b8ab955.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_6d79f29e.gif" ALIGN=LEFT><IMG SRC="roller-template-guide_html_3e97bead.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>
@@ -3900,7 +3901,63 @@
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>
+ <H3 CLASS="western">8.2.1 - Configuring the planet model</H3>
+ <P CLASS="western">The Planet model 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
@@ -4185,7 +4242,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
Modified: incubator/roller/branches/roller_3.1/docs/templateguide/generated/roller-template-guide.pdf
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/templateguide/generated/roller-template-guide.pdf?view=diff&rev=487815&r1=487814&r2=487815
==============================================================================
Binary files - no diff available.
Modified: incubator/roller/branches/roller_3.1/docs/templateguide/roller-template-guide.odt
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/templateguide/roller-template-guide.odt?view=diff&rev=487815&r1=487814&r2=487815
==============================================================================
Binary files - no diff available.