Add supported software

This commit is contained in:
Markus Unterwaditzer 2014-09-23 17:37:40 +02:00
parent 0e693c5bfe
commit 27682f130d
3 changed files with 25 additions and 10 deletions

View file

@ -18,7 +18,7 @@ Table of Contents
tutorial tutorial
api api
keyring keyring
server_support supported
troubleshooting troubleshooting
changelog changelog
vdir vdir

View file

@ -1,10 +1,25 @@
============== ==================
Server Support Supported software
============== ==================
Clients supporting vdir
=======================
- `khal <http://lostpackets.de/khal/>`_, a calendar application.
- `vdirsyncer <http://vdirsyncer.readthedocs.org/>`_, a syncronization
framework and program.
- `The ppl addressbook <http://ppladdressbook.org/>`_ uses a similar enough
storage format. There are some pitfalls though, `see the notes on the related
issue <https://github.com/hnrysmth/ppl/issues/47>`_.
Supported servers
=================
vdirsyncer is currently regularly and automatically tested against the latest vdirsyncer is currently regularly and automatically tested against the latest
versions of Radicale and ownCloud. In principle, vdirsyncer is supposed to run versions of Radicale and ownCloud. In principle, vdirsyncer is supposed to run
correctly with any remotely popular CalDAV or CardDAV server. correctly with any remotely popular CalDAV or CardDAV server.
vdirsyncer's synchronization works best if the items have ``UID`` properties. vdirsyncer's synchronization works best if the items have ``UID`` properties.
Items which don't have this property still should be synchronized fine as of Items which don't have this property still should be synchronized fine as of
@ -13,7 +28,7 @@ exception than the rule. For a possible way to automatically fix such items,
take a look at `vfix <https://github.com/geier/vfix>`_. take a look at `vfix <https://github.com/geier/vfix>`_.
Radicale Radicale
======== --------
Vdirsyncer is tested against the git version and the latest PyPI release of Vdirsyncer is tested against the git version and the latest PyPI release of
Radicale. Radicale.
@ -38,7 +53,7 @@ Radicale.
support. support.
ownCloud ownCloud
======== --------
Vdirsyncer is tested against the latest version of ownCloud. Vdirsyncer is tested against the latest version of ownCloud.

View file

@ -215,9 +215,9 @@ class DavStorage(Storage):
''' '''
.. note:: .. note::
Please also see :doc:`server_support` for very important information, Please also see :doc:`supported` for very important information, as
as changing some of the default options might be very dangerous with changing some of the default options might be very dangerous with some
some servers. servers.
:param url: Base URL or an URL to a collection. :param url: Base URL or an URL to a collection.
:param username: Username for authentication. :param username: Username for authentication.