From ab0241f8088c9c5920159200a533c7123355d044 Mon Sep 17 00:00:00 2001 From: Carla Schroder Date: Tue, 19 Apr 2016 13:28:55 -0700 Subject: [PATCH] move contacts & calendar to doc wiki --- user_manual/pim/calendar.rst | 207 +-------------------- user_manual/pim/contacts.rst | 343 +---------------------------------- 2 files changed, 11 insertions(+), 539 deletions(-) diff --git a/user_manual/pim/calendar.rst b/user_manual/pim/calendar.rst index c49b210e3..f7fca57a8 100644 --- a/user_manual/pim/calendar.rst +++ b/user_manual/pim/calendar.rst @@ -3,205 +3,10 @@ Using the Calendar App ====================== The Calendar app is not enabled by default in ownCloud |version| and needs to -be enabled seperately. It is also not a supported core app. You may ask -your ownCloud server admin to enable it, and if you are -your own admin consult the `Installation > Installing and Managing Apps -`_ -section of the `ownCloud Server Administration Manual -`_. +be enabled seperately. It is also not a supported core app. It is currently +under heavy development, so documentation has moved to the `documentation Wiki +on Github +`_. You are welcome to add content to the Wiki document; all you +need is a Github account. -The ownCloud Calendar app enables you to create and edit events, synchronize to -other calendars you might use, and create new, personalized calendars. - -By default, when you access the Calendar app for the first time, you get a -"Personal" calendar that you can use or modify as you like. - -.. figure:: ../images/calendar_default.png - :alt: Main calendar app screen. - -The Calendar app contains the following fields and controls: - -- Calendar Date Field -- Provides the current date or enables you to select a - date that you want to view. - -- Calendar View Options -- Enables you to choose between a day, week, or month - view for the main Calendar app window. Also provides a quick jump button to - access the current day (Today). - -- Calendar Selection -- Enables you to choose the calendar that you want to view. - -- Calendar Controls -- Provides controls for each individual calendar. These - controls include sharing, obtaining an external URL link to the calendar, an - export function, an edit function, and a delete (trash) button. - - .. note:: Some Ad-Block plugins hide the "Share" button for calendars. If the - "Share" button is missing, try disabling your Ad-Block plugin or add a - whitelist-entry for your OwnCloud instance. - -- Calendar Settings -- Provides access to the calendar-specific settings. These - settings include the calendar timezone selection, time format selection, week - start day, cache setting, primary CalDAV address, and iOS/OS X CalDAV address - settings. - -Creating a New Calendar ------------------------ - -The ownCloud Calendar app enables you to create new calendars for work or other -activities that you want to keep separated. You can manage each calendar -separately. - -To create a new calendar: - -1. Access the Calendar app. - -2. Click the ``+ New Calendar`` field. - - A dialog opens to enable you to create a new calendar. - -.. figure:: ../images/calendar_create_new.png - - **New calendar** - -3. Specify a name for the new calendar. - -4. (Optional) Specify a color for the new calendar. - -5. Click the blue checkbox. - - The Calendar app creates a new calendar using the name and color specified. - -Managing Calendar Settings --------------------------- - -The Calendar app settings provides global configuration that applies to all -calendars that you have created in the Calendar app. - - .. figure:: ../images/calendar_settings.png - :alt: Calendar app settings. - -In the Calendar app settings, you can modify the following: - -- Timezone -- Provides an alphabetical listing of all available countries - categorized by continent. - -- Time format -- Provides the option of using 24 hour or 12 hour time format. - -- Start day -- Provides the option of starting the calendar week on Monday, - Sunday, or Saturday. - -- Primary CalDAV address -- Provides the primary CalDAV link URL. - -- iOS/OS X CalDAV address -- Provides the iOS/OS X CalDAV link URL. - - -Synchronizing Calendars Using CalDAV ------------------------------------- -*Calendaring Extensions to WebDAV*, referred to as *CalDAV*, enables clients to -access scheduling information on remote servers. As an extension to WebDAV, -CalDAV (defined by RFC 4791) uses the iCalendar format to manage calendar data. -CalDAV enables multiple clients to access the same information for use in -cooperative planning and information sharing. - -The Calendar app provides both the Primary CalDAV address and the iOS/OSX CalDAV -address. Using these addresses, you can use CalDAV-compatible programs (for -example, Kontact, Evolution, or Mozilla Thunderbird with the Lightning Add-on) -using the address provided. - -.. Note:: The Lightning Add-on doesn't support using multiple accounts on a single - server as a default. You need to set ``calendar.network.multirealm`` to ``true`` - in the Config Editor of Mozilla Thunderbird to be able to use multiple accounts. - -Getting the CalDAV link -~~~~~~~~~~~~~~~~~~~~~~~ - -The GUI of ownCloud provides the needed links which can be used in your -CalDAV-compatible program. Open up the Calendar App and use the |caldavlink| -icon next to the calendar name as shown in the figure below: - -.. figure:: ../images/calendar_caldav_link.png - :alt: Caldav link. - -Furthermore you can get the Primary CalDAV address as well as the iOS/OS X CalDAV address by -using the |gear| icon on the bottom left of the Calendar app as shown in the figure below: - -.. figure:: ../images/calendar_caldav_ios.png - :alt: - -Creating Events ---------------- - -The Calendar app enables you to schedule events, send -invitations, and set reminders. - -To create a new event: - -1. Click a date in the month view or a time in either the week or day views. - - The ``Create a new event`` dialog box opens. - - .. figure:: ../images/calendar_create_event.png - :alt: Creating a new event. - -2. Specify a title for the event. - -3. Specify a date and time duration for the event. - -4. (Optional) Provide advanced option details. These details can include the - event location, the event category, and an event description. - -5. (Optional) Make it a repeating event, invite attendees, and set reminders. - -Exporting and Importing Events ------------------------------- - -The Calendar app enables you to export and import event or entire calendars to -or from other calendars. - -Exporting Events and Calendar -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can export either a single event or an entire calendar. If you want to export -a single event, click on the event, select "Advanced" and press the "Export Event" button in the bottom left -corner. If you want to export an entire calendar, use the download icon next to -the calendar name. - -Importing Events -~~~~~~~~~~~~~~~~ - -You can import your calendar as an iCal file using the Files app. The Calendar -app -enables you to import the calendar into a new calendar or into an already existing calendar. - -To import your calendar, click the calendar file to open the import dialog. - -Special CalDAV URLs -------------------- - -Additionally the Calendar app is providing two URLs for special functions: - -**Export calendar as an .ics file** - - https://example.com/remote.php/dav/calendars/USERNAME/CALENDARNAME?export - -**Your contacts' birthdays** - - https://example.com/remote.php/dav/calendars/USERNAME/contact_birthdays - -Calendar App FAQ ----------------- - -**Question:** Why does the Calendar app request my current location? - -.. figure:: ../images/calendar_newtimezone1.png - - **Timezone set notification** - -**Answer:** The calendar needs your current position to detect your timezone. -Without the correct timezone, a time offset exists between the events in the -ownCloud calendar and the desktop calendar to which you are synchronizing. You -can also set the timezone manually in the personal settings. - -.. |download| image:: ../images/download.png -.. |caldavlink| image:: ../images/calendar_caldav_icon.png -.. |gear| image:: ../images/gear.png diff --git a/user_manual/pim/contacts.rst b/user_manual/pim/contacts.rst index c2328b2dd..8dad40a68 100644 --- a/user_manual/pim/contacts.rst +++ b/user_manual/pim/contacts.rst @@ -3,341 +3,8 @@ Using the Contacts App ====================== The Contacts app is not enabled by default in ownCloud |version| and needs to -be enabled seperately. It is also not a supported core app. You may ask -your ownCloud server admin to enable it, and if you are -your own admin consult the `Installation > Installing and Managing Apps -`_ -section of the `ownCloud Server Administration Manual -`_. - -The ownCloud Contacts app is similar to other mobile contact applications, but -with more functionality. When you first access the Contacts app, a default -address book becomes available. - -.. figure:: ../images/contacts_empty.png - :alt: Contacts app main screen. - -In the Apps Information field for the Contacts app, you can choose to create a -new contact or a new group. This field also enables you to filter your contacts -based on grouped or ungrouped contacts. - -Adding Contacts ---------------- -You can add contacts using one of the following methods: - -* Import contacts using a Variant Call Format (VCF) file - -* Add contacts manually - -Importing Contacts -~~~~~~~~~~~~~~~~~~ - -The fastest way to add contacts is through the use of a Variant Call Format -(VCF) file. - -To import contacts using a VCF file: - -1. At the bottom of the Contacts app information field, locate the gear button. - - .. figure:: ../images/contact_bottombar.png - :alt: Contact settings gear button. - -2. Click the gear button. The Contacts app upload field opens. - - .. figure:: ../images/contact_uploadbutton.png - :alt: Contacts app upload field. - -3. Choose an address book to which you want to import contacts by clicking the -checkbox next to the address book. - -4. Select one of the options from the Import pulldown menu. These options -include the following: - - - Automatic format -- Any VCF file. ownCloud determines the file format and - imports accordingly. - - - Gmail CSV -- The comma-separated values file from your Gmail account. - - - Outlook CSV -- The comma-separated values file from your Outlook account. - - - Thunderbird CSV -- The comma-separated values file from your Thunderbird - account. - - - Yahoo CSV -- The comma-separated values file from your Yahoo account. - - - PHPLdapAdmin Idif Export -- The export record from your LDAP configuration. - - - Gmail VCard -- The VCard files from your Gmail account. - - - Standard VCard -- The VCard files from your Standard account. - - - Yahoo VCard -- The VCard files from your Yahoo account. - -5. Click the upload arrow to the right of the import option that you select. - - An Upload File window opens. - -6. Navigate to the appropriate file on your system and select it for upload. - - .. note:: You can upload files individually or, by selecting multiple files - using the CTRL button and selecting them, you can upload multiple files at - one time. - -7. Once you have selected the appropriate files, click the `Open`` button. - - .. figure:: ../images/contact_vcfpick.jpg - :alt: Selecting VCF files. - -The interface automatically places your contacts into ownCloud. - -Creating Contacts Manually -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Contacts app enables you to create contacts manually. - -To create a new contact: - -1. Click the ``+New contact`` option in the Contacts information field. - - An empty new contact configuration opens in the Application View field. - - .. figure:: ../images/contact_new.png - :alt: Addin a new contact. - -2. Specify the new contact information as follows: - - - Name -- The name of the contact. This field provides the option of - specifying added information for the user by clicking the pen button to the - right of the Name field. - - - Organization -- The organization for the contact. - - - Email -- The email address for the contact. This field defaults to the work - email address for the contact. However, you can specify a different email - designation by clicking the ``Work`` designation to the left of the email - field. - - - Phone -- The phone number for the contact. This field defaults to the home - phone number for the contact. However, you can specify a different phone - designation by clicking the ``Home`` designation to the left of the phone - field. - - - Address -- The address for the contact. This field defaults to the work - address for the contact. However, you can specify a different address - designation by clicking the ``Work`` designation to the left of the address - field. - - - Notes -- Any notes you want to add about the contact. - - .. note:: The Email, Phone, and Address fields provide the option of - specifying a contact method as "preferred." - -Editing Contact Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Contacts app enables you to edit or remove contact information. - -To edit contact information: - -1. Navigate to the specific contact that you want to modify. - -2. Select the information in the field that you want to edit. - -3. Make your modifications. - - Changes that you make to any contact information are implemented immediately. - -Removing Contact Information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Contacts app enables you to remove contact information. - -To remove contact information: - -1. Navigate to the specific contact that you want to modify. - -2. Locate the contact information field that you want to remove. - -3. Click the trash bin to the right of the contact information. - - Changes that you make to any contact information are implemented immediately. - - -Defining a Contact Avatar -~~~~~~~~~~~~~~~~~~~~~~~~~ - -By default, new contacts receive a letter avatar (picture) of "U" (for "User"). - -.. figure:: ../images/contact_picture_default.png - :alt: Default contact picture. - -When you specify the name of a contact, the avatar reflects the name by adopting -the first letter of the name you provide. For example, if you were to specify -the name of "Frederick," the avatar would dynamically change to "F" for that -contact. If you provide multiple contacts with the same name, or with names -that start with the same first letter, the avatar uses the same letter but -changes color to indicate the difference. - -.. figure:: ../images/contact_picture.png - :alt: New contact picture. - -Customizing an Avatar -~~~~~~~~~~~~~~~~~~~~~ - -In addition to dynamically altering the avatar for each contact, the Contacts -app enables you to customize the avatar. You can specify an avatar in one of the -two following ways: - -- Upload new image -- By selecting this option, ownCloud opens a File Upload - window. You can choose a new image by navigating to the image, selecting it, - and clicking ``Open``. - -- Select image from Files -- By selecting this option, ownCloud opens the Files - dialog on the ownCloud server. You can choose an image by navigating to the image - in the ownCloud directory, selecting it, and clicking ``Choose.`` - -Cropping an Avatar Image -~~~~~~~~~~~~~~~~~~~~~~~~ - -After you have selected an image for your contact, the Contacts app enables you -to crop the picture. - -.. figure:: ../images/contact_crop.jpg - :alt: Cropping contact image. - -To crop the image: - -1. Move the image crop box to the desired location and resize the box any way - you like. - -2. Click ``Crop Picture`` in the crop image dialog box. - - The Contacts app crops the image and replaces whatever image was originally - used for the contact. - -Managing Address Books ----------------------- - -Clicking on the settings (gear) button at the bottom of the Apps Information -field provides access to the Contact app settings. This field shows all -available address books, certain options for each address book, and enables you -to create new address books. - -.. figure:: ../images/contacts_settings.png - :alt: Contacts settings. - -The Contacts settings enables you to share, export, edit, and delete address -books. - -.. note:: Hover your cursor over each icon to see a brief pop-up description. - -Adding an Address Book ----------------------- - -To add an address book: - -1. Click the ``+ Add Address Book`` option in the Contacts settings field. - - A field opens requesting you to enter a display name for the new address book. - - .. figure:: ../images/contact_address_book_add.png - :alt: Adding an address book - - -2. Specify a display name for the address book. - -3. Click the checkbox icon to create the new address book. - - -Synchronizing Address Books ---------------------------- - -One of the most important features in any contact application is the ability to -keep it in sync. The ownCloud Contacts app enables you to sync your address -books to external devices that use the Android or Apple iOS operating systems. - - -Synchronizing With Android -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To synchronize with an Android device: - -1) Install CardDAV- Sync free from the Google play store by visiting `this link - `_. - This app supports auto-configuration. - - .. note:: Following the installation, visit carddavs://example.com/remote.php/dav/ - to auto-configure the app. - -3) Enter your login details. - -4) After the app has checked your login details, select the ``Sync from server to phone only`` option. - -.. figure:: ../images/contact_syncopt.jpg - -Synchronizing With Apple iOS -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To synchronize with an Apple iOS device: - -1. Open the settings application. - -2. Select Mail > Contacts > Calendars. - -3. Select ``Add Account``. - -4. Select ``other`` as the account type. - -5. Select ``Add CardDAV account``. - -6. For ``server``, enter https://example.com/remote.php/dav/principals/users/USERNAME/ - -7. Specify your username and password. - -8. Select Next. - -9. If your server does not support SSL, a warning is displayed. Select ``Continue``. - -10. If the iPhone is unable to verify the account information, perform the following: - - a. Click ``OK``. - - b. Select ``advanced settings``. - - c. Make sure ``Use SSL`` is set to "OFF". - - d. Change the port to ``80``. - - e. Return to "account information" and click ``Save``. - - Your contacts appear in the address book of your iPhone. - - -Using Other Synchronization Options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ownCloud provides the following alternative synchronization options: - -- For Android devices, you can use an official Android app. You can find this - app `here `_. - -- For iOS (iPhone and iPad) devices, you can use their official app. You can - find this app `here `_. - -Special CardDAV URLs --------------------- - -Additionally, the Contacts app is providing an URL for special functions: - -**Export an address book as a vCard file** - - https://example.com/remote.php/dav/addressbooks/USERNAME/ADDRESSBOOKNAME?export - -Troubleshooting ---------------- - -Are you having problems using the app? Have a look at the :doc:`troubleshooting` -and `Troubleshooting Contacts & Calendar`_ guides. - -.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/9.0/admin_manual/issues/index.html#troubleshooting-contacts-calendar \ No newline at end of file +be enabled seperately. It is also not a supported core app. It is currently +under heavy development, so documentation has moved to the `documentation Wiki +on Github +`_.