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

Fixed merge conflict for generated files

This commit is contained in:
Michael Hackstein 2014-06-04 18:00:58 +02:00
parent 8ccad436ea 08f57f13b2
commit fa38738ea5
78 changed files with 2263 additions and 2247 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/Books/Users/book.json
View File

@ -1,3 +1,4 @@
{ {
"plugins": ["reveal"],
"theme": "./localtheme" "theme": "./localtheme"
} }

BIN
Documentation/Books/Users/localtheme/assets/fonts/fontawesome/fontawesome-webfont.eot
View File

Binary file not shown.

3
Documentation/ImplementorManual/NamingConventions.md
View File

@ -53,7 +53,8 @@ restrictions:
`_key` attribute from a document) `_key` attribute from a document)
- It must consist of the letters a-z (lower or upper case), the digits 0-9, - It must consist of the letters a-z (lower or upper case), the digits 0-9,
the underscore (_), dash (-), or colon (:) characters only the underscore (_), dash (-), or colon (:) characters only
- Any other characters, especially multi-byte sequences, whitespace or punctuation characters cannot be used inside key values - Any other characters, especially multi-byte sequences, whitespace or
punctuation characters cannot be used inside key values
- The key must be unique within the collection it is used - The key must be unique within the collection it is used
Keys are case-sensitive, i.e. `myKey` and `MyKEY` are considered to be Keys are case-sensitive, i.e. `myKey` and `MyKEY` are considered to be

411
Documentation/Makefile.files
View File

@ -14,94 +14,98 @@ OUTPUT_FOLDER=Doxygen/manuals/$(PACKAGE_VERSION)
################################################################################ ################################################################################
WIKI = \ WIKI = \
Aql \ AqlExamples Aql \
AqlExamples \
ArangoErrors \ ArangoErrors \
CommandLin \ CommandLine \
Communicati n \ Communication \
Compil ng \ Compiling \
CookbookClu ter \ CookbookCluster \
DbaM nual \ DbaManual \
DbaManualAuthenti ation \ DbaManualAuthentication \
DbaManua Basics \ DbaManualBasics \
DbaManualDatafile ebugger \ DbaManualDatafileDebugger \
DbaManualEmergen yConsole \ DbaManualEmergencyConsole \
umpManual \ DumpManual \
E tendingAql \ ExtendingAql \
FirstS epsArangoD \ FirstStepsArangoDB \
Glos ary \ Glossary \
Graphs \ Graphs \
Hand ingCollections \ HandlingCollections \
H ndlingDatabases \ HandlingDatabases \
andlingDocument \ HandlingDocuments \
HandlingEdges \ HandlingEndpoint \ HandlingEdges \
Ha dlingIndexes \ HandlingEndpoints \
Ho e \ HandlingIndexes \
HttpAq Functions \ Home \
Htt Batch \ HttpAqlFunctions \
Htt Collection \ HttpBatch \
ttpCursor \ HttpCollection \
H tpDatabase HttpCursor \
HttpEndpoi t \ HttpDatabase \
HttpGr ph \ HttpEndpoint \
Htt Import \ HttpGraph \
ttpIndex \ HttpImport \
HttpIndex \
HttpJob \ HttpJob \
HttpMi c \ HttpMisc \
HttpQuery \ HttpQuery \
HttpRepli ation \ HttpReplication \
Htt Sharding \ HttpSharding \
HttpSi ple \ HttpSimple \
HttpSyste \ HttpSystem \
HttpTr nsactions \ HttpTraversals \ HttpTransactions \
ttpUser \ HttpTraversals \
HttpUser \
ImpManual \ ImpManual \
Impleme torManual \ ImplementorManual \
Im lementorMa ualArangoErrors \ ImplementorManualArangoErrors \
IndexBi Array \ IndexBitArray \
In exCap \ IndexCap \
IndexF lltext \ IndexFulltext \
Index eo \ IndexGeo \
IndexH sh \ IndexHash \
IndexSkipli t \ IndexSkiplist \
InstallManua \ InstallManual \
Installing \ Installing \
JSModuleActi ns \ JSModuleActions \
JSModuleC uster \ JSModuleCluster \
JSModuleConso e \ JSModuleConsole \
JSModu eFs \ JSModuleFs \
JSModuleGrap \ JSModuleGraph \
JSModuleGen ralGraph \ JSModuleGeneralGraph \
JSM dules \ JSModules \
Naming onventions \ NamingConventions \
N wFeatures11 \ NewFeatures11 \
ewFeatures12 \ NewFeatures12 \
NewFeatures 3 \ NewFeatures13 \
NewFeatures14 \ NewFeatures14 \
N wFeatures20 \ NewFeatures20 \
NewFeat res21 \ NewFeatures21 \
RefMa ual \ RefManual \
Ref anualArangoErro s \ RefManualArangoErrors \
RefMa ualReplication RefManualReplication \
RestD cument \ RestDocument \
Res Edge \ RestEdge \
Restor Manual \ RestoreManual \
Sh rding \ Sharding \
Si pleQueries \ SimpleQueries \
Task \ Tasks \
ToolsManu l \ ToolsManual \
Transact ons \ Transactions \
Traver als \ Traversals \
Upgrad ng \ Upgrading \
Upgradi gGeneral \ UpgradingGeneral \
U grading11 \ Upgrading11 \
Upgrading12 \ Upgrading12 \
Upgr ding13 \ Upgrading13 \
Upgrading1 \ Upgrading14 \
Upgrading20 Upgrading20 \
Upgrading21 \ Upgrading21 \
UserMa ual \ UserManual \
UserManualAction \ UserManualActions \
UserManualArangosh \ UserManualFoxx \ UserManualArangosh \
UserManualFoxx \
UserManualFoxxManager \ UserManualFoxxManager \
UserManualReplication \ UserManualReplication \
UserManualWebInterface \ UserManualWebInterface \
@ -109,79 +113,82 @@ WIKI = \
################################################################################ ################################################################################
### @brief TOC files ### @brief TOC files
## ###################################### ###################################### ################################################################################
DOXYGEN_TOC = DOXYGEN_TOC = \
Documentation/DbaManual/DbaManual.md \ Documentation/DbaManual/DbaManual.md \
Documentation/ mplementorManual/ImplementorMa ual.md \ Documentation/ImplementorManual/ImplementorManual.md \
Documentation/InstallationMa ual/InstallationManual.md \ Documentation/InstallationManual/InstallationManual.md \
Documentation Manual/Home.md \ Documentation/Manual/Home.md \
Documentation/RefManua /RefManual.md \ Documentation/RefManual/RefManual.md \
Documentation/ToolsManual/ToolsManual.md \ Documentation/ToolsManual/ToolsManual.md \
Documentation/UserManual/UserManual.md \ Documentation/UserManual/UserManual.md \
Documentation/Manual/Upgrading.md Documentation/Manual/Upgrading.md
################################################################################ ################################################################################
### @brief install man pag s ### @brief install man pages
################################ ##################################### ######### ################################################################################
dist_man_MANS += \ dist_man_MANS += \
Docum ntation/man/man1/arangob.1 \ Documentation/man/man1/arangob.1 \
Documentat on/man/man1/arangodump.1 \ Documentation/man/man1/arangodump.1 \
Documen ation/man/man1/arangoimp.1 \ Documentation/man/man1/arangoimp.1 \
Docume tation/man/man1/arangorestore.1 \ Documentation/man/man1/arangorestore.1 \
Documentation/man/man1/arangosh.1 \ Documentation/man/man1/arangosh.1 \
D cumentation/man/man8/rcarangod.8 \ Documentation/man/man8/rcarangod.8 \
Documentation/man/man8/arangod.8 \ Documentation/man/man8/arangod.8 \
Documentation/man/man8/arango-dfdb.8 \ Documentation/man/man8/arango-dfdb.8 \
Documentation/man/man8/foxx-manager.8 Documentation/man/man8/foxx-manager.8
################################################################################ ################################################################################
### @brie JavaScript files ### @brief JavaScript files
#################### ################################## ######################## ################################################################################
DOXYGEN = \ Doxygen/js/actions/api-aqlfuncti n.c \ DOXYGEN = \
Doxygen/js/actions/api-clust r.c \ Doxygen/js/actions/api-aqlfunction.c \
Doxygen/js/actions/api-co lection.c \ Doxygen/js/actions/api-cluster.c \
Doxygen/js/actions/api cursor.c \ Doxygen/js/actions/api-collection.c \
Doxygen/js/actions/api database.c \ Doxygen/js/actions/api-cursor.c \
Doxygen/js/action /api-edges.c \ Doxygen/js/actions/api-database.c \
Doxygen/js/actio s/api-endpoint.c \ Doxygen/js/actions/api-edges.c \
Doxygen/js/a tions/api-explain.c \ Doxygen/js/actions/api-endpoint.c \
Doxygen/j /actions/api-foxx.c \ Doxygen/js/actions/api-explain.c \
Doxygen/js actions/api-graph.c \ Doxygen/js/actions/api-foxx.c \
Doxygen/js actions/api-index.c \ Doxygen/js/actions/api-graph.c \
Doxygen/js/acti ns/api-query.c \ Doxygen/js/actions/api-index.c \
Doxygen/js/actions api-simple.c \ Doxygen/js/actions/api-query.c \
Doxygen/js/acti ns/api-system.c \ Doxygen/js/actions/api-simple.c \
Doxygen/js/actions/api-tran action.c \ Doxygen/js/actions/api-system.c \
Doxygen/js/actions/api-traver al.c \ Doxygen/js/actions/api-transaction.c \
Doxygen/js/actions/api-user.c \ Doxygen/js/common/bootstrap/module-c nsole.c \ Doxygen/js/actions/api-traversal.c \
Doxygen/js/actions/api-user.c \
Doxygen/js/common/bootstrap/module-console.c \
Doxygen/js/common/bootstrap/module-fs.c \ Doxygen/js/common/bootstrap/module-fs.c \
Do ygen/js/common/bootstrap/modules.c \ Doxygen/js/common/bootstrap/modules.c \
Doxygen/js/common/modules/js nity.c \ Doxygen/js/common/modules/jsunity.c \
Doxygen/js/common/modules/org/arangodb/aql/functions.c \ Doxygen/js/common/modules/org/arangodb/aql/functions.c \
Doxygen/js/common/modules/org/arangodb/graph/algorithms-common.c \ Doxygen/js/common/modules/org/arangodb/arango-collecti n-common.c \ Doxygen/js/common/modules/org/arangodb/graph/algorithms-common.c \
Doxygen/js/common/modules/org/arangodb/arango-statem nt-common.c \ Doxygen/js/common/modules/org/arangodb/arango-collection-common.c \
Doxygen/js/common/modules/org/arangodb/graph-co mon.c \ Doxygen/js/common/modules/org/arangodb/arango-statement-common.c \
Doxygen/js/common/modules/org/arangodb/gr ph/algorithms-common.c \ Doxygen/js/common/modules/org/arangodb/graph-common.c \
Doxygen/js/common/modules/org/aran odb/simple-query-common.c \ Doxygen/js/common/modules/org/arangodb/graph/algorithms-common.c \
Doxygen/js/server/modules/org arangodb/actions.c \ Doxygen/js/common/modules/org/arangodb/simple-query-common.c \
Doxygen/js/server/modules org/arangodb/arango-collection.c \ Doxygen/js/server/modules/org/arangodb/actions.c \
Doxygen/js/server/modules/ rg/arangodb/arango-database.c \ Doxygen/js/server/modules/org/arangodb/arango-collection.c \
Doxygen/js/server/modules/org/ rangodb/foxx.c \ Doxygen/js/server/modules/org/arangodb/arango-database.c \
Doxygen/js/server/modules/org/arangodb/f xx/authentication.c \ Doxygen/js/server/modules/org/arangodb/foxx.c \
Doxygen/js/server/modules/org/arangodb/fox /base_middleware.c \ Doxygen/js/server/modules/org/arangodb/foxx/authentication.c \
Doxygen/js/server/modules/org/arang db/foxx/controller.c \ Doxygen/js/server/modules/org/arangodb/foxx/base_middleware.c \
Doxygen/js/server/modules/org arangodb/foxx/format_middleware.c \ Doxygen/js/server/modules/org/arangodb/foxx/controller.c \
Doxygen/js/server/mod les/org/arangodb/foxx/internals.c \ Doxygen/js/server/modules/org/arangodb/foxx/format_middleware.c \
Doxygen/js/server/modules/ rg/arangodb/foxx/model.c \ Doxygen/js/server/modules/org/arangodb/foxx/internals.c \
Doxygen/js/server/modules/org/arangodb/ oxx/repository.c \ Doxygen/js/server/modules/org/arangodb/foxx/model.c \
Doxygen/js/server/modules/org/arangodb foxx/request_context.c \ Doxygen/js/server/modules/org/arangodb/foxx/repository.c \
Doxygen/js/server/modules/org arangodb/foxx/template_middleware.c \ Doxygen/js/server/modules/org/arangodb/foxx/request_context.c \
Doxygen/js/ erver/modules/org/arangodb/graph-blueprint.c \ Doxygen/js/server/modules/org/arangodb/foxx/template_middleware.c \
Doxygen/js server/modules/org/arangodb/simple-query.c \ Doxygen/js/server/modules/org/arangodb/graph-blueprint.c \
Doxygen/js/serve /modules/org/arangodb/cluster.c \ Doxygen/js/server/modules/org/arangodb/simple-query.c \
Doxygen/js/server/modules/org/arangodb/cluster.c \
Doxygen/js/server/modules/org/arangodb/cluster/planner.c \ Doxygen/js/server/modules/org/arangodb/cluster/planner.c \
Doxygen/js/server/modules/org/arangodb/cluster/kickstarter.c \ Doxygen/js/server/modules/org/arangodb/cluster/kickstarter.c \
Doxygen/js/server/server.c Doxygen/js/server/server.c
@ -191,120 +198,121 @@ DOXYGEN = \ Doxygen/js/actions/api-aqlfuncti n.c \
## ----------------------------------------------------------------------------- ## -----------------------------------------------------------------------------
################################################################################ ################################################################################
### @brief di ectory setup ### @brief directory setup
############################### ################################################ ################################################################################
.P ONY: doxygen-create-directories .PHONY: doxygen-create-directories
doxygen-create-directorie : doxygen-create-directories:
@test -d Doxygen/doc || mkdir -p Doxygen/doc @test -d Doxygen/doc || mkdir -p Doxygen/doc
@test -d Doxygen/website || mkdir -p Doxygen/website @test -d Doxygen/website || mkdir -p Doxygen/website
@test -d Doxygen/js/actions || mkdir -p Doxygen/js/actions @test -d Doxygen/js/actions || mkdir -p Doxygen/js/actions
@test -d Doxygen/js/ ommon/bootstrap || mkdir -p Doxygen/js/common/bootstrap @test -d Doxygen/js/common/bootstrap || mkdir -p Doxygen/js/common/bootstrap
@test -d Doxygen/js/common/modules/org/arangodb/aql | mkdir -p Doxygen/js/common/modules/org/arangodb/aql @test -d Doxygen/js/common/modules/org/arangodb/aql || mkdir -p Doxygen/js/common/modules/org/arangodb/aql
@test -d Doxygen/js/common/modules/org/arangodb/graph | mkdir -p Doxygen/js/common/modules/org/arangodb/graph @test -d Doxygen/js/common/modules/org/arangodb/graph || mkdir -p Doxygen/js/common/modules/org/arangodb/graph
@test -d Doxygen/js/server/modules/org/arangodb/foxx | mkdir -p Doxygen/js/server/modules/org/arangodb/foxx @test -d Doxygen/js/server/modules/org/arangodb/foxx || mkdir -p Doxygen/js/server/modules/org/arangodb/foxx
@test -d Doxygen/js/server/modules/org/arangodb/graph || m dir -p Doxygen/js/server/modules/org/arangodb/graph @test -d Doxygen/js/server/modules/org/arangodb/graph || mkdir -p Doxygen/js/server/modules/org/arangodb/graph
@te t -d Doxygen/js/server/modules/org/arangodb/cluster || mkdir -p Doxygen/js/server/modules/org/arangodb/cluste @test -d Doxygen/js/server/modules/org/arangodb/cluster || mkdir -p Doxygen/js/server/modules/org/arangodb/cluster
@test -d Doxygen/js/client || mkdir -p Doxygen/js/client @test -d Doxygen/js/client || mkdir -p Doxygen/js/client
@test -d Doxygen/man/man1 || mkdir -p Doxygen/man/man1 @test -d Doxygen/man/man1 || mkdir -p Doxygen/man/man1
@test -d Doxygen/man/man8 || mkdir -p Doxygen/man/man8 @test -d Doxygen/man/man8 || mkdir -p Doxygen/man/man8
@test -d Doxygen/xml || mkdir p Doxygen/xml @test -d Doxygen/xml || mkdir -p Doxygen/xml
.PHONY: Doxygen/js Doxygen/js/system Doxygen/js/modules .PHONY: Doxygen/js Doxygen/js/system Doxygen/js/modules
BUILT_SOURCES = Doxygen/.setup-directories BUILT_SOURCES += Doxygen/.setup-directories
Doxygen/.setup-directories: doxygen-create-directories Doxygen/.setup-directories: doxygen-create-directories
@touch $@ @touch $@
Doxygen/js/actions/%.c: @srcdir@/js/actions/%.js Doxygen/.s tup-directories Doxygen/js/actions/%.c: @srcdir@/js/actions/%.js Doxygen/.setup-directories
@python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@ @python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@
Doxygen/js/common/bootstrap/%.c: @srcdir@/js/common/bootstrap/%.js Doxyg n/.setup-directories Doxygen/js/common/bootstrap/%.c: @srcdir@/js/common/bootstrap/%.js Doxygen/.setup-directories
@python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@ @python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@
Doxygen/js/common/modules/%.c: @srcdir@/js/common/m dules/%.js Doxygen/.setup-directories Doxygen/js/common/modules/%.c: @srcdir@/js/common/modules/%.js Doxygen/.setup-directories
@python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@ @python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@
Doxygen/js/server/%.c: @srcdir@/js/server/%.js Dox gen/.setup-directories Doxygen/js/server/%.c: @srcdir@/js/server/%.js Doxygen/.setup-directories
@python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@ @python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@
Doxygen/js/ erver/modules/%.c: @srcdir@/js/server/modules/%.js Doxygen/.setup-directories Doxygen/js/server/modules/%.c: @srcdir@/js/server/modules/%.js Doxygen/.setup-directories
@python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@ @python @top_srcdir@/Documentation/Scripts/js2doxy.py $< > $@
Doxygen/xml/%.md: Doxygen/xml/%.xml Doxygen/xml/%.md: Doxygen/xml/%.xml
@python @top_srcdir@/Doxygen/Scripts/xml2md.py $< > $@ @python @top_srcdir@/Doxygen/Scripts/xml2md.py $< > $@
######################################## ####################################### ################################################################################
### @brief doxygen toc ### @brief doxygen toc
################################ ############################################### ################################################################################
.PHONY: doxygen-toc .PHONY: doxygen-toc
doxygen-toc: doxygen-toc:
pyth n @top_srcdir@/Documentation/Scripts/generateTOC.py $(DOXYGEN_TOC) >> Doxygen/toc.doxy.tmp python @top_srcdir@/Documentation/Scripts/generateTOC.py $(DOXYGEN_TOC) >> Doxygen/toc.doxy.tmp
cmp -s Doxygen/toc.doxy Doxygen/toc.doxy.tmp || mv Doxygen/toc.doxy.tmp Doxygen/toc.doxy cmp -s Doxygen/toc.doxy Doxygen/toc.doxy.tmp || mv Doxygen/toc.doxy.tmp Doxygen/toc.doxy
@rm -f Doxygen/toc.doxy.tmp @rm -f Doxygen/toc.doxy.tmp
Doxygen/toc.doxy: doxygen-toc Doxygen/toc.doxy: doxygen-toc
################################################################################ ################################################################################
### @bri f doxygen ### @brief doxygen
################################################################################ ################################################################################
.PHONY: doxygen .PHONY: doxygen
Doxyg n/arango-html.doxy: Documentation/arango.template Doxygen/toc.doxy Doxygen/arango-html.doxy: Documentation/arango.template Doxygen/toc.doxy
sed -e 's:GENERATE_HTML *= *NO: ENERATE_HTML = YES:' -e 's:ENABL D_SECTIONS *=:ENABLED_SECTIONS = HTML:' < $< $@ sed -e 's:GENERATE_HTML *= *NO:GENERATE_HTML = YES:' -e 's:ENABLED_SECTIONS *=:ENABLED_SECTIONS = HTML:' < $< > $@
cat Doxygen/toc.doxy >> $@ cat Doxygen/toc.doxy >> $@
doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN) doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN)
$(MAKE) lib/BasicsC/voc-error .h $(MAKE) lib/BasicsC/voc-errors.h
doxygen Doxygen/arango-html.doxy > /dev/null doxygen Doxygen/arango-html.doxy > /dev/null
@for w n $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh -keep-title Doxygen/html/$$w.html Doxygen/website/$$w.html; done @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --keep-title Doxygen/html/$$w.html Doxygen/website/$$w.html; done
cp -R @top_srcdir@/Documentation/images/* Doxygen/website/ cp -R @top_srcdir@/Documentation/images/* Doxygen/website/
cp -R @top_srcdir /Documentation/arangodb.css Doxygen/website cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/website
@for w i $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html --keep-title Doxygen/html/$$w.html Doxygen/doc/$$w.html; done @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html --keep-title Doxygen/html/$$w.html Doxygen/doc/$$w.html; done
cp -R @top_srcdir@/Documentation/images/* Doxygen/doc/ cp -R @top_srcdir@/Documentation/images/* Doxygen/doc/
cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/doc cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/doc
############################################################################ ### ################################################################################
### @brief latex ### @brief latex
################################################################################ ################################################################################
.PHONY: latex .PHONY: latex
Doxygen/arango-latex.doxy: Documentation/arango.template Doxygen/toc.doxy
sed -e 's:GENERATE_LATE *= *NO:GENERATE_LATEX = YES:' - 's:ENABLED_SECTIONS *=:ENABLED_SECTIONS = LAT X:' < $< > $@ Doxygen/arango-latex.doxy: Documentation/arango.template Doxygen/toc.doxy
sed -e 's:GENERATE_LATEX *= *NO:GENERATE_LATEX = YES:' -e 's:ENABLED_SECTIONS *=:ENABLED_SECTIONS = LATEX:' < $< > $@
cat Doxygen/toc.doxy >> $@ cat Doxygen/toc.doxy >> $@
lat x: Doxygen/.setup-directories Doxygen/arango-latex.doxy $(DOXYGEN) latex: Doxygen/.setup-directories Doxygen/arango-latex.doxy $(DOXYGEN)
$(MAKE) lib/BasicsC/voc-errors.h $(MAKE) lib/BasicsC/voc-errors.h
doxygen Doxygen/aran o-latex.doxy > /dev/null doxygen Doxygen/arango-latex.doxy > /dev/null
cp -R Documentation/latex/*.tex Doxygen/latex cp -R Documentation/latex/*.tex Doxygen/latex
pyth n @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/InstallManual.tex > Doxygen/latex/InstallManual.inc.te python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/InstallManual.tex > Doxygen/latex/InstallManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode install-manual.tex || rue cd Doxygen/latex && pdflatex -interaction batchmode install-manual.tex || true
python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/UserManual.tex > Doxygen/latex/UserManual.inc.tex python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/UserManual.tex > Doxygen/latex/UserManual.inc.tex
cd Dox gen/latex && pdflatex -interaction batchmode user-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode user-manual.tex || true
python @top_ rcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/ImplementorManual.tex > Doxygen/latex/ImplementorManual.inc. ex python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/ImplementorManual.tex > Doxygen/latex/ImplementorManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode implementor-manual. ex || true cd Doxygen/latex && pdflatex -interaction batchmode implementor-manual.tex || true
python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/RefManual.tex > Doxygen/latex/RefM nual.inc.tex python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/RefManual.tex > Doxygen/latex/RefManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode ref-manua .tex || true cd Doxygen/latex && pdflatex -interaction batchmode ref-manual.tex || true
python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/DbaManual.tex > Doxygen/latex/DbaMan al.inc.tex python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/DbaManual.tex > Doxygen/latex/DbaManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode dba-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode dba-manual.tex || true
python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/ToolsManual.tex > Doxygen/latex/ToolsManual.inc.tex python @top_srcdir@/Documentation/Scripts/tex2tex.py Doxygen/latex/ToolsManual.tex > Doxygen/latex/ToolsManual.inc.tex
cd Doxygen/latex && pdflatex -interaction batchmode tools-manual.tex || true cd Doxygen/latex && pdflatex -interaction batchmode tools-manual.tex || true
################### ############################################################ ################################################################################
### @brief man pages ### @brief man pages
################################################################################ ################################################################################
@ -317,36 +325,36 @@ man: Doxygen/.setup-directories
## --SECTION-- EXAMPLES ## --SECTION-- EXAMPLES
## ----------------------------------------------------------------------------- ## -----------------------------------------------------------------------------
######################## ####################################################### ################################################################################
### @brief generate json for swagger REST-API ### @brief generate json for swagger REST-API
################################################################### ############ ################################################################################
.PHONY: swagger .PHONY: swagger
swagger: swagger:
(python @srcdir@/Documentation/Scripts/generateSwaggerApi.py @srcdir@ @srcdir@/js/apps/system/aardvark/api-docs api-docs) > @srcdir@/js/apps/system/aardvark/api-docs.json (python @srcdir@/Documentation/Scripts/generateSwaggerApi.py @srcdir@ @srcdir@/js/apps/system/aardvark/api-docs api-docs) > @srcdir@/js/apps/system/aardvark/api-docs.json
####### ############################## ######################################### ################################################################################
### @brief genera e examples ### @brief generate examples
##################################### ########################################## ################################################################################
.PHONY: examples .PHONY: examples
exampl s: examples:
@rm -f /tmp/arangodb.e amples @rm -f /tmp/arangodb.examples
python @srcdir@/Documentation/ cripts/generateExamples.py \ python @srcdir@/Documentation/Scripts/generateExamples.py \
--output- ir @builddir@/Documentation/Examples \ --output-dir @builddir@/Documentation/Examples \
--aran osh-setup @srcdir@/Documentation/Exa ples/setup-arangosh.js \ --arangosh-setup @srcdir@/Documentation/Examples/setup-arangosh.js \
@srcdir@/js/actions/*.js @srcdir@/js/actions/*.js \
@srcdir@/Documentation/DbaManual/*.md \ @srcdir@/Documentation/DbaManual/*.md \
@srcdir@/Documentation/UserManual/*.md \ @srcdir@/Documentation/UserManual/*.md \
@srcdir@/Documentation/ImplementorManual/*.md \ @srcdir@/Documentation/ImplementorManual/*.md \
@src ir@/arangod/RestHandler/* cpp @srcdir@/arangod/RestHandler/*.cpp \
@srcdir@/lib/Admin/*.cpp \ @srcdir@/lib/Admin/*.cpp \
> /tmp/a angosh.examples > /tmp/arangosh.examples
$(MA E) start-server PID=$(PID) SERVER_START="--serv r.endpoint tcp://$(VOCHOST):$(VOCPORT) --server.disable-authentication true" PROTO=http $(MAKE) start-server PID=$(PID) SERVER_START="--server.endpoint tcp://$(VOCHOST):$(VOCPORT) --server.disable-authentication true" PROTO=http
@builddir@/bin/arangosh \ @builddir@/bin/arangosh \
@ -366,7 +374,7 @@ exampl s:
.PHONY: documentation-complete .PHONY: documentation-complete
ocumentation-complete: doxygen examples swagger documentation-complete: doxygen examples swagger
################################################################################ ################################################################################
### @brief cleanup ### @brief cleanup
@ -377,29 +385,30 @@ CLEANUP += \
Doxygen/* Doxygen/*
################# ################################ ############################# ################################################################################
## publish ## publish
##################################### ############### ########################## ################################################################################
.PHO Y: publish publish-html publish-pdf publish-copy .PHONY: publish publish-html publish-pdf publish-copy
publish: publish-html ublish-pdf publish: publish-html publish-pdf
make publish-copy make publish-copy
publish-copy: publish-copy:
cd Doxygen/manuals && scp -r "$(PACKAGE_VERSION)" $(MANUAL_DST) cd Doxygen/manuals && scp -r "$(PACKAGE_VERSION)" $(MANUAL_DST)
publish-ht l: publish-html:
$(MAKE) doxygen $(MAKE) doxygen
mkdir -p $(OUTPUT_FOLDER)/images mkdir -p $(OUTPUT_FOLDER)/images
@for w in $(WIKI); do cp Doxygen/website/$ w.html $(OUTP T_FOLDER); done @for w in $(WIKI); do cp Doxygen/website/$$w.html $(OUTPUT_FOLDER); done
@for i in `ls Doxygen/website/* png`; do cp $$i $(OUTPUT_FOLDER)/; done @for i in `ls Doxygen/website/*.png`; do cp $$i $(OUTPUT_FOLDER)/; done
@cp Doxygen/web ite/arangodb.css $(OUTPUT_FOLDER) @cp Doxygen/website/arangodb.css $(OUTPUT_FOLDER)
@cp Documentation Manual/shell_reference_card.pdf $(OUTPUT_FOLDER) @cp Documentation/Manual/shell_reference_card.pdf $(OUTPUT_FOLDER)
publish-pdf: $(OUTPUT_FOLDER)
publish-pdf: $(OUTPUT_FOLDER)
$(MAKE) latex $(MAKE) latex
cp Doxygen/latex/dba-manual.pdf $(OUTPUT_FOLDER) cp Doxygen/latex/dba-manual.pdf $(OUTPUT_FOLDER)
cp oxygen/latex/implementor-manual.pdf $(OUTPUT_FOLDER) cp Doxygen/latex/implementor-manual.pdf $(OUTPUT_FOLDER)
cp Doxygen/latex/install-manual.pdf $(OUTPUT_FOLDER) cp Doxygen/latex/install-manual.pdf $(OUTPUT_FOLDER)
cp Doxygen/latex/user-manual.pdf $(OUTPUT_FOLDER) cp Doxygen/latex/user-manual.pdf $(OUTPUT_FOLDER)
cp Doxygen/latex/ref-manual.pdf $(OUTPUT_FOLDER) cp Doxygen/latex/ref-manual.pdf $(OUTPUT_FOLDER)

9
Documentation/RefManual/Actions.md
View File

@ -310,8 +310,9 @@ You can write the following document into the `_routing` collection
to test the above examples. to test the above examples.
{ {
routes: [ { url: { match: "/hello/world" }, content: "route 1" } routes: [
{ url: { match: "/hello/:name|:id", constraint: { name: "/[a-z]+/", id: "/[0-9]+/" } }, content: "route 2" , { url: { match: "/hello/world" }, content: "route 1" },
{ url: { match: "/hello/:name|:id", constraint: { name: "/[a-z]+/", id: "/[0-9]+/" } }, content: "route 2" },
{ url: { match: "/:something/world" }, content: "route 3" }, { url: { match: "/:something/world" }, content: "route 3" },
{ url: { match: "/hello/*" }, content: "route 4" }, { url: { match: "/hello/*" }, content: "route 4" },
] ]
@ -357,8 +358,8 @@ Static Content{#UserManualActionsContentStatic}
You can specify a body and a content-type. You can specify a body and a content-type.
{ {
conten : { content: {
contentType: "text/h ml", contentType: "text/html",
body: "<html><body>Hello World</body></html>" body: "<html><body>Hello World</body></html>"
} }
} }

3
Documentation/RefManual/JSModuleJSUnity.md
View File

@ -17,7 +17,8 @@ Assume that you have a test file containing
function aqlTestSuite () { function aqlTestSuite () {
return { return {
testSizeOfTestCollection : function () { assertEqual(5, 5); testSizeOfTestCollection : function () {
assertEqual(5, 5);
}; };
} }

7
Documentation/Scripts/js2doxy.py
View File

@ -101,7 +101,8 @@ for line in f:
if m: if m:
if fn: if fn:
func = "void " + fn + " (" fn = Non func = "void " + fn + " ("
fn = None
else: else:
name = m.group(1) name = m.group(1)
func = "void JSF_" + name + " (" func = "void JSF_" + name + " ("
@ -126,10 +127,10 @@ for line in f:
# check for function assigment # check for function assigment
m = r4.match(line) m = r4.match(line)
if : if m:
if fn: if fn:
func = "void " + fn + " (" func = "void " + fn + " ("
fn = one fn = None
else: else:
name = m.group(1) name = m.group(1)
func = "void JSF_" + string.replace(name, '.', '_') + " (" func = "void JSF_" + string.replace(name, '.', '_') + " ("

26
Documentation/UserManual/Aql.md
View File

@ -351,7 +351,8 @@ attribute naming conventions.
FOR u IN users FOR u IN users
FOR f IN friends FOR f IN friends
FILTER u.active == true && f.active == true && u.id == f.userId RETURN u.name FILTER u.active == true && f.active == true && u.id == f.userId
RETURN u.name
In the above example, the attribute names `active`, `name`, `id`, and `userId` In the above example, the attribute names `active`, `name`, `id`, and `userId`
are qualified using the collection names they belong to (`u` and `f` are qualified using the collection names they belong to (`u` and `f`
@ -542,7 +543,7 @@ type of bind parameter has a name prefixed with an additional `@` symbol (thus
when using the bind parameter in a query, two `@` symbols must be used). when using the bind parameter in a query, two `@` symbols must be used).
FOR u IN @@collection FOR u IN @@collection
FILTER u.active == tru FILTER u.active == true
RETURN u RETURN u
Type and value order {#AqlTypeOrder} Type and value order {#AqlTypeOrder}
@ -1381,7 +1382,8 @@ AQL supports the following functions to operate on document values:
) )
[ [
{ "user1" : { "name" : "J" }, "user2" : { "name" : "T" } } { "user1" : { "name" : "J" },
"user2" : { "name" : "T" } }
] ]
When merging documents with identical attribute names, the attribute values of the When merging documents with identical attribute names, the attribute values of the
@ -1979,7 +1981,7 @@ nested, a cross product of the list elements returned by the individual `FOR`
statements will be created. statements will be created.
FOR u IN users FOR u IN users
FOR l IN locati ns FOR l IN locations
RETURN { "user" : u, "location" : l } RETURN { "user" : u, "location" : l }
In this example, there are two list iterations: an outer iteration over the list In this example, there are two list iterations: an outer iteration over the list
@ -2116,12 +2118,12 @@ making the whole query more readable.
FOR u IN users FOR u IN users
LET friends = ( LET friends = (
FOR f IN fri nds FOR f IN friends
FILTER u.id == f. serId FILTER u.id == f.userId
RETURN f RETURN f
) )
LET membersh ps = ( LET memberships = (
FOR m IN mem erships FOR m IN memberships
FILTER u.id == m.userId FILTER u.id == m.userId
RETURN m RETURN m
) )
@ -2183,10 +2185,10 @@ It is required that subqueries be put inside parentheses `(` and `)` to
explicitly mark their start and end points: explicitly mark their start and end points:
FOR u IN users FOR u IN users
LET recommenda ions = ( LET recommendations = (
FOR r IN reco mendations FOR r IN recommendations
FILTER u.id == r.userId FILTER u.id == r.userId
SOR u.rank DE C SORT u.rank DESC
LIMIT 10 LIMIT 10
RETURN r RETURN r
) )
@ -2195,7 +2197,7 @@ explicitly mark their start and end points:
FOR u IN users FOR u IN users
COLLECT city = u.city INTO g COLLECT city = u.city INTO g
RETURN { "city" : city, "numUsers" : LENGTH(g), "m xRating": M X( RETURN { "city" : city, "numUsers" : LENGTH(g), "maxRating": MAX(
FOR r IN g FOR r IN g
RETURN r.user.rating RETURN r.user.rating
) } ) }

46
Documentation/UserManual/FirstStepsArangoDB.md
View File

@ -322,22 +322,22 @@ Now extract all elements:
[ [
{ {
_id : "example/6308263", _id : "example/6308263",
_key : "1 93214", _key : "1993214",
_rev : " 993214", _rev : "1993214",
ge : 31, age : 31,
name : "Jane Smith" name : "Jane Smith"
} },
{ {
_id : "example/6242727", _id : "example/6242727",
_key "1774564", _key : "1774564",
_rev "1774564" _rev : "1774564",
age : 29, age : 29,
name : "John Doe" name : "John Doe"
}, },
{ {
_id : "example/5980583", _id : "example/5980583",
_ ey : "1512420", _key : "1512420",
_ ev : "1512420", _rev : "1512420",
Hello : "World" Hello : "World"
} }
] ]
@ -346,19 +346,19 @@ The last document was a mistake – so let's delete it:
arangosh> db.example.remove("example/5980583") arangosh> db.example.remove("example/5980583")
true true
arangosh> db.example.all().toArra () arangosh> db.example.all().toArray()
[ [
{ {
_id : "example/6308263", _id : "example/6308263",
_key : "1993214" _key : "1993214",
_rev : " 993214", _rev : "1993214",
age : 31, age : 31,
name : "Jane Smi h" name : "Jane Smith"
}, },
{ {
_id : "example/6242727", _id : "example/6242727",
_key : "17745 4", _key : "1774564",
_rev "1774564", _rev : "1774564",
age : 29, age : 29,
name : "John Doe" name : "John Doe"
} }
@ -368,12 +368,12 @@ Now we want to look for a person with a given name. We can use
`byExample` for this. The method returns a list of documents `byExample` for this. The method returns a list of documents
matching a given example. matching a given example.
arangosh> db.example.byExample({ name: "Jane Smith" } .toArray() arangosh> db.example.byExample({ name: "Jane Smith" }).toArray()
[ [
{ {
_id : "example/6308263", _id : "example/6308263",
_key : " 993214", _key : "1993214",
rev : "1993214", _rev : "1993214",
age : 31, age : 31,
name : "Jane Smith" name : "Jane Smith"
} }
@ -384,11 +384,11 @@ combine the conditions with an `and`. The syntax above becomes messy for joins
and `or` conditions. Therefore ArangoDB also supports a full-blown and `or` conditions. Therefore ArangoDB also supports a full-blown
query language. query language.
arangosh> db._query('FOR user IN example FILTER user.name == "Jane Smith" RETURN u er').toArray() arangosh> db._query('FOR user IN example FILTER user.name == "Jane Smith" RETURN user').toArray()
[ [
{ {
_id : "example/63082 3", _id : "example/6308263",
_key : "1993214 , _key : "1993214",
_rev : "1993214", _rev : "1993214",
age : 31, age : 31,
name : "Jane Smith" name : "Jane Smith"
@ -397,11 +397,11 @@ query language.
Search for all persons over 30: Search for all persons over 30:
arangosh> db._query('FOR user IN example FILTER user.age > 30 RETU N user').toArray() arangosh> db._query('FOR user IN example FILTER user.age > 30 RETURN user').toArray()
[ [
{ {
_id : "example/6 08263", _id : "example/6308263",
key : "199 214", _key : "1993214",
_rev : "1993214", _rev : "1993214",
age : 31, age : 31,
name : "Jane Smith" name : "Jane Smith"