From 7835881255d562a0647f949e190fe3ef126d4c35 Mon Sep 17 00:00:00 2001 From: Andrew McMillan Date: Wed, 2 Sep 2009 12:02:16 +1200 Subject: [PATCH] Updates to the documentation. --- docs/website/inc/page-footer.php | 2 +- docs/website/inc/page-header.php | 3 +- docs/website/index.php | 114 +++++++++++++++++-------------- docs/website/style.css | 31 +++------ 4 files changed, 72 insertions(+), 78 deletions(-) diff --git a/docs/website/inc/page-footer.php b/docs/website/inc/page-footer.php index e5833ec4..559cd758 100644 --- a/docs/website/inc/page-footer.php +++ b/docs/website/inc/page-footer.php @@ -11,7 +11,7 @@ echo $tags_to_be_closed; XHTML | CSS

-Copyright 2007 | Andrew McMillan +Copyright 2007-2009 | Andrew McMillan

diff --git a/docs/website/inc/page-header.php b/docs/website/inc/page-header.php index 6a7a81fe..4773e6b3 100644 --- a/docs/website/inc/page-header.php +++ b/docs/website/inc/page-header.php @@ -29,6 +29,7 @@ else { Installation | Client Config | Administration | +Background | DAViCal Wiki | Blog | DAViCal on Sourceforge @@ -37,7 +38,7 @@ else {

\n"; - if ( $two_panes ) { + if ( isset($two_panes) && $two_panes ) { $tags_to_be_closed .= $tags_to_be_closed; echo '
'; } diff --git a/docs/website/index.php b/docs/website/index.php index c4c6e1cc..ac5908d2 100644 --- a/docs/website/index.php +++ b/docs/website/index.php @@ -2,78 +2,86 @@ $title = "DAViCal Home"; include("inc/page-header.php"); ?> -

Background

-

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

-

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.

- -

Goals

-

CalDAV is a client-server protocol specific to managing and reporting on collections of calendar resources.

-

As such, our intentions in developing this application are as follows:

-
    -
  • Simplicity of Prerequisites
    • -
  • Simplicity of Setup
    • -
  • Simplicity of Operation
    • -
  • Web-based Administration
    • +

    About DAViCal

    +

    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.

    +

    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.

    +

    Features

    +
      DAViCal: +
    • is Free Software licensed under the General Public License.
      • +
    • uses an SQL database for storage of event data
      • +
    • supports backward-compatible access via WebDAV in read-only or read-write mode (not recommended)
      • +
    • is committed to inter-operation with the widest possible CalDAV client software.
    -

    Simplicity of Prerequisites

    -

    We have chosen to write this in PHP because we believe that PHP is a widely available web scripting language.

    -

    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.

    -

    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 fully ACID compliant.

    +

    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.

    -

    Simplicity of Setup

    -

    For the greatest ease use you should consider installing DAViCal on the Debian GNU/Linux -distribution from the readily available, signed packages.

    -

    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.

    +

    Overview of Installation and Use

    +

    Prerequisites

    +
      To install and use DAViCal you will need: +
    • a PostgreSQL database server
      • +
    • a web server which can run PHP version 5
      • +
    +

    We use Debian GNU/Linux 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.

    -

    Simplicity of Operation

    -

    In general DAViCal should not need significant maintenance to keep it operating.

    -

    Administrative functionality will be kept as simple as possible, within the target of supporting -organisations of up to several hundred staff.

    -

    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.

    +

    Getting DAViCal and Installing DAViCal

    +

    You can download DAViCal from http://debian.mcmillan.net.nz/

    +

    Start looking on the DAViCal Installation Page for more places to download, and +detailed instructions as to what to do when you have it.

    -

    Web-based Administration

    -

    General administration of the system should be through a web-based application.

    -

    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.

    +

    Using DAViCal

    +

    Read here about how to configure various CalDAV Clients with DAViCal. There is also +a page on the wiki which will sometimes have newer information.

    + +

    Getting Help

    +

    Specifically: help on DAViCal!

    +

    The best place to go for help on DAViCal is the DAViCal Wiki.

    +

    If you can't find your answer there, then the IRC channel #davical on irc.oftc.net is +a great next port of call. Many problems can be solved quickly with a short on-line chat.

    +

    Almost as good as the IRC channel is the DAViCal General Mailing List.

    +
      Other places to try include: +
    • The sourceforge forums.
      • +
    • Googling your problem.
      • +
    +

    As a last resort, or in case your organisation likes that sort of thing, paid commercial support is available +through the author's company Morphoss.

    Credits

    DAViCal CalDAV Server was conceived and written by Andrew McMillan.

    -

    Translations of the administration interface have been done by:

    -
      +
        Translations of the administration interface have been done by:
      • Lorena Paoletti (Spanish)
      • Cristina Radalescu (German)
      • Guillaume Rosquin & Maxime Delorme (French)
      • Nick Khazov (Russian)
      • Eelco Maljaars (Dutch)
      -

      Other contributors:

      -
        +
          Other contributors:
        • Maxime Delorme (CSS, LDAP, SyncML, French translations)
        • Andrew Ruthven (Various enhancements)
        -

        Your Name Here!

        -

        If you are interested in helping, there are several areas where I need help at the moment:

        - -
      • We need more documentation
        • -
      • We need to find more CalDAV-capable calendar clients to interoperate with
        • -
      • We would love you to write about your experiences in the project Wiki.
        • +

        Contributing to DAViCal

        +

        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:

        +
          Here are some things you could do that will help us to concentrate on making DAViCal a better: +
        • writing documentation
          • +
        • helping people on IRC, on the mailing list or sf.net forums
          • +
        • translating the DAViCal interface to another language
          • +
        • managing the release process
          • +
        • reviewing and tidying the Wiki updates
          • +
        • writing and reviewing patches
          • +
        • designing future functionality
          • +
        • thinking of more interesting ways to contribute to DAViCal!
        +

        Can you think of more?

        + \ No newline at end of file diff --git a/docs/website/style.css b/docs/website/style.css index a089576b..a8b6d26c 100644 --- a/docs/website/style.css +++ b/docs/website/style.css @@ -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 {