From a27fef1a5cfc0b0febee34c1a12dfdd819a59358 Mon Sep 17 00:00:00 2001 From: Frank Celler Date: Mon, 13 Jun 2016 14:32:45 +0200 Subject: [PATCH 1/2] added reference pages --- .../Appendix/References/CollectionObject.mdpp | 50 +++++++++++++++++++ .../Manual/Appendix/References/DBObject.mdpp | 40 +++++++++++++++ .../Manual/Appendix/References/README.mdpp | 1 + .../Documents/DocumentMethods.mdpp | 6 --- Documentation/Books/Manual/SUMMARY.md | 3 ++ 5 files changed, 94 insertions(+), 6 deletions(-) create mode 100644 Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp create mode 100644 Documentation/Books/Manual/Appendix/References/DBObject.mdpp create mode 100644 Documentation/Books/Manual/Appendix/References/README.mdpp diff --git a/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp b/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp new file mode 100644 index 0000000000..e7373d4c28 --- /dev/null +++ b/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp @@ -0,0 +1,50 @@ +!CHAPTER The "collection" Object + +The following methods exists on the collection object (returned by *db.name*): + +*Collection* + +* [collection.checksum()](../../DataModeling/Collections/CollectionMethods.html#checksum) +* [collection.count()](../../DataModeling/Collections/CollectionMethods.html#count) +* [collection.drop()](../../DataModeling/Collections/CollectionMethods.html#drop) +* [collection.figures()](../../DataModeling/Collections/CollectionMethods.html#figures) +* [collection.load()](../../DataModeling/Collections/CollectionMethods.html#load) +* [collection.properties()](../../DataModeling/Collections/CollectionMethods.html#properties) +* [collection.reserve()](../../DataModeling/Collections/CollectionMethods.html#reserve) +* [collection.revision()](../../DataModeling/Collections/CollectionMethods.html#revision) +* [collection.rotate()](../../DataModeling/Collections/CollectionMethods.html#rotate) +* [collection.toArray()](../../DataModeling/Collections/CollectionMethods.html#toarray) +* [collection.truncate()](../../DataModeling/Collections/CollectionMethods.html#truncate) +* [collection.type()](../../DataModeling/Collections/CollectionMethods.html#type) +* [collection.unload()](../../DataModeling/Collections/CollectionMethods.html#unload) + +*Indexes* + +* [collection.dropIndex(index)](../../Indexing/WorkingWithIndexes.html#dropping-an-index) +* [collection.ensureIndex(description)](../../Indexing/WorkingWithIndexes.html#creating-an-index) +* [collection.getIndexes(name)](../../Indexing/WorkingWithIndexes.html#listing-all-indexes-of-a-collection) +* [collection.index(index)](../../Indexing/WorkingWithIndexes.html#index-identifiers-and-handles) + +*Document* + +* [collection.all()](../../DataModeling/Collections/CollectionMethods.html#all) +* [collection.any()](../../DataModeling/Collections/CollectionMethods.html#any) +* [collection.closedRange(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.html#closed-range) +* [collection.document(object)](../../DataModeling/Collections/CollectionMethods.html#document) +* [collection.documents(keys)](../../DataModeling/Collections/CollectionMethods.html#lookup-by-keys) +* [collection.edges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc) +* [collection.exists(object)](../../DataModeling/Collections/CollectionMethods.html#exists) +* [collection.firstExample(example)](../../DataModeling/Collections/CollectionMethods.html#first-example) +* [collection.inEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc) +* [collection.insert(data)](../../DataModeling/Collections/CollectionMethods.html#insert) +* [collection.iterate(iterator,options)](../../DataModeling/Collections/CollectionMethods.html#misc) +* [collection.outEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc) +* [collection.queryByExample(example)](../../DataModeling/Collections/CollectionMethods.html#query-by-example) +* [collection.range(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.html#range) +* [collection.remove(selector)](../../DataModeling/Collections/CollectionMethods.html#remove) +* [collection.removeByKeys(keys)](../../DataModeling/Collections/CollectionMethods.html#remove-by-keys) +* [collection.rename()](../../DataModeling/Collections/CollectionMethods.html#rename) +* [collection.replace(selector, data)](../../DataModeling/Collections/CollectionMethods.html#replace) +* [collection.replaceByExample(example, data)](../../DataModeling/Collections/CollectionMethods.html#replace-by-example) +* [collection.update(selector, data)](../../DataModeling/Collections/CollectionMethods.html#update) +* [collection.updateByExample(example, data)](../../DataModeling/Collections/CollectionMethods.html#update-by-example) diff --git a/Documentation/Books/Manual/Appendix/References/DBObject.mdpp b/Documentation/Books/Manual/Appendix/References/DBObject.mdpp new file mode 100644 index 0000000000..f8a27460ef --- /dev/null +++ b/Documentation/Books/Manual/Appendix/References/DBObject.mdpp @@ -0,0 +1,40 @@ +!CHAPTER The "db" Object + +*db.name* returns a [collection object](CollectionObject.md) for the collection *name*. + +The following methods exists on the *_db* object: + +*Database* + +* [db._createDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.html#create-database) +* [db._databases()](../../DataModeling/Databases/WorkingWith.html#list-databases) +* [db._dropDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.html#drop-database) +* [db._useDatabase(name)](../../DataModeling/Databases/WorkingWith.html#use-database) + +*Indexes* + +* [db._index(index)](../../Indexing/WorkingWithIndexes.html#fetching-an-index-by-handle) +* [db._dropIndex(index)](../../Indexing/WorkingWithIndexes.html#dropping-an-index) + +*Properties* + +* [db._id()](../../DataModeling/Databases/WorkingWith.html#id) +* [db._isSystem()](../../DataModeling/Databases/WorkingWith.html#issystem) +* [db._name()](../../DataModeling/Databases/WorkingWith.html#name) +* [db._path()](../../DataModeling/Databases/WorkingWith.html#path) +* [db._version()](../../DataModeling/Documents/DocumentMethods.html#get-the-version-of-arangodb) + +*Collection* + +* [db._collection(name)](../../DataModeling/Collections/DatabaseMethods.html#collection) +* [db._create(name)](../../DataModeling/Collections/DatabaseMethods.html#create) +* [db._drop(name)](../../DataModeling/Collections/DatabaseMethods.html#drop) +* [db._truncate(name)](../../DataModeling/Collections/DatabaseMethods.html#truncate) + +*Document* + +* [db._document(object)](../../DataModeling/Documents/DatabaseMethods.html#document) +* [db._exists(object)](../../DataModeling/Documents/DatabaseMethods.html#exists) +* [db._remove(selector)](../../DataModeling/Documents/DatabaseMethods.html#remove) +* [db._replace(selector,data)](../../DataModeling/Documents/DatabaseMethods.html#replace) +* [db._update(selector,data)](../../DataModeling/Documents/DatabaseMethods.html#update) diff --git a/Documentation/Books/Manual/Appendix/References/README.mdpp b/Documentation/Books/Manual/Appendix/References/README.mdpp new file mode 100644 index 0000000000..9fd57c431d --- /dev/null +++ b/Documentation/Books/Manual/Appendix/References/README.mdpp @@ -0,0 +1 @@ +!CHAPTER References \ No newline at end of file diff --git a/Documentation/Books/Manual/DataModeling/Documents/DocumentMethods.mdpp b/Documentation/Books/Manual/DataModeling/Documents/DocumentMethods.mdpp index b3017238cd..09279aa8b3 100644 --- a/Documentation/Books/Manual/DataModeling/Documents/DocumentMethods.mdpp +++ b/Documentation/Books/Manual/DataModeling/Documents/DocumentMethods.mdpp @@ -1224,9 +1224,3 @@ as second argument. ~ db._drop("example"); @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock accessViaGeoIndex - -`edge.setProperty(name, value)` - -Changes or sets the property *name* an *edges* to *value*. - - diff --git a/Documentation/Books/Manual/SUMMARY.md b/Documentation/Books/Manual/SUMMARY.md index 9613d3c0bd..2cb6a58e33 100644 --- a/Documentation/Books/Manual/SUMMARY.md +++ b/Documentation/Books/Manual/SUMMARY.md @@ -169,6 +169,9 @@ * [Incompatible changes in 2.3](ReleaseNotes/UpgradingChanges23.md) # * [Appendix](Appendix/README.md) + * [References](Appendix/References/README.md) + * [db](Appendix/References/DBObject.md) + * [collection](Appendix/References/CollectionObject.md) * [JavaScript Modules](Appendix/JavaScriptModules/README.md) * ["console"](Appendix/JavaScriptModules/Console.md) * ["fs"](Appendix/JavaScriptModules/FS.md) From 806f277eb1d00a7bc215c733c09aa7f8c4493968 Mon Sep 17 00:00:00 2001 From: Frank Celler Date: Mon, 13 Jun 2016 15:03:34 +0200 Subject: [PATCH 2/2] fixed manual errors --- .../Books/HTTP/Edge/WorkingWithEdges.mdpp | 2 +- Documentation/Books/Makefile | 2 +- .../Appendix/References/CollectionObject.mdpp | 76 +++++++++---------- .../Manual/Appendix/References/DBObject.mdpp | 40 +++++----- .../Rest/Graph Edges/API_EDGE_READ_ALL.md | 23 ------ 5 files changed, 60 insertions(+), 83 deletions(-) delete mode 100644 Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READ_ALL.md diff --git a/Documentation/Books/HTTP/Edge/WorkingWithEdges.mdpp b/Documentation/Books/HTTP/Edge/WorkingWithEdges.mdpp index 2bac4077b2..b48872275e 100644 --- a/Documentation/Books/HTTP/Edge/WorkingWithEdges.mdpp +++ b/Documentation/Books/HTTP/Edge/WorkingWithEdges.mdpp @@ -8,7 +8,7 @@ These attributes are mandatory and must contain the document-handle of the from and to vertices of an edge. Use the general document -[REST api](../Document/WorkingWithDocuments.html) +[REST api](../Document/WorkingWithDocuments.md) for create/read/update/delete. diff --git a/Documentation/Books/Makefile b/Documentation/Books/Makefile index 9b32ce82bb..2f9481da1a 100644 --- a/Documentation/Books/Makefile +++ b/Documentation/Books/Makefile @@ -55,7 +55,7 @@ ppbook-precheck-bad-code-sections: ppbook-check-html-link: @echo "##### checking for invalid HTML links in $(NAME)" - @echo "$(ALLBOOKS)" |sed -e 's; ;\n;g' |sed -e 's;^;/;' -e 's;$$;/;' > /tmp/books.regex + @echo "$(ALLBOOKS)" | tr " " "\n" | sed -e 's;^;/;' -e 's;$$;/;' > /tmp/books.regex @egrep -r '\[.*\]\(.*\)' ppbooks/$(NAME)|grep '\.md:'| grep 'html'| grep -v 'http://' | grep -v 'https://' | grep -v 'header.css' | grep -v -f /tmp/books.regex > /tmp/relative_html_links.txt ||true @if test "`cat /tmp/relative_html_links.txt |wc -l`" -gt 0; then \ diff --git a/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp b/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp index e7373d4c28..f883f82428 100644 --- a/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp +++ b/Documentation/Books/Manual/Appendix/References/CollectionObject.mdpp @@ -4,47 +4,47 @@ The following methods exists on the collection object (returned by *db.name*): *Collection* -* [collection.checksum()](../../DataModeling/Collections/CollectionMethods.html#checksum) -* [collection.count()](../../DataModeling/Collections/CollectionMethods.html#count) -* [collection.drop()](../../DataModeling/Collections/CollectionMethods.html#drop) -* [collection.figures()](../../DataModeling/Collections/CollectionMethods.html#figures) -* [collection.load()](../../DataModeling/Collections/CollectionMethods.html#load) -* [collection.properties()](../../DataModeling/Collections/CollectionMethods.html#properties) -* [collection.reserve()](../../DataModeling/Collections/CollectionMethods.html#reserve) -* [collection.revision()](../../DataModeling/Collections/CollectionMethods.html#revision) -* [collection.rotate()](../../DataModeling/Collections/CollectionMethods.html#rotate) -* [collection.toArray()](../../DataModeling/Collections/CollectionMethods.html#toarray) -* [collection.truncate()](../../DataModeling/Collections/CollectionMethods.html#truncate) -* [collection.type()](../../DataModeling/Collections/CollectionMethods.html#type) -* [collection.unload()](../../DataModeling/Collections/CollectionMethods.html#unload) +* [collection.checksum()](../../DataModeling/Collections/CollectionMethods.md#checksum) +* [collection.count()](../../DataModeling/Collections/CollectionMethods.md#count) +* [collection.drop()](../../DataModeling/Collections/CollectionMethods.md#drop) +* [collection.figures()](../../DataModeling/Collections/CollectionMethods.md#figures) +* [collection.load()](../../DataModeling/Collections/CollectionMethods.md#load) +* [collection.properties()](../../DataModeling/Collections/CollectionMethods.md#properties) +* [collection.reserve()](../../DataModeling/Collections/CollectionMethods.md#reserve) +* [collection.revision()](../../DataModeling/Collections/CollectionMethods.md#revision) +* [collection.rotate()](../../DataModeling/Collections/CollectionMethods.md#rotate) +* [collection.toArray()](../../DataModeling/Collections/CollectionMethods.md#toarray) +* [collection.truncate()](../../DataModeling/Collections/CollectionMethods.md#truncate) +* [collection.type()](../../DataModeling/Collections/CollectionMethods.md#type) +* [collection.unload()](../../DataModeling/Collections/CollectionMethods.md#unload) *Indexes* -* [collection.dropIndex(index)](../../Indexing/WorkingWithIndexes.html#dropping-an-index) -* [collection.ensureIndex(description)](../../Indexing/WorkingWithIndexes.html#creating-an-index) -* [collection.getIndexes(name)](../../Indexing/WorkingWithIndexes.html#listing-all-indexes-of-a-collection) -* [collection.index(index)](../../Indexing/WorkingWithIndexes.html#index-identifiers-and-handles) +* [collection.dropIndex(index)](../../Indexing/WorkingWithIndexes.md#dropping-an-index) +* [collection.ensureIndex(description)](../../Indexing/WorkingWithIndexes.md#creating-an-index) +* [collection.getIndexes(name)](../../Indexing/WorkingWithIndexes.md#listing-all-indexes-of-a-collection) +* [collection.index(index)](../../Indexing/WorkingWithIndexes.md#index-identifiers-and-handles) *Document* -* [collection.all()](../../DataModeling/Collections/CollectionMethods.html#all) -* [collection.any()](../../DataModeling/Collections/CollectionMethods.html#any) -* [collection.closedRange(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.html#closed-range) -* [collection.document(object)](../../DataModeling/Collections/CollectionMethods.html#document) -* [collection.documents(keys)](../../DataModeling/Collections/CollectionMethods.html#lookup-by-keys) -* [collection.edges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc) -* [collection.exists(object)](../../DataModeling/Collections/CollectionMethods.html#exists) -* [collection.firstExample(example)](../../DataModeling/Collections/CollectionMethods.html#first-example) -* [collection.inEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc) -* [collection.insert(data)](../../DataModeling/Collections/CollectionMethods.html#insert) -* [collection.iterate(iterator,options)](../../DataModeling/Collections/CollectionMethods.html#misc) -* [collection.outEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc) -* [collection.queryByExample(example)](../../DataModeling/Collections/CollectionMethods.html#query-by-example) -* [collection.range(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.html#range) -* [collection.remove(selector)](../../DataModeling/Collections/CollectionMethods.html#remove) -* [collection.removeByKeys(keys)](../../DataModeling/Collections/CollectionMethods.html#remove-by-keys) -* [collection.rename()](../../DataModeling/Collections/CollectionMethods.html#rename) -* [collection.replace(selector, data)](../../DataModeling/Collections/CollectionMethods.html#replace) -* [collection.replaceByExample(example, data)](../../DataModeling/Collections/CollectionMethods.html#replace-by-example) -* [collection.update(selector, data)](../../DataModeling/Collections/CollectionMethods.html#update) -* [collection.updateByExample(example, data)](../../DataModeling/Collections/CollectionMethods.html#update-by-example) +* [collection.all()](../../DataModeling/Collections/CollectionMethods.md#all) +* [collection.any()](../../DataModeling/Collections/CollectionMethods.md#any) +* [collection.closedRange(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.md#closed-range) +* [collection.document(object)](../../DataModeling/Collections/CollectionMethods.md#document) +* [collection.documents(keys)](../../DataModeling/Collections/CollectionMethods.md#lookup-by-keys) +* [collection.edges(vertex-id)](../../DataModeling/Collections/CollectionMethods.md#misc) +* [collection.exists(object)](../../DataModeling/Collections/CollectionMethods.md#exists) +* [collection.firstExample(example)](../../DataModeling/Collections/CollectionMethods.md#first-example) +* [collection.inEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.md#misc) +* [collection.insert(data)](../../DataModeling/Collections/CollectionMethods.md#insert) +* [collection.iterate(iterator,options)](../../DataModeling/Collections/CollectionMethods.md#misc) +* [collection.outEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.md#misc) +* [collection.queryByExample(example)](../../DataModeling/Collections/CollectionMethods.md#query-by-example) +* [collection.range(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.md#range) +* [collection.remove(selector)](../../DataModeling/Collections/CollectionMethods.md#remove) +* [collection.removeByKeys(keys)](../../DataModeling/Collections/CollectionMethods.md#remove-by-keys) +* [collection.rename()](../../DataModeling/Collections/CollectionMethods.md#rename) +* [collection.replace(selector, data)](../../DataModeling/Collections/CollectionMethods.md#replace) +* [collection.replaceByExample(example, data)](../../DataModeling/Collections/CollectionMethods.md#replace-by-example) +* [collection.update(selector, data)](../../DataModeling/Collections/CollectionMethods.md#update) +* [collection.updateByExample(example, data)](../../DataModeling/Collections/CollectionMethods.md#update-by-example) diff --git a/Documentation/Books/Manual/Appendix/References/DBObject.mdpp b/Documentation/Books/Manual/Appendix/References/DBObject.mdpp index f8a27460ef..5c1f960caf 100644 --- a/Documentation/Books/Manual/Appendix/References/DBObject.mdpp +++ b/Documentation/Books/Manual/Appendix/References/DBObject.mdpp @@ -6,35 +6,35 @@ The following methods exists on the *_db* object: *Database* -* [db._createDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.html#create-database) -* [db._databases()](../../DataModeling/Databases/WorkingWith.html#list-databases) -* [db._dropDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.html#drop-database) -* [db._useDatabase(name)](../../DataModeling/Databases/WorkingWith.html#use-database) +* [db._createDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.md#create-database) +* [db._databases()](../../DataModeling/Databases/WorkingWith.md#list-databases) +* [db._dropDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.md#drop-database) +* [db._useDatabase(name)](../../DataModeling/Databases/WorkingWith.md#use-database) *Indexes* -* [db._index(index)](../../Indexing/WorkingWithIndexes.html#fetching-an-index-by-handle) -* [db._dropIndex(index)](../../Indexing/WorkingWithIndexes.html#dropping-an-index) +* [db._index(index)](../../Indexing/WorkingWithIndexes.md#fetching-an-index-by-handle) +* [db._dropIndex(index)](../../Indexing/WorkingWithIndexes.md#dropping-an-index) *Properties* -* [db._id()](../../DataModeling/Databases/WorkingWith.html#id) -* [db._isSystem()](../../DataModeling/Databases/WorkingWith.html#issystem) -* [db._name()](../../DataModeling/Databases/WorkingWith.html#name) -* [db._path()](../../DataModeling/Databases/WorkingWith.html#path) -* [db._version()](../../DataModeling/Documents/DocumentMethods.html#get-the-version-of-arangodb) +* [db._id()](../../DataModeling/Databases/WorkingWith.md#id) +* [db._isSystem()](../../DataModeling/Databases/WorkingWith.md#issystem) +* [db._name()](../../DataModeling/Databases/WorkingWith.md#name) +* [db._path()](../../DataModeling/Databases/WorkingWith.md#path) +* [db._version()](../../DataModeling/Documents/DocumentMethods.md#get-the-version-of-arangodb) *Collection* -* [db._collection(name)](../../DataModeling/Collections/DatabaseMethods.html#collection) -* [db._create(name)](../../DataModeling/Collections/DatabaseMethods.html#create) -* [db._drop(name)](../../DataModeling/Collections/DatabaseMethods.html#drop) -* [db._truncate(name)](../../DataModeling/Collections/DatabaseMethods.html#truncate) +* [db._collection(name)](../../DataModeling/Collections/DatabaseMethods.md#collection) +* [db._create(name)](../../DataModeling/Collections/DatabaseMethods.md#create) +* [db._drop(name)](../../DataModeling/Collections/DatabaseMethods.md#drop) +* [db._truncate(name)](../../DataModeling/Collections/DatabaseMethods.md#truncate) *Document* -* [db._document(object)](../../DataModeling/Documents/DatabaseMethods.html#document) -* [db._exists(object)](../../DataModeling/Documents/DatabaseMethods.html#exists) -* [db._remove(selector)](../../DataModeling/Documents/DatabaseMethods.html#remove) -* [db._replace(selector,data)](../../DataModeling/Documents/DatabaseMethods.html#replace) -* [db._update(selector,data)](../../DataModeling/Documents/DatabaseMethods.html#update) +* [db._document(object)](../../DataModeling/Documents/DatabaseMethods.md#document) +* [db._exists(object)](../../DataModeling/Documents/DatabaseMethods.md#exists) +* [db._remove(selector)](../../DataModeling/Documents/DatabaseMethods.md#remove) +* [db._replace(selector,data)](../../DataModeling/Documents/DatabaseMethods.md#replace) +* [db._update(selector,data)](../../DataModeling/Documents/DatabaseMethods.md#update) diff --git a/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READ_ALL.md b/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READ_ALL.md deleted file mode 100644 index 5094c2c014..0000000000 --- a/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READ_ALL.md +++ /dev/null @@ -1,23 +0,0 @@ -@startDocuBlock API_EDGE_READ_ALL -@brief reads all edges from collection - -@RESTHEADER{GET /_api/document, Read all edges from collection} - -@RESTQUERYPARAMETERS - -@RESTQUERYPARAM{collection,string,required} -The name of the collection. - -@RESTDESCRIPTION -Returns an array of all URIs for all edges from the collection identified -by *collection*. - -@RESTRETURNCODES - -@RESTRETURNCODE{200} -All went good. - -@RESTRETURNCODE{404} -The collection does not exist. -@endDocuBlock -