Return-Path: Delivered-To: apmail-incubator-roller-commits-archive@www.apache.org Received: (qmail 91626 invoked from network); 8 Jun 2005 16:09:04 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 8 Jun 2005 16:09:04 -0000 Received: (qmail 34026 invoked by uid 500); 8 Jun 2005 16:09:03 -0000 Delivered-To: apmail-incubator-roller-commits-archive@incubator.apache.org Received: (qmail 33930 invoked by uid 500); 8 Jun 2005 16:09:02 -0000 Mailing-List: contact roller-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: roller-dev@incubator.apache.org Delivered-To: mailing list roller-commits@incubator.apache.org Received: (qmail 33877 invoked by uid 99); 8 Jun 2005 16:09:01 -0000 X-ASF-Spam-Status: No, hits=-9.8 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from minotaur.apache.org (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Wed, 08 Jun 2005 09:08:51 -0700 Received: (qmail 91275 invoked by uid 65534); 8 Jun 2005 16:08:41 -0000 Message-ID: <20050608160841.91274.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Subject: svn commit: r189602 [6/50] - 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/ docs/ docs/images/ docs/installguide/ docs/installguide/old/ docs/userguide/ docs/userguide/images/ docs/userguide/old/ metadata/ metadata/database/ metadata/database/hibernate/ metadata/xdoclet/ personal/ personal/eclipse/ personal/testing/ src/ src/org/ src/org/roller/ src/org/roller/business/ src/org/roller/business/hibernate/ src/org/roller/business/utils/ src/org/roller/model/ src/org/roller/pojos/ src/org/roller/presentation/ src/org/roller/presentation/atom/ 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/tags/ src/org/roller/presentation/tags/calendar/ src/org/roller/presentation/tags/menu/ 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/search/ src/org/roller/presentation/weblog/search/operations/ 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/ tests/ tests/org/ tests/org/roller/ tests/org/roller/business/ tests/org/roller/model/ tests/org/roller/persistence/ tests/org/roller/presentation/ tests/org/roller/presentation/atom/ tests/org/roller/presentation/bookmarks/ 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/xmlrpc/ tests/org/roller/util/ tools/ tools/buildtime/ tools/buildtime/mockrunner-0.2.6/ tools/buildtime/mockrunner-0.2.6/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.1/ tools/struts-1.1/lib/ web/ web/WEB-INF/ web/WEB-INF/classes/ web/WEB-INF/classes/flavors/ web/WEB-INF/classes/themes/ web/bookmarks/ web/images/ web/images/editor/ web/images/midas/ web/images/preview/ web/images/smileys/ 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/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/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/ Date: Wed, 08 Jun 2005 16:06:46 -0000 To: roller-commits@incubator.apache.org From: snoopdave@apache.org X-Mailer: svnmailer-1.0.0-dev X-Virus-Checked: Checked X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: incubator/roller/trunk/docs/userguide/old/roller-ug.html URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/ol= d/roller-ug.html?rev=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/roller/trunk/docs/userguide/old/roller-ug.html (added) +++ incubator/roller/trunk/docs/userguide/old/roller-ug.html Wed Jun 8 09:= 06:16 2005 @@ -0,0 +1,591 @@ + + + + =20 + + =20 + + =20 + + Roller User Guide + + +

The Roller Weblogger

+

Version 0.9.6 User's Guide

+

Copyright =C2=A9 2002 David M Johnson

+

Updated: November 2, 2002
+
+

+ + +
+

Introduction

+

Roller is a Weblogger. Roller makes it easy for you to maintain a weblo= g, +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 accou= nt +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 customizi= ng +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 =C2=96 not neces= sarily +ready for prime time =C2=96 there are probably a number of design flaws an= d an +even larger number of bugs. As always with software of all sorts, and espe= cially +pre-release software such as this, use at your own risk. =C2=A0If you find= a flaw, +a bug, or something that you do not like please contribute back to the Rol= ler +project be reporting that bug to the Roller development team's J= IRA +issue tracking system.

+

Getting Started

+

Signing up for a new account

+

To sign-up for a Roller account, go the the main Roll= er +page and click on the link that reads =C2=93register as a new user.=C2=94 = 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 bui= ld +their own themes. And, there are three themes adapted from themes on blogskins.com: these are shown belo= w=2E + There is also a new XHTML/CSS based theme called x2 that was contributed +by Matt Raible.
+

+ + + + + + + + + + + =20 + +
=20 + + =20 +
3D""
+
+ 		=20 + +
+ =20 +
3D""
+
+
=20 + +
+ =20 +
3D""
+
+ 		+basic
+
+ 3D""
+
+
+

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 li= st +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.

+

Your initial website

+

Your initial website will include just one webpage th= at +is visible to your readers and that is named "Weblog". This page will incl= ude +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:

+

Figure 1: your initial Weblog page, = assuming +you chose the basic theme

+

3D""
+

+

Logging in

+

From your Weblog page or from the main Roller page, c= lick +the Login link. Enter your username and password, click submit, and you wi= ll +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, Boo= kmarks, +Newsfeeds, and Website. These links lead you to pages for editing your Web= log, +categories, bookmarks (AKA links), newsfeeds, and the actual pages that ma= ke +up your website. First, lets talk about how to edit your Weblog.

+

Editing your Weblog

+ =20 +

Adding a new entry

+

Editing your Weblog means adding new Weblog entries to be enjoyed by yo= ur +readers and editing older Weblog entries to correct mistakes, clarify poin= ts, +or to censor those drunken ramblings you entered last night.

+

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.
+

+

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 ent= ries, +bookmarks, and other things Roller should automatically reset it's cache +as needed.
+

+

Figure 2: the Edit-Weblog page
+
+

+
3D""
+
+ +We need a new screenshot here +

Publishing an entry

+

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 yo= ur entry +is visible to your readers. =C2=A0If you click "Save as Draft", then your = entry is +private.

+

The text field marked "Pub Time" controls the publish time your your en= try. +=C2=A0Changing the publish time may change the order of weblog entries dis= played +on your weblog. =C2=A0When you enter a new publish time, you must use the = format +dd.MM.yyyy HH:mm:ss

+ +

Editing an old entry

+

You can edit or remove an old Weblog entry by clicking on the Edit or R= emove +links in the Recent Weblog Entries part of the page. If the Weblog entry t= hat +you want to edit is not so recent and is not shown in the Recent Weblog En= tries +list, then you can use the Weblog Entry Archive calendar to find that old +entry.

+ +Need a SpellCheck screenshot here +

SpellChecking an entry

+

If you would like to Spellcheck your entry, click the "Spell Check" but= ton. +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 f= rom +the appropriate drop-down. If you'd rather not use the drop-downs, you ca= n edit=20 +the text directly in the textbox provided.

+ +

Posting using a Blogger API client

+

You can use any Blogger API client to post and edit Roller weblog entri= es. + 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 shou= ld +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.

+

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 w:bloggarclient. Be= low +is a screenshot of the w:bloggar client. As you can see, you need to conf= igure +w:bloggar by entering your host name, port number, and the path /roller/xm= lrpc +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.
+

+
3D""
+
+
+

Flushing the cache

+The flush-cache button allows you to flush the Roller page cache. =C2=A0Th= e page +cache is a performance feature that allows Roller to serve up pages faster +and to minimize database access. =C2=A0Normally, the cache is flushed when= you +edit a weblog entry, add a new page template, or do just about any other o= peration. +=C2=A0So, under normal conditions you should not need to flush the cache. =
+

Referer rankings

+The referer rankings page shows the hits that are coming in from other web= sites +and weblogs that have links to your weblog and to specific entries in your +weblog. =C2=A0By looking at your referer logs, you can get an idea of who = is reading +and commenting on your weblog.
+
+

Editing your bookmark collection

+

Adding new bookmark +folders

+

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 Web= log +authors like to include links to their favorite websites and to their favo= rite +Weblogs right on their Weblog page. Roller's bookmark feature makes it easy +for you to do this too.

+

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. The= re +is only one level of folders, so you cannot have a folder that contains ot= her +folders.

+

Your initial website contains two bookmark folders: one named =C2=93Blo= grolling=C2=94 +that contains Weblogging related links and one named =C2=93News=C2=94 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 pag= e=2E +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> +

Figure 3: the Edit-Bookmark Folders page
+
+

+
3D""
+
+

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-B= ookmark +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 4: the Edit-Bookmark Folder page

+

3D""
+

+

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 Edi= t-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 5: the Edit-Bookmark page
+
+

+
3D""
+
+


+

+

Importing Bookmarks in OPML format

+Roller makes it easy to import bookmarks and build your blogroll by import= ing +bookmarks in OPML format. XBEL might be a better bookmarks format, but OP= ML +is more popular in the world of weblogs. To import bookmarks via OPML, fo= llow +these steps:
+ =20 +
    +
  1. download bookmarks in OPML format from a site such as Scripting.COM +and save them as a file on your hard disk.
    2. +
  2. Login to Roller and choose the Bookmarks:Import menu option.
    3. +
  3. 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.
    4. +
+


+

+

Editing your newsfeed collection

+

Adding and deleting newsfeeds

+

A newsfeed is a list of news stories and a short desciption of each sto= ry +that is automically retrieved from some remote website. Newsfeeds are deli= vered +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 sepa= rate +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 =C2=96 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 us= ually +ends with the letters =C2=93.xml=C2=94. Enter the name that you would like= to use for +the newsfeed, enter the URL and hit enter to add the newsfeed.

+

Customizing your website

+

Website settings

+The website settings form allows you to set the following properties for y= our +weblog website:
+
    +
  • =20 +

    Website title - The title= of +your website may include HTML, but the HTML will be stripped out in your R= SS +feed. You can access your title in a page template with the expression =20 + $macros.website.title

    +
    • +
  • =20 +

    Website description -=C2= =A0The 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 expr= ession + $macros.website.description<= /p> +

    • +
  • =20 +

    Homepage page - Choose a = page +template to be used as your websites main page.

    +
    • +
  • =20 +

    Day template page - Choose +a page template to be used to display weblog entries via the $macros.showWeblogEntries() macro.

    +
    • +
  • =20 +

    Weblog editor page - Choo= se +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).

    +
    • +
  • =20 +

    Enable Blogger API - Set = to +true to enable weblogging via the Blogger API.

    +
    • +
  • =20 +

    Category for Blogger API posts +- Choose the category for incoming posts made via the blogger API.

    +
    • +
+ +

Website pages

+

Your Weblog page is defined by a page template. A template is a file wi= th +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.

+

You initial Roller website has three page template, only one of which +is visible to users. The pages are named Weblog, _DayTemplate and _css.

+
    +
  • =20 +

    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.

    +
    • +
  • =20 +

    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.

    +
    • +
  • =20 +

    The _css page is a CSS style-sheet information that is included (us= ing +a macro) on your Weblog page.

    +
    • +
+

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.

+

Note that any page whose name begins with the underbar =C2=93_=C2=94 ch= aracter 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.

+

Figure 6: the Edit-Website page

+

3D""
+

+

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 Roll= er +macros mixed in. Next you will read about the various Roller macros that +are available for your use.

+

The screenshot below shows the Weblog page being edited in the Edit-Page +page.

+

Figure 7: the Edit-Page page

+
3D""
+

+ +

Weblog Themes

+

Besides editing your pages directly, you can Preview the other template= s and +modifications to your weblog page. NOTE: this feature= is only good for editing +the default page, which must be your weblog page if you want to preview ot= her +templates. On the "Change your Weblog Template" page you may selec= t another +theme to preview, or edit the template directly. =20 +

    +
  • Clicking the "Preview" button +will load a page where you will be able to see any changes or the theme you +selected.
    • +
  • 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 y= our +Weblog page before you begin working on any changes.
    • +
  • Clicking "Cancel" clears any changes you haven't +saved and sends you to the Website Settings page.
    • +
+On the Preview page, if you=20 +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 th= e Theme +list, make any changes you desire and click Preview.

+ +

Website 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 up= load +and image to Roller and to use it in a weblog template: =20 +
    +
  1. Use the Weblog:File menu option to upload your image file
    2. +
  2. 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.showResour= cePath() +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=3D"$macr= os.showResourcePath()/leo.gif" +alt=3D"one happy baby" />
    3. +
+

User settings

+You can use the User Settings form to set your Full Name, Password, and Em= ail +address. +

Export

+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 ba= ckups +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 yo= ur +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 administrato= r's +help to recreate your user.
+

Admin

+

+The admin screen is only available to Roller administrators. =C2=A0It allo= ws an +adminstrator to delete a user account from Roller.
+
+

Macros intended for use on any page te= mplate

+

Macros tell Roller where to place the dynamic parts of your web pages. +Macros use Veloc= ity expressions and +custom JSP tag libraries. For more information on Velocity, +visit the Velocity web site and read the Velocity=20 +User's Guid= e. Note that +we use the term macro loosely, but it does have a specific meaning in Velo= city. +What we call a macro is really a Velocity expression. To learn more about= JSP +and tag libraries, visit Sun's JSP site.
+

+In a page template, you have access to an object called $macros that has m= any +methods. =C2=A0The macros object is actually a Java object. =C2=A0To see t= he methods +that are available to you via the $macr= os +object, please refer to the Javadocs for:
+
+=C2=A0=C2=A0=C2=A0 org.roller.presentation.velocity.Macros
+
+

Macros intended for use on your day tem= plate +page

+

Your Day Template page determines how each day of Web= log +entries is formatted on the page by the $macros.showWeblogEntries() +macro. =C2=A0Inside your day template you have access to a $macros object that has some addition= al +methods. =C2=A0So see the methods available to you via the $macros object = in the +day template, please refer to the Javadocs for:
+

+

org.roller.presentation.velocity.Macros
+org.roller.presentation.weblog.tags.Weblo= gEntryMacros
+

+

Additionally, inside a day template you also have acc= ess +to a collection called $entries which is made up of WeblogEntryDataEx obje= cts. +=C2=A0For information on the methods and fields of these objects please re= fer to:
+

+ +

Example weblog page and day templates

+

Here is the weblog page template for the basic theme, shown in figure +1 (macros are shown in blue):

+
=20 + 
<html>
<head>
<!DOCTYPE html PUBLIC "-//W3C//D=
TD HTML 4.01 Transitional//EN">
<title>$macros.showWebsiteTitle()</ti=
tle>    
<style type=3D"text/css">$macros.includePage("_css")
&l=
t;/style>
</head>
<body background=3D"/roller/images/bg-g=
reylines.gif">
<table cellpadding=3D"5" cellspacing=3D"15" border=
=3D"0" align=3D"center" width=3D"95%">  
   <tr>   
   <t=
d width=3D"20%" valign=3D"top" bgcolor=3D"#ffffff">     
      $macros.showNavBar(true)<=
;br>      
 =
     $macros.showEditorNavBar(true)<br>
 =
     $macros.showBookmarks("Blogrolling",true)<br>      
 =
     $macros.showBookmarks("News",true)   
   </td>   
 =
  <td width=3D"60%" valign=3D"top" bgcolor=3D"#ffffff">              =
 
      <h2>$macros.showWebsiteTitle()</h2=
>              
      $macros.showWeblogCategoryChooser()<br>    
      $macros.showWeblogEntries()      </td>   
   <td valign=3D"top" bgcolor=3D"#ffffff" width=3D=
"20%">        
      $macros.showWeblogCalendar()<b=
r>      
      $macros.showRSSBadge()   
   &=
lt;/td>
   </tr>
</table>             
</body>=
;
</html>

+
+

Here is the Day Template for the Weblog shown in figure 1:

+
=20 + 
<table width=3D"95%">
<tr>
   <td>
   $macros.showPermalink()
 =
  $macros.showEntryDate()
   </td>
</tr>
</t=
able>
#foreach( $entry in $entries )<p>
   <b>$entry.title</b> $entry.text 
   <font size=
=3D"2">($entry.updateTime/$entry.pubTime)</font>
&=
lt;/p>
+#end
+
+
+

+

+
+ + Added: incubator/roller/trunk/docs/userguide/old/weblog.gif URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/ol= d/weblog.gif?rev=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D Binary file - no diff available. Propchange: incubator/roller/trunk/docs/userguide/old/weblog.gif ---------------------------------------------------------------------------= --- svn:mime-type =3D application/octet-stream Added: incubator/roller/trunk/docs/userguide/old/weblog_.jpg URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/ol= d/weblog_.jpg?rev=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D Binary file - no diff available. Propchange: incubator/roller/trunk/docs/userguide/old/weblog_.jpg ---------------------------------------------------------------------------= --- svn:mime-type =3D application/octet-stream Added: incubator/roller/trunk/docs/userguide/quickstart.wiki URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/userguide/qu= ickstart.wiki?rev=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/roller/trunk/docs/userguide/quickstart.wiki (added) +++ incubator/roller/trunk/docs/userguide/quickstart.wiki Wed Jun 8 09:06:= 16 2005 @@ -0,0 +1,36 @@ +!!!Getting started with Roller + +This document describes how to create a new Roller account and make your f= irst 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 th= e 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 themes= e adapted from themes on [http://blogskins.com]. Take a look at the RollerT= hemes page to see some screenshots. + +[http://www.rollerweblogger.org/userguide/images/qs1-newuser.png] + +!!!Welcome=20 + +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 be= low, which is just one part of the Roller Editor UI. The Weblog:Edit page i= s shown below. To make a weblog post enter a title in the Title field (titl= es 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, Rol= ler 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__ bu= tton to post it to your weblog or the __Save as Draft__ button to save it a= s 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/us= erguide.wiki?rev=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/roller/trunk/docs/userguide/userguide.wiki (added) +++ incubator/roller/trunk/docs/userguide/userguide.wiki Wed Jun 8 09:06:1= 6 2005 @@ -0,0 +1,751 @@ +!!!The Roller Weblogger User Guide v0.9.7 +See also: InstallationGuide + +Orignal text is ''Copyright =C2=A9 2003 David M Johnson'' + +* [1] Introduction=20 + +* [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=20 +** 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=20 +** [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=20 +** 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 accoun= t and bam you have a weblog. You can start posting right away. You will nee= d to know a little about HTML if you want to kick it up a notch by customiz= ing 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 rea= dy for prime time there are probably a number of design flaws and an even l= arger 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 fla= w, a bug, or something that you do not like please contribute back to the R= oller project be reporting that bug to the Roller development team's [JIRA = issue tracking system|http://opensource.atlassian.com/projects/roller/Dashb= oard.jspa]. + + + +\\ +\\ +!!![#2] Gettings started + +To get started with Roller you need to either 1) find a Roller site somewh= ere that is offering new user registration or 2) install Roller yourself. T= here are a couple of sites offering free Roller accounts. One is AnthonyEde= n's aptly named FreeRoller site, hosted by JavaLobby. Another is [http://bl= ogs.application-servers.com]. Both of these sites are currently running Rol= ler 0.9.6, so some of the features described in this guide will not be avai= lable. What about installing Roller? You should only attempt to install Rol= ler yourself if you are comfortable with system, database, and Java app ser= ver 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.=20 + + + +\\ +!!QuickStartGuide + +So, how do you get started? The Roller QuickStartGuide shows you how to cr= eate 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 fir= st time users). + + + +\\ +!!The Roller Web Application + +There are three main parts of the Roller Web Application: the main page, u= ser website pages, and the Editor UI.=20 + +* __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 refe= rer ranking). Under the list of the most recent weblog posts, there is a br= ight orange XML icon that links to an RssFeed that combines all of the webl= ogs on the site into one aggregated new feed. For each of the weblogs liste= d in the most popular weblogs list there is a bright orange XML icon that l= inks 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 contai= n VelocityTemplateLanguage expressions, control statements, and a special s= et of VelociMacros for useful things like a WeblogCalendar, EditorNavBar, P= ageNavBar, 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 yo= ur weblog, managing weblog categories, managing a bookmark collection (AKA = blogroll) managing newsfeeds, configuring, and administering a Roller websi= te 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 m= enu. + +To help you find your way around the Roller Web Application, there are thr= ee types of Navigation Bars in Roller: the Navigation-Bar, the Page Navigat= ion Bar and the Editor Navigation Bar. + + +__Navigation Bar__ + +The Navigation Bar appears at the top of the Roller main page and at the t= op of the Roller Editor UI. When you are not logged into Roller the navigat= ion 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 'Archi= ve' and you were logged into Roller, your Navigation Bar would look like th= is: + +[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 yo= u wanted. For example, if you had pages named 'Weblog', 'Bookmarks', and 'A= rchive' 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 yo= ur weblog page. Like the Page Navigation Bar, the Editor Navigation Bar is = also produced by a Roller macro. The macro is called #showEditorNavBar() an= d it is also included in all of the default Roller templates. If you are no= t logged into Roller, the Editor Navigation Bar will hide itself. The Edito= r 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 in= to 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 c= ategories, and viewing your referer logs. Here is the Weblog sub-menu of th= e Roller Editor UI: + +[http://www.rollerweblogger.org/userguide/images/eui-weblog.png] + + + + +\\ +!!Adding a new weblog post=20 + +To add a new Weblog post you simply go to the Weblog:Edit page, enter an o= ptional title in the Title field, enter the your post in the Content text a= rea, choose a category from the Category combo, and hit the __Post to Weblo= g__ button. As soon as you do that, your Weblog entry is posted to your Web= log 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 suppor= t 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 chang= e this Publication Time. I know this is lame, but you must enter the date i= n the format 'dd.MM.yyyy HH:mm:ss'. If you don't like it then fix it and se= nd [us|http://sourceforge.net/mail/?group_id=3D47722] 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 save= d 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 eac= h 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 th= at lists your most recent weblog posts, both public and private (AKA drafts= )=2E 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 i= s 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 chec= k 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 ch= oose 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 w= riting about them. + +*__Remove__: This will remove the weblog post. First, Roller will ask you = "are you sure?" =20 + + + +\\ +!!Working with Weblog Comments + +If you have enabled comments in your Website:Settings page and you have on= e of the comments macros in your day template (__#showCommentsLink()__ or _= _#showCommentsPageLink()__) then your users may leave comments on each of y= our weblog entries. Also, Trackbacks that come in from other weblogs are tr= eated 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 v= iew and delete the comments that are associated with your weblog entries. T= o 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 yo= u 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/mttrackb= ack.html] enabled, then you should send that weblog a Trackback ping.=20 + +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 t= he other site, copy it with ALT-C (or whatever). +# Click the __Send Trackback__ link your weblog entry in the Weblog:Edit p= age. The Roller __Send a Trackback__ page will appear. +# Paste the Trackback URL that you found step 1 into the Trackback URL fi= eld 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 on= e below with the number 0 in the 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 post= s 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 i= t 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 po= st. Currently, Roller only allows you to assign each weblog post to one cat= egory. + +__The Weblog Category Chooser__ + +When a user views your site, they can choose which category to view. All o= f the stock Roller weblog templates include the Weblog Category Chooser (d= isplayed 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 choo= se to subscribe to specific categories. All of the stock Roller weblog temp= lates display a list of your RSS feeds (displayed by the #showRSSLinks() ma= cro), 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 delet= e 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 c= ache. The page cache is a performance feature that allows Roller to serve = up pages faster and to minimize database access. Normally, the cache is fl= ushed when you edit a weblog entry, add a new page template, or do just abo= ut 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 comin= g 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 w= ord ''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 page= s=2E Each of these pages is defined by a ''page template'' also known as a = ''page''. One of these pages is your weblog.=20 + +As a Roller user, you are free to customize the look-and-feel of your webs= ite as you wish. When you establish your Roller user account, you can choos= e 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 somethin= g 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 an= d 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 __We= bsite:Settings__ page, switching themes using the Theme Switcher __Website:= Themes__ page, customizing your page templates via the __Website:Pages__ pa= ge, 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. I= t also allows you to choose an HTML editor for the __Weblog:Editor__ page a= nd 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 y= our 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 tit= le in a page template with the expression $macros.website.title + + +* __Description of this website__ - The description of your website may in= clude HTML, but the HTML will be stripped out in your RSS feed. You can acc= ess your description in a page template with the expression __$website.desc= ription__ + +* __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 ar= e WysiwygEditors +** editor-text.jsp=20 +** editor-dhtml.jsp +** editor-ekit.jsp +** editor-midas.jsp +** editor-text-js.jsp + +* __Allow commments for your weblog__ - Set this to true to enable comment= s 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 w= orry about this. + +* __Enable Blogger API for your weblog__ - Set to true to enable webloggin= g via the Blogger API. This will allow you to use handy Blogging clients li= ke [w:bloggar|http://www.wbloggar.com/] to post to your weblog. + +* __Category for posts recieved via Blogger API__ - Choose the category fo= r incoming posts made via the Blogger API. This only applies if you bloggin= g client does not support categories. + +* __Ignore incoming referers that contain any of these (comma-separated) w= ords__ - you can use this to filter out what referers are accepted. Somewha= t useful if you start getting hit by referer spam, but not a complete solut= ion 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 th= e available Roller themes. You might have picked the Robot theme, or the Ro= ller 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 me= nu 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 f= irst a word of warning. If you have customized your theme on your own by mo= difying the HTML, CSS, and/or JavaScript in the pages that comprise your Ro= ller theme, then watch our. Switching themes using the Roller Theme Switche= r 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 screensho= t below. If you want to select this new theme you will have to hit the __Ed= it__ button to return to the Theme Switcher and then hit the __Save__ butto= n 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 upl= oad 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.=20 +# Place an HTML IMG tag where you want the image.=20 + +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.=20 +# Place an HTML IMG tag where you want the image.=20 + +In either case, you should specify the absolute URL to your image in the I= MG 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/use= rname/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: + +{{{ +3D"one +}}} + + + +\\ + +\\ +!!![#5] Customizing your theme with Roller Macros=20 + + +Your website's theme is defined by a set of page templates. A page templat= e 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 abo= ut anything else you can enter into Roller as text. Roller uses the powerfu= l Velocity template language and this gives you a lot of power and flexibil= ity in customizing the look and feel and layout of your website and your we= blog pages. For more information on the Velocity template language, refer t= o the [Velocity website|http://jakarta.apache.org/velocity/] and to the [Ve= locity Reference Guide|http://jakarta.apache.org/velocity/vtl-reference-gui= de.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 macr= os 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 fo= r a migration guide to help you move from the old macros to the new macros.= '' + + + +\\ +!![5.1|#51] Weblog and day pages=20 + +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 purpose= s of these two pages. + + +__Your Weblog page__ + +Your weblog page is the main page of your website, the one that is specifi= ed 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.=20 + +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 real= ly 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: + +{{{ + + + =20 + __#showWebsiteTitle()__ =20 + + #showRSSAutodiscoveryLink() + + =20 + =20 + =20 + =20 + +
+
+

#showWebsiteTitle()

=20 +

#showWebsiteDescription()

=20 + #showWeblogCategoryChooser()
+
=20 + #showWeblogEntries("_day" 15) + 		+

Calendar

=20 + #showWeblogCalendar()
=20 +

RSS Feeds

=20 + #showRSSBadge()
+ #showRSSLinks() +

Links

+ #showBookmarks("Blogroll" true false)
=20 + #showBookmarks("News" true false) +

Navigation

+ #showBasicNavBar(true)
=20 + #showEditorNavBar(true)
+

Referers

+ #showReferers(30 20) +
+ + +}}} + +For a full listing of the Roller Macros refer to the Roller Macros and Var= iable Reference section below. The most important macro on the page is the = __#showWeblogEntries__ macro. As you can see, it takes two arguments, the f= irst is the name of the day page to use in the display of the weblog entrie= s and the second is the number of weblog entries to be displayed on the pag= e=2E + + +__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 Ba= sic theme: + +{{{ +
+
+ #showDayPermalink( $day ) + #showEntryDate( $day ) +
+#foreach( $entry in $entries ) +

+ $entry.title $entry.text + ($entry.pubTime) + #showEntryPermalink( $entry ) + #showCommentsPageLink( $entry ) +

+#end =20 +#showLinkbacks( $day ) +
+}}} + +Note that there are two variables __$day__ and __$entries__ available for = use in the day template that are not available in other templates. The __$d= ay__ variable refers to a date object (java.util.date) that contains the da= te of the day that is being rendered by the dat page. The $entries variable= contains a collection of weblog entry objects (org.roller.model.WeblogEntr= yData). The example above uses a Velocity __#foreach__ loop to iterate thro= ugh the individual entries in the entries collection and to display the tit= le, text, and publish time of each. + + + +\\ +!![5.2|#52] Other pages and comments=20 + + +You can add as many pages as you like to your Roller website, you can choo= se which ones are to appear in your website's navigation bar, you can inclu= de pages in other pages using the __#includePage__ macro, and you can inclu= de 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 p= age is to be your default Page, that is, the page that your readers first s= ee 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.=20 + + +__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 web= site's navigation menu that is dislayed by the __#showNavBar__ macros.=20 + + +__Pop-up comments, the comments page, and TwistyComments__ + +The Basic theme example above also uses the __#showCommentsPageLink__ macr= o 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 Comme= nts'' check-box on the __Website:Settings__ page. + +What about Raible's TwistyComments? They are available in Roller 0.9.8, bu= t 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=20 + +For a complete list of the Roller Macros, see the [Macro Reference Guide|h= ttp://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].=20 + +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 co= ntext). +|__$baseURL__ | Base URL for your Roller website=20 +|__$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 view= ed. +|__$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=20 +|__$rollerVersion__ | Version number of Roller software +|__$utilities__ | A utilities object=20 +|__$stringUtils__ | A string utilities object + +Date formatting variables and objects: + +|__$dateFormatter__ | Date formatter object=20 +|__$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() m= acro:\\ 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=20 + + + +\\ +!![5.4|#54]Creating and packaging your own Roller theme=20 + +A Roller theme is, at a minimum, a subdirectory in the Roller ''themes'' d= irectory with a page template named Weblog.vm in it. How does Roller determ= ine what themes are available? Roller considers every subdirectory in the t= hemes directory to be a theme.=20 + + +__How does Roller create a theme?__ + +When you create a new user or switch themes for an existing user, Roller w= ill read in a new theme for that user. When Roller reads in a theme for a u= ser, all it is does is to create or replace the user's page templates.=20 +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'' e= xtension + +# The page template that is named ''Weblog'' is set to be the website's de= fault 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 ''d= istributable'' 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, l= isted below, whenever you refer to a file in your theme: + +* #showThemeScript( themeName, scriptFileName ) +* #showThemeScriptPath( themeName ) +* #showThemeStyleImport( themeName, scriptFileName ) =20 +* #showThemeStyle( themeName, styleFileName ) +* #showThemeStylePath( themeName, styleFileName ) +* #showThemeImage( themeName, imageFileName ) +* #showThemeImagePath( themeName, imageFileName ) +* #showThemePath( themeName ) + +=20 + +\\ +\\ +!!! [#6]Using Roller for Bookmark and Blogroll Management=20 + +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 li= nks 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 t= hat make up your website. + +Bookmarks Management Submenu: + +[http://www.rollerweblogger.org/userguide/images/eui-bookmarks.png] + + + +\\ +!!Adding new bookmark folders=20 + + +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 i= s only one level of folders, so you cannot have a folder that contains othe= r 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 s= ee 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=20 + + +Once you have defined one or more bookmark folders, you can start adding b= ookmarks to those folders. From the Edit-Bookmark Folders page, click the E= dit link for the Folder you wish to edit. You will be taken to the Edit-Boo= kmark 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=20 + +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-Bo= okmark Folder page. That will take you to the Edit-Bookmark page and from t= here you can change the name, description and display priority of the bookm= ark you have chosen to edit. You can also move the bookmark to another fold= er by changing the Bookmark Folder combo-box. + +Figure: the Edit-Bookmark page + + +\\ +!!Displaying your bookmarks=20 + +You can use the __[#showBookmarks|http://www.rollerweblogger.org/velocidoc= s/macro-showBookmarks3.html]__ macro to display your bookmarks on your webs= ite pages. The macro will display all of the bookmarks in one of your bookm= ark folders. The arguments are ''String folderName'', ''boolean showFolderN= ame'', and ''boolean expandingFolder''. The expanding folder feature is imp= lemented using JavaScript, so, it will only work if the Roller JavaScript f= ile 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 expandin= g folder. First, near the top and inside the tag of your page, inclu= de the Roller JavaScript page roller.js, as shown below: + +{{{ +=2E.. + + =20 + My badass blog=20 + + + +=2E.. +}}} + +Later in your page, include the __#showBookmarks__ macro to display your b= ookmarks: + +{{{ +=2E.. + #showBookmarks( "News" true true ) +=2E.. +}}} + + + + +\\ +!!Importing Bookmarks in OPML format + +Roller makes it easy to import bookmarks and build your blogroll by import= ing 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 s= ave 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 b= ookmarks will be imported into a folder called "unfiled". You can use Rolle= r to organize the bookmarks as you wish. + + + +\\ +!!![#7] Using Roller for Display of RSS Newsfeeds=20 + +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 deliv= ered 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 separat= e page that you create as part of your Weblog's website. Your initial websi= te 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 lat= er to display your newsfeeds. + + +Before you include a newsfeed on your website, you should probaby make sur= e that doing so is OK with the provider of the newsfeed. Some providers mig= ht 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 lawye= r 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 usual= ly 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=20 + +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 an= d check the box that reads Enable Blogger API for your weblog. You should a= lso pick a category for posts made through the Blogger API because some blo= gging clients do no support categories. + + + +\\ +!!Using w:bloggar + +[w:bloggar|http://www.wbloggar.com/] is a full-featured blogging client th= at runs on Windows. If you want to take advantage of all of the cool w:blog= gar features, like support for titles and categories, then you'll need to m= odify the w:bloggar configuration file. The configuration file is located i= n 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= =3D'' and then some number. That count is the number of sections in the ''C= MS.ini'' file. Since we are adding a section, we need to increment that num= ber by one. For example, below we have incremented it from 15 to 16. + +{{{ +[CMS] +Count=3D16 +}}} + +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=3DRoller Weblogger +URL=3Dhttp://rollerweblogger.org +Icon=3Drollerbadge.jpg +Service=3D0 +Host=3Dmyhost.com +Page=3D/roller/xmlrpc +Port=3D80 +Https=3D0 +MultiCateg=3D3 +GetCategMethod=3D3 +PostMethod=3D3 +GetPostsMethod=3D3 +TemplateMethod=3D1 +}}} + +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 ''<>'' in the account combo-box and enter your Roller user-nam= e 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?'' messag= e-box and hit ''OK''. Next, you'll see the ''Account Properties'' dialog-bo= x, shown below. Choose ''Roller Weblogger'' in the Blog Tool combo-box, ent= er a name for this account in the Alias text-field, and check ''Ping Weblog= s=2Ecom''. __NOTE__:If you are using FreeRoller, remove the ''/roller'' fro= m the start of the ''Page'' setting as shown below: =20 + +[http://www.rollerweblogger.org/userguide/images/bloggar-account-settings.= png] + + + + +\\ +\\ +!!![#9] Configuration and Administration of Roller=20 + +If your friendly Roller adminstrator has added your username to the list o= f admin users in roller-config.xml, then you will have access to the Roller= adminstration menus __Website:Admin__ and __Website:Config__. Let's discus= s what you can do with those menus. + + + + +\\ +\\ +!!Admin + +The admin screen is only available to Roller administrators. It allows yo= u to edit user information and to delete users. All you have to do is to pi= ck a user using the combo-box, make your changes, and hit submit. If you ha= ve 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 s= ubmit 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 R= SS feed +* __Site Administrator's E-Mail Address__: admin's E-Mail address, to be i= nclude in side-side RSS feed +* __Absolute URL to this site__: (optional) to be used as basis for creati= ng absolute URLs. If you are running your Servlet Container behind a Web Se= rver, 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 si= te (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'' lin= k 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 remove= d=2E +* __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 linefe= eds into
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 use= rs are allowed to upload. +* __Forbidden Extensions__: comma-separated list of file extensions that u= sers are NOT allowed to upload. +* __Max File Size (MB)__: max size of file that users are allowed to uploa= d=2E +* __Max Directory Size (MB)__: total upload directory size per user. +* __Upload Directory__: store user uploads under this directory with a sub= directory 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 o= n their pages? +* __Cache incoming RSS newsfeeds__: cache aggregated newsfeeds? I'm not su= re why you'd ever want to turn this off. +* __RSS newsfeed Cache Time__: Time, in minutes to cache each aggregated n= ewsfeed. + Added: incubator/roller/trunk/docs/wbloggar.txt URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/wbloggar.txt= ?rev=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/roller/trunk/docs/wbloggar.txt (added) +++ incubator/roller/trunk/docs/wbloggar.txt Wed Jun 8 09:06:16 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=3D11 + +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 dr= op=20 +rollerbadge.jpg in the same directory as CMS.ini. + + [CMS-11] + Name=3DRoller + URL=3Dhttp://www.rollerweblogger.org + Icon=3Drollerbadge.jpg + Service=3D0 + Host=3Dyourserver.com + Page=3D/roller/xmlrpc + Port=3D80 + Https=3D0 + MultiCateg=3D3 + GetCategMethod=3D3 + PostMethod=3D3 + GetPostsMethod=3D3 + TemplateMethod=3D1 + =20 +If you are a FreeRoller user, then here are your settings: + + [CMS-11] + Name=3DFreeRoller + URL=3Dhttp://www.rollerweblogger.org + Icon=3Drollerbadge.jpg + Service=3D0 + Host=3Dfreeroller.net + Page=3D/xmlrpc + Port=3D80 + Https=3D0 + MultiCateg=3D3 + GetCategMethod=3D3 + PostMethod=3D3 + GetPostsMethod=3D3 + TemplateMethod=3D1 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=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/roller/trunk/metadata/database/094-to-095-migration-raw.sql (= added) +++ incubator/roller/trunk/metadata/database/094-to-095-migration-raw.sql W= ed Jun 8 09:06:16 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; =20 +DROP TABLE user; +create table rolleruser (=20 + 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; =20 +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; =20 +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=20 + (id, name, description, websiteid, template, updatetime)=20 + SELECT id, name, description, websiteid, template, updatetime FROM tem= ppage; + +CREATE TABLE tempwebsite AS SELECT * FROM website; =20 +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 +);=20 +INSERT INTO website SELECT * FROM tempwebsite; + +CREATE TABLE tempfolder AS SELECT * FROM folder; =20 +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=20 + FROM tempfolder; +UPDATE folder SET parentid =3D NULL WHERE name=3D'root' AND parentid=3D0; + +CREATE TABLE tempbookmark AS SELECT * FROM bookmark; =20 +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; =20 +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; =20 +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; =20 +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 ( user= name ); + +alter table website add constraint website_userid_fk foreign key ( userid = ) references rolleruser ( id ); + +alter table folder add constraint folder_websiteid_fk foreign key ( websit= eid ) references website( id ); +alter table folder add constraint folder_parentid_fk foreign key ( parenti= d ) references folder( id ); + +alter table bookmark add constraint bookmark_folderid_fk foreign key ( fol= derid ) references folder( id ); + +alter table weblogcategory add constraint weblogcategory_websiteid_fk fore= ign key ( websiteid ) references website( id ); + +alter table weblogentry add constraint weblogentry_websiteid_fk foreign ke= y ( websiteid ) references website( id ); +alter table weblogentry add constraint weblogentry_categoryid_fk foreign k= ey ( categoryid ) references weblogcategory( id ); + +alter table newsfeed add constraint newsfeed_websiteid_fk foreign key ( we= bsiteid ) 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=3D189602&view=3Dauto =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/roller/trunk/metadata/database/095-to-096-migration-raw.sql (= added) +++ incubator/roller/trunk/metadata/database/095-to-096-migration-raw.sql W= ed Jun 8 09:06:16 2005 @@ -0,0 +1,21 @@ + +ALTER TABLE weblogentry ADD COLUMN (publishentry @BOOLEAN_SQL_TYPE2@ not n= ull); + +ALTER TABLE website ADD COLUMN (editorpage varchar(255) not null); +UPDATE website SET editorpage =3D '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=20 + (id, role, username, userid)=20 + SELECT temprole.id, role, temprole.username, rolleruser.id=20 + FROM temprole, rolleruser + WHERE temprole.username =3D rolleruser.username; +ALTER TABLE role ADD CONSTRAINT role_userid_fk=20 + foreign key ( userid ) references rolleruser( id );