From 2be9e32a7b3c93e7fbae12ca72c7decaed7125d7 Mon Sep 17 00:00:00 2001 From: Frank Celler Date: Wed, 6 Feb 2013 17:09:57 +0100 Subject: [PATCH] converting .dox to .md --- .../ImplementorManual/HttpIndexFulltext.md | 15 +++ .../ImplementorManual/HttpIndexFulltextTOC.md | 6 ++ Documentation/UserManual/IndexFulltext.md | 20 ++++ Documentation/UserManual/IndexFulltextTOC.md | 7 ++ arangod/Documentation/index-fulltext.dox | 100 ------------------ 5 files changed, 48 insertions(+), 100 deletions(-) create mode 100644 Documentation/ImplementorManual/HttpIndexFulltext.md create mode 100644 Documentation/ImplementorManual/HttpIndexFulltextTOC.md create mode 100644 Documentation/UserManual/IndexFulltext.md create mode 100644 Documentation/UserManual/IndexFulltextTOC.md delete mode 100644 arangod/Documentation/index-fulltext.dox diff --git a/Documentation/ImplementorManual/HttpIndexFulltext.md b/Documentation/ImplementorManual/HttpIndexFulltext.md new file mode 100644 index 0000000000..54f48fdc68 --- /dev/null +++ b/Documentation/ImplementorManual/HttpIndexFulltext.md @@ -0,0 +1,15 @@ +Accessing Fulltext Indexes via Http {#IndexFulltextHttp} +======================================================== + +@EMBEDTOC{IndexFulltextHttpTOC} + +If a fulltext index exists, then @ref HttpSimpleFulltext +"/_api/simple/fulltext" will use this index to execute the specified +fulltext query. + +@anchor IndexFulltextHttpEnsureFulltextIndex +@copydetails JSF_POST_api_index_fulltext + +@CLEARPAGE +@anchor IndexFulltextHttpFulltext +@copydetails JSA_PUT_api_simple_fulltext diff --git a/Documentation/ImplementorManual/HttpIndexFulltextTOC.md b/Documentation/ImplementorManual/HttpIndexFulltextTOC.md new file mode 100644 index 0000000000..6d7ad3a718 --- /dev/null +++ b/Documentation/ImplementorManual/HttpIndexFulltextTOC.md @@ -0,0 +1,6 @@ +TOC {#IndexFulltextHttpTOC} +=========================== + +- @ref IndexFulltextHttp + - @ref IndexFulltextHttpEnsureFulltextIndex "POST /_api/index" + - @ref IndexFulltextHttpFulltext "PUT /_api/simple/fulltext" diff --git a/Documentation/UserManual/IndexFulltext.md b/Documentation/UserManual/IndexFulltext.md new file mode 100644 index 0000000000..fbcf18f69c --- /dev/null +++ b/Documentation/UserManual/IndexFulltext.md @@ -0,0 +1,20 @@ +Fulltext indexes {#IndexFulltext} +================================= + +@EMBEDTOC{IndexFulltextTOC} + +Fulltext Indexes {#IndexFulltextIntro} +====================================== + +This is an introduction to ArangoDB's fulltext indexes. + +It is possible to define a fulltext index on one textual attribute of a +collection of documents. The fulltext index can then be used to efficiently find +exact words or prefixes of words contained in these documents. + +Accessing Fulltext Indexes from the Shell {#IndexFulltextShell} +=============================================================== + +@anchor IndexFulltextShellEnsureFulltextIndex +@copydetails JS_EnsureFulltextIndexVocbaseCol + diff --git a/Documentation/UserManual/IndexFulltextTOC.md b/Documentation/UserManual/IndexFulltextTOC.md new file mode 100644 index 0000000000..2f6c1e5384 --- /dev/null +++ b/Documentation/UserManual/IndexFulltextTOC.md @@ -0,0 +1,7 @@ +TOC {#IndexFulltextTOC} +======================= + +- @ref IndexFulltext + - @ref IndexFulltextIntro + - @ref IndexFulltextShell + - @ref IndexFulltextShellEnsureFulltextIndex "collection.ensureFulltextIndex" diff --git a/arangod/Documentation/index-fulltext.dox b/arangod/Documentation/index-fulltext.dox deleted file mode 100644 index 1b4aced451..0000000000 --- a/arangod/Documentation/index-fulltext.dox +++ /dev/null @@ -1,100 +0,0 @@ -//////////////////////////////////////////////////////////////////////////////// -/// @brief indexes -/// -/// @file -/// -/// DISCLAIMER -/// -/// Copyright 2012 triagens GmbH, Cologne, Germany -/// -/// Licensed under the Apache License, Version 2.0 (the "License"); -/// you may not use this file except in compliance with the License. -/// You may obtain a copy of the License at -/// -/// http://www.apache.org/licenses/LICENSE-2.0 -/// -/// Unless required by applicable law or agreed to in writing, software -/// distributed under the License is distributed on an "AS IS" BASIS, -/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -/// See the License for the specific language governing permissions and -/// limitations under the License. -/// -/// Copyright holder is triAGENS GmbH, Cologne, Germany -/// -/// @author Jan Steemann -/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexFulltextTOC -/// -/// -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexFulltext Fulltext indexes -/// -/// This is an introduction to ArangoDB's fulltext indexes. -/// -/// @EMBEDTOC{IndexFulltextTOC} -/// -/// @section IndexFulltextIntro Fulltext Indexes -//////////////////////////////////////////////// -/// -/// It is possible to define a fulltext index on one textual attribute of a -/// collection of documents. The fulltext index can then be used to efficiently -/// find exact words or prefixes of words contained in these documents. -/// -/// @section IndexFulltextShell Accessing Fulltext Indexes from the Shell -///////////////////////////////////////////////////////////////////////// -/// -/// @anchor IndexFulltextShellEnsureFulltextIndex -/// @copydetails JS_EnsureFulltextIndexVocbaseCol -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexFulltextHttpTOC -/// -/// -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexFulltextHttp Accessing Fulltext Indexes via Http -/// -/// If a fulltext index exists, then @ref HttpSimpleFulltext -/// "/_api/simple/fulltext" will use this index to execute the specified fulltext -/// query. -/// -/// @EMBEDTOC{IndexFulltextHttpTOC} -/// -/// @anchor IndexFulltextHttpEnsureFulltextIndex -/// @copydetails JSF_POST_api_index_fulltext -/// -/// @anchor IndexFulltextHttpFulltext -/// @copydetails JSA_PUT_api_simple_fulltext -//////////////////////////////////////////////////////////////////////////////// - -// Local Variables: -// mode: c++ -// mode: outline-minor -// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)" -// End: