restructured the user documentation

This commit is contained in:
Bernhard Posselt
2013-02-08 12:56:03 +01:00
parent 2f9a1ccf10
commit 03d17afe41
9 changed files with 276 additions and 29 deletions

View File

@@ -37,7 +37,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
master_doc = 'contents'
# General information about the project.
project = u'ownCloud User Manual'

28
user_manual/contents.rst Normal file
View File

@@ -0,0 +1,28 @@
.. _contents:
===============================
ownCloud documentation contents
===============================
.. toctree::
:hidden:
index
.. toctree::
:maxdepth: 3
webinterface
files/index
calendars
contacts
bookmarks
mediaplayer
migration
Indices and tables
==================
* :ref:`genindex`

View File

@@ -62,7 +62,7 @@ drive to map ownCloud to. Finally, enter the address to your ownCloud instance,
for an SSL protected server. Check ``Reconnect at logon`` to make this mapping persistent
across reboots. If you want to connect as another user, check ``Connect using different credentials``.
.. figure:: images/explorer_webdav.png
.. figure:: ../images/explorer_webdav.png
:scale: 80%
Mapping WebDAV on Windows Explorer.
@@ -155,7 +155,7 @@ Assuming your owncloud instance is installed at ``http://www.yourserver.com/ownc
Ubuntu/Gnome (Nautilus)
~~~~~~~~~~~~~~~~~~~~~~~
.. figure:: images/nautilus_webdav.png
.. figure:: ../images/nautilus_webdav.png
Nautilus WebDAV mounting dialog

View File

@@ -0,0 +1,14 @@
=======================
Files & Synchronization
=======================
.. toctree::
:maxdepth: 1
files
versioncontrol
sync
sync_ios
sync_kde
sync_osx
connecting_webdav

View File

@@ -0,0 +1,22 @@
Desktop Synchronisation
========================
For synchronizing files with your desktop computer, we recommend using the
`ownCloud Client`_ for Windows, Mac OS X and Linux.
The ownCloud Desktop Client enables you to connect to your private ownCloud Server.
You can create folders in your home directory, and keep the contents of those
folders synced with your ownCloud server. Simply copy a file into the directory
and the ownCloud desktop client does the rest. Make a change to the files on one
computer, it will flow across the others using these desktop sync clients. Always
have your latest files with you wherever you are.
Its usage is documented separately in the `ownCloud Desktop Client Manual`_.
Furthermore, It is possible to synchronize your ownCloud calendar and address book
with a variety of different operating systems and devices. It is also possible to
mount your ownCloud storage via WebDAV, which is also documented in the next chapters.
.. _ownCloud Client: http://owncloud.org/sync-client/
.. _ownCloud Desktop Client Manual: http://doc.owncloud.com/desktop/1.1/

View File

@@ -0,0 +1,59 @@
iOS - Synchronize iPhone/iPad
=============================
Synchronizing the Calendar
~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Open the settings application.
#. Select Mail, Contacts, Calendars.
#. Select Add Account.
#. Select Other as account type.
#. Select Add CalDAV account.
#. For server, type ``ADDRESS/remote.php/caldav/principals/username``
#. Enter your user name and password.
#. Select Next.
#. If your server does not support SSL, a warning will be displayed.
Select Continue.
#. If the iPhone is unable to verify the account information perform the
following:
- Select OK.
- Select advanced settings.
- Make sure Use SSL is set to OFF.
- Change port to 80.
- Go back to account information and hit Save.
Your calendar should now be visible in the Calendar application
Synchronizing the Address book
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Open the settings application.
#. Select Mail, Contacts, Calendars.
#. Select Add Account.
#. Select Other as account type.
#. Select Add CardDAV account.
#. For server, type ``ADDRESS/remote.php/carddav/principals/username``
#. Enter your user name and password.
#. Select Next.
#. If your server does not support SSL, a warning will be displayed.
Select Continue.
#. If the iPhone is unable to verify the account information perform the
following:
- Select OK.
- Select advanced settings.
- Make sure Use SSL is set to OFF.
- Change port to 80.
- Go back to account information and hit Save.
Now should now find your contacts in the address book of your
iPhone.Problems have been reported for iOS 4.X. A possible solution is
at the `forum`_.
.. _forum: http://forum.owncloud.org/viewtopic.php?f=3&t=71&p=2211#p2197

View File

@@ -0,0 +1,57 @@
Synchronizing with KDE SC
=========================
.. image:: /images/kdes1.png
From KDE SC 4.8 and forward setting up ownCloud is very easy.From System
Settings Personal Information/Akonadi Resources Configuration select DAV
Groupware resource.
.. image:: /images/kdes2.png
Enter your ownCloud username and password and click "Next".
.. image:: /images/kdes3.png
Select ownCloud in the drop down list and click "Next".
.. image:: /images/kdes4.png
Enter the host name and installation path. If you do not use SSL
remember to de-select "Use secure connection".
.. image:: /images/kdes5.png
Test the connection. If everything went well you should see a message
like the one below.
.. image:: /images/kdes6.png
Click "Finish" and you will be able to change the display name and
refresh interval.
.. image:: /images/kdes7.png
Now you should see the Akonadi resource doing the first
synchronization.
.. missing
.. .. image:: /images/kdes8.png
You can find the Contacts and Calendars in Kontact (or
KOrganizer/KAddressbook if you run the programs separately.)
.. image:: /images/kdes9.png
.. image:: /images/kdes.png

View File

@@ -0,0 +1,50 @@
Synchronizing with OS X
=======================
To use ownCloud with iCal you will need to use the following URL:
http://ADDRESS/remote.php/caldav/principals/username/
In principle the setup is the same as with iOS using the path
``ADDRESS/remote.php/caldav/principals/username/`` to sync with
ownCloud. For OS X 10.7 Lion and 10.8 Mountain Lion everything works
fine, but OS X 10.6 (Snow Leopard) and older needs some fiddling to
work. A user contributed the following:
#. Make sure, Addressbook is not running. If it is, select the windows
and press Command + Q to terminate it.
#. Navigate to ``/Users/YOUR\_USERNAME/Library/Application
Support/AddressBook/Sources``. If you have all ready some kind of
address book setup, it is likely you will see some folders named like
this ``BEA92826-FBF3-4E53-B5C6-ED7C2B454430``. Note down what folders
there are now and leave the window open.
#. Open addressbook and try to add a new CardDav addressbook. At this
point, it does not matter what information you enter. It will come up
with the same error message you mentioned before when you click
"Create". Ignore it and click "Create" again. A non-functional
address book will be added.
#. Close Address-Book again using Command + Q
#. Go back to the folder window from step 2. You will now see a newly
created folder with another long string as its name.
#. Navigate to the newly created folder and edit the
``Configuration.plist`` with your favorite text editor.
#. Search for a section looking like this:
``<key>servername</key> <string>http://:0(null)</string> <key>username</key> <string>Whatever_you_entered_before</string>``
8. Make it look like this. Please note that the :80 after **YOUR_DOMAIN**
is important:
``<key>servername</key <string>http://YOUR_DOMAIN:80/owncloud/remote.php/carddav/principals/username</string> <key>username</key <string>username</string>``
9. Save the file and open Address Book again. It will not work yet.
10. Open the preferences for your ownCloud CardDAV-Account and enter your password.
11. You may have to restart Address Book once more. After this, it should work.
There is also an easy `HOWTO`_ in the forum.
.. _HOWTO: http://forum.owncloud.org/viewtopic.php?f=3&t=132

View File

@@ -1,30 +1,47 @@
.. _contents:
.. _index:
Contents
========
.. toctree::
:maxdepth: 2
introduction
webinterface
connecting_webdav
files
calendars
contacts
bookmarks
sync
sync_kde
sync_osx
sync_ios
mediaplayer
versioncontrol
migration
.. add more chapters
Indices and tables
==================
User Documentation
==================
**Welcome to ownCloud, your self-hosted file sync and share solution.**
* :ref:`genindex`
OwnCloud is open source file sync and share software for everyone from individuals operating the free Community Edition, to large enterprises and service providers operating ownCloud Enterprise Edition. ownCloud provides a safe, secure and compliant file sync and share solution on servers you control.
With ownCloud you can share one or more folders on your PC, and sync them with your ownCloud server. Place files in your local shared directories, and those files are immediately synced to the server, and then to other PCs via the desktop client. Not near a desktop client? No problem, simply log in with the web client and manage your files there. The Android and iOS mobile apps allow you to browse, download and upload photos and videos. On Android, you may also create, download, edit and upload any other files, with the correct software installed.
Whether using a mobile device, a workstation, or a web client, ownCloud provides the ability to put the right files in the right hands at the right time on any device in one simple-to-use, secure, private and controlled solution. After all, with ownCloud, its Your Cloud, Your Data, Your Way.
Webinterface
============
* :doc:`webinterface`
Files & Synchronization
=======================
* :doc:`files/files`
* :doc:`files/versioncontrol`
* :doc:`files/sync`
* :doc:`files/sync_ios`
* :doc:`files/sync_kde`
* :doc:`files/sync_osx`
* :doc:`files/connecting_webdav`
Calendar
========
* :doc:`calendars`
Contacts
========
* :doc:`contacts`
Bookmarks
=========
* :doc:`bookmarks`
Mediaplayer
===========
* :doc:`mediaplayer`
Export
======
* :doc:`migration`