Merge pull request #589 from owncloud/oc-document

Create Admin page for documents app, update user page
This commit is contained in:
Carla Schroder
2014-10-02 14:34:19 -07:00
4 changed files with 75 additions and 31 deletions

View File

@@ -0,0 +1,28 @@
Configuring the Collaborative Documents App
===========================================
The Documents application supports editing documents within ownCloud, without the
need to launch an external application. The Documents app supports these
features:
* Cooperative edit, with multiple users editing files simultaneously.
* Document creation within ownCloud.
* Document upload.
* Share and edit files in the browser, and then share them inside ownCloud or
through a public link.
Supported file formats are `.odt`, `.doc`, and `.docx`. `.odt` is supported
natively in ownCloud, and you must have LibreOffice or OpenOffice installed on
the ownCloud server to convert `.doc`, and `.docx` documents.
Enabling the Documents App
==========================
Go to your Apps page and click the ``Enable`` button. You also have the option
to grant access to the Documents apps to selected user groups. By default it is
available to all groups.
.. image:: ../images/documents_app_enable.png
See "Collaborative Document Editing" in the User manual to learn how to create
and share documents in the Documents application.

View File

@@ -10,6 +10,7 @@ Configuration
auth_ldap
server_to_server_managing
background_jobs
configuring_documents
configuration_assets
configuration_3rdparty
configuration-antivirus

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

View File

@@ -1,68 +1,83 @@
Documents
=========
Collaborative Document Editing
==============================
Document editing is an ownCloud app introduced in version 6. With this app, multiple users
can edit rich-text simultaneously. The documents can be created from within the
web-interface or existing documents can be uploaded. Sharing and editing can be done
securely in the browser and be shared inside ownCloud or via a public link. User that
have an account on the same server can be invited or public invitations can also be
sent be email. The editing works on top of normal ODF files that are stored in ownCloud.
The Documents application supports editing documents within ownCloud, without
the need to launch an external application. The Documents app supports these
features:
* Cooperative edit, with multiple users editing files simultaneously.
* Document creation within ownCloud.
* Document upload.
* Share and edit files in the browser, and then share them inside ownCloud or
through a public link.
Supported file formats are `.odt`, `.doc`, and `.docx`.
The main interface
------------------
.. image:: images/oc_documents.png
Create/Upload a Document
~~~~~~~~~~~~~~~~~~~~~~~~
Create or Upload a Document
~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the documents application, click on the respective buttons to create or upload a document into your ownCloud. The *New document* button will create a document named "New document.odt". The extension ODT is an OpenDocument format, which many major office applications let you create/edit/view.
The *Upload* button allows you to upload any kind of document, but currently you can only edit ODT files within ownCloud.
In the Documents application, you can upload an existing document or create a
new one. The *New document* button creates a document named "New
document.odt". The extension ODT is an OpenDocument format, which is supported
by most word processors including Microsoft Word, LibreOffice Writer, and
OpenOffice Writer.
Edit a Document
~~~~~~~~~~~~~~~
If ownCloud contains at least one ODT file, you can immediately start editing by clicking on
the file within the documents app. Clicking on documents in files app will only display it. Below, you
can see editing a newly created document file:
To edit a document, access the Documents app from your Apps menu at the top
left of your ownCloud window.
.. image:: images/oc_documents_edit.png
Here is the explanation of each field in the image shown above:
#. Clicking on the file name allows you to change filename.
#. Allows you to share the document to public, specific users or groups. Will be explained in detail in :ref:`Share a document <share-a-document>` section.
#. Formatting toolbar lets you change text styles.
#. Click on the file name to change it.
#. Share your document (See the :ref:`Share a document
<share-a-document>` section.)
#. Formatting toolbar.
#. Zoom in/out
#. Close document by saving changes
#. Users currently editing this document
#. Close and save.
#. Users currently editing this document.
Collaboratively Editing a Document
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To edit a file collaboratively, it needs to be shared with at least one user by using the *Share* button. When multiple uses have permission to edit a document, they will be able to edit it at the same time. The cursor of all editing users will be the same color as the border color of their user picture.
To edit a file collaboratively, it must be shared with everyone who needs
editing permissions. Multiple users can edit it at the same time, and changes
appear as they are made. The cursor of each user is the same color as the
border color of their user picture.
.. figure:: images/oc_documents_col_edit.png
If a user is not a local user (e.g accessing the file using public link), he/she will be shown as guest in user list and they will type a nickname before editing.
If a user is not a local user (e.g accessing the file using public link), they
will be shown as guest in the user list, automatically named Guest 1, Guest 2,
and so on. Guests can change their nicknames at any time.
Delete a Document
~~~~~~~~~~~~~~~~~
A document can be deleted using the files app and following the same procedure as for other file types. Clicking on the cross icon deletes the selected document.
You can't delete a document from inside the Document app, but must go to your
Files page and delete it from there. You'll find it in your default documents
directory, as configured on your Personal page.
.. _share-a-document:
Share a Document
~~~~~~~~~~~~~~~~
Document sharing has the same options as when sharing other files. While editing a document, you can use the *Share* button to enable other users to edit the document. This button will display all available options to share:
Document sharing has the same options as when sharing other files. While editing
a document, you can use the *Share* button to enable other users to edit the
document. This button will display all available options to share:
.. figure:: images/oc_documents_share.png
By default, you can enter local users or groups to share with. Checking *Share link* will enable sharing via a public link, for which you can set a password to prevent editing by unwanted users. Shares can also have an expiration date that will expire the link after a given date. ownCloud will send the public link to users by email by typing each email address into the email field. Separate multiple email addresses with a space.
By default, you can enter local users or groups to share with. Checking *Share
link* will enable sharing via a public link. Shares can optionally have an
expiration date and password. ownCloud will send the public link to users by
email by typing each email address into the email field. Separate multiple
email addresses with a space.
To see all of the features of the ownCloud document app, watch the
`video on YouTube <https://www.youtube.com/watch?v=70pCBnNPdew>`_.