Merge pull request #4472 from owncloud/10.9-c18b7ee-4155

[10.9] [PR 4155] Content for search elastic v2

modules/admin_manual/pages/configuration/search/index.adoc

@@ -1,28 +1,27 @@
 = Full Text Search 
 :toc: right
-:ingest-attachment-processor-url: https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest-attachment.html
+:elastic-search-url: https://www.elastic.co/elasticsearch/
 :search_elastic-app-url: {oc-marketplace-url}/apps/search_elastic 
-
+:simple-query-string-query-url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html
 == Introduction
 
-The {search_elastic-app-url}[Full Text Search app] integrates full text search into ownCloud, powered by Elasticsearch.
+The {search_elastic-app-url}[Full Text Search app] integrates full text search into ownCloud, powered by Elasticsearch. This allows users to search not only for file names but also within files stored in ownCloud.
 
 == Prerequisites
 
-A fully functioning Elasticsearch server with the {ingest-attachment-processor-url}[ingest-attachment processor] must be present.
-The ingest-attachment processor lets Elasticsearch extract file attachments in common formats, such as PPT, XLS, and PDF.
+A fully functioning {elastic-search-url}[Elasticsearch server] with the ingest-attachment processor must be present.
+
+NOTE: Version 1.0.0 of the Full Text Search app only works with Elasticsearch version 5.6. With version 2.0.0 of the app, Elasticsearch version 7 is supported and required.
 
-To install the processor, from your Elasticsearch installation directory, run the following command:
+The ingest-attachment processor lets Elasticsearch extract file attachments in common formats. 
+To install the processor, run the following command from your Elasticsearch installation directory:
 
 [source=console]
 ----
 bin/elasticsearch-plugin install ingest-attachment
 service elasticsearch restart
 ----
 
-NOTE: Only Elasticsearch version 5.6 is fully supported by version 1.0.0 of the Full Text Search app. 
-Version 7 of Elasticsearch will be supported by version 2.0.0 of the app.
-
 == Install and Configure the Full Text Search App
 
 To install the app, use the Marketplace app on your ownCloud server or proceed manually:
@@ -35,16 +34,17 @@ To configure the Full Text Search, go to menu:Settings[Search (admin)] and set t
 .Configuring Elasticsearch in ownCloud
 image:apps/search_elastic/configuration_successful.png[Configuring Elasticsearch in ownCloud]
 
-TIP: The index can also be managed from the command line, via the xref:configuration/server/occ_command.adoc#full-text-search[occ search:index commands]. 
+TIP: The index can also be managed from the command line, via the xref:configuration/server/occ_commands/core_commands/full_text_search_commands.adoc[occ search:index commands].
 These commands let administrators _create_, _rebuild_, _reset_, and _update_ the search index.
 
+To find out more about usage, check out the section in the User Manual: xref:user_manual:/files/webgui/search.adoc[Search & Full Text Search].
+
 == Known Limitations
 
 Currently, the app has the following known limitations:
 
 * Files are shown twice in search results when searching by filename.
 * If a shared file is renamed by the sharee (share receiver), the sharee cannot find the file using the new filename.
-* If the search query doesn't match the _start_ of at least one word in an available file's name, no results are returned.
 * Search results are not updated when a text file is rolled back to an earlier version.
 * The app does not return results for federated share files.
 * The app only works with the default encryption module "_Master Key_".

modules/user_manual/pages/files/webgui/search.adoc

@@ -7,14 +7,15 @@ ownCloud comes with a regular search function allowing you to find files by thei
 
 == Regular Search
 
-The regular search function in the ownCloud web interface offers a simple search for elements of file names. This also works when you only enter "pain" but meant to look for spain. However, you may also get results for pain or painful. If you start at the top level "All files", you will also see results in subfolders. If you change into a directory, the search starts in this folder, displays the results, then continues to search in all other folders.
+The regular search function in the ownCloud web interface offers a simple search for elements of file names. This also works when you only enter "pain" but meant to look for Spain. However, you also get results for pain or painful. If you start at the top level "All files", you will also see results in subfolders. If you change into a directory, the search starts in this folder, displays the results, then continues to search in all other folders.
 
 A click on one of the results takes you either to the location of the file, if you are not already in that folder, or the item is opened.
 
 The search is not case-sensitive, so capital letters are treated the same as lower case characters. You can type Spain or spain and will get the same results. When you start typing, the search also starts.
 
 == Full Text Search App
 
-Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search in files of the most common formats.
+Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search within files of the most common formats. Like with the regular search, you can enter only the first part of a string and it matches all occurances of words starting with the search string.
+
+If you are looking for all terms containing a specific string like in the above example "pain", wildcards can be used, e.g. an asterisk: *pain gives you results like braine, Spain and painful. Using a question mark instead of the asterisk limits the preceeding characters to exactly one. In this example, only Spain would show up if you entered the search string "?pain".
 
-Version 1.0.0 of the Full Text Search app works like the regular search. You start typing and the search starts even on incomplete words.