From cf7eaa11bcd946fe6f451ed19e3c9268b85adb8d Mon Sep 17 00:00:00 2001
From: Andrew McMillan <debian@mcmillan.net.nz>
Date: Wed, 17 Oct 2007 10:17:14 +1300
Subject: [PATCH] Rename to DAViCal in the documentation.

---
 docs/website/administration.php  |  8 ++--
 docs/website/inc/page-header.php |  6 ++-
 docs/website/index.php           |  3 +-
 docs/website/installation.php    | 66 ++++++++++++++++++++------------
 4 files changed, 52 insertions(+), 31 deletions(-)

diff --git a/docs/website/administration.php b/docs/website/administration.php
index 4702f861..d9078546 100644
--- a/docs/website/administration.php
+++ b/docs/website/administration.php
@@ -98,14 +98,14 @@ P4  ==>> Administers Group  ==> G
 </pre>
 
 
-<h1>Configuring Calendar Clients for RSCDS</h1>
-<p>The <a href="http://rscds.sourceforge.net/clients.php">RSCDS client setup page on sourceforge</a> has information on how
+<h1>Configuring Calendar Clients for DAViCal</h1>
+<p>The <a href="http://rscds.sourceforge.net/clients.php">DAViCal client setup page on sourceforge</a> has information on how
 to configure Evolution, Mozilla Calendar (Sunbird &amp; Lightning) and Mulberry to use remotely hosted calendars.</p>
 <p>The administrative interface has no facility for viewing or modifying calendar data.</p>
 
-<h1>Configuring RSCDS</h1>
+<h1>Configuring DAViCal</h1>
 <p>If you can read this then things must be mostly working already.</p>
-<p>The <a href="http://rscds.sourceforge.net/installation.php">RSCDS installation page</a> on sourceforge has
+<p>The <a href="http://rscds.sourceforge.net/installation.php">DAViCal installation page</a> on sourceforge has
 some further information on how to install and configure this application.</p>
 
 
diff --git a/docs/website/inc/page-header.php b/docs/website/inc/page-header.php
index f2433937..6fa74c3b 100644
--- a/docs/website/inc/page-header.php
+++ b/docs/website/inc/page-header.php
@@ -17,10 +17,14 @@ if ( isset($title) ) {
   echo $title;
 }
 else {
+<<<<<<< HEAD:docs/website/inc/page-header.php
   echo "DAViCal CalDAV Server";
+=======
+  echo "DAViCal";
+>>>>>>> Rename to DAViCal in the documentation.:docs/website/inc/page-header.php
 }
 ?></div>
-<div id="subTitle">DAViCal CalDAV Server</div>
+<div id="subTitle">A CalDAV Store</div>
 <div id="headerLinks">
 <a href="index.php" class="hlink">Home</a> |
 <a href="installation.php" class="hlink">Installation</a> |
diff --git a/docs/website/index.php b/docs/website/index.php
index bbdae445..c4c6e1cc 100644
--- a/docs/website/index.php
+++ b/docs/website/index.php
@@ -56,7 +56,7 @@ works using the CalDAV protocol.</p>
 <ul>
 <li>Lorena Paoletti (Spanish)</li>
 <li>Cristina Radalescu (German)</li>
-<li>Guillaume Rosquin (French)</li>
+<li>Guillaume Rosquin &amp; Maxime Delorme (French)</li>
 <li>Nick Khazov (Russian)</li>
 <li>Eelco Maljaars (Dutch)</li>
 </ul>
@@ -69,7 +69,6 @@ works using the CalDAV protocol.</p>
 <h1>Your Name Here!</h1>
 <p>If you are interested in helping, there are several areas where I need help at the moment:</p>
 <i>
-<li>The project needs a better name - feel free to suggest one!</li>
 <li>We need more documentation</li>
 <li>We need to find more CalDAV-capable calendar clients to interoperate with</li>
 <li>We would love you to write about your experiences in the project Wiki.</li>
diff --git a/docs/website/installation.php b/docs/website/installation.php
index e477f4e5..262a98c6 100644
--- a/docs/website/installation.php
+++ b/docs/website/installation.php
@@ -12,7 +12,7 @@ deb http://debian.mcmillan.net.nz/debian unstable awm
 </pre>
 <p>to your <code>/etc/apt/sources.list</code>.  Once you have done that you
 can use <code>apt-get</code> or <code>synaptic</code> or some other equivalent package
-manager to fetch and install <code>rscds</code> and all the dependencies.</p>
+manager to fetch and install <code>DAViCal</code> and all the dependencies.</p>
 
 <p>This repository is signed by Andrew McMillan's public key, which you can install so that
 you don't get asked for confirmation all the time:</p>
@@ -31,15 +31,15 @@ notes to pages somewhere under here:
 
 <h3>RPM Packages of DAViCal</h3>
 <p>We have created RPM packages of DAViCal and libawl-php from the .deb packages
-using "alien". I don't know how well these work, so would appreciate feedback
-about your success with them.</p>
+using "alien". These are reported to work fine, so use them and then proceed to the
+Pre-requisites section below.</p>
 
 <h3>SuSE Linux</h3>
 <p>On SuSE Linux you may need to look in /var/lib/pgsql/data/ for the pg_hba.conf file.</p>
 
 <h3>Gentoo, Slackware, BSD and the rest</h3>
 
-<p>You will need to download the latest versions of the <code>rscds</code> and <code>awl</code> packages
+<p>You will need to download the latest versions of the <code>DAViCal</code> and <code>awl</code> packages
 from the <a href="http://sourceforge.net/project/showfiles.php?group_id=179845">sourceforge download page for DAViCal</a>.</p>
 <p>You will need to untar these.  Preferably you will untar them from within the "<code>/usr/share</code>" directory and everything
 will be in it's expected location (well, except the docs, but it will at least be tidy and everything will be in one place).</p>
@@ -68,7 +68,7 @@ a number of years.</p>
 <p>The following other software is also needed:</p>
 <ul>
   <li>Apache: 1.3.x or 2.x.x</li>
-  <li>PHP: 5.0 or greater, PHP4 might work</li>
+  <li>PHP: 5.0 or greater</li>
   <li>PostgreSQL: 8.1 or greater</li>
 </ul>
 
@@ -78,10 +78,11 @@ if you want to increase the security or scalability of your
 installation.</p>
 
 <p>Since the CalDAV store takes over a significant amount of path
-hierarchy, it is designed to be installed in it's own virtual
-host.  However if you want it to operate within the web root of some
+hierarchy, it can be easier in it's own virtual
+host.  If you want it to operate within the web root of some
 other application there are instructions on the Wiki about doing this,
-and other fancy tricks such as URL rewriting to shorten the path.</p>
+as well as other fancy tricks such as configuring URL rewriting in
+order to shorten the path.</p>
 
 
 <h1>Database Setup</h1>
@@ -124,7 +125,7 @@ have put them.</p>
 running as a user who has rights to create a new database, so you
 may need to do this as the "postgres" user, for example:</p>
 <pre>
-su postgres -c /usr/share/rscds/dba/create-database.sh
+su postgres -c /usr/share/davical/dba/create-database.sh
 </pre>
 
 <h2>Connecting to the Database</h2>
@@ -168,23 +169,40 @@ reload or restart the PostgreSQL process for the change to come
 into effect.</p>
 
 <h1>Apache VHost Configuration</h1>
+<h2>Relative to an existing DocumentRoot</h2>
+
+<p>You can create a symlink from an existing web root directory to the
+/usr/share/rscds/htdocs directory, such as:</p>
+
+<pre>
+cd /my/apache/docroot
+ln -s /usr/share/davical/htdocs davical
+</pre>
+
+You will need to change your global PHP configuration to include the
+directory '/usr/share/awl/inc' in the 'include_path' setting, along with
+any other directories already needed by other applications.
+
+You will also need to ensure that 'magic_quotes_gpc' is off.
+
+<h2>Using a Virtual Host</h2>
 
 <p>Your Apache instance needs to be configured for Virtual Hosts.  If
 this is not already the case you may want to read some documentation
 about that, and you most likely will want to ensure that any existing
-site becomes the **default** virtual host, with RSCDS only being a
+site becomes the **default** virtual host, with DAViCal only being a
 single virtual host.</p>
 
 <p>I use a Virtual Host stanza like this:</p>
 <pre>
 #
-# Virtual Host def for Debian packaged RSCDS
+# Virtual Host def for Debian packaged DAViCal
 &lt;VirtualHost 123.4.56.78 >
-  DocumentRoot /usr/share/rscds/htdocs
+  DocumentRoot /usr/share/davical/htdocs
   DirectoryIndex index.php index.html
   ServerName davical.example.net
   ServerAlias calendar.example.net
-  Alias /images/ /usr/share/rscds/htdocs/images/
+  Alias /images/ /usr/share/davical/htdocs/images/
   php_value include_path /usr/share/awl/inc
   php_value magic_quotes_gpc 0
   php_value register_globals 0
@@ -204,30 +222,30 @@ installed from a package.</p>
 
 <p>Once your VHost is installed an working correctly, you should be
 able to browse to that address and see a page telling you that
-you need to configure RSCDS.</p>
+you need to configure DAViCal.</p>
 
 <p>On Debian systems (or derivatives such as Ubuntu), when you are
 using Apache 2, you should put this definition in the /etc/apache2/sites-available
 directory and you can use the 'a2ensite' command to enable it.</p>
 
 
-<h1>RSCDS Configuration</h1>
+<h1>DAViCal Configuration</h1>
 
-<p>The RSCDS configuration generally resides in /etc/rscds/&lt;domain&gt;-conf.php
+<p>The DAViCal configuration generally resides in /etc/davical/&lt;domain&gt;-conf.php
 and is a regular PHP file which sets (or overrides) some specific variables.</p>
 
 <pre>
 &lt;?php
 //  $c->domain_name = "calendar.example.net";
-//  $c->sysabbr     = 'rscds';
+//  $c->sysabbr     = 'DAViCal';
 //  $c->admin_email = 'admin@example.net';
-//  $c->system_name = "Really Simple CalDAV Store";
+//  $c->system_name = "DAViCal Server Administration";
 //  $c->collections_always_exist = true;
 //  $c->enable_row_linking = true;
 //  $c->default_locale = en_NZ.UTF-8;
 
-//  $c->pg_connect[] = 'dbname=rscds port=5433 user=general';
-  $c->pg_connect[] = 'dbname=rscds port=5432 user=general';
+  $c->pg_connect[] = 'dbname=davical port=5433 user=general';
+  $c->pg_connect[] = 'dbname=davical port=5432 user=general';
 
 ?>
 </pre>
@@ -246,7 +264,7 @@ creation of calendar collections.</p>
 <p>The "enable_row_linking" option controls whether javascript is used
 to make the entire row clickable in browse lists in the administration
 pages.  Since this doesn't work in Konqueror you may want to set this
-to false if you expect people to be using Konqueror with the RSCDS
+to false if you expect people to be using Konqueror with the DAViCal
 administration pages.</p>
 
 <p>You should set the 'domain_name' and 'admin_email' as they are used
@@ -283,7 +301,7 @@ are supported on your system.</p>
 pages and log in as 'admin' (the password is the bit after the '**'
 in the 'password' field of the 'usr' table so:</p>
 <pre>
-psql rscds -c 'select username, password from usr;'
+psql davical -c 'select username, password from usr;'
 </pre>
 
 <p>should show you a list.  Note that once you change a password it
@@ -301,8 +319,8 @@ about your experiences in the Wiki, including distribution specific notes, to pa
 
 <h1>Upgrades</h1>
 
-<p>Whenever you upgrade the RSCDS application to a new version you will need to
-run dba/update-rscds-database which will apply any pending database patches, as well as
+<p>Whenever you upgrade the DAViCal application to a new version you will need to
+run dba/update-davical-database which will apply any pending database patches, as well as
 enabling any new translations.</p>
 
 <p>In due course the running of this script will be able to be handled by