1
0
Fork 0

updated manual for 1.4

This commit is contained in:
Frank Celler 2013-08-08 14:40:49 +02:00
parent 0191273ce9
commit 52e90633b2
14 changed files with 152 additions and 26 deletions

View File

@ -273,7 +273,7 @@ v1.4.0-alpha1 (2013-08-02)
* issue #512: Binded Parameters for LIMIT
v1.3.3 (XXXX-XX-XX)
v1.3.3 (2013-08-01)
-------------------
* issue #570: updateFishbowl() fails once
@ -285,7 +285,7 @@ v1.3.3 (XXXX-XX-XX)
* added missing error reporting for errors that happened during import of edges
v1.3.2 (2013-XX-XX)
v1.3.2 (2013-06-21)
-------------------
* fixed memleak in internal.download()

View File

@ -4,6 +4,95 @@
## --SECTION-- DOCUMENTATION
## -----------------------------------------------------------------------------
################################################################################
### @brief pages
################################################################################
WIKI = \
Aql \
AqlExamples \
ArangoErrors \
CommandLine \
Communication \
Compiling \
DbaManual \
DbaManualAuthentication \
DbaManualBasics \
DbaManualDatafileDebugger \
DbaManualEmergencyConsole \
ExtendingAql \
FirstStepsArangoDB \
Glossary \
Graphs \
HandlingCollections \
HandlingDocuments \
HandlingEdges \
HandlingIndexes \
Home \
HttpAqlFunctions \
HttpBatch \
HttpCollection \
HttpCurrentDatabase \
HttpCursor \
HttpGraph \
HttpImport \
HttpIndex \
HttpMisc \
HttpQuery \
HttpReplication \
HttpSimple \
HttpSystem \
HttpTransactions \
HttpTraversals \
HttpUser \
ImpManual \
ImpManualBasics \
ImplementorManual \
ImplementorManualArangoErrors \
IndexBitArray \
IndexCap \
IndexCapHttp \
IndexFulltext \
IndexFulltextHttp \
IndexGeo \
IndexGeoHttp \
IndexHash \
IndexHashHttp \
IndexSkiplist \
IndexSkiplistHttp \
InstallManual \
Installing \
JSModuleActions \
JSModuleConsole \
JSModuleFs \
JSModuleGraph \
JSModules \
NamingConventions \
NewFeatures11 \
NewFeatures12 \
NewFeatures13 \
NewFeatures14 \
RefManual \
RefManualArangoErrors \
RefManualReplication \
RestDocument \
RestEdge \
SimpleQueries \
Transactions \
Upgrading \
Upgrading11 \
Upgrading12 \
Upgrading13 \
Upgrading14 \
UserManual \
UserManualActions \
UserManualArangosh \
UserManualFoxx \
UserManualFoxxManager \
UserManualReplication \
UserManualWebInterface \
jsUnity
################################################################################
### @brief TOC files
################################################################################

View File

@ -22,55 +22,53 @@ for various languages including the Big-P (PHP, Python, Perl) and Ruby.
Please contact @S_EXTREF_S{http://www.arangodb.org/connect,us} if you have any
questions.
Upgrading to ArangoDB 1.3 {#ArangoDBUpgrading13}
Upgrading to ArangoDB 1.4 {#ArangoDBUpgrading14}
================================================
- @BOOK_REF{NewFeatures13}
- @BOOK_REF{Upgrading13}
- @BOOK_REF{NewFeatures14}
- @BOOK_REF{Upgrading14}
See @ref Upgrading from older releases.
ArangoDB's User Manuals {#ArangoDBUserManual}
=============================================
- @BOOK_REF{UserManual} @ifnot XML @EXTREF{user-manual.pdf,pdf} @endif
- @BOOK_REF{UserManual} @S_EXTREF{user-manual.pdf,pdf}
- @BOOK_REF{DbaManual} @ifnot XML @EXTREF{dba-manual.pdf,pdf} @endif
- @BOOK_REF{DbaManual} @S_EXTREF{dba-manual.pdf,pdf}
- @BOOK_REF{ImpManual} @ifnot XML @EXTREF{imp-manual.pdf,pdf} @endif
- @BOOK_REF{ImpManual} @S_EXTREF{imp-manual.pdf,pdf}
- also see the @ref Glossary
@ifnot XML
- @EXTREF{arangodb_1.2_shell_reference_card.pdf,Cheat Sheet}
@endif
- @EXTREF{arangodb_1.4_shell_reference_card.pdf,Cheat Sheet}
ArangoDB's Administrator Manuals {#ArangoDBAdminManual}
=======================================================
- @BOOK_REF{InstallManual} @ifnot XML @EXTREF{install-manual.pdf,pdf} @endif
- @BOOK_REF{InstallManual} @S_EXTREF{install-manual.pdf,pdf}
ArangoDB's Developer Manuals {#ArangoDBAPIManual}
=================================================
- @BOOK_REF{ImplementorManual} @ifnot XML @EXTREF{implementor-manual.pdf,pdf} @endif
- @BOOK_REF{ImplementorManual} @S_EXTREF{implementor-manual.pdf,pdf}
- @BOOK_REF{RefManual} @ifnot XML @EXTREF{ref-manual.pdf,pdf} @endif
- @BOOK_REF{RefManual} @S_EXTREF{ref-manual.pdf,pdf}
API aka Drivers {#HomeApi}
==========================
Though ArangoDB is yet a young project, a couple of people started to
add APIs for different programming languages/frameworks. See
@EXTREF{http://www.arangodb.org/api,http://www.arangodb.org/api}.
@S_EXTREF{http://www.arangodb.org/api,http://www.arangodb.org/api}.
Stay in Contact {#HomeStayInContact}
====================================
Frank is twittering for the project on Twitter using
@EXTREF{http://www.twitter.com/fceller,@@fceller}. We've also a
@S_EXTREF{http://www.twitter.com/fceller,@@fceller}. We've also a
"generic" twitter account mainly for announcements called
@EXTREF{http://www.twitter.com/arangodb,@@arangodb}
@S_EXTREF{http://www.twitter.com/arangodb,@@arangodb}
You can also subscribe to a low traffic announcement list on the
@EXTREF{http://www.arangodb.org/connect,connect page}.
@S_EXTREF{http://www.arangodb.org/connect,connect page}.

View File

@ -0,0 +1,17 @@
New Features in ArangoDB 1.4 {#NewFeatures14}
=============================================
@NAVIGATE_NewFeatures14
@EMBEDTOC{NewFeatures14TOC}
Features and Improvements {#NewFeatures14Introduction}
======================================================
The following list shows in detail which features have been added or improved in
ArangoDB 1.4. ArangoDB 1.4 also contains several bugfixes that are not listed
here - see the CHANGELOG for details.
Replication{#NewFeatures14Replication}
--------------------------------------
See @ref UserManualReplication for details.

View File

@ -0,0 +1,5 @@
TOC {#NewFeatures14TOC}
=======================
- @ref NewFeatures14Introduction
- @ref NewFeatures14Replication

View File

@ -1,11 +1,14 @@
Upgrading ArangoDB{#Upgrading}
==============================
- @ref NewFeatures13
- @ref Upgrading13
- @ref NewFeatures14
- @ref Upgrading14
Older Releases:
- @BOOK_REF{NewFeatures13}
- @BOOK_REF{Upgrading13}
- @BOOK_REF{NewFeatures12}
- @BOOK_REF{Upgrading12}

View File

@ -0,0 +1,10 @@
Upgrading to ArangoDB 1.4 {#Upgrading14}
========================================
@NAVIGATE_Upgrading14
@EMBEDTOC{Upgrading14TOC}
Upgrading {#Upgrading14Introduction}
====================================
1.4 is currently alpha, please do not use in production.

View File

@ -0,0 +1,4 @@
TOC {#Upgrading14TOC}
=====================
- @ref Upgrading14Introduction

View File

@ -9,5 +9,6 @@ ArangoDB's Reference Manual (@VERSION) {#RefManual}
@CHAPTER_REF{JSModuleGraph}
@CHAPTER_REF{JSModuleActions}
@CHAPTER_REF{jsUnity}
@CHAPTER_REF{UserManualActions}
@CHAPTER_REF{RefManualReplication}
@CHAPTER_REF{RefManualArangoErrors}

View File

@ -10,14 +10,13 @@ ArangoDB's User Manual (@VERSION) {#UserManual}
@CHAPTER_REF{HandlingDocuments}
@CHAPTER_REF{HandlingEdges}
@CHAPTER_REF{SimpleQueries}
@CHAPTER_REF{Graphs}
@CHAPTER_REF{Aql}
@CHAPTER_REF{ExtendingAql}
@CHAPTER_REF{AqlExamples}
@CHAPTER_REF{Graphs}
@CHAPTER_REF{Transactions}
@CHAPTER_REF{UserManualReplication}
@CHAPTER_REF{UserManualFoxxManager}
@CHAPTER_REF{UserManualFoxx}
@CHAPTER_REF{UserManualActions}
@CHAPTER_REF{UserManualReplication}
@CHAPTER_REF{Transactions}
@CHAPTER_REF{CommandLine}
@CHAPTER_REF{Glossary}

View File

@ -32,4 +32,4 @@ publish-pdf: $(OUTPUT_FOLDER)
cp Doxygen/latex/user-manual.pdf $(OUTPUT_FOLDER)
cp Doxygen/latex/ref-manual.pdf $(OUTPUT_FOLDER)
cp Doxygen/latex/imp-manual.pdf $(OUTPUT_FOLDER)
cp Documentation/Manual/arangodb_1.2_shell_reference_card.pdf $(OUTPUT_FOLDER)
cp Documentation/Manual/arangodb_$(MAJOR_MINOR)_shell_reference_card.pdf $(OUTPUT_FOLDER)

View File

@ -1 +1 @@
Please refer to Documentation/Manual/Upgrading12.md
Please refer to Documentation/Manual/Upgrading14.md