[Pkg-owncloud-commits] [owncloud-doc] 217/227: Created new Lucene search app page, added to index.rst

[David Prévot]

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud-doc.

commit ceed63409b469e445ecf01e3c7e8c7230a492e04
Author: Carla Schroder <carla at owncloud.com>
Date:   Tue Oct 7 17:55:12 2014 -0700

    Created new Lucene search app page, added to index.rst
---
 admin_manual/configuration/configuring_search.rst |  30 ++++++++++++++++++++++
 admin_manual/configuration/index.rst              |   1 +
 admin_manual/images/lucene-search-enable.png      | Bin 0 -> 17268 bytes
 admin_manual/images/lucene-search-user.png        | Bin 0 -> 11849 bytes
 admin_manual/index.rst                            |   1 +
 5 files changed, 32 insertions(+)

diff --git a/admin_manual/configuration/configuring_search.rst b/admin_manual/configuration/configuring_search.rst
new file mode 100644
index 0000000..6043659
--- /dev/null
+++ b/admin_manual/configuration/configuring_search.rst
@@ -0,0 +1,30 @@
+Enabling Full-Text Search
+=========================
+The Full-Text Search app indexes plain text, ``.docx``, ``.xlsx``, ``.pptx``, 
+``.odt``, ``.ods`` and ``.pdf`` files stored in ownCloud. It is based on Zend 
+Search Lucene, which is a good general purpose text 
+search engine written in PHP 5. The Zend Lucene index is stored on the 
+filesystem (in ``owncloud/data/$user``) and does not require a database server. 
+
+Using the Full-Text Search app is literally set-it-and-forget-it: all you do is 
+enable it on your Apps page, and then it automatically indexes all documents on 
+your ownCloud server, including documents on remote shares.
+
+.. figure:: ../images/lucene-search-enable.png
+
+When you want to find a document, enter your search term in the search field at 
+the upper right of your ownCloud Web interface. You can run a search from any 
+ownCloud page. Hover your cursor over any of your search results to see what 
+folder it is in, or click on the filename and it takes you to the folder.
+
+
+.. figure:: ../images/lucene-search-user.png
+
+**Known limitations**
+
+It does not work with the Encryption app, because the background indexing 
+process does not have access to the key needed to decrypt files when the user is 
+not logged in.
+
+Not all PDF versions can be indexed because the its text extraction is 
+incompatible with newer PDF versions.
\ No newline at end of file
diff --git a/admin_manual/configuration/index.rst b/admin_manual/configuration/index.rst
index 7069b44..cf747b5 100644
--- a/admin_manual/configuration/index.rst
+++ b/admin_manual/configuration/index.rst
@@ -30,3 +30,4 @@ Configuration
    custom_mount_config
    custom_user_backend
    xsendfile
+   configuring_search
diff --git a/admin_manual/images/lucene-search-enable.png b/admin_manual/images/lucene-search-enable.png
new file mode 100644
index 0000000..2e4c2b6
Binary files /dev/null and b/admin_manual/images/lucene-search-enable.png differ
diff --git a/admin_manual/images/lucene-search-user.png b/admin_manual/images/lucene-search-user.png
new file mode 100644
index 0000000..d16322c
Binary files /dev/null and b/admin_manual/images/lucene-search-user.png differ
diff --git a/admin_manual/index.rst b/admin_manual/index.rst
index e3273a7..addec0a 100644
--- a/admin_manual/index.rst
+++ b/admin_manual/index.rst
@@ -75,6 +75,7 @@ contains the following topics:
 * :doc:`configuration/configuration_language`
 * :doc:`configuration/configuration-antivirus`
 * :doc:`configuration/configuration_preview`
+* :doc:`configuration/configuring_search`
 
 Maintenance
 ===========

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git