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 2005/06/09 05:19:20 UTC
svn commit: r189695 [7/67] - in /incubator/roller/trunk: ./ contrib/
contrib/lib/ contrib/plugins/ contrib/plugins/src/ contrib/plugins/src/org/
contrib/plugins/src/org/roller/ contrib/plugins/src/org/roller/presentation/
contrib/plugins/src/org/roller/presentation/velocity/
contrib/plugins/src/org/roller/presentation/velocity/plugins/
contrib/plugins/src/org/roller/presentation/velocity/plugins/acronyms/
contrib/plugins/src/org/roller/presentation/velocity/plugins/bookmarks/
contrib/plugins/src/org/roller/presentation/velocity/plugins/email/
contrib/plugins/src/org/roller/presentation/velocity/plugins/jspwiki/
contrib/plugins/src/org/roller/presentation/velocity/plugins/radeox/
contrib/plugins/src/org/roller/presentation/velocity/plugins/readmore/
contrib/plugins/src/org/roller/presentation/velocity/plugins/smileys/
contrib/plugins/src/org/roller/presentation/velocity/plugins/textile/
contrib/plugins/src/org/roller/presentation/velocity/plugins/topictag/
custom/ custom/src/ custom/web/ docs/ docs/images/ docs/installguide/
docs/installguide/old/ docs/userguide/ docs/userguide/images/
docs/userguide/old/ metadata/ metadata/database/
metadata/database/hibernate/ metadata/xdoclet/ nbproject/ personal/
personal/eclipse/ personal/testing/ sandbox/ sandbox/planetroller/
sandbox/planetroller/metadata/ sandbox/planetroller/metadata/database/
sandbox/planetroller/src/ sandbox/planetroller/src/org/
sandbox/planetroller/src/org/roller/
sandbox/planetroller/src/org/roller/tools/
sandbox/planetroller/src/org/roller/tools/planet/
sandbox/planetroller/templates/ sandbox/planetroller/test/
sandbox/planetroller/test/org/ sandbox/planetroller/test/org/roller/
sandbox/planetroller/test/org/roller/model/
sandbox/planetroller/test/org/roller/tools/
sandbox/planetroller/test/org/roller/tools/planet/
sandbox/planetroller/testdata/ sandbox/planetroller/testdata/cache/
sandbox/planetroller/testdata/output/ sandbox/standalone/
sandbox/standalone/jspwiki/ sandbox/standalone/jspwiki/default/
sandbox/standalone/jspwiki/default/images/ sandbox/standalone/lib/
sandbox/standalone/src/ sandbox/standalone/src/org/
sandbox/standalone/src/org/roller/ sandbox/standalone/src/org/roller/jspwiki/
sandbox/standalone/src/org/roller/tomcat/
sandbox/standalone/src/org/roller/util/ sandbox/standalone/tests/
sandbox/standalone/tests/org/ sandbox/standalone/tests/org/roller/
sandbox/standalone/tests/org/roller/util/ sandbox/standalone/tomcat/ src/
src/org/ src/org/roller/ src/org/roller/business/
src/org/roller/business/hibernate/ src/org/roller/business/search/
src/org/roller/business/search/operations/ src/org/roller/business/utils/
src/org/roller/config/ src/org/roller/config/runtime/ src/org/roller/model/
src/org/roller/pojos/ src/org/roller/presentation/
src/org/roller/presentation/atomapi/ src/org/roller/presentation/bookmarks/
src/org/roller/presentation/bookmarks/actions/
src/org/roller/presentation/bookmarks/formbeans/
src/org/roller/presentation/bookmarks/tags/
src/org/roller/presentation/filters/ src/org/roller/presentation/forms/
src/org/roller/presentation/newsfeeds/ src/org/roller/presentation/pagecache/
src/org/roller/presentation/pagecache/rollercache/
src/org/roller/presentation/pings/ src/org/roller/presentation/planet/
src/org/roller/presentation/tags/ src/org/roller/presentation/tags/calendar/
src/org/roller/presentation/tags/menu/ src/org/roller/presentation/util/
src/org/roller/presentation/velocity/ src/org/roller/presentation/weblog/
src/org/roller/presentation/weblog/actions/
src/org/roller/presentation/weblog/formbeans/
src/org/roller/presentation/weblog/tags/ src/org/roller/presentation/website/
src/org/roller/presentation/website/actions/
src/org/roller/presentation/website/formbeans/
src/org/roller/presentation/website/tags/
src/org/roller/presentation/xmlrpc/ src/org/roller/util/
src/org/roller/util/rome/ tests/ tests/org/ tests/org/roller/
tests/org/roller/ant/ tests/org/roller/business/
tests/org/roller/presentation/ tests/org/roller/presentation/atomapi/
tests/org/roller/presentation/bookmarks/
tests/org/roller/presentation/filters/
tests/org/roller/presentation/velocity/
tests/org/roller/presentation/velocity/plugins/
tests/org/roller/presentation/velocity/plugins/smileys/
tests/org/roller/presentation/velocity/plugins/textile/
tests/org/roller/presentation/weblog/ tests/org/roller/presentation/xmlrpc/
tests/org/roller/util/ tests/org/roller/util/rome/ tools/ tools/buildtime/
tools/buildtime/ant-1.6.2/ tools/buildtime/findbugs/
tools/buildtime/findbugs/lib/ tools/buildtime/findbugs/plugin/
tools/buildtime/mockrunner-0.3/ tools/buildtime/mockrunner-0.3/lib/
tools/buildtime/mockrunner-0.35/ tools/buildtime/mockrunner-0.35/lib/
tools/buildtime/tomcat-4.1.24/ tools/buildtime/xdoclet-1.2/
tools/buildtime/xdoclet-1.2/lib/ tools/hibernate-2.1/
tools/hibernate-2.1/lib/ tools/lib/ tools/standard-1.0.3/
tools/standard-1.0.3/lib/ tools/standard-1.0.3/tld/ tools/struts-1.2.4/
tools/struts-1.2.4/lib/ web/ web/WEB-INF/ web/WEB-INF/classes/
web/WEB-INF/classes/flavors/ web/WEB-INF/classes/themes/ web/bookmarks/
web/editor/ web/editor/images/ web/images/ web/images/editor/
web/images/midas/ web/images/preview/ web/images/smileys/ web/planet/
web/tags/ web/templates/ web/theme/ web/theme/images/ web/theme/lavender/
web/theme/scripts/ web/theme/scripts/classes/ web/themes/ web/themes/basic/
web/themes/berkley/ web/themes/berkley/images/ web/themes/brushedmetal/
web/themes/brushedmetal/images/ web/themes/cheb/ web/themes/cheb/images/
web/themes/cheb/scripts/ web/themes/clean/ web/themes/currency-i18n/
web/themes/currency-i18n/images/ web/themes/currency/
web/themes/currency/images/ web/themes/grey2/ web/themes/moonshine/
web/themes/movablemanila/ web/themes/movablemanila/images/
web/themes/pacifica/ web/themes/robot/ web/themes/rolling/
web/themes/rolling/images/ web/themes/sotto/ web/themes/sotto/images/
web/themes/sotto/styles/ web/themes/sunsets/ web/themes/sunsets/images/
web/themes/sunsets/scripts/ web/themes/sunsets/styles/ web/themes/werner/
web/themes/x2/ web/themes/x2/images/ web/themes/x2/scripts/
web/themes/x2/styles/ web/weblog/ web/website/
Added: incubator/roller/trunk/docs/userguide/old/roller-ug.html
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/old/roller-ug.html?rev=189695&view=auto
==============================================================================
--- incubator/roller/trunk/docs/userguide/old/roller-ug.html (added)
+++ incubator/roller/trunk/docs/userguide/old/roller-ug.html Wed Jun 8 20:18:46 2005
@@ -0,0 +1,591 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+
+ <meta name="generator" content="HTML Tidy, see www.w3.org">
+
+ <meta name="Generator" content="Workbench 6.0">
+
+ <meta http-equiv="CONTENT-TYPE"
+ content="text/html; charset=windows-1252">
+ <title>Roller User Guide</title>
+</head>
+<body lang="en-US">
+<h1 class="western">The Roller Weblogger</h1>
+<h2>Version 0.9.6 User's Guide</h2>
+<p class="western">Copyright © 2002 David M Johnson</p>
+<p class="western">Updated: November 2, 2002<br>
+<br>
+</p>
+<ul>
+ <li>
+ <p><a href="#introduction">Introduction</a></p>
+ </li>
+ <li>
+ <div><a href="#getting_started">Getting started</a></div>
+
+ <ul>
+ <li style="margin-bottom: 0in;">Sign up for a new account</li>
+ <li style="margin-bottom: 0in;">Your initial website</li>
+
+ </ul>
+ <br>
+ </li>
+ <li>
+ <div><a href="#editing_your_weblog">Editing your weblog</a></div>
+
+ <ul>
+ <li>Adding a new entry</li>
+ <li>Publishing an entry</li>
+
+ <li>Editing an old entry</li>
+ <li>Publishing an entry</li>
+ <li>Spellchecking an entry</li>
+
+ <li>Posting using a Blogger API client</li>
+ <li>Flushing the cache</li>
+
+ <li>Referer rankings</li>
+
+ </ul>
+ <br>
+ </li>
+ <li>
+ <div><a href="#editing_bookmarks">Editing your bookmark collection</a></div>
+
+ <ul>
+ <li>Adding new bookmark folders</li>
+ <li>Adding bookmarks to folders</li>
+ <li>Importing Bookmarks in OPML format</li>
+
+ </ul>
+ <br>
+ </li>
+ <li>
+ <div><a href="#editing_newsfeeds">Editing your newsfeed collection</a></div>
+
+ <ul>
+ <li>Adding and deleting newsfeeds</li>
+
+ </ul>
+ <br>
+ </li>
+ <li>
+ <div><a href="#customizing_your_pages">Customizing your website</a></div>
+ </li>
+
+ <ul>
+ <li>Website settings</li>
+ <li>Choosing an editor<br>
+ </li>
+ <li>Website pages</li>
+ <li>Weblog themes</li>
+ <li>Website files</li>
+ <li>User settings</li>
+ <li>Export</li>
+ <li>Admin</li>
+
+ </ul>
+</ul>
+<ul>
+ <li>
+ <div><a href="#macros_for_page">Macros for use on Pages</a></div>
+ </li>
+ <li>
+ <div><a href="#macros_for_day">Macros for use on your DayTemplate page</a></div>
+ </li>
+ <li>Example Weblog page and date templates<br>
+ </li>
+
+</ul>
+ <br>
+<h2><a name="introduction"></a>Introduction</h2>
+<p>Roller is a Weblogger. Roller makes it easy for you to maintain a weblog,
+even if you are have little or no knowledge of HTML. All you have to do is
+go to a web site that is running the Roller software, sign up for an account
+and bam you have a weblog. You can start posting right away. You will need
+to know a little about HTML if you want to kick it up a notch by customizing
+the layout of your Weblog and adding new pages to your Weblog website. More
+on that later.</p>
+<p>Please note that Roller is currently beta quality code not necessarily
+ready for prime time there are probably a number of design flaws and an
+even larger number of bugs. As always with software of all sorts, and especially
+pre-release software such as this, use at your own risk. If you find a flaw,
+a bug, or something that you do not like please contribute back to the Roller
+project be reporting that bug to the Roller development team's <a
+ href="http://opensource.atlassian.com/projects/roller/Dashboard.jspa">JIRA
+issue tracking system</a>.</p>
+<h2><a name="getting_started"></a>Getting Started</h2>
+<h3>Signing up for a new account</h3>
+<p class="western">To sign-up for a Roller account, go the the main Roller
+page and click on the link that reads register as a new user. Enter your
+login name, your real name, your desired password, your e-mail address, and
+pick one of the predefined Weblog themes provided by Roller. There is a
+basic theme, which is a very good starting point for those who wish to build
+their own themes. And, there are three themes adapted from themes on <a
+ href="http://www.blogskins.com">blogskins.com</a>: these are shown below.
+ There is also a new XHTML/CSS based theme called x2 that was contributed
+by <a href="http://www.raibledesigns.com/">Matt Raible</a>.<br>
+</p>
+<table cellpadding="10" cellspacing="2" border="0" width="100%">
+ <tbody>
+ <tr>
+ <td valign="top">
+ <div align="center"><a href="grey2.gif">grey2<br>
+ <br>
+ </a></div>
+
+ <div align="center"><a href="grey2.gif"><img src="grep2_.jpg"
+ alt="" width="300" height="300"></a><br>
+ </div>
+ </td>
+ <td valign="top">
+ <div align="center"><a href="pacifica.gif">pacifica<br>
+ </a></div>
+ <a href="pacifica.gif"><br>
+ </a>
+ <div align="center"><a href="pacifica.gif"><img
+ src="pacifica_.jpg" alt="" width="300" height="300"></a><br>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td valign="top">
+ <div align="center"><a href="currency.gif">currency<br>
+ </a></div>
+ <a href="currency.gif"><br>
+ </a>
+ <div align="center"><a href="currency.gif"><img
+ src="currency_.jpg" alt="" width="300" height="300"></a><br>
+ </div>
+ </td>
+ <td valign="top" align="center"><a
+ href="weblog.gif">
+basic<br>
+ <br>
+ </a><a href="weblog.gif"><img src="weblog_.jpg" alt="" width="300"
+ height="276"></a><br>
+ <br>
+ </td>
+ </tr>
+
+ </tbody>
+</table>
+<p class="western">After your account is created you will be returned to
+the main Roller page. You will see that your name has been added to the list
+of Roller users displayed on the main page. If you click on your name in
+this list, you will be taken to your Weblog page.</p>
+<h3>Your initial website</h3>
+<p class="western">Your initial website will include just one webpage that
+is visible to your readers and that is named "Weblog". This page will include
+a navigation bar, a weblog category chooser, a weblog calendar, some links
+and a weblog area where your posts will appear. The screenshot below shows
+what your page will look like if you chose the Roller basic theme:</p>
+<p class="western" align="center">Figure 1: your initial Weblog page, assuming
+you chose the basic theme</p>
+<p class="western" align="center"> <a href="weblog.gif"><img
+ src="weblog_.jpg" alt="" width="300" height="276"></a><br clear="left">
+</p>
+<h3>Logging in</h3>
+<p class="western">From your Weblog page or from the main Roller page, click
+the Login link. Enter your username and password, click submit, and you will
+be taken to your Weblob page again. But this time, you will see some new
+Links on the page: Weblog:Edit, Weblog:Categories, Weblog:Flush-Cache, Bookmarks,
+Newsfeeds, and Website. These links lead you to pages for editing your Weblog,
+categories, bookmarks (AKA links), newsfeeds, and the actual pages that make
+up your website. First, lets talk about how to edit your Weblog.</p>
+<h2><a name="editing_your_weblog"></a>Editing your Weblog</h2>
+
+<h3>Adding a new entry</h3>
+<p>Editing your Weblog means adding new Weblog entries to be enjoyed by your
+readers and editing older Weblog entries to correct mistakes, clarify points,
+or to censor those drunken ramblings you entered last night.</p>
+<p>To add a new Weblog entry you simply go to the Edit-Weblog page, enter
+an optional title, enter the Weblog entry, choose a Weblog category. and
+hit the Submit button. As soon as you do that, your Weblog entry is posted
+to your Weblog for the world to see. <br>
+</p>
+<p>Generally, you will not need to use the Flush Cache link on the Weblog:Edit
+page, unless you are using SQL to muck about in the Roller database and you
+want to force the cache to reset itself. Normally, as you edit weblog entries,
+bookmarks, and other things Roller should automatically reset it's cache
+as needed.<br>
+</p>
+<p align="center">Figure 2: the Edit-Weblog page<br>
+<br>
+</p>
+<div align="center"><a href="edit-weblog.gif"><img
+ src="edit-weblog_.jpg" alt="" width="300" height="421"></a><br
+ clear="left">
+</div>
+
+<span style="color: red;">We need a new screenshot here</span>
+<h3>Publishing an entry</h3>
+<p>The buttons "Post to Weblog" and "Save as Draft" control whether or not your weblog entry is
+visible on your weblog's main page. If you click "Post to Weblog", then your entry
+is visible to your readers. If you click "Save as Draft", then your entry is
+private.</p>
+<p>The text field marked "Pub Time" controls the publish time your your entry.
+ Changing the publish time may change the order of weblog entries displayed
+on your weblog. When you enter a new publish time, you must use the format
+<span style="font-weight: bold;">dd.MM.yyyy HH:mm:ss</span></p>
+
+<h3>Editing an old entry</h3>
+<p>You can edit or remove an old Weblog entry by clicking on the Edit or Remove
+links in the Recent Weblog Entries part of the page. If the Weblog entry that
+you want to edit is not so recent and is not shown in the Recent Weblog Entries
+list, then you can use the Weblog Entry Archive calendar to find that old
+entry.</p>
+
+<span style="color: red;">Need a SpellCheck screenshot here</span>
+<h3>SpellChecking an entry</h3>
+<p>If you would like to Spellcheck your entry, click the "Spell Check" button.
+This will take you to another page which displays "suspect" words in drop-downs.
+The Spellchecking software doesn't understand HTML, so any tags used will likely
+be marked as suspect. To correct any errors, select the proper spelling from
+the appropriate drop-down. If you'd rather not use the drop-downs, you can edit
+the text directly in the textbox provided.</p>
+
+<h3>Posting using a Blogger API client</h3>
+<p>You can use any Blogger API client to post and edit Roller weblog entries.
+ Before you can do this, you must go to the Roller Website:Settings menu
+and check the box that reads Enable Blogger API for your weblog. You should
+also pick a category for posts made through the Blogger API. Be aware that
+one shortcoming of Blogger API based blogging clients titles. The Blogger
+API does not support weblog entry titles.</p>
+<p>Once you have enabled Blogger API support for your weblog, you can use
+any Blogger API client to post and edit your Roller weblog. For example,
+you could use the <a href="http://wbloggar.com">w:bloggar</a>client. Below
+is a screenshot of the w:bloggar client. As you can see, you need to configure
+w:bloggar by entering your host name, port number, and the path /roller/xmlrpc
+into the w:bloggar Account Connection dialog-box. You also need to enter
+your Roller username and password in to the w:bloggar login dialog.<br>
+</p>
+<div style="text-align: center;"><a
+ href="bloggar.jpg"><img
+ alt=""
+ src="bloggar_.jpg"
+ width="300" height="289" border="0"></a><br>
+</div>
+<br>
+<h3>Flushing the cache</h3>
+The flush-cache button allows you to flush the Roller page cache. The page
+cache is a performance feature that allows Roller to serve up pages faster
+and to minimize database access. Normally, the cache is flushed when you
+edit a weblog entry, add a new page template, or do just about any other operation.
+ So, under normal conditions you should not need to flush the cache. <br>
+<h3>Referer rankings</h3>
+The referer rankings page shows the hits that are coming in from other websites
+and weblogs that have links to your weblog and to specific entries in your
+weblog. By looking at your referer logs, you can get an idea of who is reading
+and commenting on your weblog.<br>
+<br>
+<h2><a name="editing_bookmarks"></a>Editing your bookmark collection</h2>
+<h3>Adding new book<span style="text-decoration: underline;"></span>mark
+folders</h3>
+<p>You probably already have a web bookmark collection stored in your web
+browser, so why do you need to enter bookmarks into Roller. Well, most Weblog
+authors like to include links to their favorite websites and to their favorite
+Weblogs right on their Weblog page. Roller's bookmark feature makes it easy
+for you to do this too.</p>
+<p>Bookmarks are organized in to named folders. You can define any number
+of folders and each of these folders can hold any number of bookmarks. There
+is only one level of folders, so you cannot have a folder that contains other
+folders. </p>
+<p>Your initial website contains two bookmark folders: one named Blogrolling
+that contains Weblogging related links and one named News that contains
+links to well known news sources. If you look at Figure 1 again, you can
+see that these two folder are displayed on the left side of the Weblog page.
+You can use Roller's bookmark management features to rename these folders
+if you wish, or you can delete them add add folders of your own choosing.</p>
+<p align="center">Figure 3: the Edit-Bookmark Folders page<br>
+<br>
+</p>
+<div align="center"><a href="edit-bookmark.gif"><img
+ src="edit-bookmark_.jpg" alt="" width="300" height="355"></a><br
+ clear="left">
+</div>
+<h3>Adding bookmarks to folders</h3>
+<p>Once you have defined one or more bookmark folders, you can start adding
+bookmarks to those folders. From the Edit-Bookmark Folders page, click the
+Edit link for the Folder you wish to edit. You will be taken to the Edit-Bookmark
+Folder page for that folder. From there you can edit the name of the folder
+and you can add and remove bookmarks in that folder.</p>
+<p align="center">Figure 4: the Edit-Bookmark Folder page</p>
+<p align="center"><a href="edit-folder.gif"><img src="edit-folder_.jpg"
+ alt="" width="300" height="355"></a><br>
+</p>
+<h3>Editing a bookmark</h3>
+<p>After you use the Edit-Bookmark Folder to add a bookmark, you can edit
+the Bookmark itself. To edit a bookmark, click on the Edit link in the Edit-Bookmark
+Folder page. That will take you to the Edit-Bookmark page and from there
+you can change the name, description and display priority of the bookmark
+you have chosen to edit. You can also move the bookmark to another folder
+by changing the Bookmark Folder combo-box.</p>
+<p align="center">Figure 5: the Edit-Bookmark page<br>
+<br>
+</p>
+<div align="center"><a href="edit-bookmark.gif"><img
+ src="edit-bookmark_.jpg" alt="" width="300" height="355"></a><br
+ clear="left">
+</div>
+<p><br>
+</p>
+<h3>Importing Bookmarks in OPML format</h3>
+Roller makes it easy to import bookmarks and build your blogroll by importing
+bookmarks in OPML format. XBEL might be a better bookmarks format, but OPML
+is more popular in the world of weblogs. To import bookmarks via OPML, follow
+these steps:<br>
+
+<ol>
+ <li>download bookmarks in OPML format from a site such as Scripting.COM
+and save them as a file on your hard disk.</li>
+ <li>Login to Roller and choose the Bookmarks:Import menu option.</li>
+ <li>Use the file-upload capability to upload the OPML file into Roller.
+ The bookmarks will be imported into a folder called "unfiled". You can
+use Roller to organize the bookmarks as you wish. </li>
+</ol>
+<p><br>
+</p>
+<h2><a name="editing_newsfeeds"></a>Editing your newsfeed collection</h2>
+<h3>Adding and deleting newsfeeds</h3>
+<p>A newsfeed is a list of news stories and a short desciption of each story
+that is automically retrieved from some remote website. Newsfeeds are delivered
+in a format known as Really Simple Syndication or Rich Site Summary or just
+RSS.</p>
+<p>Roller allows you to include newsfeeds on your Weblog page or on a separate
+page that you create as part of your Weblog's website. Your initial website
+will include three newsfeeds, but none of these newsfeeds are displayed on
+your Weblog page. You can use one of the macros that we will discuss later
+to display your newsfeeds.</p>
+<p>Before you include a newsfeed on your website, you should probaby make
+sure that doing so is OK with the provider of the newsfeed. Some providers
+might frown upon this and by frown I mean that they might sick a pack of
+rabid lawyers on your ass. Anyhow, use your own judgement here I am not
+a lawyer and I am not responsible for any of your current or future legal
+troubles.</p>
+<p>To add a newsfeed you need a URL to the providers RSS feed. This URL usually
+ends with the letters .xml. Enter the name that you would like to use for
+the newsfeed, enter the URL and hit enter to add the newsfeed.</p>
+<h2><a name="customizing_your_pages"></a>Customizing your website</h2>
+<h3>Website settings</h3>
+The website settings form allows you to set the following properties for your
+weblog website:<br>
+<ul>
+ <li>
+ <p><span style="font-weight: bold;">Website title</span> - The title of
+your website may include HTML, but the HTML will be stripped out in your RSS
+feed. You can access your title in a page template with the expression
+ <span style="font-weight: bold;">$macros.website.title</span></p>
+ </li>
+ <li>
+ <p><span style="font-weight: bold;">Website description</span> - The description
+of your website may include HTML, but the HTML will be stripped out in your
+RSS feed. You can access your description in a page template with the expression
+ <span style="font-weight: bold;">$macros.website.description</span></p>
+ </li>
+ <li>
+ <p><span style="font-weight: bold;">Homepage page</span> - Choose a page
+template to be used as your websites main page.</p>
+ </li>
+ <li>
+ <p><span style="font-weight: bold;">Day template page</span> - Choose
+a page template to be used to display weblog entries via the <span
+ style="font-weight: bold;">$macros.showWeblogEntries()</span> macro.</p>
+ </li>
+ <li>
+ <p><span style="font-weight: bold;">Weblog editor page</span> - Choose
+either the plain old text editor (editor-text.jsp), the Ekit editor applet
+(editor-ekit.jsp), or the IE only Mitchell editor (editor-dhtml.jsp).</p>
+ </li>
+ <li>
+ <p><span style="font-weight: bold;">Enable Blogger API </span>- Set to
+true to enable weblogging via the Blogger API.</p>
+ </li>
+ <li>
+ <p><span style="font-weight: bold;">Category for Blogger API posts</span>
+- Choose the category for incoming posts made via the blogger API.</p>
+ </li>
+</ul>
+
+<h3>Website pages</h3>
+<p>Your Weblog page is defined by a page template. A template is a file with
+some special "macros" that indicate where Roller is supposed to put your
+Weblog, Weblog Calendar, and other dynamically created content. A templage
+can be an HTML file, an HTML fragment, a CSS page, or just about anything
+else you can enter into Roller as text.</p>
+<p>You initial Roller website has three page template, only one of which
+is visible to users. The pages are named Weblog, _DayTemplate and _css.</p>
+<ul>
+ <li>
+ <p>The Weblog page is the visible page, it is the HTML template that
+defines your Weblog. It is a mix of HTML and Roller macros that render the
+dynamic parts of the page like the Weblog Calendar and the actual Weblog
+entries.</p>
+ </li>
+ <li>
+ <p>The _DayTemplate page is the HTML template that defines the entries
+for each day are formatted in your Weblog page. This is essentially an HTML
+fragment with some Roller macros for rendering the day's Weblog entries,
+title, date, and other items.</p>
+ </li>
+ <li>
+ <p>The _css page is a CSS style-sheet information that is included (using
+a macro) on your Weblog page.</p>
+ </li>
+</ul>
+<p>You can define as many pages as you would like. You must specify which
+page is to be your Default Page, that is, the page that your readers first
+see when they visit your website. You must also specify which page is your
+Weblog day template.</p>
+<p>Note that any page whose name begins with the underbar _ character will
+not be visible to your readers. That is why the _DayTemplate and _css pages
+start with underbars, they are used internally and are not meant for public
+consumption.</p>
+<p align="center">Figure 6: the Edit-Website page</p>
+<p align="center"><a
+ href="edit-website.gif"><img
+ src="edit-website_.jpg"
+ alt="" width="300" height="355"></a><br>
+</p>
+<p>If you click on one of the Current Pages in the Edit-Website page, you
+will be directed to the Edit-Page page so that you can edit that page. You
+can put anything on a page, but typically you will put HTML with some Roller
+macros mixed in. Next you will read about the various Roller macros that
+are available for your use.</p>
+<p>The screenshot below shows the Weblog page being edited in the Edit-Page
+page.</p>
+<p align="center">Figure 7: the Edit-Page page</p>
+<div style="text-align: center;"><a
+ href="edit-page.gif"><img
+ src="edit-page_.jpg"
+ alt="" width="300" height="346"></a><br>
+</div><br>
+
+<h3>Weblog Themes</h3>
+<p>Besides editing your pages directly, you can Preview the other templates and
+modifications to your weblog page. <font color="red">NOTE: this feature is only good for editing
+the default page, which must be your weblog page if you want to preview other
+templates.</font> On the "Change your Weblog Template" page you may select another
+theme to preview, or edit the template directly.
+<ul>
+<li>Clicking the "Preview" button
+will load a page where you will be able to see any changes or the theme you
+selected.</li>
+<li>Clicking "Save" saves those changes, or the new theme, to your Weblog page:
+this change cannot be 'undone'. You might want to make a backup copy of your
+Weblog page before you begin working on any changes.</li>
+<li>Clicking "Cancel" clears any changes you haven't
+saved and sends you to the Website Settings page.</li>
+</ul>
+On the Preview page, if you
+click edit you will be sent back to the Change your Weblog Template page. If
+you had selected a Theme it will be selected on this page and its template displayed
+in the edit box. To continue editing this template, select Custom from the Theme
+list, make any changes you desire and click Preview.</p>
+
+<h3>Website files</h3>
+Roller now includes a file-upload feature that allows you to upload images
+and other file for use in your weblog templates. Here are the steps to upload
+and image to Roller and to use it in a weblog template:
+<ol>
+ <li>Use the Weblog:File menu option to upload your image file</li>
+ <li>Use the Weblog:Pages menu to edit one of your templates. Place the
+HTML IMG tag where you want the image to appear and use $macros.showResourcePath()
+directive to build the URL for the image. For example, if your image was
+called leo.gif you might insert an IMG tag like this: <img src="$macros.showResourcePath()/leo.gif"
+alt="one happy baby" /></li>
+</ol>
+<h3>User settings</h3>
+You can use the User Settings form to set your Full Name, Password, and Email
+address.
+<h3>Export</h3>
+Your Roller administrator should be using some sort of database utility to
+back up the Roller database on a regular basis. If you are worried that backups
+are not being done and you want to store a copy of your Roller data on your
+personal computer, you can use Roller's new export capability to export your
+weblog data in Roller's XML format. Currently, there is no import facility
+for Roller XML so in the case of data-loss you will need your administrator's
+help to recreate your user.<br>
+<h3>Admin</h3>
+<h3></h3>
+The admin screen is only available to Roller administrators. It allows an
+adminstrator to delete a user account from Roller.<br>
+<br>
+<h2><a name="macros_for_page"></a>Macros intended for use on any page template</h2>
+<p>Macros tell Roller where to place the dynamic parts of your web pages.
+Macros use <a href="http://jakarta.apache.org/velocity/index.html">Velocity</a> expressions and
+custom JSP tag libraries. For more information on Velocity,
+visit the Velocity web site and read the Velocity
+<a href="http://jakarta.apache.org/velocity/user-guide.html">User's Guide</a>. Note that
+we use the term macro loosely, but it does have a specific meaning in Velocity.
+What we call a macro is really a Velocity expression. To learn more about JSP
+and tag libraries, visit Sun's <a href="http://java.sun.com/products/jsp/">JSP site</a>.<br>
+</p>
+In a page template, you have access to an object called $macros that has many
+methods. The macros object is actually a Java object. To see the methods
+that are available to you via the <span style="font-weight: bold;">$macros</span>
+object, please refer to the Javadocs for:<br>
+<br>
+ <a
+ href="http://www.rollerweblogger.org/javadoc/org/roller/presentation/velocity/Macros.html">org.roller.presentation.velocity.Macros</a><br>
+<br>
+<h2><a name="macros_for_day"></a>Macros intended for use on your day template
+page</h2>
+<p class="western">Your Day Template page determines how each day of Weblog
+entries is formatted on the page by the <span style="font-weight: bold;">$macros.showWeblogEntries()</span>
+macro. Inside your day template you have access to a <span
+ style="font-weight: bold;">$macros</span> object that has some additional
+methods. So see the methods available to you via the $macros object in the
+day template, please refer to the Javadocs for:<br>
+</p>
+<p class="western" style="margin-left: 40px;"><a
+ href="http://www.rollerweblogger.org/javadoc/org/roller/presentation/velocity/Macros.html">org.roller.presentation.velocity.Macros</a><br>
+<a
+ href="http://www.rollerweblogger.org/javadoc/org/roller/presentation/weblog/tags/WeblogEntryMacros.html">org.roller.presentation.weblog.tags.WeblogEntryMacros</a><br>
+</p>
+<p class="western">Additionally, inside a day template you also have access
+to a collection called $entries which is made up of WeblogEntryDataEx objects.
+ For information on the methods and fields of these objects please refer to:<br>
+</p>
+<div style="margin-left: 40px;"><a
+ href="http://www.rollerweblogger.org/javadoc/org/roller/presentation/weblog/WeblogEntryDataEx.html">org.roller.presentation.weblog.WeblogEntryDataEx</a><br>
+<br>
+</div>
+<h2><a name="examples"></a>Example weblog page and day templates</h2>
+<p>Here is the weblog page template for the basic theme, shown in figure
+1 (macros are shown in blue):</p>
+<blockquote>
+ <pre><html><br><head><br><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><br><title><span
+ style="color: rgb(51,51,255);">$macros.showWebsiteTitle()</span></title> <br><style type="text/css"><span
+ style="color: rgb(51,51,255);">$macros.includePage("_css")</span><br></style><br></head><br><body background="/roller/images/bg-greylines.gif"><br><table cellpadding="5" cellspacing="15" border="0" align="center" width="95%"> <br> <tr> <br> <td width="20%" valign="top" bgcolor="#ffffff"> <br><span
+ style="color: rgb(51,51,255);"> $macros.showNavBar(true)</span><br> <span
+ style="color: rgb(51,51,255);"> </span><br
+ style="color: rgb(51,51,255);"><span style="color: rgb(51,51,255);"> $macros.showEditorNavBar(true)</span><br><br
+ style="color: rgb(51,51,255);"><span style="color: rgb(51,51,255);"> $macros.showBookmarks("Blogrolling",true)</span><br> <span
+ style="color: rgb(51,51,255);"> </span><br
+ style="color: rgb(51,51,255);"><span style="color: rgb(51,51,255);"> $macros.showBookmarks("News",true)</span> <br> </td> <br> <td width="60%" valign="top" bgcolor="#ffffff"> <br> <h2><span
+ style="color: rgb(51,51,255);">$macros.showWebsiteTitle()</span></h2> <br> <span
+ style="color: rgb(51,51,255);">$macros.showWeblogCategoryChooser()</span><br> <br> <span
+ style="color: rgb(51,51,255);">$macros.showWeblogEntries()</span> <br> </td> <br> <td valign="top" bgcolor="#ffffff" width="20%"> <br> <span
+ style="color: rgb(51,51,255);">$macros.showWeblogCalendar()</span><br> <br> <span
+ style="color: rgb(51,51,255);">$macros.showRSSBadge()</span> <br> </td><br> </tr><br></table> <br></body><br></html><br><br></pre>
+</blockquote>
+<p>Here is the Day Template for the Weblog shown in figure 1:</p>
+<blockquote>
+ <pre><table width="95%"><br><tr><br> <td><br> <span
+ style="color: rgb(51,51,255);"> $macros.showPermalink()</span><br
+ style="color: rgb(51,51,255);"><span style="color: rgb(51,51,255);"> $macros.showEntryDate()</span><br> </td><br></tr><br></table><br><span
+ style="color: rgb(51,51,255);">#foreach( $entry in $entries )</span><br><p><br> <b><span
+ style="color: rgb(51,51,255);">$entry.title</span></b> <span
+ style="color: rgb(51,51,255);">$entry.text</span> <br> <font size="2">(<span
+ style="color: rgb(51,51,255);">$entry.updateTime</span>/<span
+ style="color: rgb(51,51,255);">$entry.pubTime</span>)</font><br></p>
+<span style="color: rgb(51,51,255);">#end</span>
+ <br></pre>
+</blockquote>
+<pre><br></pre>
+<pre><br></pre>
+<br>
+</body>
+</html>
Added: incubator/roller/trunk/docs/userguide/old/weblog.gif
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/old/weblog.gif?rev=189695&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/userguide/old/weblog.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/userguide/old/weblog_.jpg
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/old/weblog_.jpg?rev=189695&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/roller/trunk/docs/userguide/old/weblog_.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/roller/trunk/docs/userguide/quickstart.wiki
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/quickstart.wiki?rev=189695&view=auto
==============================================================================
--- incubator/roller/trunk/docs/userguide/quickstart.wiki (added)
+++ incubator/roller/trunk/docs/userguide/quickstart.wiki Wed Jun 8 20:18:46 2005
@@ -0,0 +1,36 @@
+!!!Getting started with Roller
+
+This document describes how to create a new Roller account and make your first weblog post.
+
+!!!Sign-up for a New Account
+
+To sign-up for a Roller account, go the the main Roller page and click on the link that reads "register as a new user." You will be presented with the form below. Enter your login name, your real name, your desired password, your e-mail address, and pick one of the predefined Weblog themes provided by Roller. There is a basic theme, which is a very good starting point for those who wish to build their own themes, and there are a couple of themese adapted from themes on [http://blogskins.com]. Take a look at the RollerThemes page to see some screenshots.
+
+[http://www.rollerweblogger.org/userguide/images/qs1-newuser.png]
+
+!!!Welcome
+
+Next you'll see the welcome page. You'll see the URL for your weblog, the URL for your RSS feed, and a login link. After you make a note of your URLs, click the login link to login to your weblog.
+
+[http://www.rollerweblogger.org/userguide/images/qs2-welcome.png]
+
+!!!Login to Roller
+
+I'm pretty sure you know what to do here.
+
+[http://www.rollerweblogger.org/userguide/images/qs3-login.png]
+
+!!!Make your First Weblog Post
+
+After you login, you will be presented with the Weblog:Edit page, shown below, which is just one part of the Roller Editor UI. The Weblog:Edit page is shown below. To make a weblog post enter a title in the Title field (titles are nice, but optional), enter your post in the Content field, and pick a category combo-box. Don't enter anything in for the Publication Time, Roller will fill that in for you. You can use any sort of HTML markup that you want in your post, but make sure you close all of your HTML tags.
+
+When you are happy with your post, you can click the __Post to Weblog__ button to post it to your weblog or the __Save as Draft__ button to save it as a private post for later editing. Optionally, you may choose to click the __Spell Check__ button to check and correct spelling errors in your post.
+
+[http://www.rollerweblogger.org/userguide/images/qs4-first-post.png]
+
+!!!How does it look
+
+After you post your weblog entry, click the Weblog link in the Navigation Bar at the very top of the Weblog:Edit page. You should see your weblog and the new post that you just entered. Something like this:
+
+[http://www.rollerweblogger.org/userguide/images/qs5-myblog.png]
+
Added: incubator/roller/trunk/docs/userguide/userguide.wiki
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/userguide.wiki?rev=189695&view=auto
==============================================================================
--- incubator/roller/trunk/docs/userguide/userguide.wiki (added)
+++ incubator/roller/trunk/docs/userguide/userguide.wiki Wed Jun 8 20:18:46 2005
@@ -0,0 +1,752 @@
+!!!The Roller Weblogger User Guide v0.9.7
+See also: InstallationGuide
+
+Orignal text is ''Copyright © 2003 David M Johnson''
+
+* [1] Introduction
+
+* [2] Getting started
+** QuickStartGuide
+** The Roller Web Application
+** Roller Navigation Bars
+** The Roller Editor UI
+
+* [3] Managing your Weblog
+** Adding a New Weblog Post
+** Working with Old Weblog Posts
+** Working with Weblog Comments
+** Sending Trackbacks
+** Weblog Categories
+** Referer Rankings
+** Flushing the Cache
+
+* [4] Customizing your Website
+** Website Settings
+** Website Themes
+** Uploading Files
+
+* [5] Customizing your theme with Roller Macros
+** [5.1|51] Weblog and day pages
+** [5.2|52] Other pages and comments
+** [5.3|53] Roller Macros and Variables
+** [5.4|54] Creating and packaging your own Roller theme
+
+* [6] Using Roller for Bookmark and Blogroll Management
+** Adding new bookmark folders
+** Adding bookmarks to folders
+** Editing a bookmark
+** Displaying your bookmarks
+** Importing OPML via the Bookmarks:Import Page
+
+* [7] Using Roller for Display of RSS Newsfeeds
+** Newsfeeds:Subscriptions Page
+** Newsfeeds:View All Page
+** Newsfeed Display Macros
+
+* [8] Using a Blogging Client with Roller
+** Configuring w:bloggar
+
+* [9] Configuration and Administration of Roller
+** The Website:Admin Page
+** The Website:Config Page
+
+
+\\
+\\
+!!![#1] Introduction
+
+Roller is a Weblogger. Roller makes it easy for you to maintain a weblog, even if you are have little or no knowledge of HTML. All you have to do is go to a web site that is running the Roller software, sign up for an account and bam you have a weblog. You can start posting right away. You will need to know a little about HTML if you want to kick it up a notch by customizing the layout of your Weblog and adding new pages to your Weblog website. More on that later.
+
+Please note that Roller is currently beta quality code not necessarily ready for prime time there are probably a number of design flaws and an even larger number of bugs. As always with software of all sorts, and especially pre-release software such as this, use at your own risk. If you find a flaw, a bug, or something that you do not like please contribute back to the Roller project be reporting that bug to the Roller development team's [JIRA issue tracking system|http://opensource.atlassian.com/projects/roller/Dashboard.jspa].
+
+
+
+\\
+\\
+!!![#2] Gettings started
+
+To get started with Roller you need to either 1) find a Roller site somewhere that is offering new user registration or 2) install Roller yourself. There are a couple of sites offering free Roller accounts. One is AnthonyEden's aptly named FreeRoller site, hosted by JavaLobby. Another is [http://blogs.application-servers.com]. Both of these sites are currently running Roller 0.9.6, so some of the features described in this guide will not be available. What about installing Roller? You should only attempt to install Roller yourself if you are comfortable with system, database, and Java app server administation. If you are ready for the challenge, download Roller from the DownloadPage on SourceForge and follow the instructions in the Roller InstallationGuide to install and start Roller.
+
+
+
+\\
+!!QuickStartGuide
+
+So, how do you get started? The Roller QuickStartGuide shows you how to create a new Roller account and how to make your first weblog post (it's on a separate page because it has lots of images and is only interesting to first time users).
+
+
+
+\\
+!!The Roller Web Application
+
+There are three main parts of the Roller Web Application: the main page, user website pages, and the Editor UI.
+
+* __The Roller main page__: The main page of a Roller site shows the most 15 most recent weblog posts for all of the users weblogs that are hosted on the site and a the 15 most popular weblogs for the day (according the referer ranking). Under the list of the most recent weblog posts, there is a bright orange XML icon that links to an RssFeed that combines all of the weblogs on the site into one aggregated new feed. For each of the weblogs listed in the most popular weblogs list there is a bright orange XML icon that links to the RssFeed for that weblog.
+
+* __User pages__: Each Roller user has his or her own "website" within the Roller installation. A website is a set of pages, each page is defined by an HTML page template that may be edited by the user. These page may contain VelocityTemplateLanguage expressions, control statements, and a special set of VelociMacros for useful things like a WeblogCalendar, EditorNavBar, PageNavBar, RefererList, and other things. One of these pages is the user's weblog page or default weblog page. More about this later...
+
+* __The Editor UI__: The Roller Editor UI is a web-based UI for editing your weblog, managing weblog categories, managing a bookmark collection (AKA blogroll) managing newsfeeds, configuring, and administering a Roller website and installation. The menu for the Editor UI contains the same items as the Editor Navigation Bar, but is presented in an Amazon-style tabbed menu format. The rest of this guide will walk you through using the Editor UI to do all these things and we'll take a closer look at the Roller Editor UI menu.
+
+To help you find your way around the Roller Web Application, there are three types of Navigation Bars in Roller: the Navigation-Bar, the Page Navigation Bar and the Editor Navigation Bar.
+
+
+__Navigation Bar__
+
+The Navigation Bar appears at the top of the Roller main page and at the top of the Roller Editor UI. When you are not logged into Roller the navigation bar looks like this:
+
+[http://www.rollerweblogger.org/userguide/images/navbar.png]
+
+When you logged to Roller, the navigation bar expands to show links to all of your public pages, to the Weblog:Edit page and to the Website:Settings page. For example, if you had pages named 'Weblog', 'Bookmarks', and 'Archive' and you were logged into Roller, your Navigation Bar would look like this:
+
+[http://www.rollerweblogger.org/userguide/images/navbar-auth.png]
+
+
+__Page Navigation Bar__
+
+The Page Navigation Bar is produced by a Roller macro that may be used in Roller user pages. The macro is called #showNavBar() and it is included in all of the default Roller template, but you could choose to remove it if you wanted. For example, if you had pages named 'Weblog', 'Bookmarks', and 'Archive' and you were not logged into Roller, your Page Navigation Bar would look like this:
+
+[http://www.rollerweblogger.org/userguide/images/page-navbar.png]
+
+After you logged into Roller your Page Navigation Bar would look like this:
+
+[http://www.rollerweblogger.org/userguide/images/page-navbar-auth.png]
+
+
+__Editor Navigation Bar__
+
+The purpose of the Editor Navigation Bar is to make it easy for you, when you are logged into Roller, to access the Roller Editor UI directly from your weblog page. Like the Page Navigation Bar, the Editor Navigation Bar is also produced by a Roller macro. The macro is called #showEditorNavBar() and it is also included in all of the default Roller templates. If you are not logged into Roller, the Editor Navigation Bar will hide itself. The Editor Navigation Bar looks like this:
+
+[http://www.rollerweblogger.org/userguide/images/editor-navbar.png]
+
+Clicking on any of the links on the Editor Navigation Bar will take you into the Roller Editor UI.
+
+
+
+\\
+\\
+!!![#3] Managing your Weblog
+
+In Roller, managing your weblog includes writing new weblog posts, editing old weblog posts, deleting comments, sending trackbacks, creating weblog categories, and viewing your referer logs. Here is the Weblog sub-menu of the Roller Editor UI:
+
+[http://www.rollerweblogger.org/userguide/images/eui-weblog.png]
+
+
+
+
+\\
+!!Adding a new weblog post
+
+To add a new Weblog post you simply go to the Weblog:Edit page, enter an optional title in the Title field, enter the your post in the Content text area, choose a category from the Category combo, and hit the __Post to Weblog__ button. As soon as you do that, your Weblog entry is posted to your Weblog for the world to see. Here is the relevant part of the Weblog:Edit page.
+
+[http://www.rollerweblogger.org/userguide/images/new-post.png]
+
+The above screenshow shows the default plain text weblog post editor. With this editor, you are entering raw HTML and if you don't know HTML you will not be able to do bold, italics, paragraph breaks, etc. Roller also support several other WysiwygEditors and you can pick the one you want using the Website:Settings menu of the Editor UI.
+
+__The Publication Time Field__
+
+When you make a new weblog post, you don't need to enter anything into the Publication Time field. Roller will fill that in for you when you hit the post or save button. When you edit your post later, you may choose to change this Publication Time. I know this is lame, but you must enter the date in the format 'dd.MM.yyyy HH:mm:ss'. If you don't like it then fix it and send [us|http://sourceforge.net/mail/?group_id=47722] the code.
+
+__Save as Draft__
+
+If you want to save your post as a draft, a private draft that nobody can see but you, then hit the __Save as Draft__ button. Your entry will be saved and you can edit and post it later.
+
+__Spell Check__
+
+If you want to spell check your entry before posting it or saving it as a draft, then hit the __Spell Check__ button. The Spell Checker will note each misspelling and will offer alternatives for each, as shown below:
+
+[http://www.rollerweblogger.org/userguide/images/spell-check.png]
+
+
+
+
+\\
+!!Working with Old Weblog Posts
+
+You can also use the Weblog:Edit page to manage your old posts. Below the Title and Content fields, and below the Post and Save buttons is a table that lists your most recent weblog posts, both public and private (AKA drafts). There is also a calendar so that you can navigate to even older posts. The bottom of the Weblog:Edit page looks like this:
+
+[http://www.rollerweblogger.org/userguide/images/edit-old-posts.png]
+
+There are a number of operations that you can perform on each post. Here is a summary:
+
+*__Edit__: This will load the post into the edit-weblog text area so that you may edit it and then either repost it, save it as a draft or spell check it.
+
+*__Comments__: This will display the comments that have been made by users either through the comment form or Roller's Trackback facility. You may choose to delete comment, but you cannot edit them.
+
+*__Send Trackback__: This will display the Send Trackback page so that you can send a Trackback ping to another blog to tell that blog that you are writing about them.
+
+*__Remove__: This will remove the weblog post. First, Roller will ask you "are you sure?"
+
+
+
+\\
+!!Working with Weblog Comments
+
+If you have enabled comments in your Website:Settings page and you have one of the comments macros in your day template (__#showCommentsLink()__ or __#showCommentsPageLink()__) then your users may leave comments on each of your weblog entries. Also, Trackbacks that come in from other weblogs are treated as comments.
+
+You can't edit comments, that wouldn't be right now would it? However, you can delete the comments that you do not like. From the Editor UI you can view and delete the comments that are associated with your weblog entries. To view the comments for a weblog entry, click on the __Comments__ link for that entry on the __Weblog:Edit__ page. You'll see the Delete Comments page as shown below. Click the checkboxes for the comments and/or Trackbacks you wish to delete and blow them away.
+
+
+[http://www.rollerweblogger.org/userguide/images/delete-comments.png]
+
+
+
+
+\\
+!!Sending Trackbacks
+
+
+If you are writing about something you read on another weblog, you want to let the author and readers of that weblog know that you are doing so, and that other weblog is [MT Trackback|http://www.movabletype.org/docs/mttrackback.html] enabled, then you should send that weblog a Trackback ping.
+
+To send a Trackback for one of your weblog entries following these steps:
+
+# Locate the Trackback URL for the weblog entry that you wish to ping on the other site, copy it with ALT-C (or whatever).
+# Click the __Send Trackback__ link your weblog entry in the Weblog:Edit page. The Roller __Send a Trackback__ page will appear.
+# Paste the Trackback URL that you found step 1 into the Trackback URL field of the __Send A Trackback__ page and click the send button.
+
+Here is the __Send a Trackback__ page:
+
+[http://www.rollerweblogger.org/userguide/images/send-trackback.png]
+
+If the Trackback completed successfully, you should see a page like the one below with the number 0 in the <error> tags. If the Trackback failed you should see an error message that explains what went wrong.
+
+[http://www.rollerweblogger.org/userguide/images/sent-trackback.png]
+
+
+
+
+\\
+!!Weblog Categories
+
+Roller's weblog categories feature allows you to organize your weblog posts by category. For example, you might setup a category called "Family" for your family related posts, a category called "Music" for your music posts, and a category called "Misc" for everything else.
+
+When you write a new weblog post you must decide which category to place it in. On the Weblog:Edit page, there is a combo-box that allows you to pick a category for your post or to change the category when you edit an old post. Currently, Roller only allows you to assign each weblog post to one category.
+
+__The Weblog Category Chooser__
+
+When a user views your site, they can choose which category to view. All of the stock Roller weblog templates include the Weblog Category Chooser (displayed by the #showWeblogCategoryChooser() macro) close to the top of the page so that your readers can pick which category to display or "All" for all categories of posts.
+
+__RSS Feed for Each Category__
+
+Your weblog's main RSS newfeed includes all categories, but users can choose to subscribe to specific categories. All of the stock Roller weblog templates display a list of your RSS feeds (displayed by the #showRSSLinks() macro), one for all categories and one for each separate category.
+
+__Adding, Renaming, and Removing Weblog Categories__
+
+You can change the names of your categories, add new categories, and delete categories using the Weblog:Categories page of the Roller Editor UI.
+
+
+
+\\
+!!Flushing the Cache
+
+The __Weblog:Flush__ Cache menu item allows you to flush the Roller page cache. The page cache is a performance feature that allows Roller to serve up pages faster and to minimize database access. Normally, the cache is flushed when you edit a weblog entry, add a new page template, or do just about any other operation. So, under normal conditions you should not need to flush the cache.
+
+
+
+\\
+!!Referer Rankings
+
+The __Weblog:Referer__ referer rankings page shows the hits that are coming in from other websites and weblogs that have links to your weblog and to specific entries in your weblog. By looking at your referer logs, you can get an idea of who is reading and commenting on your weblog.
+
+
+
+\\
+\\
+!!![#4] Customizing Your Website
+
+If you are thinking "my website? What ''are'' you talking about? I thought I had a weblog not a website," then let me explain. In Roller we use the word ''website'' because, as a Roller user, that is what you have, a website. You don't just have a weblog, you have a website made up of multiple pages. Each of these pages is defined by a ''page template'' also known as a ''page''. One of these pages is your weblog.
+
+As a Roller user, you are free to customize the look-and-feel of your website as you wish. When you establish your Roller user account, you can choose one of the dozen or so stock themes for your website. Later, you can use the Theme Switcher to switch to a different theme. Or, if you know something about HTML and CSS you can customize the look-and-feel and layout of your website yourself by modifying the page templates that make up your site and by adding new pages. Best of all, you can do all of this through the web-based Roller Editor UI.
+
+Figure: The Roller Editor UI's Website Menu and it's Submenus:
+[http://www.rollerweblogger.org/userguide/images/eui-website.png]
+
+In this section, we'll discuss making simple settings changes via the __Website:Settings__ page, switching themes using the Theme Switcher __Website:Themes__ page, customizing your page templates via the __Website:Pages__ page, and uploading files to your website via the __Website:Files__ menu.
+
+
+
+\\
+!!Website Settings
+
+The __Website:Settings__ page allows you to set some simple configuration properties for your website, like the title and description of your site. It also allows you to choose an HTML editor for the __Weblog:Editor__ page and to enable and disable support for the BloggerAPI and for Comments. The __Website:Settings__ page is shown below.
+
+[http://www.rollerweblogger.org/userguide/images/website-settings.png]
+
+The website settings form allows you to set the following properties for your weblog website:
+
+* __Title of this website__ - The title of your website may include HTML, but the HTML will be stripped out in your RSS feed. You can access your title in a page template with the expression $macros.website.title
+
+
+* __Description of this website__ - The description of your website may include HTML, but the HTML will be stripped out in your RSS feed. You can access your description in a page template with the expression __$website.description__
+
+* __Page to be used as the homepage__ - Choose a page template to be used as your websites main page.
+
+* __Weblog editor page to be used__ - Choose a weblog editor page, some are WysiwygEditors
+** editor-text.jsp
+** editor-dhtml.jsp
+** editor-ekit.jsp
+** editor-midas.jsp
+** editor-text-js.jsp
+** editor-wiki-js.jsp
+
+* __Allow commments for your weblog__ - Set this to true to enable comments for your weblog. Note that, in order for comments to work, you will also have to include the comments macro in your day template. All of the themes that come with Roller include this macro, so you shouldn't really have to worry about this.
+
+* __Enable Blogger API for your weblog__ - Set to true to enable weblogging via the Blogger API. This will allow you to use handy Blogging clients like [w:bloggar|http://www.wbloggar.com/] to post to your weblog.
+
+* __Category for posts recieved via Blogger API__ - Choose the category for incoming posts made via the Blogger API. This only applies if you blogging client does not support categories.
+
+* __Ignore incoming referers that contain any of these (comma-separated) words__ - you can use this to filter out what referers are accepted. Somewhat useful if you start getting hit by referer spam, but not a complete solution to the referer spam problem.
+
+\\
+!!Website Themes
+
+A Website Theme is a look-and-feel for your website, a skin, if you will. When you created your Roller weblog/user-account, you picked from one of the available Roller themes. You might have picked the Robot theme, or the Roller theme, or whatever. A theme determines how your Roller website looks.
+
+If you want to change your theme, you can use the Roller Website:Themes menu to switch to a different theme. This is really easy and does not require any knowledge of HTML. I'll illustrate this below with a screenshot, but first a word of warning. If you have customized your theme on your own by modifying the HTML, CSS, and/or JavaScript in the pages that comprise your Roller theme, then watch our. Switching themes using the Roller Theme Switcher will destroy the customizations that you have made.
+
+Below is the Roller theme switcher. You can pick a new theme, preview it, and then either cancel or save the theme. If you don't hit the save button, your theme will not be switched.
+
+[http://www.rollerweblogger.org/userguide/images/theme-switcher1.png]
+
+If you were to pick the Moonshine theme in the "Select a theme" combo-box and then hit the preview button, you would see something like the screenshot below. If you want to select this new theme you will have to hit the __Edit__ button to return to the Theme Switcher and then hit the __Save__ button to save your theme selection.
+
+[http://www.rollerweblogger.org/userguide/images/theme-switcher2.png]
+
+
+
+\\
+!!Uploading Files
+
+Roller now includes a file-upload feature that allows you to upload images and other file for use in your weblog templates. Here are the steps to upload an image to Roller and to use it in a weblog template:
+
+# Use the Website:File menu option to upload your image file
+# Use the Website:Pages menu to edit one of your templates.
+# Place an HTML IMG tag where you want the image.
+
+Here are the steps to upload an image to Roller and use it in one of your weblog entries:
+
+# Use the Weblsite:File menu option to upload your image file
+# Use the Weblog:Edit menu to add or edit a weblog entry.
+# Place an HTML IMG tag where you want the image.
+
+In either case, you should specify the absolute URL to your image in the IMG tag, and you should add an ALT attribute to explain your image. Uploaded Images will be available at a URL like this: http://sitename/resources/username/imagename.ext. For example, if your site is FreeRoller, your username is mrroller, and your image name is leo.gif, then your IMG tag should look like this:
+
+{{{
+<IMG SRC="http://freeroller.net/resources/mrroller/leo.gif" ALT="one happy baby" />
+}}}
+
+
+
+\\
+
+\\
+!!![#5] Customizing your theme with Roller Macros
+
+
+Your website's theme is defined by a set of page templates. A page template is a file with some special macros that indicate where Roller is supposed to put your Weblog, Weblog Calendar, and other dynamically created content. A template can be an HTML file, an HTML fragment, a CSS page, or just about anything else you can enter into Roller as text. Roller uses the powerful Velocity template language and this gives you a lot of power and flexibility in customizing the look and feel and layout of your website and your weblog pages. For more information on the Velocity template language, refer to the [Velocity website|http://jakarta.apache.org/velocity/] and to the [Velocity Reference Guide|http://jakarta.apache.org/velocity/vtl-reference-guide.html]. Roller user's refer to page templates as either pages or template, the words page and template are used interchangably.
+
+''__NOTE__: Older versions of Roller used macros that began with __$macros__. These old macros have all been replaced by newer macros. The newer macros all start with the __#__ hash mark. See section [5.1|51] below on Roller Macro and Variable Reference for more information on the new macros and for a migration guide to help you move from the old macros to the new macros.''
+
+
+
+\\
+!![5.1|#51] Weblog and day pages
+
+Every Roller theme is a little different, but all themes have a minmum of two page templates: a weblog page and a day page. Let's discuss the purposes of these two pages.
+
+
+__Your Weblog page__
+
+Your weblog page is the main page of your website, the one that is specified as the default page in your Website:Settings page. This page is the page that displays the entries in your weblog, your weblog calendar, etc. This page can be very complex, or very simple, depending on your page design.
+
+To understand the weblog template, let's take a look at a simple example. Below is the weblog page template from Roller's Basic theme. This is a really good example because it is so basic and because it uses most, if not all, of the Roller Macros that you'd want to use on a weblog page:
+
+{{{
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <title>__#showWebsiteTitle()__</title>
+ <style type="text/css">#includePage("_css")</style>
+ #showRSSAutodiscoveryLink()
+<script type="text/javascript" src="$ctxPath/theme/scripts/roller.js">
+</script>
+</head>
+<body>
+<table border="0" align="center" width="95%"><tbody><tr>
+ <td class="entries" width="80%" valign="top" bgcolor="#ffffff">
+ <center>
+ <h1>#showWebsiteTitle()</h1>
+ <p class="descrip">#showWebsiteDescription()</p>
+ #showWeblogCategoryChooser()<br>
+ </center>
+ #showWeblogEntries("_day" 15)
+ </td>
+ <td width="20%" valign="top" bgcolor="#ffffff" width="20%">
+ <h2>Calendar</h2>
+ #showWeblogCalendar()<br>
+ <h2>RSS Feeds</h2>
+ #showRSSBadge()<br>
+ #showRSSLinks()
+ <h2>Links</h2>
+ #showBookmarks("Blogroll" true false)<br>
+ #showBookmarks("News" true false)
+ <h2>Navigation</h2>
+ #showBasicNavBar(true)<br>
+ #showEditorNavBar(true)<br>
+ <h2>Referers</h2>
+ #showReferers(30 20)
+ </td>
+</tr></tbody></table>
+</body>
+</html>
+}}}
+
+For a full listing of the Roller Macros refer to the Roller Macros and Variable Reference section below. The most important macro on the page is the __#showWeblogEntries__ macro. As you can see, it takes two arguments, the first is the name of the day page to use in the display of the weblog entries and the second is the number of weblog entries to be displayed on the page.
+
+
+__Your Day Page__
+
+Your Day page is used by the __#showWeblogEntries__ macro to display your weblog entries. This is where you customize the display of each day and of each weblog entry. Returning our example, below is the day page from the Basic theme:
+
+{{{
+<div class="box">
+<div class="entry">
+ #showDayPermalink( $day )
+ #showEntryDate( $day )
+</div>
+#foreach( $entry in $entries )
+ <p>
+ <b>$entry.title</b> $entry.text
+ <span class="dateStamp">($entry.pubTime)</span>
+ #showEntryPermalink( $entry )
+ #showCommentsPageLink( $entry )
+</p>
+#end
+#showLinkbacks( $day )
+</div>
+}}}
+
+Note that there are two variables __$day__ and __$entries__ available for use in the day template that are not available in other templates. The __$day__ variable refers to a date object (java.util.date) that contains the date of the day that is being rendered by the dat page. The $entries variable contains a collection of weblog entry objects (org.roller.model.WeblogEntryData). The example above uses a Velocity __#foreach__ loop to iterate through the individual entries in the entries collection and to display the title, text, and publish time of each.
+
+
+
+\\
+!![5.2|#52] Other pages and comments
+
+
+You can add as many pages as you like to your Roller website, you can choose which ones are to appear in your website's navigation bar, you can include pages in other pages using the __#includePage__ macro, and you can include Roller macros in any of these pages. Use the Roller Editor UI's Website:Pages menu to add new pages and to edit your existing pages.
+
+
+__Your default page__
+
+You can define as many pages as you would like, but you must specify one page is to be your default Page, that is, the page that your readers first see when they visit your website. You can specify your default page in your website settings on the Website:Settings page of the Roller Editor UI.
+
+
+__Some pages are visible, some are not__
+
+Note that any page whose name begins with the underbar "_" character will not be visible to your readers, meaning that it will not appear in your website's navigation menu that is dislayed by the __#showNavBar__ macros.
+
+
+__Pop-up comments, the comments page, and TwistyComments__
+
+The Basic theme example above also uses the __#showCommentsPageLink__ macro to display a link to the comments page for the weblog entry. If, instead, you wanted to use a popup comment, you could use the __#showCommentsLink__ macro. __NOTE__: comments will not work unless you check the ''Allow Comments'' check-box on the __Website:Settings__ page.
+
+What about Raible's TwistyComments? They are available in Roller 0.9.8, but not in Roller 0.9.7.
+
+If you are upgrading from Roller 0.9.6, take a look at EnablingComments.
+
+
+
+\\
+!![5.3|#53] Roller Macros and Variables
+
+For a complete list of the Roller Macros, see the [Macro Reference Guide|http://www.rollerweblogger.org/velocidocs/index.html]. If you are upgrading your pages from Roller 0.9.6, then see the [Macro Conversion Guide |http://rollerweblogger.org/docs/macro_conv.html].
+
+There are also a host of variables and objects that are available for your use in page templates:
+
+|__$now__ | The current time (a java.util.Date object).
+|__$ctxPath__ | The path under which Roller is running (see Webapp context).
+|__$baseURL__ | Base URL for your Roller website
+|__$absolutebaseURL__ | Absolute base URL for your Roller website.
+|__$uploadPath__ | The location where uploaded files are placed.
+|__$user__ | The current user object for the page/entry being viewed.
+|__$userName__ | The current user's username.
+|__$fullName__ | The current user's full name.
+|__$emailAddress__ | The current user's email address.
+|__$macros__ | The old legacy Roller 0.9.6 macros object.
+|__$website__ | The website for the current user.
+|__$page__ | The current page being viewed.
+|__$requestParameters__ | A map of the request parameters
+|__$rollerVersion__ | Version number of Roller software
+|__$utilities__ | A utilities object
+|__$stringUtils__ | A string utilities object
+
+Date formatting variables and objects:
+
+|__$dateFormatter__ | Date formatter object
+|__$toStringFormat__ | A date format to be used with the macro formatDate( $dateFormat $date ) :\\ EEEE MMMM dd, yyyy
+|__$plainFormat__ | Another date format for use with the formatDate() macro:\\ yyyyMMdd
+
+If the page is a day page template, then these variables are available too:
+
+|__$day__ | Date object holding date being displayed
+|__$entries__ | Collection of entries for date being displayed
+
+If the page is a comments page, then these variables are available:
+
+|__$isCommentPage__ | will be set to true
+|__$entry__ | weblog entry containing collection of comments
+|__$autoFormat__ | True if comments should be autoformatted
+|__$escapeHtml__ | True if HTML should be escaped
+
+
+
+\\
+!![5.4|#54]Creating and packaging your own Roller theme
+
+A Roller theme is, at a minimum, a subdirectory in the Roller ''themes'' directory with a page template named Weblog.vm in it. How does Roller determine what themes are available? Roller considers every subdirectory in the themes directory to be a theme.
+
+
+__How does Roller create a theme?__
+
+When you create a new user or switch themes for an existing user, Roller will read in a new theme for that user. When Roller reads in a theme for a user, all it is does is to create or replace the user's page templates.
+Roller follows these steps to read in a theme:
+
+# For each file in the theme's subdirectory that ends with ''.vm'' Roller creates a page template with the same name as the file, minus the ''.vm'' extension
+
+# The page template that is named ''Weblog'' is set to be the website's default page.
+
+
+__Including images, JavaScript, and CSS style sheets in a theme__
+
+If you want to create a more sophisticated theme, one that takes advantage of the Roller theme macros, you can use the following directory structure for your theme (as illustrated by [MattRaible]'s x2 theme):
+
+[http://www.rollerweblogger.org/userguide/images/theme-dir-structure.png]
+
+The page templates go in the root directory of the theme, images in the ''images'' directory, JavaScript files in the ''scripts'' directory, and CSS style sheets in the ''styles'' directory. Then, you can make your theme ''distributable'' by using relative paths to get to all of your themes images, scripts, and style sheets. You do this by using the Roller theme macros, listed below, whenever you refer to a file in your theme:
+
+* #showThemeScript( themeName, scriptFileName )
+* #showThemeScriptPath( themeName )
+* #showThemeStyleImport( themeName, scriptFileName )
+* #showThemeStyle( themeName, styleFileName )
+* #showThemeStylePath( themeName, styleFileName )
+* #showThemeImage( themeName, imageFileName )
+* #showThemeImagePath( themeName, imageFileName )
+* #showThemePath( themeName )
+
+
+
+\\
+\\
+!!! [#6]Using Roller for Bookmark and Blogroll Management
+
+You probably already have a web bookmark (AKA links) collection stored in your web browser, so why do you need to enter bookmarks into Roller? There are a couple of reasons. Most bloggers like to display a ''blogroll'' of links to favorite blogs. Most bloggers also like to display lists of favorite websites. By entering your bookmarks into the Roller bookmark manager, you'll find that it is easier to display your bookmarks on the various pages that make up your website.
+
+Bookmarks Management Submenu:
+
+[http://www.rollerweblogger.org/userguide/images/eui-bookmarks.png]
+
+
+
+\\
+!!Adding new bookmark folders
+
+
+Bookmarks are organized in to named folders. You can define any number of folders and each of these folders can hold any number of bookmarks. There is only one level of folders, so you cannot have a folder that contains other folders.
+
+Your initial website contains two bookmark folders: one named "Blogrolling" that contains Weblogging related links and one named "News" that contains links to well known news sources. If you look at Figure 1 again, you can see that these two folder are displayed on the left side of the Weblog page. You can use Roller's bookmark management features to rename these folders if you wish, or you can delete them add add folders of your own choosing.
+
+
+Figure: the Edit-Bookmark Folders page
+
+
+
+\\
+!!Adding bookmarks to folders
+
+
+Once you have defined one or more bookmark folders, you can start adding bookmarks to those folders. From the Edit-Bookmark Folders page, click the Edit link for the Folder you wish to edit. You will be taken to the Edit-Bookmark Folder page for that folder. From there you can edit the name of the folder and you can add and remove bookmarks in that folder.
+
+Figure: the Edit-Bookmark Folder page
+
+
+
+\\
+!!Editing a bookmark
+
+After you use the Edit-Bookmark Folder to add a bookmark, you can edit the Bookmark itself. To edit a bookmark, click on the Edit link in the Edit-Bookmark Folder page. That will take you to the Edit-Bookmark page and from there you can change the name, description and display priority of the bookmark you have chosen to edit. You can also move the bookmark to another folder by changing the Bookmark Folder combo-box.
+
+Figure: the Edit-Bookmark page
+
+
+\\
+!!Displaying your bookmarks
+
+You can use the __[#showBookmarks|http://www.rollerweblogger.org/velocidocs/macro-showBookmarks3.html]__ macro to display your bookmarks on your website pages. The macro will display all of the bookmarks in one of your bookmark folders. The arguments are ''String folderName'', ''boolean showFolderName'', and ''boolean expandingFolder''. The expanding folder feature is implemented using JavaScript, so, it will only work if the Roller JavaScript file is included on the page where the macro is used.
+
+For example, let's say that you want to display a folder named "News", you want to display the folder name, and you want to display it as an expanding folder. First, near the top and inside the <head> tag of your page, include the Roller JavaScript page roller.js, as shown below:
+
+{{{
+...
+ <html>
+ <head>
+ <title>My badass blog</title>
+ <script type="text/javascript" src="/theme/scripts/roller.js"></script>
+ </head>
+ <body>
+...
+}}}
+
+Later in your page, include the __#showBookmarks__ macro to display your bookmarks:
+
+{{{
+...
+ #showBookmarks( "News" true true )
+...
+}}}
+
+
+
+
+\\
+!!Importing Bookmarks in OPML format
+
+Roller makes it easy to import bookmarks and build your blogroll by importing bookmarks in OPML format. XBEL might be a better bookmarks format, but OPML is more popular in the world of weblogs. To import bookmarks via OPML, follow these steps:
+
+#download bookmarks in OPML format from a site such as Scripting.COM and save them as a file on your hard disk.
+#Login to Roller and choose the Bookmarks:Import menu option.
+#Use the file-upload capability to upload the OPML file into Roller. The bookmarks will be imported into a folder called "unfiled". You can use Roller to organize the bookmarks as you wish.
+
+
+
+\\
+!!![#7] Using Roller for Display of RSS Newsfeeds
+
+Newsfeed Aggregation Submenu:
+
+[http://www.rollerweblogger.org/userguide/images/eui-newsfeeds.png]
+
+
+
+\\
+!!Adding and deleting newsfeeds
+
+A newsfeed is a list of news stories and a short desciption of each story that is automically retrieved from some remote website. Newsfeeds are delivered in a format known as Really Simple Syndication or Rich Site Summary or just RSS.
+
+Roller allows you to include newsfeeds on your Weblog page or on a separate page that you create as part of your Weblog's website. Your initial website will include three newsfeeds, but none of these newsfeeds are displayed on your Weblog page. You can use one of the macros that we will discuss later to display your newsfeeds.
+
+
+Before you include a newsfeed on your website, you should probaby make sure that doing so is OK with the provider of the newsfeed. Some providers might frown upon this and by frown I mean that they might sick a pack of rabid lawyers on your ass. Anyhow, use your own judgement here, I am not a lawyer and I am not responsible for any of your current or future legal troubles.
+
+To add a newsfeed you need a URL to the providers RSS feed. This URL usually ends with the letters ".xml". Enter the name that you would like to use for the newsfeed, enter the URL and hit enter to add the newsfeed.
+
+
+
+\\
+\\
+!!![#8] Using a Blogging Client with Roller
+
+You can use any Blogger API client to post and edit Roller weblog entries. Before you can do this, you must go to the Roller Website:Settings menu and check the box that reads Enable Blogger API for your weblog. You should also pick a category for posts made through the Blogger API because some blogging clients do no support categories.
+
+
+
+\\
+!!Using w:bloggar
+
+[w:bloggar|http://www.wbloggar.com/] is a full-featured blogging client that runs on Windows. If you want to take advantage of all of the cool w:bloggar features, like support for titles and categories, then you'll need to modify the w:bloggar configuration file. The configuration file is located in the CMS directory of the w:bloggar install, it is named ''CMS.ini''.
+
+To configure w:bloggar for Roller, you'll need to add a Roller section to CMS.ini. Near the start of ''CMS.ini'', you find a line that reads ''Config='' and then some number. That count is the number of sections in the ''CMS.ini'' file. Since we are adding a section, we need to increment that number by one. For example, below we have incremented it from 15 to 16.
+
+{{{
+[CMS]
+Count=16
+}}}
+
+Next, add the following section at the end of the CMS.ini file. Make sure that the number at the end of ''CMS-'' matches the number that you entered for the count above.
+
+{{{
+[CMS-16]
+Name=Roller Weblogger
+URL=http://rollerweblogger.org
+Icon=rollerbadge.jpg
+Service=0
+Host=myhost.com
+Page=/roller/xmlrpc
+Port=80
+Https=0
+MultiCateg=3
+GetCategMethod=3
+PostMethod=3
+GetPostsMethod=3
+TemplateMethod=1
+}}}
+
+Once you've doen this, start w:bloggar. To hook up to your Roller account, choose the File-Select-Account menu item. You'll see the dialog-box below, choose ''<<New>>'' in the account combo-box and enter your Roller user-name and password, as shown below.
+
+[http://www.rollerweblogger.org/userguide/images/bloggar-new-account.png]
+
+Next, answer ''Yes'' to the ''Do you want to create this account?'' message-box and hit ''OK''. Next, you'll see the ''Account Properties'' dialog-box, shown below. Choose ''Roller Weblogger'' in the Blog Tool combo-box, enter a name for this account in the Alias text-field, and check ''Ping Weblogs.com''. __NOTE__:If you are using FreeRoller, remove the ''/roller'' from the start of the ''Page'' setting as shown below:
+
+[http://www.rollerweblogger.org/userguide/images/bloggar-account-settings.png]
+
+
+
+
+\\
+\\
+!!![#9] Configuration and Administration of Roller
+
+If your friendly Roller adminstrator has added your username to the list of admin users in roller-config.xml, then you will have access to the Roller adminstration menus __Website:Admin__ and __Website:Config__. Let's discuss what you can do with those menus.
+
+
+
+
+\\
+\\
+!!Admin
+
+The admin screen is only available to Roller administrators. It allows you to edit user information and to delete users. All you have to do is to pick a user using the combo-box, make your changes, and hit submit. If you have a lot of users, this page may take a while to load - all the user names will be put into the combo-box! Don't like this? Why don't you fix it and submit a patch to the Roller dev team?
+
+[http://www.rollerweblogger.org/userguide/images/user-admin.png]
+
+
+
+\\
+!!Config
+
+The Website:Config page allows you to tweak all sorts of Roller settings. It is a big page, so we will discuss each section separately below.
+
+[http://www.rollerweblogger.org/userguide/images/admin-site.png]
+
+* __Site Name__: name of the site, to be included in site-wide RSS feed
+* __Site Description__: description of site, to be included in site-wide RSS feed
+* __Site Administrator's E-Mail Address__: admin's E-Mail address, to be include in side-side RSS feed
+* __Absolute URL to this site__: (optional) to be used as basis for creating absolute URLs. If you are running your Servlet Container behind a Web Server, you may need to set this.
+* __Enable Linkback extraction__: LinkBack extraction is expensive, a one-shot thread is started for each incoming referer. For a large multu-user site (like FreeRoller), it should probably be turned off.
+
+[http://www.rollerweblogger.org/userguide/images/admin-users.png]
+
+* __Allow New Users__: Set this to enable the ''register as new user'' link on the main page.
+* __Admin Users__: Comma-separated list of users that have admin rights.
+* __New User Data__: This is no longer used by Roller and should be removed.
+* __New User Themes__: Directory where new user themes are located.
+* __Editor Pages__: comma-separated list of weblog editing pages available to users, some are WysiwygEditors.
+* __Autoformat Comments__: should comments be auto-formatted (turns linefeeds into <br> tags)?
+* __Escape Comment HTML__: should HTML be remove from comments?
+* __E-Mail Comments?__: turn on e-mail comment notification for all users. This should be a per-user setting, not a site wide setting.
+
+[http://www.rollerweblogger.org/userguide/images/admin-upload.png]
+
+* __Enable File Uploads__: are users allowed to upload files?
+* __Allowed Extensions__: comma-separated list of file extensions that users are allowed to upload.
+* __Forbidden Extensions__: comma-separated list of file extensions that users are NOT allowed to upload.
+* __Max File Size (MB)__: max size of file that users are allowed to upload.
+* __Max Directory Size (MB)__: total upload directory size per user.
+* __Upload Directory__: store user uploads under this directory with a subdirectory per user.
+* __Upload Path__: URL that is mapped to the upload directory.
+
+[http://www.rollerweblogger.org/userguide/images/admin-rss-agg.png]
+
+* __Enable RSS Aggregator__: allow users to display aggregated newsfeeds on their pages?
+* __Cache incoming RSS newsfeeds__: cache aggregated newsfeeds? I'm not sure why you'd ever want to turn this off.
+* __RSS newsfeed Cache Time__: Time, in minutes to cache each aggregated newsfeed.
+
Added: incubator/roller/trunk/docs/wbloggar.txt
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/wbloggar.txt?rev=189695&view=auto
==============================================================================
--- incubator/roller/trunk/docs/wbloggar.txt (added)
+++ incubator/roller/trunk/docs/wbloggar.txt Wed Jun 8 20:18:46 2005
@@ -0,0 +1,43 @@
+
+Near the start of the bloggar\CMS\CMS.ini file, bump up the count by one.
+
+Like this:
+
+ [CMS]
+ Count=11
+
+Then add following to the end of the CMS.ini file. Change 'yourserver.com'
+to the address of your Roller server. If you want the icon to work then drop
+rollerbadge.jpg in the same directory as CMS.ini.
+
+ [CMS-11]
+ Name=Roller
+ URL=http://www.rollerweblogger.org
+ Icon=rollerbadge.jpg
+ Service=0
+ Host=yourserver.com
+ Page=/roller/xmlrpc
+ Port=80
+ Https=0
+ MultiCateg=3
+ GetCategMethod=3
+ PostMethod=3
+ GetPostsMethod=3
+ TemplateMethod=1
+
+If you are a FreeRoller user, then here are your settings:
+
+ [CMS-11]
+ Name=FreeRoller
+ URL=http://www.rollerweblogger.org
+ Icon=rollerbadge.jpg
+ Service=0
+ Host=freeroller.net
+ Page=/xmlrpc
+ Port=80
+ Https=0
+ MultiCateg=3
+ GetCategMethod=3
+ PostMethod=3
+ GetPostsMethod=3
+ TemplateMethod=1
Added: incubator/roller/trunk/metadata/database/094-to-095-migration-raw.sql
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/metadata/database/094-to-095-migration-raw.sql?rev=189695&view=auto
==============================================================================
--- incubator/roller/trunk/metadata/database/094-to-095-migration-raw.sql (added)
+++ incubator/roller/trunk/metadata/database/094-to-095-migration-raw.sql Wed Jun 8 20:18:46 2005
@@ -0,0 +1,134 @@
+-- we will drop & recreate every table so
+-- that the new named constraints can be used
+-- for HSQLDB replace text datatypes with longvarchar
+-- for Postresql replace bit datatype with boolean
+
+CREATE TABLE tempuser AS SELECT * FROM user;
+DROP TABLE user;
+create table rolleruser (
+ id varchar(255) not null primary key,
+ username varchar(255) not null,
+ password varchar(255) not null,
+ fullname varchar(255) not null,
+ emailaddress varchar(255) not null
+);
+INSERT INTO rolleruser SELECT * FROM tempuser;
+
+CREATE TABLE temprole AS SELECT * FROM role;
+DROP TABLE role;
+create table role (
+ id varchar(255) not null primary key,
+ role varchar(255) not null,
+ username varchar(255) not null
+);
+INSERT INTO role SELECT * FROM temprole;
+
+CREATE TABLE temppage AS SELECT * FROM page;
+DROP TABLE page;
+create table page (
+ id varchar(255) not null primary key,
+ name varchar(255) not null,
+ description varchar(255) null,
+ link varchar(255) null,
+ websiteid varchar(255) not null,
+ template @TEXT_SQL_TYPE@ not null,
+ updatetime timestamp not null
+);
+INSERT INTO page
+ (id, name, description, websiteid, template, updatetime)
+ SELECT id, name, description, websiteid, template, updatetime FROM temppage;
+
+CREATE TABLE tempwebsite AS SELECT * FROM website;
+DROP TABLE website;
+create table website (
+ id varchar(255) not null primary key,
+ name varchar(255) not null,
+ description varchar(255) not null,
+ userid varchar(255) not null,
+ defaultpageid varchar(255) default 0 not null,
+ weblogdayid varchar(255) not null,
+ enablebloggerapi @BOOLEAN_SQL_TYPE_FALSE@ not null,
+ bloggercatid varchar(255) null
+);
+INSERT INTO website SELECT * FROM tempwebsite;
+
+CREATE TABLE tempfolder AS SELECT * FROM folder;
+DROP TABLE folder;
+create table folder (
+ id varchar(255) not null primary key,
+ name varchar(255) not null,
+ description varchar(255) null,
+ parentid varchar(255) null,
+ websiteid varchar(255) not null
+);
+INSERT INTO folder SELECT id,name,description,parentid,websiteid
+ FROM tempfolder;
+UPDATE folder SET parentid = NULL WHERE name='root' AND parentid=0;
+
+CREATE TABLE tempbookmark AS SELECT * FROM bookmark;
+DROP TABLE bookmark;
+create table bookmark (
+ id varchar(255) not null primary key,
+ folderid varchar(255) not null,
+ name varchar(255) not null,
+ description varchar(255) null,
+ url varchar(255) not null,
+ priority integer default 100 not null,
+ image varchar(255) null
+);
+INSERT INTO bookmark SELECT * FROM tempbookmark;
+ALTER TABLE bookmark ADD COLUMN (weight integer default 0 not null);
+ALTER TABLE bookmark ADD COLUMN (feedurl varchar(255) null);
+
+CREATE TABLE tempweblogcategory AS SELECT * FROM weblogcategory;
+DROP TABLE weblogcategory;
+create table weblogcategory (
+ id varchar(255) not null primary key,
+ name varchar(255) not null,
+ description varchar(255) null,
+ websiteid varchar(255) not null,
+ image varchar(255) null
+);
+INSERT INTO weblogcategory SELECT * FROM tempweblogcategory;
+
+CREATE TABLE tempweblogentry AS SELECT * FROM weblogentry;
+DROP TABLE weblogentry;
+create table weblogentry (
+ id varchar(255) not null primary key,
+ anchor varchar(255) not null,
+ title varchar(255) not null,
+ text @TEXT_SQL_TYPE@ not null,
+ pubtime timestamp not null,
+ updatetime timestamp not null,
+ websiteid varchar(255) not null,
+ categoryid varchar(255) not null
+);
+INSERT INTO weblogentry SELECT * FROM tempweblogentry;
+
+CREATE TABLE tempnewsfeed AS SELECT * FROM newsfeed;
+DROP TABLE newsfeed;
+create table newsfeed (
+ id varchar(255) not null primary key,
+ name varchar(255) not null,
+ description varchar(255) not null,
+ link varchar(255) not null,
+ websiteid varchar(255) not null
+);
+INSERT INTO newsfeed SELECT * FROM tempnewsfeed;
+
+-- Now add the constraints
+alter table rolleruser add constraint rolleruser_username_uq unique ( username );
+
+alter table website add constraint website_userid_fk foreign key ( userid ) references rolleruser ( id );
+
+alter table folder add constraint folder_websiteid_fk foreign key ( websiteid ) references website( id );
+alter table folder add constraint folder_parentid_fk foreign key ( parentid ) references folder( id );
+
+alter table bookmark add constraint bookmark_folderid_fk foreign key ( folderid ) references folder( id );
+
+alter table weblogcategory add constraint weblogcategory_websiteid_fk foreign key ( websiteid ) references website( id );
+
+alter table weblogentry add constraint weblogentry_websiteid_fk foreign key ( websiteid ) references website( id );
+alter table weblogentry add constraint weblogentry_categoryid_fk foreign key ( categoryid ) references weblogcategory( id );
+
+alter table newsfeed add constraint newsfeed_websiteid_fk foreign key ( websiteid ) references website( id );
Added: incubator/roller/trunk/metadata/database/095-to-096-migration-raw.sql
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/metadata/database/095-to-096-migration-raw.sql?rev=189695&view=auto
==============================================================================
--- incubator/roller/trunk/metadata/database/095-to-096-migration-raw.sql (added)
+++ incubator/roller/trunk/metadata/database/095-to-096-migration-raw.sql Wed Jun 8 20:18:46 2005
@@ -0,0 +1,21 @@
+
+ALTER TABLE weblogentry ADD COLUMN (publishentry @BOOLEAN_SQL_TYPE2@ not null);
+
+ALTER TABLE website ADD COLUMN (editorpage varchar(255) not null);
+UPDATE website SET editorpage = 'editor-ekit.jsp';
+
+CREATE TABLE temprole AS SELECT * FROM role;
+DROP TABLE role;
+create table role (
+ id varchar(255) not null primary key,
+ role varchar(255) not null,
+ username varchar(255) not null,
+ userid varchar(255) not null
+);
+INSERT INTO role
+ (id, role, username, userid)
+ SELECT temprole.id, role, temprole.username, rolleruser.id
+ FROM temprole, rolleruser
+ WHERE temprole.username = rolleruser.username;
+ALTER TABLE role ADD CONSTRAINT role_userid_fk
+ foreign key ( userid ) references rolleruser( id );