nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-08-11 15:26:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Some updates to documentation.

Browse Source
This commit is contained in:
Andrew McMillan 2008-11-01 22:58:47 +13:00
parent ff87efdc1d
commit 7293c91308
3 changed files with 27 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/website/administration.php
View File

@ -28,15 +28,16 @@ for that person (or group or resource - but from now we'll just call them users)
<h2>Types of Relationships</h2>
<p>These define the structure of the relationships between users.</p>
<p>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.</p>
they should create an "Is assistant to" relationship between the assistant and themselves.</p>
<p>Relationships themselves are maintained on the User maintenance screen.</p>
<p>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.</p>
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.</p>
<p>You can also define other relationship types beyond the basic ones just described.</p>
<p>Relationship links work in three ways, as follows:</p>
<ul>
<li>Where users relate to each other (i.e. links to non-group targets), the relationship type will define whether access is read only, or read &amp; write.</li>
<li>Where users relate to each other (i.e. links to non-group targets), the relationship type will define whether access is free/busy only, read only,
read &amp; write or full administrative control.</li>
<li>Where a set of users link to a group, which does not further link to other users/resources, they will share the same access to each other.</li>
<li>Where a set of users link to a group, which then links to other users/resources, the access restrictions will apply as the lesser of their link to that group, or the link from the group. They will have no access to each other's calendars.</li>
</ul>
@ -99,16 +100,15 @@ P4 ==>> Administers Group ==> G
<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
<p>The <a href="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 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">DAViCal installation page</a> on sourceforge has
<p>The <a href="installation.php">DAViCal installation page</a> on sourceforge has
some further information on how to install and configure this application.</p>
<?php
include("inc/page-footer.php");
?>

6
docs/website/clients/Mulberry-details.php
View File

@ -20,10 +20,10 @@ PROPFIND requests.</p>
</ol>
<h2>Caveats</h2>
<p>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.</p>
<p>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 <em>just fine</em> when I followed them to the letter the next day. Go figure.
I think I need to record some screenshots of this one...</p>
<p>If you're using Mulberry on Linux you probably have really crappy fonts purporting to be Helvetica, Times
and Courier - go into File -&gt; Preferences -&gt; 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.</p>

48
docs/website/installation.php
View File

@ -27,7 +27,7 @@ sudo apt-key advanced --keyserver subkeys.pgp.net --recv-keys CCA377BD77494424B0
<h2>Other Linux Users</h2>
<p>Please write something up about your experiences in the Wiki, adding distribution specific
notes to pages somewhere under here:
<a href="http://rscds.sourceforge.net/moin/InstallationStuff">http://rscds.sourceforge.net/moin/InstallationStuff</a></p>
<a href="http://wiki.davical.org/w/Installation_Stuff">http://wiki.davical.org/w/Installation_Stuff</a></p>
<h3>RPM Packages of DAViCal</h3>
<p>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.</p>
<p>If you want greater security, or if you want to have the
database on a different server, you should read the
<a href="http://www.postgresql.org/docs/8.1/interactive/client-authentication.html">PostgreSQL documentation on pg_hba.conf</a>
<a href="http://www.postgresql.org/docs/8.3/interactive/client-authentication.html">PostgreSQL documentation on pg_hba.conf</a>
for the version you are using.</p>
<p>Once you have changed the pg_hba.conf file you will need to
@ -203,11 +203,11 @@ single virtual host.</p>
ServerName davical.example.net
ServerAlias calendar.example.net
Alias /images/ /usr/share/davical/htdocs/images/
<Directory /usr/share/davical/htdocs/>
&lt;Directory /usr/share/davical/htdocs/>
AllowOverride None
Order allow,deny
Allow from all
</Directory>
&lt;/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.</p>
// $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';
</pre>
<p>See the wiki for the full list of <a href="http://wiki.davical.org/w/Configuration_settings">DAViCal configuration settings</a>.</p>
<p>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.</p>
<p>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.</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 DAViCal
administration pages.</p>
<p>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.</p>
@ -281,18 +268,17 @@ configuration to one of the supported locales.</p>
<h1>Supported Locales</h1>
<p>At present the following locales are supported:</p>
<ul>
<li>English (New Zealand)</li>
<li>Spanish (Argentinian)</li>
<li>German</li>
<li>French</li>
<li>Russian</li>
<li>Dutch</li>
<li>English</li>
<li>German / Deutsch</li>
<li>Spanish / Español</li>
<li>French / Français</li>
<li>Russian / Русский</li>
<li>Netherlands / Nederlands</li>
<li>Polish / Polski</li>
<li>Hungarian / Magyar</li>
<li>Japanese / 日本語</li>
</ul>
<p>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 :-)</p>
<p>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.</p>
<p>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:
<a href="http://rscds.sourceforge.net/moin/InstallationStuff">http://rscds.sourceforge.net/moin/InstallationStuff</a></p>
<a href="http://wiki.davical.org/w/Installation_Stuff">http://wiki.davical.org/w/Installation_Stuff</a></p>
<h1>Upgrades</h1>