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

Updates to the documentation.

Browse Source
This commit is contained in:
Andrew McMillan 2009-09-02 12:02:16 +12:00
parent 57e743569b
commit 7835881255
4 changed files with 72 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/website/inc/page-footer.php
View File

@ -11,7 +11,7 @@ echo $tags_to_be_closed;
<a href="http://validator.w3.org/check?uri=referer" class="flink">XHTML</a> | <a href="http://jigsaw.w3.org/css-validator/check/referer" class="flink">CSS</a>
</p>
<p class="right">
Copyright 2007 | Andrew McMillan
Copyright 2007-2009 | Andrew McMillan
</p>
<p align="center">
<a href="http://andrew.mcmillan.net.nz/"><img src="http://sf-rscds.mcmillan.net.nz/clear-1.png" width="1" height="1" border="0" title="DAViCal CalDAV Server by Andrew McMillan" alt=" " /></a>

3
docs/website/inc/page-header.php
View File

@ -29,6 +29,7 @@ else {
<a href="installation.php" class="hlink">Installation</a> |
<a href="clients.php" class="hlink">Client Config</a> |
<a href="administration.php" class="hlink">Administration</a> |
<a href="background.php" class="hlink">Background</a> |
<a href="http://wiki.davical.org/w/Main_Page" class="hlink">DAViCal Wiki</a> |
<a href="http://andrew.mcmillan.net.nz/" class="hlink">Blog</a> |
<a href="http://sourceforge.net/projects/rscds/" class="hlink">DAViCal on Sourceforge</a>
@ -37,7 +38,7 @@ else {
<div id="pageContent">
<?php
$tags_to_be_closed = "</div>\n";
if ( $two_panes ) {
if ( isset($two_panes) && $two_panes ) {
$tags_to_be_closed .= $tags_to_be_closed;
echo '<div id="leftSide">';
}

114
docs/website/index.php
View File

@ -2,78 +2,86 @@
$title = "DAViCal Home";
include("inc/page-header.php");
?>
<h1>Background</h1>
<p>The CalDAV specification has been under development for a few years now, and at the same time we
have seen increasing pressure from people and organisations in the open source world to provide a
solution to their shared calendaring problems.
</p>
<p>In evaluating the possibilities for shared calendaring, there are a number of possible approaches, but
we have elected to follow the path of implementing CalDAV because we believe it is a good specification
and that it will in due course gain client implementations and provide the richest user
experience through those client implementations.</p>
<h1>Goals</h1>
<p>CalDAV is a client-server protocol specific to managing and reporting on <em>collections</em> of <em>calendar resources</em>.</p>
<p>As such, our intentions in developing this application are as follows:</p>
<ul>
<li>Simplicity of Prerequisites</li>
<li>Simplicity of Setup</li>
<li>Simplicity of Operation</li>
<li>Web-based Administration</li>
<h1>About DAViCal</h1>
<p>DAViCal is a server for calendar sharing. It is an implementation of the CalDAV protocol which is designed
for storing calendaring resources (in iCalendar format) on a remote shared server. </p>
<p>An increasing number of calendar clients support
the maintenance of shared remote calendars through CalDAV including Mozilla Calendar
(Sunbird/Lightning), Evolution, Mulberry, Chandler, and various other closed-source products
such as Apple's iCal and iPhone. </p>
<h2>Features</h2>
<ul>DAViCal:
<li>is <a href="http://www.gnu.org/philosophy/open-source-misses-the-point.html">Free Software</a> licensed under the <a href="http://www.gnu.org/licenses/gpl.html">General Public License</a>.</li>
<li>uses an SQL database for storage of event data</li>
<li>supports backward-compatible access via WebDAV in read-only or read-write mode (not recommended)</li>
<li>is committed to inter-operation with the widest possible CalDAV client software.</li>
</ul>
<h2>Simplicity of Prerequisites</h2>
<p>We have chosen to write this in PHP because we believe that PHP is a widely available web scripting language.</p>
<p>We have chosen to use the Apache web server because it is also widely available. This is not necessarily a requirement,
but no testing has been undertaken in other PHP environments to date.</p>
<p>We have chosen to use the PostgreSQL database, because it is a free, open-source database, which operates on a very wide set of
operating environments, and which is <em>fully</em> ACID compliant.</p>
<p>DAViCal supports basic delegation of read/write access among calendar users, multiple users or clients reading
and writing the same calendar entries over time, and scheduling of meetings with free/busy time displayed. </p>
<h2>Simplicity of Setup</h2>
<p>For the greatest ease use you should consider installing DAViCal on the <a href="http://www.debian.org/">Debian GNU/Linux</a>
distribution from the readily available, signed packages.</p>
<p>We expect to increase the level of automation and simplicity for the Debian target release in particular, although other
distributions might also become easier at the same time. We do expect slightly greater installation complexity in the first
few releases as we come to understand the particular problems people experience.</p>
<h1>Overview of Installation and Use</h1>
<h2>Prerequisites</h2>
<ul>To install and use DAViCal you will need:
<li>a PostgreSQL database server</li>
<li>a web server which can run PHP version 5</li>
</ul>
<p>We use <a href="http://www.debian.org/">Debian GNU/Linux</a> for this, but other people use various different
versions of Linux, FreeBSD, Mac OSX and even Microsoft Windows. We definitely do not recommend using Windows
for this unless you are completely hobbled by silly internal IT policies and have to do so.</p>
<h2>Simplicity of Operation</h2>
<p>In general DAViCal should not need significant maintenance to keep it operating.</p>
<p>Administrative functionality will be kept as simple as possible, within the target of supporting
organisations of up to several hundred staff.</p>
<p>The server-side smarts in DAViCal are intended to be fairly minimal in order to support CalDAV
only in a manner sufficient to inter-operate with clients, and with the focus primarily
on the storage of calendar resources.</p>
<h2>Getting DAViCal and Installing DAViCal</h2>
<p>You can download DAViCal from <a href="http://debian.mcmillan.net.nz/">http://debian.mcmillan.net.nz/</a></p>
<p>Start looking on the <a href="installation.php">DAViCal Installation Page</a> for more places to download, and
detailed instructions as to what to do when you have it.</p>
<h2>Web-based Administration</h2>
<p>General administration of the system should be through a web-based application.</p>
<p>Calendars will not be made available in a web-based view in initial releases. It is unlikely that calendars will ever be
maintainable through a web-based client, although the server should support the use of web-based client software which
works using the CalDAV protocol.</p>
<h2>Using DAViCal</h2>
<p>Read here about <a href="clients.php">how to configure various CalDAV Clients with DAViCal</a>. There is also
a page on the wiki which will sometimes have newer information.</p>
<h2>Getting Help</h2>
<p>Specifically: help on DAViCal!</p>
<p>The <em>best</em> place to go for help on DAViCal is the <a href="http://wiki.davical.org/">DAViCal Wiki</a>.</p>
<p>If you can't find your answer there, then the IRC channel #davical on <a href="http://irc.oftc.net/">irc.oftc.net</a> is
a great next port of call. Many problems can be solved quickly with a short on-line chat.</p>
<p>Almost as good as the IRC channel is the <a href="https://lists.sourceforge.net/mailman/listinfo/rscds-general">DAViCal General Mailing List</a>.</p>
<ul>Other places to try include:
<li>The sourceforge forums.</li>
<li>Googling your problem.</li>
</ul>
<p>As a last resort, or in case your organisation likes that sort of thing, paid commercial support is available
through the author's company <a href="http://www.morphoss.com/products/davical/support">Morphoss</a>.</p>
<h1>Credits</h1>
<p>DAViCal CalDAV Server was conceived and written by <a href="http://andrew.mcmillan.net.nz/">Andrew McMillan</a>.</p>
<p>Translations of the administration interface have been done by:</p>
<ul>
<ul>Translations of the administration interface have been done by:
<li>Lorena Paoletti (Spanish)</li>
<li>Cristina Radalescu (German)</li>
<li>Guillaume Rosquin &amp; Maxime Delorme (French)</li>
<li>Nick Khazov (Russian)</li>
<li>Eelco Maljaars (Dutch)</li>
</ul>
<p>Other contributors:</p>
<ul>
<ul>Other contributors:
<li>Maxime Delorme (CSS, LDAP, SyncML, French translations)</li>
<li>Andrew Ruthven (Various enhancements)</li>
</ul>
<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>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>
<h1>Contributing to DAViCal</h1>
<p>We welcome contributions from interested people. You don't need to be able to write code - there are lots of
small tasks around the project that can be done.
CalDAV server:</p>
<ul>Here are some things you could do that will help us to concentrate on making DAViCal a better:
<li>writing documentation</li>
<li>helping people on IRC, on the mailing list or sf.net forums</li>
<li>translating the DAViCal interface to another language</li>
<li>managing the release process</li>
<li>reviewing and tidying the Wiki updates</li>
<li>writing and reviewing patches</li>
<li>designing future functionality</li>
<li>thinking of more interesting ways to contribute to DAViCal!</li>
</ul>
<p>Can you think of more?</p>
<?php
include("inc/page-footer.php");
?>

31
docs/website/style.css
View File

@ -43,39 +43,24 @@ hr {
padding-top: 64px;
padding-right: 5px;
display:block;
text-decoration: none;
}
.hlink:link {
.hlink {
color: #FFFFFF;
font-family: helvetica, arial, sans-serif;
font-size: 8pt;
font-size: 80%;
text-decoration: none;
}
.hlink:active {
}
.hlink:link, .hlink:active, .hlink:visited {
color: #FFFFFF;
font-family: helvetica, arial, sans-serif;
font-size: 8pt;
font-size: 80%;
text-decoration: none;
}
}
.hlink:hover {
color: #FFFFFF;
font-family: helvetica, arial, sans-serif;
font-size: 8pt;
font-size: 80%;
text-decoration: underline;
}
.hlink:visited {
color: #FFFFFF;
font-family: helvetica, arial, sans-serif;
font-size: 8pt;
font-size: 80%;
text-decoration: none;
}
}
#pageContent {
/* Not used for anything at present */
@ -120,14 +105,14 @@ ol, ul {
ul {
list-style-type: square;
font-family: helvetica, arial, sans-serif;
}
li {
list-style-position: outside;
margin-left: 2em;
font-family: helvetica, arial, sans-serif;
font-size: 90%;
margin-bottom: 5px;
margin: 0.1em 2em;
}
code {