Add ported user documentation (from CGI).

This commit is contained in:
Daniel Molkentin
2012-12-11 14:45:29 +01:00
parent bc49e99e0e
commit fca8b245b7
29 changed files with 295 additions and 13 deletions

View File

@@ -16,10 +16,10 @@ Importing
~~~~~~~~~
So first well check out how to import all the VCF files as they are a lot
more faster way of creating contacts in this wonderful app.
more faster way of creating contacts.
Just below the contact list, 3 buttons: The middle one let you upload files.
.. figure:: images/contact_bottombar.jpg
.. image:: images/contact_bottombar.jpg
Once you've clicked it, the upload window let you choose your files.
@@ -27,17 +27,17 @@ We can upload the files one by one or upload all of them at one go.
Let me demonstrate.
Open the directory in which you store all the files and then do the following
Keep pressing ctrl and select the files to upload.
Keep pressing CTRL and select the files to upload.
After you are done just click on the open button
After the upload it should look something like this in which all the names and contacts will be sorted alphabetically
.. figure:: images/contact_vcfpick.jpg
.. image:: images/contact_vcfpick.jpg
Then, the interface ask you where to put your imported contacts.
You have the ability to choose an existing addressbook or to create a new one.
Then click on "Ok" and that's all for the import of contacts.
Then click on "OK" and that's all for the import of contacts.
.. figure:: images/contact_import.jpg
.. image:: images/contact_import.jpg
Create contacts manually
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,7 +50,7 @@ the name, the address, the e-mail, the telephone nr, ...
Just click on a field and start typing the information.
You can use the "Add Field" button to add another types of information for this contact.
.. figure:: images/contact_emptycontact.jpg
.. image:: images/contact_emptycontact.jpg
When you want to remove an information of your contact, just click on little delete icon
at the right of the field you want to remove.
@@ -61,7 +61,7 @@ Adding picture to the contact
There are two methods in which you can give a picture id to the specific contact
.. figure:: images/contact_picture.jpg
.. image:: images/contact_picture.jpg
1) **Direct upload**
2) **Select pics already uploaded in ownCloud files.**
@@ -69,7 +69,7 @@ There are two methods in which you can give a picture id to the specific contact
After you have selected the picture for the contact you get
an option to crop the picture to suit your requirements
.. figure:: images/contact_crop.jpg
.. image:: images/contact_crop.jpg
You can crop the picture however you wish and then press OK.
@@ -85,7 +85,7 @@ When you click on the third button of the bottom bar,
you will have access to the application's settings.
Then, press on the "More button" to access the options of your Addressbooks.
.. figure:: images/contact_del_ab.jpg
.. image:: images/contact_del_ab.jpg
You have there the ability to add, delete, download or share your addressbooks.
Hover your cursor on every icon to see what they mean.
@@ -105,7 +105,7 @@ Syncing with Android
4) After the app has checked your login details you may just select- Sync server to phone option
5) That's it there is nothing else to do for Android :)
.. figure:: images/contact_syncopt.jpg
.. image:: images/contact_syncopt.jpg
Syncing your IOS device
~~~~~~~~~~~~~~~~~~~~~~~

52
user_manual/files.rst Normal file
View File

@@ -0,0 +1,52 @@
Accessing your Files
====================
Desktop
-------
Your ownCloud instance can be accessed on every platform via the web interface. There are also options to integrate it with your desktop:
In most cases, accessing ownCloud using your file manager will be
sufficient:
- *Connect to Server …* `in your file manager`_:
``webdav://ADDRESS/files/webdav.php``
- Change the protocol to ``dav://`` in Nautilus or ``http://`` in
Finder
However, some applications only allow you to save to a local folder. To
get around this issue, you can:
+ `Sync your ownCloud folders and local folders`_
+ `Mount ownCloud to a local folder without sync`_
The
Desktop Syncing Client called Mirall is now released for Linux and
Windows. You can follow the current changes at the `ownCloud Mirall
repository`_. We work on porting this to Mac OS and packaging for all
major linux distributions.
Mobile
-------
There are apps in development for both `Android`_ and `webOS`_. Feel
free to `contribute, if you can`_! Right now you can use other apps to
connect to ownCloud from your phone via WebDAV. `WebDAV Navigator`_ is a
good (proprietary) app for `Android App`_ , `iPhone`_ & `BlackBerry`_.
.. _in your file manager: http://en.wikipedia.org/wiki/Webdav#Implementations
.. _Sync your ownCloud folders and local folders: http://owncloud.org/documentation/sync-clients/
.. _Mount ownCloud to a local folder without sync: http://owncloud.org/use/webdav/
.. _ownCloud Mirall repository: https://gitorious.org/owncloud/mirall
.. _Android: http://gitorious.org/owncloud/android
.. _webOS: http://gitorious.org/owncloud/webos
.. _contribute, if you can: /contribute/
.. _WebDAV Navigator: http://seanashton.net/webdav/
.. _Android App: http://market.android.com/details?id=com.schimera.webdavnavlite
.. _iPhone: http://itunes.apple.com/app/webdav-navigator/id382551345
.. _BlackBerry: http://appworld.blackberry.com/webstore/content/46279

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

BIN
user_manual/images/kdes.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

@@ -7,10 +7,17 @@ Contents
:maxdepth: 2
introduction
connecting/index
connecting/webdav
connecting_browser
connecting_webdav
files
contacts
bookmarks
sync
sync_kde
sync_osx
sync_ios
mediaplayer
versioncontrol
.. add more chapters

View File

@@ -0,0 +1,27 @@
Native Media Player Support
===========================
.. image:: images/mediaplayer.png
You can access your music stored in ownCloud with every
Ampache-compatible media player. You can find the URL for your specific
ownCloud installation in your personal settings, or replace ADDRESS with
the URL of your ownCloud installation yourself.
``Ampache-URL: http://ADDRESS/apps/media/``
Ampache-compatible players that work with ownCloud include:
- `amaroK`_, standard KDE music player
- `tomahawk`_, cross platform player
- `justplayer`_, music player for android
You can find more information about Ampache and other players at the
`Ampache wikipedia article`_
The current maintainer of the Media Player is Robin Appelman.
.. _amaroK: http://amarok.kde.org/
.. _tomahawk: http://www.tomahawk-player.org/
.. _justplayer: http://justplayer-dev.blogspot.com/
.. _Ampache wikipedia article: http://en.wikipedia.org/wiki/Ampache

14
user_manual/sync.rst Normal file
View File

@@ -0,0 +1,14 @@
Desktop Synchronisation
========================
For synchronizing files with your desktop computer, we recommend using the
`ownCloud Client`_ for Windows, Mac OS X and Linux. 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/

59
user_manual/sync_ios.rst Normal file
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

60
user_manual/sync_kde.rst Normal file
View File

@@ -0,0 +1,60 @@
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.\
.. raw:: html
.. 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.\
.. 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

53
user_manual/sync_osx.rst Normal file
View File

@@ -0,0 +1,53 @@
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 the :80 after **YOUR_DOMAIN**
it 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 wont 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.
I know that this is incredibly painful from an end-users perspective. On
iPhones / iPads it is far less painful. Therefore, Id like to blame
this issue on Address Book for Mac OS X Snow Leopard for now.There is
also an easy `HOWTO`_ in the forum.
.. _HOWTO: http://forum.owncloud.org/viewtopic.php?f=3&t=132

View File

@@ -0,0 +1,10 @@
Version Control
===============
ownCloud supports simple version control for files. Versioning is
enabled by default, and creates backups of files which are accessible
via the history tab. This tab also links to the history page, where you
can roll back a file to any previous version.Changes made at intervals
greater than two minutes are saved in data/[user]/versions, and made
accessible using the above pages.