diff --git a/Documentation/Manual/Glossary.md b/Documentation/Manual/Glossary.md new file mode 100644 index 0000000000..8ed98b5182 --- /dev/null +++ b/Documentation/Manual/Glossary.md @@ -0,0 +1,36 @@ +Glossary {#Glossary} +==================== + +@NAVIGATE{ImpManual,Home,InstallManual} + +@copydoc GlossaryCollection + +@copydoc GlossaryCollectionIdentifier + +@copydoc GlossaryCollectionName + +@copydoc GlossaryDocument + +@copydoc GlossaryDocumentEtag + +@copydoc GlossaryDocumentHandle + +@copydoc GlossaryDocumentIdentifier + +@copydoc GlossaryDocumentRevision + +@copydoc GlossaryEdge + +@copydoc GlossaryEdgeCollection + +@copydoc GlossaryIndexGeo + +@copydoc GlossaryIndexHash + +@copydoc GlossaryIndex + +@copydoc GlossaryIndexHandle + +@copydoc GlossaryIndexPrioQueue + +@copydoc GlossaryIndexSkiplist diff --git a/Documentation/Manual/GlossaryCollection.md b/Documentation/Manual/GlossaryCollection.md new file mode 100644 index 0000000000..7e9bb2b2fc --- /dev/null +++ b/Documentation/Manual/GlossaryCollection.md @@ -0,0 +1,5 @@ +Collection {#GlossaryCollection} +================================ + +@GE{Collection}: A collection consists of documents. It is uniquely identified +by it's collection identifier. It also has a unique name. diff --git a/Documentation/Manual/GlossaryCollectionIdentifier.md b/Documentation/Manual/GlossaryCollectionIdentifier.md new file mode 100644 index 0000000000..9c47d6bc86 --- /dev/null +++ b/Documentation/Manual/GlossaryCollectionIdentifier.md @@ -0,0 +1,6 @@ +CollectionIdentifier {#GlossaryCollectionIdentifier} +==================================================== + +@GE{Collection Identifier}: A collection identifier identifies a +collection in a database. It is an integer and is unique within the +database. diff --git a/Documentation/Manual/GlossaryCollectionName.md b/Documentation/Manual/GlossaryCollectionName.md new file mode 100644 index 0000000000..8c38e5a2e7 --- /dev/null +++ b/Documentation/Manual/GlossaryCollectionName.md @@ -0,0 +1,10 @@ +CollectionName {#GlossaryCollectionName} +======================================== + +@GE{Collection Name}: A collection name identifies a collection in a +database. It is an string and is unique within the database. Unlike +the collection identifier it is supplied by the creator of the +collection. The collection name can consist of letters, digits and +the characters `_` (underscore) and `-` (dash). Please refer +to @ref NamingConventions for more information on valid collection +names. diff --git a/Documentation/Manual/GlossaryDocument.md b/Documentation/Manual/GlossaryDocument.md new file mode 100644 index 0000000000..80b31b87ff --- /dev/null +++ b/Documentation/Manual/GlossaryDocument.md @@ -0,0 +1,6 @@ +Document {#GlossaryDocument} +============================ + +@GE{Document}: Documents in ArangoDB are JSON objects. These objects +can be nested (to any depth) and may contains lists. Each document is +uniquely identified by its document handle. diff --git a/Documentation/Manual/GlossaryDocumentEtag.md b/Documentation/Manual/GlossaryDocumentEtag.md new file mode 100644 index 0000000000..c542fb5b4b --- /dev/null +++ b/Documentation/Manual/GlossaryDocumentEtag.md @@ -0,0 +1,6 @@ +DocumentEtag {#GlossaryDocumentEtag} +==================================== + +@GE{Document Etag}: The document revision enclosed in double +quotes. The revision is returned by several HTTP API methods in the +`Etag` HTTP header. diff --git a/Documentation/Manual/GlossaryDocumentHandle.md b/Documentation/Manual/GlossaryDocumentHandle.md new file mode 100644 index 0000000000..07054bc504 --- /dev/null +++ b/Documentation/Manual/GlossaryDocumentHandle.md @@ -0,0 +1,6 @@ +DocumentHandle {#GlossaryDocumentHandle} +======================================== + +@GE{Document Handle}: A document handle uniquely identifies a document +in the database. It is a string and consists of a collection +identifier and a document identifier separated by `/`. diff --git a/Documentation/Manual/GlossaryDocumentIdentifier.md b/Documentation/Manual/GlossaryDocumentIdentifier.md new file mode 100644 index 0000000000..a154142d71 --- /dev/null +++ b/Documentation/Manual/GlossaryDocumentIdentifier.md @@ -0,0 +1,6 @@ +DocumentIdentifier {#GlossaryDocumentIdentifier} +================================================ + +@GE{Document Identifier}: A document identifier identifies a document +in a given collection. It unique within the collection of the +document. diff --git a/Documentation/Manual/GlossaryDocumentRevision.md b/Documentation/Manual/GlossaryDocumentRevision.md new file mode 100644 index 0000000000..f3fc410924 --- /dev/null +++ b/Documentation/Manual/GlossaryDocumentRevision.md @@ -0,0 +1,17 @@ +DocumentRevision {#GlossaryDocumentRevision} +============================================ + +@GE{Document Revision}: As ArangoDB supports MVCC, documents can exist +in more than one revision. The document revision is the MVCC token +used to identify a particular revision of a document. It is an integer +and unique within the list of document revision for a single +document. Earlier revisions of a document have smaller numbers. +Document revisions can be used to conditionally update, replace or +delete documents in the database. In order to find a particular +revision of a document, you need the document handle and the document +revision. + +ArangoDB currently uses 64bit unsigned integer values for document +revisions. As this datatype is not portable to all client languages, +clients should rather use strings to store document revision ids +locally. diff --git a/Documentation/Manual/GlossaryEdge.md b/Documentation/Manual/GlossaryEdge.md new file mode 100644 index 0000000000..55ae9d5eb2 --- /dev/null +++ b/Documentation/Manual/GlossaryEdge.md @@ -0,0 +1,7 @@ +Edge {#GlossaryEdge} +==================== + +@GE{Edge}: Edges in ArangoDB are special documents. In addition to the +internal attributes `_id` and `_rev`, they have two attributes +`_from` and `_to`, which contain document handles, namely the +start-point and the end-point of the edge. diff --git a/Documentation/Manual/GlossaryEdgeCollection.md b/Documentation/Manual/GlossaryEdgeCollection.md new file mode 100644 index 0000000000..5dc8bd4594 --- /dev/null +++ b/Documentation/Manual/GlossaryEdgeCollection.md @@ -0,0 +1,5 @@ +EdgeCollection {#GlossaryEdgeCollection} +======================================== + +@GE{Edge Collection}: Edge collections are special collection where +edge documents live. diff --git a/Documentation/Manual/GlossaryIndex.md b/Documentation/Manual/GlossaryIndex.md new file mode 100644 index 0000000000..6d95874d91 --- /dev/null +++ b/Documentation/Manual/GlossaryIndex.md @@ -0,0 +1,6 @@ +Index {#GlossaryIndex} +====================== + +@GE{Index}: Indexes are used to allow fast access to documents. For +each collection there is always the primary index which is a hash +index for the document identifier. diff --git a/Documentation/Manual/GlossaryIndexGeo.md b/Documentation/Manual/GlossaryIndexGeo.md new file mode 100644 index 0000000000..e45609e063 --- /dev/null +++ b/Documentation/Manual/GlossaryIndexGeo.md @@ -0,0 +1,5 @@ +GeoIndex {#GlossaryIndexGeo} +============================ + +@GE{Geo Index}: A geo index is used to find places on the surface of +the earth fast. diff --git a/Documentation/Manual/GlossaryIndexHandle.md b/Documentation/Manual/GlossaryIndexHandle.md new file mode 100644 index 0000000000..8c8ecd5b31 --- /dev/null +++ b/Documentation/Manual/GlossaryIndexHandle.md @@ -0,0 +1,6 @@ +IndexHandle {#GlossaryIndexHandle} +================================== + +@GE{Index Handle}: An index handle uniquely identifies an index in the +database. It is a string and consists of a collection identifier and a +index identifier separated by `/`. diff --git a/Documentation/Manual/GlossaryIndexHash.md b/Documentation/Manual/GlossaryIndexHash.md new file mode 100644 index 0000000000..91a404ab98 --- /dev/null +++ b/Documentation/Manual/GlossaryIndexHash.md @@ -0,0 +1,5 @@ +HashIndex {#GlossaryIndexHash} +============================== + +@GE{Hash Index}: A hash index is used to find documents based on +examples. diff --git a/Documentation/Manual/GlossaryIndexPrioQueue.md b/Documentation/Manual/GlossaryIndexPrioQueue.md new file mode 100644 index 0000000000..d392b7a4dd --- /dev/null +++ b/Documentation/Manual/GlossaryIndexPrioQueue.md @@ -0,0 +1,5 @@ +PriorityQueue {#GlossaryIndexPrioQueue} +======================================= + +@GE{Priority Queue}: A priority queue based on an attribute of the +documents. diff --git a/Documentation/Manual/GlossaryIndexSkiplist.md b/Documentation/Manual/GlossaryIndexSkiplist.md new file mode 100644 index 0000000000..c962d34e89 --- /dev/null +++ b/Documentation/Manual/GlossaryIndexSkiplist.md @@ -0,0 +1,4 @@ +SkiplistIndex {#GlossaryIndexSkiplist} +====================================== + +@GE{Skiplist Index}: A skiplist is used to find ranges of documents. diff --git a/Documentation/UserManual/Home.md b/Documentation/Manual/Home.md similarity index 98% rename from Documentation/UserManual/Home.md rename to Documentation/Manual/Home.md index 1f05e17716..8ff6463f09 100644 --- a/Documentation/UserManual/Home.md +++ b/Documentation/Manual/Home.md @@ -53,8 +53,6 @@ ArangoDB's Administrator Manuals {#ArangoDBAdminManual} - @ref InstallManual @ifnot XML @EXTREF{install-manual.pdf,pdf} @endif -- @ref Glossary - ArangoDB's Developer Manuals {#ArangoDBAPIManual} ================================================= @@ -62,8 +60,6 @@ ArangoDB's Developer Manuals {#ArangoDBAPIManual} - @ref RefManual @ifnot XML @EXTREF{ref-manual.pdf,pdf} @endif -- @ref Glossary - API aka Drivers {#HomeApi} ========================== diff --git a/Documentation/arango.template.in b/Documentation/arango.template.in index 5cd38b2045..da80b7ee32 100644 --- a/Documentation/arango.template.in +++ b/Documentation/arango.template.in @@ -222,6 +222,7 @@ ALIASES += \ ALIASES += \ "NAVIGATE{3}=@htmlonly
prev | home | next
@endhtmlonly" \ "NAVIGATE_FIRST{2}=@htmlonly
prev | home | next
@endhtmlonly" \ + "NAVIGATE_LAST{2}=@htmlonly
prev | home | next
@endhtmlonly" \ "EMBEDTOC{1}=@if LATEX@else@htmlonly
@endhtmlonly@copydoc \1\n@htmlonly
@endhtmlonly@endif" # glossary diff --git a/arangod/Documentation/glossary.dox b/arangod/Documentation/glossary.dox deleted file mode 100644 index 938ed9df8b..0000000000 --- a/arangod/Documentation/glossary.dox +++ /dev/null @@ -1,190 +0,0 @@ -//////////////////////////////////////////////////////////////////////////////// -/// @brief over the wire protocol -/// -/// @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 Dr. Frank Celler -/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page Glossary -/// -/// @copydoc GlossaryCollection -/// -/// @copydoc GlossaryCollectionIdentifier -/// -/// @copydoc GlossaryCollectionName -/// -/// @copydoc GlossaryDocument -/// -/// @copydoc GlossaryDocumentEtag -/// -/// @copydoc GlossaryDocumentHandle -/// -/// @copydoc GlossaryDocumentIdentifier -/// -/// @copydoc GlossaryDocumentRevision -/// -/// @copydoc GlossaryEdge -/// -/// @copydoc GlossaryEdgeCollection -/// -/// @copydoc GlossaryIndexGeo -/// -/// @copydoc GlossaryIndexHash -/// -/// @copydoc GlossaryIndex -/// -/// @copydoc GlossaryIndexHandle -/// -/// @copydoc GlossaryIndexPrioQueue -/// -/// @copydoc GlossaryIndexSkiplist -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page GlossaryCollection -//////////////////////////// -/// -/// @GE{Collection}: A collection consists of documents. It is uniquely identified -/// by it's collection identifier. It also has a unique name. -/// -/// @page GlossaryCollectionIdentifier -////////////////////////////////////// -/// -/// @GE{Collection Identifier}: A collection identifier identifies a collection -/// in a database. It is an integer and is unique within the database. -/// -/// @page GlossaryCollectionName -//////////////////////////////// -/// -/// @GE{Collection Name}: A collection name identifies a collection in a -/// database. It is an string and is unique within the database. Unlike the -/// collection identifier it is supplied by the creator of the collection. The -/// collection name can consist of letters, digits and the characters @LIT{_} -/// (underscore) and @LIT{-} (dash). Please refer to @ref NamingConventions for more -/// information on valid collection names. -/// -/// @page GlossaryDocument -////////////////////////// -/// -/// @GE{Document}: Documents in ArangoDB are JSON objects. These objects can be -/// nested (to any depth) and may contains lists. Each document is uniquely identified -/// by its document handle. -/// -/// @page GlossaryDocumentEtag -////////////////////////////// -/// -/// @GE{Document Etag}: The document revision enclosed in double quotes. The revision -/// is returned by several HTTP API methods in the @LIT{Etag} HTTP header. -/// -/// @page GlossaryDocumentHandle -//////////////////////////////// -/// -/// @GE{Document Handle}: A document handle uniquely identifies a document in -/// the database. It is a string and consists of a collection identifier and a -/// document identifier separated by @LIT{/}. -/// -/// @page GlossaryDocumentIdentifier -//////////////////////////////////// -/// -/// @GE{Document Identifier}: A document identifier identifies a document in a -/// given collection. It is an integer and is unique within the collection of the -/// document. -/// Currently, ArangoDB uses 64bit unsigned integers for document identifiers but this is an -/// implementation detail that clients should not rely on. Additionally, as this -/// datatype is not portable to all client languages, clients should rather use -/// strings to store document identifiers locally. -/// -/// @page GlossaryDocumentRevision -////////////////////////////////// -/// -/// @GE{Document Revision}: As ArangoDB supports MVCC, documents can exist in -/// more than one revision. The document revision is the MVCC token used to -/// identify a particular revision of a document. It is an integer and unique -/// within the list of document revision for a single document. Earlier revisions -/// of a document have smaller numbers. -/// Document revisions can be used to conditionally update, replace or delete -/// documents in the database. In order to find a particular revision -/// of a document, you need the document handle and the document revision. -/// -/// ArangoDB currently uses 64bit unsigned integer values for document revisions. -/// As this datatype is not portable to all client languages, clients should -/// rather use strings to store document revision ids locally. -/// -/// @page GlossaryEdge -////////////////////// -/// -/// @GE{Edge}: Edges in ArangoDB are special documents. In addition to the -/// internal attributes @LIT{_id} and @LIT{_rev}, they have two attributes -/// @LIT{_from} and @LIT{_to}, which contain document handles, namely the -/// start-point and the end-point of the edge. -/// -/// @page GlossaryEdgeCollection -//////////////////////////////// -/// -/// @GE{Edge Collection}: Edge collections are special collection where -/// edge documents live. Instead of using @LIT{db}, one must use @LIT{edges} -/// to access the edge collection. -/// -/// @page GlossaryIndexGeo -////////////////////////// -/// -/// @GE{Geo Index}: A geo index is used to find places on the surface of the -/// earth fast. -/// -/// @page GlossaryIndexHash -/////////////////////////// -/// -/// @GE{Hash Index}: A hash index is used to find documents based on examples. -/// -/// @page GlossaryIndex -/////////////////////// -/// -/// @GE{Index}: Indexes are used to allow fast access to documents. For each -/// collection there is always the primary index which is a hash index for -/// the document identifier. -/// -/// @page GlossaryIndexHandle -///////////////////////////// -/// -/// @GE{Index Handle}: An index handle uniquely identifies an index in the -/// database. It is a string and consists of a collection identifier and a -/// index identifier separated by @LIT{/}. -/// -/// @page GlossaryIndexPrioQueue -//////////////////////////////// -/// -/// @GE{Priority Queue}: A priority queue based on an attribute of the -/// documents. -/// -/// @page GlossaryIndexSkiplist -/////////////////////////////// -/// -/// @GE{Skiplist Index}: A skiplist is used to find ranges of documents. -//////////////////////////////////////////////////////////////////////////////// - -// Local Variables: -// mode: c++ -// mode: outline-minor -// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)" -// End: diff --git a/arangod/Documentation/implementor-manual.dox b/arangod/Documentation/implementor-manual.dox index 7670ca6718..2fc2f0bd94 100644 --- a/arangod/Documentation/implementor-manual.dox +++ b/arangod/Documentation/implementor-manual.dox @@ -26,7 +26,9 @@ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// -/// @page ImplementorManual ArangoDB's Reference Manual for API Implementors (@VERSION) +/// @page ImplementorManual ArangoDB for API Implementors (@VERSION) +/// +/// @NAVIGATE{InstallManual,Home,RefManual} /// /// @if LATEX ///