Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix dangling anchors and add checker script to the make target.

This commit is contained in:
Wilfried Goesgens 2015-11-26 18:51:39 +01:00
parent 389c3e0cf0
commit aae19ff291
73 changed files with 227 additions and 190 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
Documentation/Books/Makefile
View File

@ -46,9 +46,9 @@ book-check-markdown-leftovers:
find books/$(NAME) -name '*.html' -exec grep '##' {} \; -print; \
exit 1; \
fi
@if test "`find books/Users/ -name '*.html' -exec grep '\.md\"' {} \; | grep -v data-filepath | wc -l`" -gt 0; then \
echo "found dangling markdown links: "; \
find books/$(NAME) -name '*.html' -exec grep '\.md"' {} \; -print | grep -v data-filepath \
@if test "`find books/$(NAME) -name '*.html' -exec grep '\.md\"' {} \; | grep -v data-filepath | wc -l`" -gt 0; then \
find books/$(NAME) -name '*.html' -exec grep '\.md"' {} \; -print | grep -v data-filepath; \
echo "found dangling markdown links; see the list above "; \
exit 1; \
fi
@if test "`find books/$(NAME) -name '*.html' -exec grep '\.md#' {} \; -print | wc -l`" -gt 0; then \
@ -57,6 +57,40 @@ book-check-markdown-leftovers:
exit 1; \
fi
book-check-dangling-anchors:
grep -R "a href" books/$(NAME) | \
grep -v styles/header.js | \
grep -v /app.js | \
grep -v navigation| \
grep -v 'http://' | \
grep -v 'https://' | \
grep '#' |sed 's;\(.*\.html\):.*a href="\(.*\)#\(.*\)">.*</a>.*;\1,\2,\3;' > /tmp/anchorlist.txt
NO=0; \
for i in `cat /tmp/anchorlist.txt`; do \
ANCHOR=`echo $$i | cut '-d,' -f 3`; \
FN=`echo $$i | cut '-d,' -f 2`; \
SFN=`echo $$i | cut '-d,' -f 1`; \
if test -z "$$FN"; then \
FN=$$SFN; \
else \
SFNP=`echo $$SFN | sed 's;/[a-zA-Z]*.html;;'`; \
FN="$${SFNP}/$${FN}"; \
fi; \
if test -n "$$ANCHOR"; then \
if grep -q "id=\"$$ANCHOR\">" $$FN; then \
/bin/true; \
else \
echo "$$i"; \
NO=$$((NO + 1)); \
fi; \
fi; \
done; \
if test "$${NO}" -gt 0; then \
echo "$${NO} Dangling anchors found!"; \
exit 1; \
fi
build-book-symlinks:
echo "generate backwards compatibility symlinks:"
cd books/$(NAME); pwd; \
@ -100,6 +134,7 @@ build-book:
python deprecated.py
make book-check-markdown-leftovers
make book-check-dangling-anchors
clean-book:
@rm -rvf books/$(NAME) ppbooks/$(NAME)

2
Documentation/Books/Users/Aql/DataModification.mdpp
View File

@ -145,7 +145,7 @@ the operation type:
The name of the modified collection (*users* and *backup* in the above cases)
must be known to the AQL executor at query-compile time and cannot change at
runtime. Using a bind parameter to specify the [collection name](../Glossary/index.html#collection_name) is allowed.
runtime. Using a bind parameter to specify the [collection name](../Glossary/README.md#collection-name) is allowed.
Data-modification queries are restricted to modifying data in a single
collection per query. That means a data-modification query cannot modify

2
Documentation/Books/Users/Aql/DateFunctions.mdpp
View File

@ -377,7 +377,7 @@ There are two recommended ways to store timestamps in ArangoDB:
- as [Epoch number](https://en.wikipedia.org/wiki/Epoch_%28reference_date%29)
The sort order of both is identical due to the sort properties of ISO date strings.
Therefore, you can work with [skiplist indices](../IndexHandling/Skiplist.html) and use
Therefore, you can work with [skiplist indices](../IndexHandling/Skiplist.md) and use
string comparisons (less than, greater than, in, equality) to express time ranges in your queries:
@startDocuBlockInline working_with_date_time

4
Documentation/Books/Users/Aql/DocumentFunctions.mdpp
View File

@ -147,9 +147,9 @@ AQL supports the following functions to operate on document values:
KEEP(doc, 'firstname', 'name', 'likes')
KEEP(doc, [ 'firstname', 'name', 'likes' ])
- *PARSE_IDENTIFIER(document-handle)*: Parses the [document handle](../Glossary/index.html#document_handle) specified in
- *PARSE_IDENTIFIER(document-handle)*: Parses the [document handle](../Glossary/README.md#document-handle) specified in
*document-handle* and returns a the handle's individual parts a separate attributes.
This function can be used to easily determine the [collection name](../Glossary/index.html#collection_name) and key from a given document.
This function can be used to easily determine the [collection name](../Glossary/README.md#collection-name) and key from a given document.
The *document-handle* can either be a regular document from a collection, or a document
identifier string (e.g. *_users/1234*). Passing either a non-string or a non-document or a
document without an *_id* attribute will result in an error.

2
Documentation/Books/Users/Aql/FulltextFunctions.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Fulltext functions
AQL offers the following functions to filter data based on [fulltext indexes](../Glossary/index.html#fulltext_index):
AQL offers the following functions to filter data based on [fulltext indexes](../Glossary/README.md#fulltext-index):
- *FULLTEXT(collection, attribute, query, limit)*:
Returns all documents from collection *collection* for which the attribute *attribute*

2
Documentation/Books/Users/Aql/GeoFunctions.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Geo functions
AQL offers the following functions to filter data based on [geo indexes](../Glossary/index.html#geo_index):
AQL offers the following functions to filter data based on [geo indexes](../Glossary/README.md#geo-index):
- *NEAR(collection, latitude, longitude, limit, distancename)*:
Returns at most *limit* documents from collection *collection* that are near

2
Documentation/Books/Users/Aql/GraphOperations.mdpp
View File

@ -24,7 +24,7 @@ the amount of vertices in the graph, *x* the amount of start vertices and *y* th
target vertices. Hence a suggestion may be to use Dijkstra when x\*y < n and the functions supports choosing your algorithm.
!SUBSECTION Example Graph
All examples in this chapter will use [this simple city graph](../Graphs/README.md#the_city_graph):
All examples in this chapter will use [this simple city graph](../Graphs/README.md#the-city-graph):
![Cities Example Graph](../Graphs/cities_graph.png)

4
Documentation/Books/Users/Aql/Invoke.mdpp
View File

@ -263,12 +263,12 @@ is an array of warnings that occurred during optimization or execution plan crea
Each plan in the result is an object with the following attributes:
- *nodes*: the array of execution nodes of the plan. The list of available node types
can be found [here](../Aql/Optimizer.html)
can be found [here](../Aql/Optimizer.md)
- *estimatedCost*: the total estimated cost for the plan. If there are multiple
plans, the optimizer will choose the plan with the lowest total cost.
- *collections*: an array of collections used in the query
- *rules*: an array of rules the optimizer applied. The list of rules can be
found [here](../Aql/Optimizer.html)
found [here](../Aql/Optimizer.md)
- *variables*: array of variables used in the query (note: this may contain
internal variables created by the optimizer)

6
Documentation/Books/Users/Aql/Operations.mdpp
View File

@ -568,7 +568,7 @@ is not transactional.
Only a single *REMOVE* statement is allowed per AQL query, and it cannot be combined
with other data-modification or retrieval operations. A remove operation is
restricted to a single collection, and the [collection name](../Glossary/index.html#collection_name) must not be dynamic.
restricted to a single collection, and the [collection name](../Glossary/README.md#collection-name) must not be dynamic.
The syntax for a remove operation is:
@ -578,7 +578,7 @@ REMOVE key-expression IN collection options
*collection* must contain the name of the collection to remove the documents
from. *key-expression* must be an expression that contains the document identification.
This can either be a string (which must then contain the [document key](../Glossary/index.html#document_key)) or a
This can either be a string (which must then contain the [document key](../Glossary/README.md#document-key)) or a
document, which must contain a *_key* attribute.
The following queries are thus equivalent:
@ -989,7 +989,7 @@ FOR i IN 1..100
INSERT { value: i } IN numbers
```
When inserting into an [edge collection](../Glossary/index.html#edge_collection), it is mandatory to specify the attributes
When inserting into an [edge collection](../Glossary/README.md#edge-collection), it is mandatory to specify the attributes
*_from* and *_to* in document:
```

4
Documentation/Books/Users/AqlExamples/CollectionQueries.mdpp
View File

@ -86,7 +86,7 @@ relationships between users. The example data for *relations* are as follows:
Note that all documents created in the two collections will automatically get the
following server-generated attributes:
* *_id*: A unique id, consisting of [collection name](../Glossary/index.html#collection_name) and a server-side sequence value
* *_id*: A unique id, consisting of [collection name](../Glossary/README.md#collection-name) and a server-side sequence value
* *_key*: The server sequence value
* *_rev*: The document's revision id
@ -97,6 +97,6 @@ Please also note that with real-world data, you might want to create additional
indexes on the data (left out here for brevity). Adding indexes on attributes that are
used in *FILTER* statements may considerably speed up queries. Furthermore, instead of
using attributes such as *id*, *from* and *to*, you might want to use the built-in
*_id*, *_from* and *_to* attributes. Finally, [edge collection](../Glossary/index.html#edge_collection)s provide a nice way of
*_id*, *_from* and *_to* attributes. Finally, [edge collection](../Glossary/README.md#edge-collection)s provide a nice way of
establishing references / links between documents. These features have been left out here
for brevity as well.

4
Documentation/Books/Users/AqlExtending/README.mdpp
View File

@ -6,10 +6,10 @@ fully-featured programming language.
To add missing functionality or to simplify queries, users
may add their own functions to AQL. These functions can be written
in JavaScript, and must be registered via the API;
see [Registering Functions](../AqlExtending/Functions.html).
see [Registering Functions](../AqlExtending/Functions.md).
In order to avoid conflicts with existing or future built-in
function names, all user functions must be put into separate
namespaces. Invoking a user functions is then possible by referring
to the fully-qualified function name, which includes the namespace,
too; see [Conventions](../AqlExtending/Conventions.html).
too; see [Conventions](../AqlExtending/Conventions.md).

2
Documentation/Books/Users/ArangoActions/Modifying.mdpp
View File

@ -360,7 +360,7 @@ will appear.*
!SECTION Application Deployment
Using single routes or [bundles](#routing_bundles) can be
Using single routes or [bundles](#routing-bundles) can be
become a bit messy in large applications. Kaerus has written a [deployment tool](https://github.com/kaerus/arangodep) in node.js.
Note that there is also [Foxx](../Foxx/README.md) for building applications

6
Documentation/Books/Users/Collections/README.mdpp
View File

@ -13,14 +13,14 @@ name. ArangoDB internally uses the collection's unique identifier to look up
collections. This identifier, however, is managed by ArangoDB and the user has
no control over it. In order to allow users to use their own names, each collection
also has a unique name which is specified by the user. To access a collection
from the user perspective, the [collection name](../Glossary/index.html#collection_name) should be used, i.e.:
from the user perspective, the [collection name](../Glossary/README.md#collection-name) should be used, i.e.:
!SUBSECTION Collection
`db._collection(collection-name)`
A collection is created by a ["db._create"](../Collections/DatabaseMethods.md) call.
For example: Assume that the [collection identifier](../Glossary/index.html#collection_identifier) is *7254820* and the name is
For example: Assume that the [collection identifier](../Glossary/README.md#collection-identifier) is *7254820* and the name is
*demo*, then the collection can be accessed as:
db._collection("demo")
@ -43,4 +43,4 @@ use
`db._create(collection-name)`
This call will create a new collection called *collection-name*.
This method is a database method and is documented in detail at [Database Methods](../Collections/DatabaseMethods.html#create)
This method is a database method and is documented in detail at [Database Methods](../Collections/DatabaseMethods.md#create)

2
Documentation/Books/Users/ConfigureArango/Authentication.mdpp
View File

@ -60,7 +60,7 @@ or given in a wrong format, or there already exists a user with the specified
name.
The new user account can only be used after the server is either restarted or
the server authentication cache is [reloaded](#examples_reload).
the server authentication cache is [reloaded](#reload).
**Note**: this function will not work from within the web interface

2
Documentation/Books/Users/ConfigureArango/Communication.mdpp
View File

@ -20,4 +20,4 @@ exit. This option is useful only when used in conjunction with the option
scheduler.backend. An integer is returned (which is platform dependent) which
indicates available backends on your platform. See libev for further details and
for the meaning of the integer returned. This describes the allowed integers for
*scheduler.backend*, see [here](#command-line-options-for-communication) for details.
*scheduler.backend*, see [here](#commandline-options-for-communication) for details.

4
Documentation/Books/Users/Documents/DocumentAddress.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Address and ETag of a Document
All documents in ArangoDB have a [document handle](../Glossary/index.html#document_handle). This handle uniquely defines a
All documents in ArangoDB have a [document handle](../Glossary/README.md#document-handle). This handle uniquely defines a
document and is managed by ArangoDB. The interface allows you to access the
documents of a collection as:
@ -17,6 +17,6 @@ can leave out the *collection* and use the shortcut:
db._document("demo/362549736")
Each document also has a [document revision](../Glossary/index.html#document_revision) or ETag which is returned in the
Each document also has a [document revision](../Glossary/README.md#document-revision) or ETag which is returned in the
*_rev* field when requesting a document. The document's key is returned in the
*_key* attribute.

6
Documentation/Books/Users/Documents/README.mdpp
View File

@ -6,7 +6,7 @@ documents from the JavaScript shell *arangosh*. For other languages see the
corresponding language API.
Documents in ArangoDB are JSON objects. These objects can be nested (to any depth)
and may contain lists. Each document is uniquely identified by its [document handle](../Glossary/index.html#document_handle).
and may contain lists. Each document is uniquely identified by its [document handle](../Glossary/README.md#document-handle).
For example:
@ -29,13 +29,13 @@ For example:
}
```
All documents contain special attributes: the document handle in *_id*, the
document's unique key in *_key* and and the ETag aka [document revision](../Glossary/index.html#document_revision) in
document's unique key in *_key* and and the ETag aka [document revision](../Glossary/README.md#document-revision) in
*_rev*. The value of the *_key* attribute can be specified by the user when
creating a document. *_id* and *_key* values are immutable once the document
has been created. The *_rev* value is maintained by ArangoDB autonomously.
A document handle uniquely identifies a document in the database. It is a string and
consists of the collection's name and the [document key](../Glossary/index.html#document_key) (_key attribute) separated by /.
consists of the collection's name and the [document key](../Glossary/README.md#document-key) (_key attribute) separated by /.
As ArangoDB supports MVCC, documents can exist in more than
one revision. The document revision is the MVCC token used to identify a particular

4
Documentation/Books/Users/Edges/README.mdpp
View File

@ -6,10 +6,10 @@ corresponding language API.
Edges in ArangoDB are special documents. In addition to the internal
attributes *_key*, *_id* and *_rev*, they have two attributes *_from* and *_to*,
which contain [document handles](../Glossary/index.html#document_handle), namely the start-point and the end-point of the edge.
which contain [document handles](../Glossary/README.md#document-handle), namely the start-point and the end-point of the edge.
The values of *_from* and *_to* are immutable once saved.
[Edge collections](../Glossary/index.html#edge_collection) are special collections that store edge documents. Edge documents
[Edge collections](../Glossary/README.md#edge-collection) are special collections that store edge documents. Edge documents
are connection documents that reference other documents. The type of a collection
must be specified when a collection is created and cannot be changed afterwards.

7
Documentation/Books/Users/FirstSteps/Arangod.mdpp
View File

@ -16,8 +16,9 @@ if a lockfile is already present.
The following command starts the ArangoDB database in server mode. You will
be able to access the server using HTTP requests on port 8529. Look
[here](#frequently_used_options) for a list of
frequently used options – see [here](../ConfigureArango/README.md) for a complete list.
[here](#frequently-used-options) for a list of
frequently used options – see
[here](../ConfigureArango/README.md) for a complete list.
```
unix> /usr/local/sbin/arangod /tmp/vocbase
@ -156,4 +157,4 @@ you can skip this section.
This should return a response with an *HTTP 200* status code when the
server is running. If it does it also means the server is generally
accepting connections. Alternative tools to check connectivity are *lynx*
or *ab*.
or *ab*.

2
Documentation/Books/Users/FirstSteps/Arangosh.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Details about the ArangoDB Shell
After the server has been [started](../FirstSteps/Arangod.html#details_about_the_arangodb_server),
After the server has been [started](../FirstSteps/Arangod.md#details-about-the-arangodb-server),
you can use the ArangoDB shell (_arangosh_) to administrate the
server. Without any arguments, the ArangoDB shell will try to contact
the server on port 8529 on the localhost. For more information see the

2
Documentation/Books/Users/Foxx/Develop/Controller.mdpp
View File

@ -197,7 +197,7 @@ The **request** object inherits several attributes from the underlying Actions:
* *server*: a JSON object with sub-attributes *address* (containing server
host name or IP address) and *port* (server port).
* *path*: request URI path, with potential [database name](../../Glossary/index.html#database_name) stripped off.
* *path*: request URI path, with potential [database name](../../Glossary/README.md#database-name) stripped off.
* *url*: request URI path + query string, with potential database name
stripped off

2
Documentation/Books/Users/Foxx/Develop/Queues.mdpp
View File

@ -13,7 +13,7 @@ Please note that Foxx job queues are database-specific. Queues and jobs are alwa
For the low-level functionality see [the chapter on the **Task Management** module](../../ModuleTasks/).
As of ArangoDB 2.6, Foxx queue job types are defined as regular Foxx scripts. To learn more about Foxx scripts, see [the chapter on Foxx scripts](./Scripts.html). Function-based job types are still supported in 2.6 but have been removed in 2.7.
As of ArangoDB 2.6, Foxx queue job types are defined as regular Foxx scripts. To learn more about Foxx scripts, see [the chapter on Foxx scripts](./Scripts.md). Function-based job types are still supported in 2.6 but have been removed in 2.7.
For an example of re-usable job types see the various mailer apps available in the Foxx app store.

2
Documentation/Books/Users/Foxx/Develop/Scripts.mdpp
View File

@ -32,7 +32,7 @@ queue.push(
);
```
For more information the Foxx job queue, see [the chapter about queues](./Queues.html).
For more information the Foxx job queue, see [the chapter about queues](./Queues.md).
!SECTION Script arguments and return values

4
Documentation/Books/Users/Foxx/Production/Productionmode.mdpp
View File

@ -40,6 +40,6 @@ For more information see the [Debugging](Debugging.md) section.
!SECTION Considerations for production environments
So you have created your server side application utilizing Foxx services as their backend.
To get optimal performance you may want to implement [an HTTP connection pool using keepalive](../../GeneralHttp/README.md#keep-alive).
To get optimal performance you may want to implement [an HTTP connection pool using keepalive](../../GeneralHttp/README.md#http-keepalive).
You may even consider to implement [non blocking HTTP requests](../../GeneralHttp/README.md#blocking-vs.-non-blocking-http-requests) to save resources on your connection pool.
You may even consider to implement [non blocking HTTP requests](../../GeneralHttp/README.md#blocking-vs-nonblocking-http-requests) to save resources on your connection pool.

10
Documentation/Books/Users/Foxx/README.mdpp
View File

@ -139,7 +139,7 @@ of what Foxx is, how it works and how to get it up and running in short time.
It is tutorial that should be solvable in 10 minutes or less and will guide you to your first
application giving a few insights on the way.
[Read More](Nutshell/index.html)
[Read More](Nutshell/README.md)
!SECTION Install a Foxx Application
@ -147,7 +147,7 @@ You would like to get some inspiration from running Applications?
Or you already have an Application that does what you need?
This chapter will guide you to get an Application up and running.
[Read More](Install/index.html)
[Read More](Install/README.md)
!SECTION Develop your own Foxx
@ -157,7 +157,7 @@ It will explain how to use the development mode and which debugging mechanisms a
It introduces the tips and tricks on how to build your own API.
And presents all libraries that are available from a Foxx Application.
[Read More](Develop/index.html)
[Read More](Develop/README.md)
!SECTION Running Foxx Applications in production
@ -166,7 +166,7 @@ This chapter is dedicated to all the possibilities on how to run a Foxx Applicat
It will start with how to leverage it from development to production.
We will continue with migration of the Application to a newer version.
[Read More](Production/index.html)
[Read More](Production/README.md)
!SECTION Foxx in a cluster
@ -175,4 +175,4 @@ Want to setup your micro-service based application?
This chapter will explain what has to be changed to run a Foxx application within a cluster setup.
It will also explain how to move your application from a single server to an unlimited amount of servers.
[Read More](Cluster/index.html)
[Read More](Cluster/README.md)

2
Documentation/Books/Users/GeneralGraphs/FluentAQLInterface.mdpp
View File

@ -8,7 +8,7 @@ As an example you can start with a set of vertices, select their direct neighbor
The result of this query will be the set of outgoing edges.
For each part of the query it is possible to further refine the resulting set of elements by giving examples for them.
Examples will explain the API on the [social graph](../Graphs/README.md#the_social_graph):
Examples will explain the API on the [social graph](../Graphs/README.md#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)

2
Documentation/Books/Users/GeneralGraphs/Functions.mdpp
View File

@ -4,7 +4,7 @@ This chapter describes various functions on a graph.
A lot of these accept a vertex (or edge) example as parameter as defined in the next section.
Examples will explain the API on the [the city graph](../Graphs/README.md#the_city_graph):
Examples will explain the API on the [the city graph](../Graphs/README.md#the-city-graph):
![Social Example Graph](../Graphs/cities_graph.png)

6
Documentation/Books/Users/GeneralGraphs/Management.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Graph Management
Before we create our first graph, the philosophy of handling the graph content has to be introduced.
A graph contains of a set of edge definitions each referring to one [edge collection](../Glossary/index.html#edge_collection) and
A graph contains of a set of edge definitions each referring to one [edge collection](../Glossary/README.md#edge-collection) and
defining constraints on the vertex collections used as start and end points of the edges.
Furthermore a graph can contain an arbitrary amount of vertex collections, called orphan collections, that are not used in any edge definition but should be managed by the graph.
In order to create a non empty graph the functionality to create edge definitions has to be introduced first:
@ -28,7 +28,7 @@ An edge definition is always a directed relation of a graph. Each graph can have
**Warning: Deprecated**
This function is deprecated and will be removed soon.
Please use [Relation](../GeneralGraphs/Management.html#relation) instead.
Please use [Relation](../GeneralGraphs/Management.md#relation) instead.
@startDocuBlock JSF_general_graph_undirectedRelation
@ -37,7 +37,7 @@ Please use [Relation](../GeneralGraphs/Management.html#relation) instead.
**Warning: Deprecated**
This function is deprecated and will be removed soon.
Please use [Relation](../GeneralGraphs/Management.html#relation) instead.
Please use [Relation](../GeneralGraphs/Management.md#relation) instead.
@startDocuBlock JSF_general_graph_directedRelation

2
Documentation/Books/Users/GeneralGraphs/README.mdpp
View File

@ -10,7 +10,7 @@ There is no need to include the referenced collections within the query, this mo
A Graph consists of *vertices* and *edges*. Edges are stored as documents in *edge
collections*. In general a vertex is stored in a document collection.
The type of edges that are allowed within a graph is defined by *edge definitions*:
An edge definition is a combination of an [edge collection](../Glossary/index.html#edge_collection), and the vertex collections that the edges within this collection can connect.
An edge definition is a combination of an [edge collection](../Glossary/README.md#edge-collection), and the vertex collections that the edges within this collection can connect.
A graph can have an arbitrary number of edge definitions and arbitrary many additional vertex collections.
!SUBSECTION Warning

2
Documentation/Books/Users/GeneralHttp/README.mdpp
View File

@ -109,7 +109,7 @@ the server must be started with the option [--server.disable-authentication](../
Please note that requests using the HTTP OPTIONS method will be answered by
ArangoDB in any case, even if no authentication data is sent by the client or if
the authentication data is wrong. This is required for handling CORS preflight
requests (see [Cross Origin Resource Sharing requests](#cross_origin_resource_sharing_%28cors%29_requests)). The response to an HTTP OPTIONS request
requests (see [Cross Origin Resource Sharing requests](#cross-origin-resource-sharing-cors-requests)). The response to an HTTP OPTIONS request
will be generic and not expose any private data.
Please note that when authentication is turned on in ArangoDB, it will by

4
Documentation/Books/Users/Glossary/README.mdpp
View File

@ -16,7 +16,7 @@ opaque strings when they store or use it locally.
!SUBSECTION Collection Name
A collection name identifies a collection in a database. It is a string and is unique within the database. Unlike the collection identifier it is supplied by the creator of the collection. The collection name must consist of letters, digits, and the _ (underscore) and - (dash) characters only. Please refer to [NamingConventions](../NamingConventions/CollectionNames.html) for more information on valid collection names.
A collection name identifies a collection in a database. It is a string and is unique within the database. Unlike the collection identifier it is supplied by the creator of the collection. The collection name must consist of letters, digits, and the _ (underscore) and - (dash) characters only. Please refer to [NamingConventions](../NamingConventions/CollectionNames.md) for more information on valid collection names.
!SUBSECTION Database
@ -26,7 +26,7 @@ A database contains its own collections (which cannot be accessed from other dat
There will always be at least one database in ArangoDB. This is the default database, named _system. This database cannot be dropped, and provides special operations for creating, dropping, and enumerating databases. Users can create additional databases and give them unique names to access them later. Database management operations cannot be initiated from out of user-defined databases.
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically derived from the endpoint. Please refer to [DatabaseEndpoint](../HttpDatabase/DatabaseEndpoint.html) for more information.
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically derived from the endpoint. Please refer to [DatabaseEndpoint](../HttpDatabase/DatabaseEndpoint.md) for more information.
!SUBSECTION Database Name

13
Documentation/Books/Users/HttpAsyncResultsManagement/README.mdpp
View File

@ -21,7 +21,8 @@ Furthermore, please note that even if the client closes the HTTP
connection, the request running on the server will still continue until
it is complete and only then notice that the client no longer listens.
Thus closing the connection does not help to abort a long running query!
See below under [Async Execution and later Result Retrieval](#async_execution_and_later_result_retrieval) and [HttpJobPutCancel](../HttpAsyncResultsManagement/index.html#managing_async_results_via_http) for details.
See below under [Async Execution and later Result Retrieval](#async-execution-and-later-result-retrieval)
and [HttpJobPutCancel](#managing-async-results-via-http) for details.
!SUBSUBSECTION Fire and Forget
@ -50,13 +51,13 @@ the server will reject the request with an HTTP 500 error.
Finally, please note that it is not possible to cancel such a
non-blocking request after the fact. If you need to cancel requests,
use [Async Execution and later Result Retrieval](#async_execution_and_later_result_retrieval)
and [HttpJobPutCancel](..#managing_async_results_via_http) below.
use [Async Execution and later Result Retrieval](#async-execution-and-later-result-retrieval)
and [HttpJobPutCancel](#managing-async-results-via-http) below.
!SUBSUBSECTION Async Execution and later Result Retrieval
By adding the HTTP header *x-arango-async: store* to a request, clients can instruct
the ArangoDB server to execute the operation asynchronously as [above](#fire_and_forget)
the ArangoDB server to execute the operation asynchronously as [above](#fire-and-forget)
"above", but also store the operation result in memory for a later retrieval. The
server will return a job id in the HTTP response header *x-arango-async-id*. The client
can use this id in conjunction with the HTTP API at */_api/job*, which is described in
@ -67,7 +68,7 @@ ready for retrieval, and which are not. Clients can also use the async jobs API
retrieve the original results of an already executed async job by passing it the
originally returned job id. The server will then return the job result as if the job was
executed normally. Furthermore, clients can cancel running async jobs by
their job id, see [HttpJobPutCancel](../HttpAsyncResultsManagement/index.html#managing_async_results_via_http).
their job id, see [HttpJobPutCancel](#managing-async-results-via-http).
ArangoDB will keep all results of jobs initiated with the *x-arango-async: store*
header. Results are removed from the server only if a client explicitly asks the
@ -88,7 +89,7 @@ lost in case of a crash.
As mentioned above it is possible to cancel an asynchronously running
job using its job ID. This is done with a PUT request as described in
[HttpJobPutCancel](../HttpAsyncResultsManagement/index.html#managing_async_results_via_http).
[HttpJobPutCancel](#managing-async-results-via-http).
However, a few words of explanation about what happens behind the
scenes are in order. Firstly, a running async query can internally be

2
Documentation/Books/Users/HttpBatchRequest/README.mdpp
View File

@ -202,7 +202,7 @@ Content-length: 53
Please note that the database used for all part operations of a batch
request is determined by scanning the original URL (the URL that contains
*/_api/batch*). It is not possible to override the [database name](../Glossary/index.html#database_name) in
*/_api/batch*). It is not possible to override the [database name](../Glossary/README.md#database-name) in
part operations of a batch. When doing so, any other database name used
in a batch part will be ignored.

2
Documentation/Books/Users/HttpBulkImports/Arangodump.mdpp
View File

@ -27,7 +27,7 @@ or use authentication, you can use the following command-line options:
* *--server.disable-authentication <bool>*: whether or not to use authentication
Here's an example of dumping data from a non-standard endpoint, using a dedicated
[database name](../Glossary/index.html#database_name):
[database name](../Glossary/README.md#database-name):
unix> arangodump --server.endpoint tcp://192.168.173.13:8531 --server.username backup --server.database mydb --output-directory "dump"

4
Documentation/Books/Users/HttpBulkImports/Arangoimp.mdpp
View File

@ -7,8 +7,8 @@ The most convenient method to import a lot of data into ArangoDB is to use the
*arangoimp* command-line tool. It allows you to import data records from a file
into an existing database collection.
It is possible to import [document keys](../Glossary/index.html#document_key) with the documents using the *_key*
attribute. When importing into an [edge collection](../Glossary/index.html#edge_collection), it is mandatory that all
It is possible to import [document keys](../Glossary/README.md#document-key) with the documents using the *_key*
attribute. When importing into an [edge collection](../Glossary/README.md#edge-collection), it is mandatory that all
imported documents have the *_from* and *_to* attributes, and that they contain
valid references.

6
Documentation/Books/Users/HttpBulkImports/Arangorestore.mdpp
View File

@ -33,7 +33,7 @@ target database, the username and passwords passed to _arangorestore_ (in option
new database.
Here's an example of reloading data to a non-standard endpoint, using a dedicated
[database name](../Glossary/index.html#database_name):
[database name](../Glossary/README.md#database-name):
unix> arangorestore --server.endpoint tcp://192.168.173.13:8531 --server.username backup --server.database mydb --input-directory "dump"
@ -94,7 +94,7 @@ It can be specified multiple times if required:
unix> arangorestore --collection myusers --collection myvalues --input-directory "dump"
Collections will be processed by in alphabetical order by _arangorestore_, with all document
collections being processed before all [edge collection](../Glossary/index.html#edge_collection)s. This is to ensure that reloading
collections being processed before all [edge collection](../Glossary/README.md#edge-collection)s. This is to ensure that reloading
data into edge collections will have the document collections linked in edges (*_from* and
*_to* attributes) loaded.
@ -113,7 +113,7 @@ Note that setting *--recycle-ids* to *true* will also cause collections to be (r
the target database with the exact same collection id as in the input directory. Any potentially
existing collection in the target database with the same collection id will then be dropped.
Setting *--recycle-ids* to *false* or omitting it will only use the [collection name](../Glossary/index.html#collection_name) from the
Setting *--recycle-ids* to *false* or omitting it will only use the [collection name](../Glossary/README.md#collection-name) from the
input directory and allow the target database to create the collection with a different id
(though with the same name) than in the input directory.

2
Documentation/Books/Users/HttpBulkImports/ImportingHeadersAndValues.mdpp
View File

@ -36,7 +36,7 @@ errors occurred.
!SECTION Importing into Edge Collections
Please note that when importing documents into an [edge collection](../Glossary/index.html#edge_collection), it is
Please note that when importing documents into an [edge collection](../Glossary/README.md#edge-collection), it is
mandatory that all imported documents contain the *_from* and *_to* attributes,
and that these contain references to existing collections.

2
Documentation/Books/Users/HttpBulkImports/README.mdpp
View File

@ -22,7 +22,7 @@ The *collection* query parameter must be used to specify the target collection f
the import. The optional query parameter *createCollection* can be used to create
a non-existing collection during the import. If not used, importing data into a
non-existing collection will produce an error. Please note that the *createCollection*
flag can only be used to create document collections, not [edge collections](../Glossary/index.html#edge_collection).
flag can only be used to create document collections, not [edge collections](../Glossary/README.md#edge-collection).
The *waitForSync* query parameter can be set to *true* to make the import only
return if all documents have been synced to disk.

2
Documentation/Books/Users/HttpCollection/README.mdpp
View File

@ -7,7 +7,7 @@ This is an introduction to ArangoDB's HTTP interface for collections.
!SUBSUBSECTION Collection
A collection consists of documents. It is uniquely identified by its
[collection identifier](../Glossary/index.html#collection_identifier). It also has a unique name that clients should
[collection identifier](../Glossary/README.md#collection-identifier). It also has a unique name that clients should
use to identify and access it. Collections can be renamed. This will
change the collection name, but not the collection identifier.
Collections have a type that is specified by the user when the collection

2
Documentation/Books/Users/HttpDatabase/DatabaseEndpoint.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Database-to-Endpoint Mapping
If a [database name](../Glossary/index.html#database_name) is present in the URI as above, ArangoDB will consult the database-to-endpoint
If a [database name](../Glossary/README.md#database-name) is present in the URI as above, ArangoDB will consult the database-to-endpoint
mapping for the current endpoint, and validate if access to the database is allowed on the
endpoint.
If the endpoint is not restricted to an array of databases, ArangoDB will continue with the

2
Documentation/Books/Users/HttpDatabase/NotesOnDatabases.mdpp
View File

@ -15,7 +15,7 @@ applications until they are explicitly installed for the particular database.
ArangoDB can handle multiple databases in the same server instance. Databases can be used to logically group and separate data. An ArangoDB database consists of collections and dedicated database-specific worker processes.
A database contains its own collections (which cannot be accessed from other databases), Foxx applications and replication loggers and appliers. Each ArangoDB database contains its own system collections (e.g. _users, _graphs, ...).
There will always be at least one database in ArangoDB. This is the default [database name](../Glossary/index.html#database_name)d _system. This database cannot be dropped and provides special operations for creating, dropping and enumerating databases. Users can create additional databases and give them unique names to access them later. Database management operations cannot be initiated from out of user-defined databases.
There will always be at least one database in ArangoDB. This is the default [database name](../Glossary/README.md#database-name)d _system. This database cannot be dropped and provides special operations for creating, dropping and enumerating databases. Users can create additional databases and give them unique names to access them later. Database management operations cannot be initiated from out of user-defined databases.
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically determined by the algorithm described in Database-to-Endpoint Mapping .

2
Documentation/Books/Users/HttpDatabase/README.mdpp
View File

@ -4,7 +4,7 @@
Any operation triggered via ArangoDB's HTTP REST API is executed in the context of exactly
one database. To explicitly specify the database in a request, the request URI must contain
the [database name](../Glossary/index.html#database_name) in front of the actual path:
the [database name](../Glossary/README.md#database-name) in front of the actual path:
http://localhost:8529/_db/mydb/...

6
Documentation/Books/Users/HttpDocument/AddressAndEtag.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Address and ETag of a Document
All documents in ArangoDB have a [document handle](../Glossary/index.html#document_handle). This handle uniquely identifies
All documents in ArangoDB have a [document handle](../Glossary/README.md#document-handle). This handle uniquely identifies
a document. Any document can be retrieved using its unique URI:
http://server:port/_api/document/<document-handle>
@ -11,7 +11,7 @@ is:
http://localhost:8529/_api/document/demo/362549736
The above URL scheme does not specify a [database name](../Glossary/index.html#database_name) explicitly, so the
The above URL scheme does not specify a [database name](../Glossary/README.md#database-name) explicitly, so the
default database will be used. To explicitly specify the database context, use
the following URL schema:
@ -23,7 +23,7 @@ Example:
**Note**: The following examples use the short URL format for brevity.
Each document also has a [document revision](../Glossary/index.html#document_revision) or Etag with is returned in the
Each document also has a [document revision](../Glossary/README.md#document-revision) or Etag with is returned in the
"ETag" HTTP header when requesting a document.
If you obtain a document using *GET* and you want to check if a newer revision

4
Documentation/Books/Users/HttpDocument/README.mdpp
View File

@ -4,7 +4,7 @@
This is an introduction to ArangoDB's REST interface for documents.
Documents in ArangoDB are JSON objects. These objects can be nested (to any depth) and may contain lists. Each document is uniquely identified by its [document handle](../Glossary/index.html#document_handle).
Documents in ArangoDB are JSON objects. These objects can be nested (to any depth) and may contain lists. Each document is uniquely identified by its [document handle](../Glossary/README.md#document-handle).
An example document:
@ -28,7 +28,7 @@ An example document:
```
All documents contain special attributes: the document handle in `_id`, the
document's unique key in `_key` and and the Etag aka [document revision](../Glossary/index.html#document_revision) in
document's unique key in `_key` and and the Etag aka [document revision](../Glossary/README.md#document-revision) in
`_rev`. The value of the `_key` attribute can be specified by the user when
creating a document. `_id` and `_key` values are immutable once the document
has been created. The `_rev` value is maintained by ArangoDB autonomously.

4
Documentation/Books/Users/HttpEdge/AddressAndEtag.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Address and ETag of an Edge
All documents in ArangoDB have a [document handle](../Glossary/index.html#document_handle). This handle uniquely identifies
All documents in ArangoDB have a [document handle](../Glossary/README.md#document-handle). This handle uniquely identifies
a document. Any document can be retrieved using its unique URI:
http://server:port/_api/document/<document-handle>
@ -15,7 +15,7 @@ attribute of the edge, is *demo/362549736*, then the URL of that edge is:
http://localhost:8529/_api/edge/demo/362549736
The above URL scheme does not specify a [database name](../Glossary/index.html#database_name) explicitly, so the
The above URL scheme does not specify a [database name](../Glossary/README.md#database-name) explicitly, so the
default database will be used. To explicitly specify the database context, use
the following URL schema:

2
Documentation/Books/Users/HttpEdge/README.mdpp
View File

@ -17,7 +17,7 @@ are stored in documents in regular collections.
CEO. You would express this relationship with the *to* and *_to* attributes
- the "normal" collection stores all the properties about the reception,
e.g. that 20 people are working there and the room number etc
- *_from* is the [document handle](../Glossary/index.html#document_handle) of the linked vertex (incoming relation)
- *_from* is the [document handle](../Glossary/README.md#document-handle) of the linked vertex (incoming relation)
- *_to* is the document handle of the linked vertex (outgoing relation)
!SECTION Documents, Identifiers, Handles

4
Documentation/Books/Users/HttpGharial/Edges.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Handling Edges
Examples will explain the API on the [knows graph](../Graphs/README.md#the_knows_graph):
Examples will explain the API on the [knows graph](../Graphs/README.md#the-knowsgraph):
![Social Example Graph](../Graphs/knows_graph.png)
@ -8,7 +8,7 @@ Examples will explain the API on the [knows graph](../Graphs/README.md#the_knows
@startDocuBlock JSF_general_graph_edge_get_http_examples
Examples will explain the API on the [social graph](../Graphs/README.md#the_social_graph):
Examples will explain the API on the [social graph](../Graphs/README.md#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)

2
Documentation/Books/Users/HttpGharial/Management.mdpp
View File

@ -2,7 +2,7 @@
!CHAPTER Manage your graphs
The graph module provides functions dealing with graph structures.
Examples will explain the API on the [social graph](../Graphs/README.md#the_social_graph):
Examples will explain the API on the [social graph](../Graphs/README.md#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)

2
Documentation/Books/Users/HttpGharial/README.mdpp
View File

@ -10,7 +10,7 @@ There is no need to include the referenced collections within the query, this mo
A Graph consists of *vertices* and *edges*. Edges are stored as documents in *edge
collections*. In general a vertex is stored in a document collection.
The type of edges that are allowed within a graph is defined by *edge definitions*:
An edge definition is a combination of a [edge collection](../Glossary/index.html#edge_collection), and the vertex collections that the edges within this collection can connect.
An edge definition is a combination of a [edge collection](../Glossary/README.md#edge-collection), and the vertex collections that the edges within this collection can connect.
A graph can have an arbitrary number of edge definitions and arbitrary many additional vertex collections.
!SUBSECTION Warning

2
Documentation/Books/Users/HttpGharial/Vertices.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Handling Vertices
Examples will explain the API on the [social graph](../Graphs/README.md#the_social_graph):
Examples will explain the API on the [social graph](../Graphs/README.md#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)

2
Documentation/Books/Users/HttpIndexes/Fulltext.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Fulltext
If a [fulltext index](../Glossary/index.html#fulltext_index) exists, then /_api/simple/fulltext will use this index to execute the specified fulltext query.
If a [fulltext index](../Glossary/README.md#fulltext-index) exists, then /_api/simple/fulltext will use this index to execute the specified fulltext query.
<!-- js/actions/api-index.js -->
@startDocuBlock JSF_post_api_index_fulltext

4
Documentation/Books/Users/HttpIndexes/README.mdpp
View File

@ -7,8 +7,8 @@ general. There are special sections for various index types.
!SUBSUBSECTION 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 key](../Glossary/index.html#document_key) (_key attribute). This index cannot be dropped or changed.
[edge collections](../Glossary/index.html#edge_collection) will also have an automatically created edges index, which cannot be modified. This index provides quick access to documents via the _from and _to attributes.
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 key](../Glossary/README.md#document-key) (_key attribute). This index cannot be dropped or changed.
[edge collections](../Glossary/README.md#edge-collection) will also have an automatically created edges index, which cannot be modified. This index provides quick access to documents via the _from and _to attributes.
Most user-land indexes can be created by defining the names of the attributes which should be indexed. Some index types allow indexing just one attribute (e.g. fulltext index) whereas other index types allow indexing multiple attributes.

2
Documentation/Books/Users/HttpTraversal/README.mdpp
View File

@ -7,7 +7,7 @@ initiated by clients by sending the traversal description for execution to
the server.
Traversals in ArangoDB are used to walk over a graph
stored in one [edge collection](../Glossary/index.html#edge_collection). It can easily be described
stored in one [edge collection](../Glossary/README.md#edge-collection). It can easily be described
which edges of the graph should be followed and which actions
should be performed on each visited vertex.
Furthermore the ordering of visiting the nodes can be

4
Documentation/Books/Users/IndexHandling/IndexBasics.mdpp
View File

@ -21,7 +21,7 @@ ArangoDB provides the following index types:
!SUBSECTION Primary Index
For each collection there will always be a *primary index* which is a hash index
for the [document keys](../Glossary/index.html#document_key) (`_key` attribute)
for the [document keys](../Glossary/README.md#document-key) (`_key` attribute)
of all documents in the collection. The primary index allows quick selection
of documents in the collection using either the `_key` or `_id` attributes. It will
be used from within AQL queries automatically when performing equality lookups on
@ -44,7 +44,7 @@ mechanism to create user-defined primary indexes.
!SUBSECTION Edges Index
Every [edge collection](../Glossary/index.html#edge_collection) also has an
Every [edge collection](../Glossary/README.md#edge-collection) also has an
automatically created *edges index*. The edges index provides quick access to
documents by either their `_from` or `_to` attributes. It can therefore be
used to quickly find connections between vertex documents and is invoked when

2
Documentation/Books/Users/IndexHandling/WhichIndex.mdpp
View File

@ -128,7 +128,7 @@ will not know beforehand whether the values which are compared to `doc.attr` wil
Sparse skiplist indexes can be used for sorting if the optimizer can safely detect that the
index range does not include `null` for any of the index attributes.
Note that if you intend to use [joins](../AqlExamples/Join.html) it may be clever
Note that if you intend to use [joins](../AqlExamples/Join.md) it may be clever
to use non-sparsity and maybe even uniqueness for that attribute, else all items containing
the `null` value will match against each other and thus produce large results.

2
Documentation/Books/Users/Installing/Linux.mdpp
View File

@ -8,7 +8,7 @@ We provide packages for:
* Centos
* Debian
* Fedora
* [Linux-Mint](#linux-mint)
* [Linux-Mint](#linuxmint)
* Mandriva
* OpenSUSE
* RedHat RHEL

4
Documentation/Books/Users/Installing/MacOSX.mdpp
View File

@ -2,9 +2,9 @@
The preferred method for installing ArangoDB under Mac OS X is
[homebrew](#homebrew). However, in case you are not using homebrew, we provide a [command-line
app](#command-line_app) which contains all the executables.
app](#command-line-app) which contains all the executables.
There is also a version available in the [AppStore](#apple's_app_store), which comes with a nice
There is also a version available in the [AppStore](#apples-app-store), which comes with a nice
graphical user interface to start and stop the server.
!SECTION Homebrew

2
Documentation/Books/Users/Installing/Upgrading.mdpp
View File

@ -5,7 +5,7 @@
To upgrade an existing ArangoDB database to a newer version of ArangoDB
(e.g. 2.2 to 2.3, or 2.3 to 2.4), the following method is recommended:
* Check the *CHANGELOG* and the [list of incompatible changes](../Upgrading/UpgradingChanges26.html) for API or other changes in the new version of ArangoDB and make sure your applications can deal with them
* Check the *CHANGELOG* and the [list of incompatible changes](../Upgrading/UpgradingChanges26.md) for API or other changes in the new version of ArangoDB and make sure your applications can deal with them
* Stop the "old" arangod service or binary
* Copy the entire "old" data directory to a safe place (that is, a backup)
* Install the new version of ArangoDB and start the server with the *--upgrade* option once. This might write to the logfile of ArangoDB, so you may want to check the logs for any issues before going on.

2
Documentation/Books/Users/ModuleQueries/README.mdpp
View File

@ -15,7 +15,7 @@ The query module provides the infrastructure for working with currently running
!SUBSECTION Currently running queries
We [create a task](../ModuleTasks/index.html) that spawns queries, so we have nice output. Since this task
We [create a task](../ModuleTasks/README.md) that spawns queries, so we have nice output. Since this task
uses resources, you may want to increase `period` (and not forget to remove it... afterwards):
@startDocuBlockInline QUERY_02_listQueries

4
Documentation/Books/Users/NewFeatures/NewFeatures26.mdpp
View File

@ -201,7 +201,7 @@ https://www.arangodb.com/2015/05/reusable-foxx-apps-with-configurations/
And the blog post on Foxx dependencies can be found here:
https://www.arangodb.com/2015/05/foxx-dependencies-for-more-composable-foxx-apps/
For more information on manifests see the [Manifest chapter](../Foxx/Develop/Manifest.html). More information on using dependencies can be found in the chapter on [Foxx exports](../Foxx/Develop/Exports.html).
For more information on manifests see the [Manifest chapter](../Foxx/Develop/Manifest.md). More information on using dependencies can be found in the chapter on [Foxx exports](../Foxx/Develop/Exports.md).
!SUBSECTION Mocha Tests
@ -215,7 +215,7 @@ https://docs.arangodb.com/cookbook/FoxxTesting.html
The API documentation has been updated to Swagger 2. You can now also mount API
documentation in your own Foxx apps. For more information see the
[API Documentation chapter](../Foxx/Develop/ApiDocumentation.html) in the
[API Documentation chapter](../Foxx/Develop/ApiDocumentation.md) in the
Foxx documentation.
Also see the blog post introducing this feature:

2
Documentation/Books/Users/Sharding/StatusOfImplementation.mdpp
View File

@ -78,7 +78,7 @@ road map):
maintenance and scaling of a cluster. However, in version 2.0 the
cluster layout is static and no redistribution of data between the
DBservers or moving of shards between servers is possible.
* At this stage the sharding of an [edge collection](../Glossary/index.html#edge_collection) is independent of
* At this stage the sharding of an [edge collection](../Glossary/README.md#edge-collection) is independent of
the sharding of the corresponding vertex collection in a graph.
For version 2.2 we plan to synchronize the two, to allow for more
efficient graph traversal functions in large, sharded graphs. We

2
Documentation/Books/Users/SimpleQueries/FulltextQueries.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Fulltext queries
ArangoDB allows to run queries on text contained in document attributes. To use
this, a [fulltext index](../Glossary/index.html#fulltext_index) must be defined for the attribute of the collection that
this, a [fulltext index](../Glossary/README.md#fulltext-index) must be defined for the attribute of the collection that
contains the text. Creating the index will parse the text in the specified
attribute for all documents of the collection. Only documents will be indexed
that contain a textual value in the indexed attribute. For such documents, the

6
Documentation/Books/Users/SimpleQueries/ModificationQueries.mdpp
View File

@ -11,8 +11,8 @@ modify lots of documents in a collection.
All methods can optionally be restricted to a specific number of operations.
However, if a limit is specific but is less than the number of matches, it
will be undefined which of the matching documents will get removed/modified.
[Remove by Example](../Documents/DocumentMethods.html#remove_by_example),
[Replace by Example](../Documents/DocumentMethods.html#replace_by_example) and
[Update by Example](../Documents/DocumentMethods.html#update_by_example)
[Remove by Example](../Documents/DocumentMethods.md#remove-by-example),
[Replace by Example](../Documents/DocumentMethods.md#replace-by-example) and
[Update by Example](../Documents/DocumentMethods.md#update-by-example)
are described with examples in the subchapter
[Collection Methods](../Documents/DocumentMethods.md).

2
Documentation/Books/Users/Traversals/ExampleData.mdpp
View File

@ -1,6 +1,6 @@
!CHAPTER Example Data
The following examples all use a vertex collection *v* and an [edge collection](../Glossary/index.html#edge_collection) *e*. The vertex
The following examples all use a vertex collection *v* and an [edge collection](../Glossary/README.md#edge-collection) *e*. The vertex
collection *v* contains continents, countries, and capitals. The edge collection *e*
contains connections between continents and countries, and between countries and capitals.

2
Documentation/Books/Users/Traversals/UsingTraversalObjects.mdpp
View File

@ -551,7 +551,7 @@ var config = {
The edges connected to a vertex are determined by the expander. So far we have used a
default expander (the default inbound expander to be precise). The default inbound
expander simply enumerates all connected ingoing edges for a vertex, based on the
[edge collection](../Glossary/index.html#edge_collection) specified in the traversal configuration.
[edge collection](../Glossary/README.md#edge-collection) specified in the traversal configuration.
There is also a default outbound expander, which will enumerate all connected outgoing
edges. Finally, there is an any expander, which will follow both ingoing and outgoing

2
Documentation/Books/Users/Upgrading/Upgrading23.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Upgrading to ArangoDB 2.3
Please read the following sections if you upgrade from a previous version to
ArangoDB 2.3. Please be sure that you have checked the list of [changes in 2.3](../Upgrading/UpgradingChanges23.html)
ArangoDB 2.3. Please be sure that you have checked the list of [changes in 2.3](../Upgrading/UpgradingChanges23.md)
before upgrading.
Please note first that a database directory used with ArangoDB 2.3

2
Documentation/Books/Users/Upgrading/Upgrading24.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Upgrading to ArangoDB 2.4
Please read the following sections if you upgrade from a previous version to
ArangoDB 2.4. Please be sure that you have checked the list of [changes in 2.4](../Upgrading/UpgradingChanges24.html)
ArangoDB 2.4. Please be sure that you have checked the list of [changes in 2.4](../Upgrading/UpgradingChanges24.md)
before upgrading.
Please note first that a database directory used with ArangoDB 2.4

2
Documentation/Books/Users/Upgrading/Upgrading25.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Upgrading to ArangoDB 2.5
Please read the following sections if you upgrade from a previous version to
ArangoDB 2.5. Please be sure that you have checked the list of [changes in 2.5](../Upgrading/UpgradingChanges25.html)
ArangoDB 2.5. Please be sure that you have checked the list of [changes in 2.5](../Upgrading/UpgradingChanges25.md)
before upgrading.
Please note first that a database directory used with ArangoDB 2.5

2
Documentation/Books/Users/Upgrading/Upgrading26.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Upgrading to ArangoDB 2.6
Please read the following sections if you upgrade from a previous version to
ArangoDB 2.6. Please be sure that you have checked the list of [changes in 2.6](../Upgrading/UpgradingChanges26.html)
ArangoDB 2.6. Please be sure that you have checked the list of [changes in 2.6](../Upgrading/UpgradingChanges26.md)
before upgrading.
Please note first that a database directory used with ArangoDB 2.6

4
Documentation/Books/Users/WebInterface/README.mdpp
View File

@ -23,7 +23,7 @@ request URI path as follows:
The above will load the web interface for the database *mydb*.
To restrict access to the web interface, use
[ArangoDB's authentication feature](../GeneralHttp/index.html#Authentication).
[ArangoDB's authentication feature](../GeneralHttp/README.md#authentication).
!SECTION Select Functionality provided by the Web Interface
@ -71,7 +71,7 @@ service can be installed multiple times using different mount points.
The *Graphs* tab provides a viewer facility for graph data stored in ArangoDB. It
allows browsing ArangoDB graphs stored in the *_graphs* system collection or a
graph consisting of an arbitrary vertex and [edge collection](../Glossary/index.html#edge_collection).
graph consisting of an arbitrary vertex and [edge collection](../Glossary/README.md#edge-collection).
Please note that the graph viewer requires client-side SVG and that you need a
browser capable of rendering that. Especially Internet Explorer browsers older

4
js/apps/system/_api/gharial/APP/gharial.js
View File

@ -274,7 +274,7 @@
/// @RESTRETURNCODE{409}
/// Returned if there is a conflict storing the graph.
/// This can occur either if a graph with this name is already stored, or if there is one edge definition with a
/// the same [edge collection](../Glossary/index.html#edge_collection)
/// the same [edge collection](../Glossary/index.html#edge-collection)
/// but a different signature used in any other graph.
///
/// @EXAMPLES
@ -1629,7 +1629,7 @@
/// Creates a new edge in the collection.
/// Within the body the has to contain a *\_from* and *\_to* value referencing to valid vertices in the graph.
/// Furthermore the edge has to be valid in the definition of this
/// [edge collection](../Glossary/index.html#edge_collection).
/// [edge collection](../Glossary/index.html#edge-collection).
///
/// @RESTURLPARAMETERS
///

86
js/common/modules/org/arangodb/general-graph.js
View File

@ -435,7 +435,7 @@ AQLGenerator.prototype._edges = function(edgeExample, options) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -490,7 +490,7 @@ AQLGenerator.prototype.edges = function(example) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -546,7 +546,7 @@ AQLGenerator.prototype.outEdges = function(example) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -655,7 +655,7 @@ AQLGenerator.prototype._vertices = function(example, options, mergeWith) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -716,7 +716,7 @@ AQLGenerator.prototype.vertices = function(example) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -776,7 +776,7 @@ AQLGenerator.prototype.fromVertices = function(example) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -909,12 +909,12 @@ AQLGenerator.prototype.pathEdges = function() {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
/// * *direction*: The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
/// * *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition_of_examples)
/// * *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition-of-examples)
/// * *edgeCollectionRestriction* : One or a list of edge-collection names that should be
/// considered to be on the path.
/// * *vertexCollectionRestriction* : One or a list of vertex-collection names that should be
@ -1110,7 +1110,7 @@ AQLGenerator.prototype.restrict = function(restrictions) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -2200,7 +2200,7 @@ var updateBindCollections = function(graph) {
/// `graph.vertexCollectionName.remove(vertexId, options)`
///
/// Additionally removes all ingoing and outgoing edges of the vertex recursively
/// (see [edge remove](#edge.remove)).
/// (see [edge remove](#remove-an-edge)).
///
/// @PARAMS
///
@ -2730,7 +2730,7 @@ Graph.prototype._OUTEDGES = function(vertexId) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -2778,7 +2778,7 @@ Graph.prototype._edges = function(edgeExample) {
/// @PARAMS
///
/// @PARAM{examples, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
///
/// @EXAMPLES
///
@ -2941,12 +2941,12 @@ Graph.prototype._getVertexCollectionByName = function(name) {
/// @PARAMS
///
/// @PARAM{vertexExample, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](#definition-of-examples)
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
/// * *direction*: The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
/// * *edgeExamples*: Filter the edges, see [Definition of examples](#definition_of_examples)
/// * *neighborExamples*: Filter the neighbor vertices, see [Definition of examples](#definition_of_examples)
/// * *edgeExamples*: Filter the edges, see [Definition of examples](#definition-of-examples)
/// * *neighborExamples*: Filter the neighbor vertices, see [Definition of examples](#definition-of-examples)
/// * *edgeCollectionRestriction* : One or a list of edge-collection names that should be
/// considered to be on the path.
/// * *vertexCollectionRestriction* : One or a list of vertex-collection names that should be
@ -2998,7 +2998,7 @@ Graph.prototype._neighbors = function(vertexExample, options) {
///
/// This function returns the intersection of *graph_module._neighbors(vertex1Example, optionsVertex1)*
/// and *graph_module._neighbors(vertex2Example, optionsVertex2)*.
/// For parameter documentation see [_neighbors](#_neighbors).
/// For parameter documentation see [_neighbors](#neighbors).
///
/// The complexity of this method is **O(n\*m^x)** with *n* being the maximal amount of vertices
/// defined by the parameters vertexExamples, *m* the average amount of neighbors and *x* the
@ -3062,7 +3062,7 @@ Graph.prototype._commonNeighbors = function(vertex1Example, vertex2Example, opti
///
/// `graph._countCommonNeighbors(vertex1Example, vertex2Examples, optionsVertex1, optionsVertex2)`
///
/// Similar to [_commonNeighbors](#_commonNeighbors) but returns count instead of the elements.
/// Similar to [_commonNeighbors](#commonneighbors) but returns count instead of the elements.
///
/// @EXAMPLES
///
@ -3144,10 +3144,10 @@ Graph.prototype._countCommonNeighbors = function(vertex1Example, vertex2Example,
/// @PARAMS
///
/// @PARAM{vertex1Examples, object, optional}
/// Filter the set of source vertices, see [Definition of examples](#definition_of_examples)
/// Filter the set of source vertices, see [Definition of examples](#definition-of-examples)
///
/// @PARAM{vertex2Examples, object, optional}
/// Filter the set of vertices compared to, see [Definition of examples](#definition_of_examples)
/// Filter the set of vertices compared to, see [Definition of examples](#definition-of-examples)
///
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
@ -3208,7 +3208,7 @@ Graph.prototype._commonProperties = function(vertex1Example, vertex2Example, opt
///
/// `graph._countCommonProperties(vertex1Example, vertex2Examples, options)`
///
/// Similar to [_commonProperties](#_commonProperties) but returns count instead of
/// Similar to [_commonProperties](#commonproperties) but returns count instead of
/// the objects.
///
/// @EXAMPLES
@ -3344,17 +3344,17 @@ Graph.prototype._paths = function(options) {
/// representing the length.
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @PARAMS
///
/// @PARAM{startVertexExample, object, optional}
/// An example for the desired start Vertices
/// (see [Definition of examples](#definition_of_examples)).
/// (see [Definition of examples](#definition-of-examples)).
///
/// @PARAM{endVertexExample, object, optional}
/// An example for the desired
/// end Vertices (see [Definition of examples](#definition_of_examples)).
/// end Vertices (see [Definition of examples](#definition-of-examples)).
///
/// @PARAM{options, object, optional}
/// An object containing options, see below:
@ -3370,7 +3370,7 @@ Graph.prototype._paths = function(options) {
/// end vertex of a path.
/// * *edgeExamples* : A filter example for the
/// edges in the shortest paths
/// (see [example](#short_explaination_of_the_vertex_example_parameter)).
/// (see [example](#definition-of-examples)).
/// * *algorithm* : The algorithm to calculate
/// the shortest paths. If both start and end vertex examples are empty
/// [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is
@ -3435,7 +3435,7 @@ Graph.prototype._shortestPath = function(startVertexExample, endVertexExample, o
///
/// `graph._distanceTo(startVertexExample, endVertexExample, options)`
///
/// This function is a wrapper of [graph._shortestPath](#_shortestpath).
/// This function is a wrapper of [graph._shortestPath](#shortestpath).
/// It does not return the actual path but only the distance between two vertices.
///
/// @EXAMPLES
@ -3495,12 +3495,12 @@ Graph.prototype._distanceTo = function(startVertexExample, endVertexExample, opt
/// example as parameter for vertexExample.
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @PARAMS
///
/// @PARAM{vertexExample, object, optional}
/// Filter the vertices, see [Definition of examples](#definition_of_examples)
/// Filter the vertices, see [Definition of examples](#definition-of-examples)
///
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
@ -3511,7 +3511,7 @@ Graph.prototype._distanceTo = function(startVertexExample, endVertexExample, opt
/// considered for source vertices.
/// * *endVertexCollectionRestriction* : One or a list of vertex-collection names that should be
/// considered for target vertices.
/// * *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition_of_examples)
/// * *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition-of-examples)
/// * *algorithm*: The algorithm to calculate the shortest paths, possible values are
/// [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) and
/// [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
@ -3587,10 +3587,10 @@ Graph.prototype._absoluteEccentricity = function(vertexExample, options) {
///
/// `graph._eccentricity(vertexExample, options)`
///
/// Similar to [_absoluteEccentricity](#_absoluteeccentricity) but returns a normalized result.
/// Similar to [_absoluteEccentricity](#absoluteeccentricity) but returns a normalized result.
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @EXAMPLES
///
@ -3646,12 +3646,12 @@ Graph.prototype._eccentricity = function(options) {
/// example as parameter for *vertexExample*.
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @PARAMS
///
/// @PARAM{vertexExample, object, optional}
/// Filter the vertices, see [Definition of examples](#definition_of_examples)
/// Filter the vertices, see [Definition of examples](#definition-of-examples)
///
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
@ -3662,7 +3662,7 @@ Graph.prototype._eccentricity = function(options) {
/// considered for source vertices.
/// * *endVertexCollectionRestriction* : One or a list of vertex-collection names that should be
/// considered for target vertices.
/// * *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition_of_examples)
/// * *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition-of-examples)
/// * *algorithm*: The algorithm to calculate the shortest paths, possible values are
/// [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) and
/// [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
@ -3736,10 +3736,10 @@ Graph.prototype._absoluteCloseness = function(vertexExample, options) {
///
/// `graph._closeness(options)`
///
/// Similar to [_absoluteCloseness](#_absolutecloseness) but returns a normalized value.
/// Similar to [_absoluteCloseness](#absolutecloseness) but returns a normalized value.
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @EXAMPLES
///
@ -3801,12 +3801,12 @@ Graph.prototype._closeness = function(options) {
/// `graph._absoluteBetweenness(vertexExample, options)`
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @PARAMS
///
/// @PARAM{vertexExample, object, optional}
/// Filter the vertices, see [Definition of examples](#definition_of_examples)
/// Filter the vertices, see [Definition of examples](#definition-of-examples)
///
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
@ -3880,7 +3880,7 @@ Graph.prototype._absoluteBetweenness = function(example, options) {
///
/// `graph_module._betweenness(options)`
///
/// Similar to [_absoluteBetweeness](#_absolutebetweeness) but returns normalized values.
/// Similar to [_absoluteBetweeness](#absolutebetweenness) but returns normalized values.
///
/// @EXAMPLES
///
@ -3943,7 +3943,7 @@ Graph.prototype._betweenness = function(options) {
/// `graph._radius(options)`
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @PARAMS
///
@ -4023,7 +4023,7 @@ Graph.prototype._radius = function(options) {
/// `graph._diameter(graphName, options)`
///
/// The complexity of the function is described
/// [here](../Aql/GraphOperations.html#the_complexity_of_the_shortest_path_algorithms).
/// [here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
///
/// @PARAMS
///
@ -4630,12 +4630,12 @@ Graph.prototype._removeVertexCollection = function(vertexCollectionName, dropCol
/// @PARAMS
///
/// @PARAM{vertexExample1, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](Functions.md#definition-of-examples)
/// @PARAM{vertexExample2, object, optional}
/// See [Definition of examples](#definition_of_examples)
/// See [Definition of examples](Functions.md#definition-of-examples)
/// @PARAM{options, object, optional}
/// An object defining further options. Can have the following values:
/// * *edgeExamples*: Filter the edges, see [Definition of examples](#definition_of_examples)
/// * *edgeExamples*: Filter the edges, see [Definition of examples](Functions.md#definition-of-examples)
/// * *edgeCollectionRestriction* : One or a list of edge-collection names that should be
/// considered to be on the path.
/// * *vertex1CollectionRestriction* : One or a list of vertex-collection names that should be

62
js/server/modules/org/arangodb/aql.js
View File

@ -6709,15 +6709,15 @@ function IS_EXAMPLE_SET (example) {
/// representing the length.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///
/// * *graphName* : The name of the graph as a string.
/// * *startVertexExample* : An example for the desired start Vertices
/// (see [example](#short_explanation_of_the_example_parameter)).
/// (see [example](#short-explanation-of-the-example-parameter)).
/// * *endVertexExample* : An example for the desired
/// end Vertices (see [example](#short_explanation_of_the_example_parameter)).
/// end Vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* (optional) : An object containing the following options:
/// * *direction* : The direction of the edges as a string.
/// Possible values are *outbound*, *inbound* and *any* (default).
@ -6731,7 +6731,7 @@ function IS_EXAMPLE_SET (example) {
/// end vertex of a path.
/// * *edgeExamples* : A filter example for the
/// edges in the shortest paths
/// (see [example](#short_explanation_of_the_example_parameter)).
/// (see [example](#short-explanation-of-the-example-parameter)).
/// * *algorithm* : The algorithm to calculate
/// the shortest paths. If both start and end vertex examples are empty
/// [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is
@ -6952,7 +6952,7 @@ function AQL_TRAVERSAL (vertexCollection,
/// *Parameters*
/// * *graphName* : The name of the graph as a string.
/// * *startVertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *direction* : The direction of the edges as a string. Possible values
/// are *outbound*, *inbound* and *any* (default).
/// * *options*: Object containing optional options.
@ -7128,7 +7128,7 @@ function AQL_TRAVERSAL_TREE (vertexCollection,
///
/// `GRAPH_DISTANCE_TO (graphName, startVertexExample, endVertexExample, options)`
///
/// This function is a wrapper of [GRAPH\_SHORTEST\_PATH](#graph_shortest_path).
/// This function is a wrapper of [GRAPH\_SHORTEST\_PATH](#graphshortestpath).
/// It does not return the actual path but only the distance between two vertices.
///
/// @EXAMPLES
@ -7209,13 +7209,13 @@ function AQL_GRAPH_DISTANCE_TO (graphName,
///
/// * *graphName* : The name of the graph as a string.
/// * *startVertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *direction* : The direction of the edges as a string.
/// Possible values are *outbound*, *inbound* and *any* (default).
/// * *connectName* : The result attribute which
/// contains the connection.
/// * *options* (optional) : An object containing options, see
/// [Graph Traversals](../Aql/GraphOperations.html#graph_traversal):
/// [Graph Traversals](../Aql/GraphOperations.md#graphtraversal):
///
/// @EXAMPLES
///
@ -7485,14 +7485,14 @@ function AQL_NEIGHBORS (vertexCollection,
///
/// * *graphName* : The name of the graph as a string.
/// * *vertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* : An object containing the following options:
/// * *direction* : The direction
/// of the edges. Possible values are *outbound*, *inbound* and *any* (default).
/// * *edgeExamples* : A filter example for the edges to
/// the neighbors (see [example](#short_explanation_of_the_example_parameter)).
/// the neighbors (see [example](#short-explanation-of-the-example-parameter)).
/// * *neighborExamples* : An example for the desired neighbors
/// (see [example](#short_explanation_of_the_example_parameter)).
/// (see [example](#short-explanation-of-the-example-parameter)).
/// * *edgeCollectionRestriction* : One or multiple edge
/// collection names. Only edges from these collections will be considered for the path.
/// * *vertexCollectionRestriction* : One or multiple vertex
@ -7712,7 +7712,7 @@ function AQL_GRAPH_NEIGHBORS (graphName,
///
/// * *graphName* : The name of the graph as a string.
/// * *vertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* (optional) : An object containing the following options:
/// * *direction* : The direction
/// of the edges as a string. Possible values are *outbound*, *inbound* and *any* (default).
@ -7725,7 +7725,7 @@ function AQL_GRAPH_NEIGHBORS (graphName,
/// collection names. Only vertices from these collections will be considered as
/// end vertex of a path.
/// * *edgeExamples* : A filter example
/// for the edges (see [example](#short_explanation_of_the_example_parameter)).
/// for the edges (see [example](#short-explanation-of-the-example-parameter)).
/// * *minDepth* : Defines the minimal length of a path from an edge
/// to a vertex (default is 1, which means only the edges directly connected to a vertex would
/// be returned).
@ -7880,7 +7880,7 @@ function AQL_GRAPH_EDGES (graphName,
///
/// * *graphName* : The name of the graph as a string.
/// * *vertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* (optional) : An object containing the following options:
/// * *direction* : The direction of the edges as a string. Possible values are
/// *outbound*, *inbound* and *any* (default).
@ -7956,7 +7956,7 @@ function AQL_GRAPH_VERTICES (graphName,
/// Hence the default call would have a complexity of **O(n\*m)**;
///
/// For parameter documentation read the documentation of
/// [GRAPH_NEIGHBORS](#graph_neighbors).
/// [GRAPH_NEIGHBORS](#graphneighbors).
///
/// @EXAMPLES
///
@ -8094,9 +8094,9 @@ function AQL_GRAPH_COMMON_NEIGHBORS (graphName,
///
/// * *graphName* : The name of the graph as a string.
/// * *vertex1Example* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *vertex2Example* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* (optional) : An object containing the following options:
/// * *vertex1CollectionRestriction* : One or multiple vertex
/// collection names. Only vertices from these collections will be considered.
@ -8259,13 +8259,13 @@ function TRAVERSAL_ABSOLUTE_ECCENTRICITY_VISITOR (config, result, node, path) {
/// of the vertices defined by the examples.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///
/// * *graphName* : The name of the graph as a string.
/// * *vertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* (optional) : An object containing the following options:
/// * *direction* : The direction of the edges as a string.
/// Possible values are *outbound*, *inbound* and *any* (default).
@ -8278,7 +8278,7 @@ function TRAVERSAL_ABSOLUTE_ECCENTRICITY_VISITOR (config, result, node, path) {
/// collection names. Only vertices from these collections will be considered as
/// end vertex of a path.
/// * *edgeExamples* : A filter example for the edges in the
/// shortest paths (see [example](#short_explanation_of_the_example_parameter)).
/// shortest paths (see [example](#short-explanation-of-the-example-parameter)).
/// * *algorithm* : The algorithm to calculate
/// the shortest paths as a string. If vertex example is empty
/// [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is
@ -8372,7 +8372,7 @@ function TRAVERSAL_ECCENTRICITY_VISITOR (config, result, node, path) {
/// of the graphs vertices
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///
@ -8472,17 +8472,17 @@ function TRAVERSAL_ABSOLUTE_CLOSENESS_VISITOR (config, result, node, path) {
/// `GRAPH_ABSOLUTE_CLOSENESS (graphName, vertexExample, options)`
///
/// The GRAPH\_ABSOLUTE\_CLOSENESS function returns the
/// [closeness](http://en.wikipedia.org/wiki/Centrality#Closeness_centrality)
/// [closeness](http://en.wikipedia.org/wiki/Centrality#Closeness-centrality)
/// of the vertices defined by the examples.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///
/// * *graphName* : The name of the graph as a string.
/// * *vertexExample* : An example for the desired
/// vertices (see [example](#short_explanation_of_the_example_parameter)).
/// vertices (see [example](#short-explanation-of-the-example-parameter)).
/// * *options* : An object containing the following options:
/// * *direction* : The direction of the edges.
/// Possible values are *outbound*, *inbound* and *any* (default).
@ -8496,7 +8496,7 @@ function TRAVERSAL_ABSOLUTE_CLOSENESS_VISITOR (config, result, node, path) {
/// end vertex of a path.
/// * *edgeExamples* : A filter example for the
/// edges in the shortest paths (
/// see [example](#short_explanation_of_the_example_parameter)).
/// see [example](#short-explanation-of-the-example-parameter)).
/// * *algorithm* : The algorithm to calculate
/// the shortest paths. Possible values are
/// [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default)
@ -8630,11 +8630,11 @@ function TRAVERSAL_CLOSENESS_VISITOR (config, result, node, path) {
/// `GRAPH_CLOSENESS (graphName, options)`
///
/// The GRAPH\_CLOSENESS function returns the normalized
/// [closeness](http://en.wikipedia.org/wiki/Centrality#Closeness_centrality)
/// [closeness](http://en.wikipedia.org/wiki/Centrality#Closeness-centrality)
/// of graphs vertices.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///
@ -8742,7 +8742,7 @@ function AQL_GRAPH_CLOSENESS (graphName, options) {
/// of all vertices in the graph.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
///
/// * *graphName* : The name of the graph as a string.
@ -8838,7 +8838,7 @@ function AQL_GRAPH_ABSOLUTE_BETWEENNESS (graphName, options) {
/// of graphs vertices.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///
@ -8919,7 +8919,7 @@ function AQL_GRAPH_BETWEENNESS (graphName, options) {
/// of a graph.*
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// * *graphName* : The name of the graph as a string.
/// * *options* : An object containing the following options:
@ -9006,7 +9006,7 @@ function AQL_GRAPH_RADIUS (graphName, options) {
/// of a graph.
///
/// The complexity of the function is described
/// [here](#the_complexity_of_the_shortest_path_algorithms).
/// [here](#the-complexity-of-the-shortest-path-algorithms).
///
/// *Parameters*
///