From 7293c91308b48eb45bd6de6ec0684ad1c6c9d2a3 Mon Sep 17 00:00:00 2001 From: Andrew McMillan Date: Sat, 1 Nov 2008 22:58:47 +1300 Subject: [PATCH] Some updates to documentation. --- docs/website/administration.php | 14 +++---- docs/website/clients/Mulberry-details.php | 6 +-- docs/website/installation.php | 48 ++++++++--------------- 3 files changed, 27 insertions(+), 41 deletions(-) diff --git a/docs/website/administration.php b/docs/website/administration.php index d9078546..56f084b2 100644 --- a/docs/website/administration.php +++ b/docs/website/administration.php @@ -28,15 +28,16 @@ for that person (or group or resource - but from now we'll just call them users)

Types of Relationships

These define the structure of the relationships between users.

A manager might want to grant full access to their calendar to an assistant, for example, so -there should be an "Is assisted by" relationship between the manager and the assistant.

+they should create an "Is assistant to" relationship between the assistant and themselves.

Relationships themselves are maintained on the User maintenance screen.

It can also be useful to have several people having the same kind of access to a particular -set of resources. The "Is a member of group" relationship is used to link users to the group, -and then the group is linked to each resource with the "Administers Resource" relationship.

+set of resources. The "Is a member of group" relationship is used to grant each user access to +the group, and then each resource links to the group with the "Administers Resource" relationship.

You can also define other relationship types beyond the basic ones just described.

Relationship links work in three ways, as follows:

@@ -99,16 +100,15 @@ P4 ==>> Administers Group ==> G

Configuring Calendar Clients for DAViCal

-

The DAViCal client setup page on sourceforge has information on how +

The DAViCal client setup page on sourceforge has information on how to configure Evolution, Mozilla Calendar (Sunbird & Lightning) and Mulberry to use remotely hosted calendars.

The administrative interface has no facility for viewing or modifying calendar data.

Configuring DAViCal

If you can read this then things must be mostly working already.

-

The DAViCal installation page on sourceforge has +

The DAViCal installation page on sourceforge has some further information on how to install and configure this application.

diff --git a/docs/website/clients/Mulberry-details.php b/docs/website/clients/Mulberry-details.php index af58256b..b39dd00c 100644 --- a/docs/website/clients/Mulberry-details.php +++ b/docs/website/clients/Mulberry-details.php @@ -20,10 +20,10 @@ PROPFIND requests.

Caveats

-

Unfortunately Mulberry is not (yet) open-source, though it is free, so we must wait on the developer to fix -the user interface niggles when he gets around to it.

Note that Mulberry has a complex user interface. When I wrote this I went back into Mulberry and initially thought that DAViCal had regressed somewhat and that these instructions didn't exactly work... :-) It turned out that these instructions worked just fine when I followed them to the letter the next day. Go figure. I think I need to record some screenshots of this one...

- +

If you're using Mulberry on Linux you probably have really crappy fonts purporting to be Helvetica, Times + and Courier - go into File -> Preferences -> Fonts and change them to something nicer as soon as + possible. Apple paid a lot of money to license those fonts, but few Linux users or distributors do.

diff --git a/docs/website/installation.php b/docs/website/installation.php index d374746a..56661113 100644 --- a/docs/website/installation.php +++ b/docs/website/installation.php @@ -27,7 +27,7 @@ sudo apt-key advanced --keyserver subkeys.pgp.net --recv-keys CCA377BD77494424B0

Other Linux Users

Please write something up about your experiences in the Wiki, adding distribution specific notes to pages somewhere under here: - http://rscds.sourceforge.net/moin/InstallationStuff

+ http://wiki.davical.org/w/Installation_Stuff

RPM Packages of DAViCal

We have created RPM packages of DAViCal and libawl-php from the .deb packages @@ -161,7 +161,7 @@ IP address will need to change to the webserver's IP address.

If you want greater security, or if you want to have the database on a different server, you should read the -PostgreSQL documentation on pg_hba.conf +PostgreSQL documentation on pg_hba.conf for the version you are using.

Once you have changed the pg_hba.conf file you will need to @@ -203,11 +203,11 @@ single virtual host.

ServerName davical.example.net ServerAlias calendar.example.net Alias /images/ /usr/share/davical/htdocs/images/ - + <Directory /usr/share/davical/htdocs/> AllowOverride None Order allow,deny Allow from all - + </Directory> php_value include_path /usr/share/awl/inc php_value magic_quotes_gpc 0 php_value register_globals 0 @@ -245,32 +245,19 @@ and is a regular PHP file which sets (or overrides) some specific variables.

// $c->domain_name = "calendar.example.net"; // $c->sysabbr = 'DAViCal'; // $c->admin_email = 'admin@example.net'; -// $c->system_name = "DAViCal Server Administration"; -// $c->collections_always_exist = true; +// $c->system_name = "Example DAViCal Server"; // $c->enable_row_linking = true; -// $c->default_locale = en_NZ.UTF-8; $c->pg_connect[] = 'dbname=davical port=5432 user=davical_app'; +

See the wiki for the full list of DAViCal configuration settings.

+

Multiple values may be specified for the PostgreSQL connect string, so that you can (e.g.) use PGPool to cache the database connection but fall back to a raw database connection if it is not running.

-

The "collections_always_exist" value defines whether a MKCALENDAR -command is needed to create a calendar collection before calendar -resources can be stored in it. You will want to leave this to the -default (true) if people will be using Evolution or Sunbird / -Lightning against this because that software does not support the -creation of calendar collections.

- -

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 DAViCal -administration pages.

-

You should set the 'domain_name' and 'admin_email' as they are used within the system for constructing URLs, and for notifying some kinds of events.

@@ -281,18 +268,17 @@ configuration to one of the supported locales.

Supported Locales

At present the following locales are supported:

-

In addition the Argentinian Spanish translation is also configured as base Spanish -and Mexican Spanish since although I don't have translations for those yet I expect I -can find someone to do them for me... (you know who you are :-)

-

If you want locale support you probably know more about configuring it than me, but at this stage it should be noted that all translations are UTF-8, and pages are served as UTF-8, so you will need to ensure that the UTF-8 versions of these locales @@ -318,7 +304,7 @@ to use this, and the docs for that are elsewhere.

If you had to do something else that is not covered here, or if you have any other notes you want to add to help others through the installation process, please write something up about your experiences in the Wiki, including distribution specific notes, to pages somewhere under here: - http://rscds.sourceforge.net/moin/InstallationStuff

+ http://wiki.davical.org/w/Installation_Stuff

Upgrades