merged examples paths, new intro text

Documentation/Scripts/html2html.sh

@@ -36,7 +36,7 @@ else
   FOOTER='</body></html>'
 fi
 
-echo -n > $OUPUT.tmp
+echo -n > $OUTPUT.tmp
 
 if test -n "$HEADER";  then
   echo $HEADER >> $OUTPUT.tmp

Documentation/arango.template.in

@@ -222,6 +222,7 @@ ALIASES                = \
   "EMBEDTOC{1}=@if LATEX@else<hr>@copydoc \1\n<hr>@endif" \
   "RESTHEADER{2}=@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else <hr><em>\1</em> (\2)<hr><br>@endif" \
   "LATEXBREAK=@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" \
+  "EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else<a href=\1>\2</a> @endif" \
   "EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else<a href= \1>\2</a>@endif" \
   "EXTRES{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else&nbsp;<a href= \1>\2</a>@endif" \
   "INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif" \
@@ -764,10 +765,7 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = @srcdir@/Documentation/Examples.Ahuacatl \
+EXAMPLE_PATH           = @srcdir@/Documentation/Examples
-                         @srcdir@/Documentation/Examples.ArangoDB \
-                         @srcdir@/Documentation/Examples.Durham \
-                         @srcdir@/Documentation/Examples.Fyn
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

Documentation/arangodb.css

@@ -68,8 +68,8 @@ h2 {
     color: #404040;
     font-family: Helvetica,Times New Roman;
     font-size: 26px;
-    margin-bottom: 10px;
+    margin-bottom: 14px;
-    padding: 14px 0 34px;
+    padding: 14px 0  by 4px;
 }
 
 a:link, a:visited {
@@ -93,15 +93,11 @@ hr {
 }
 
 code {
-	font-family: Monaco, Consolas, "Andale Mono", "DejaVu Sans Mono", monospace;
+    font-family: Monaco, Consolas, "Andale Mono", "DejaVu Sans Mono", monospace;
-    background-color: #FBFCFD !important;
-    border: 1px solid #C4CFE5 !important;
     font-family: monospace,fixed;
     font-size: 105%;
     line-height: 175%;
-    margin: 4px 8px 4px 2px;
     overflow: auto;
-    padding: 2px 6px;
     word-wrap: break-word;
 }
 
@@ -121,7 +117,7 @@ pre, pre.fragment {
     font-family: monospace,fixed;
     font-size: 105%;
     line-height: 125%;
-    margin: 4px 8px 4px 2px;
+    margin: 4px 8px 24px 2px;
     overflow: auto;
     padding: 4px 6px;
     word-wrap: break-word;

arangod/Documentation/FirstStepsArangoDB.md

@@ -0,0 +1,259 @@
+First Steps with ArangoDB {#FirstStepsArangoDB}
+===============================================
+
+@EMBEDTOC{FirstStepsArangoDBTOC}
+
+What is ArangoDB? {#FirstStepsArangoDBIntro}
+============================================
+
+ArangoDB is a universal open-source database with a flexible data
+model for documents, graphs, and key-values. You can easily build high
+performance applications using a convenient sql-like query language or
+JavaScript/Ruby extensions.
+
+The database server `arangod` stores all documents and serves them
+using a REST interface. There are driver for all major language like
+Ruby, Python, PHP, JavaScript, and Perl. In the following sections we
+will use the JavaScript shell to communicate with the database and
+demonstrate some of ArangoDB's features using JavaScript.
+
+Getting Familiar with ArangoDB {#FirstStepsArangoDBServerStart}
+===============================================================
+
+First of all download and install the corresponding RPM or Debian
+package or use homebrew on the MacOS X. See the
+@EXTREF_S{InstallManual.html, installation manual} for more details.
+
+For Linux:
+
+- visit the official ArangoDB download page at 
+  @EXTREF{www.arangodb.org/download,http://www.arangodb.org/download}
+  and download the correct package for you Linux distribution
+
+- install the package using you favorite package manager
+
+- start up the database server, normally this is down by
+  executing `/etc/init.d/arangod start`. The exact command
+  depends on your Linux distribution
+
+For MacOS X:
+
+- execute `brew install arangodb`
+
+- and start the server using `/usr/local/sbin/arangod &`
+
+After these steps there should be a running instance of `arangod` -
+the ArangoDB database server.
+
+    > ps auxw | fgrep arangod
+    arangodb        14536   0,1  0,6  5307264  23464 s002  S     1:21pm   0:00.18 /usr/local/sbin/arangod
+
+If there is no such process, check the log file
+`/var/log/arangodb/arangod.log` for errors.
+
+Exploring Collections and Documents {#FirstStepsArangoDBFirstSteps}
+===================================================================
+
+ArangoDB is a database that serves documents to clients.
+
+- A *document* contains zero or more attributes, each of these
+  attribute has a value. A value can either be a atomic type, i. e.,
+  integer, strings, boolean or a list or an embedded document. Documents
+  are normally represented as JSON objects.
+
+- Documents are grouped into *collections*. A collection can contains zero
+  or more documents.
+
+- *Queries* are used to extract documents based on filtere criterias;
+  queries can be as simple as a query by-example or as complex as a
+  joins using many collections or graph structures.
+
+- *Cursors* are used to iterate over the result of a query.
+
+- *Indexes* are used to speed up of searches; there are various different
+  types of indexes like hash indexes, geo-indexes, bit-indexes.
+
+If you are familiar with RDBMS then it is safe to compare collections
+to tables and documents to rows. However, bringing structure to the
+"rows" has many advantages - as you will see later.
+
+Starting the JavaScript shell {#FirstStepsArangoDBConnecting}
+-------------------------------------------------------------
+
+The easiest way to connect to the database is the JavaScript shell
+`arangosh`. You can either start it from the command-line or as an
+embedded version in the browser. Using the command-line tool has the
+advantage that you can use auto-completion.
+
+    > arangosh --server.password ""
+					   _     
+      __ _ _ __ __ _ _ __   __ _  ___  ___| |__  
+     / _` | '__/ _` | '_ \ / _` |/ _ \/ __| '_ \ 
+    | (_| | | | (_| | | | | (_| | (_) \__ \ | | |
+     \__,_|_|  \__,_|_| |_|\__, |\___/|___/_| |_|
+			   |___/                 
+
+    Welcome to arangosh 1.x.y. Copyright (c) 2012 triAGENS GmbH.
+    Using Google V8 3.9.4 JavaScript engine.
+    Using READLINE 6.1.
+
+    Connected to Arango DB 127.0.0.1:8529 Version 1.x.y
+
+    ------------------------------------- Help -------------------------------------
+    Predefined objects:                                                 
+      arango:                                ArangoConnection           
+      db:                                    ArangoDatabase             
+    Example:                                                            
+     > db._collections();                    list all collections       
+     > db.<coll_name>.all();                 list all documents         
+     > id = db.<coll_name>.save({ ... });    save a document            
+     > db.<coll_name>.remove(<_id>);         delete a document          
+     > db.<coll_name>.document(<_id>);       get a document             
+     > help                                  show help pages            
+     > helpQueries                           query help                 
+     > exit                                                             
+    arangosh>
+
+This gives you a prompt, where you can issue JavaScript commands.
+
+The standard setup does not require a password. Depending on you
+setup, you might need to specify the endpoint, username and password
+in order to run the shell on your system. You can use the options
+`--server.endpoint`, `--server.username` and `--server.password` for
+this. If you do not specify a password, arangosh will prompt for one.
+
+    > ./arangosh --server.endpoint tcp://127.0.0.1:8529 --server.username root
+
+Querying {#FirstStepsArangoDBQuerying}
+--------------------------------------
+
+All documents are stored in collections. All collections are stored in a
+database. The database object is accessible there the variable `db` from
+the module 
+
+    arangosh> db = require("org/arangodb").db;
+    [object ArangoDatabase]
+
+Creating a collection is simple. You can use the `_create` method
+of the `db` variable.
+
+    arangosh> db._create("example");
+    [ArangoCollection 70628, "example" (status loaded)]
+
+After the collection has been create you can easily access it using
+the path `db.example`. The collection currently shows as `loaded`,
+meaning that its loaded into memory. If you restart the server and
+access the collection again, it will now show as `unloaded`. You can
+also manually unload a collection
+
+    arangosh> db.example.unload();
+    arangosh> db.example;
+    [ArangoCollection 70628, "example" (status unloaded)]
+
+Whenever you use a collection, ArangoDB will automatically load it
+into memory for you.
+
+In order to create new documents in a collection, use the `save`
+operator. 
+
+    arangosh> db.example.save({ Hallo : "World" });
+    { error : false, _id : "70628/1512420", _rev : 1512420 }
+    arangosh> db.example.save({ name : "Mustermann", age : 29 });
+    { error : false, _id : "70628/1774564", _rev : 1774564 }
+    arangosh> db.example.save({ name : "Musterfrau", age : 31 });
+    { error : false, _id : "70628/1774565", _rev : 1774565 }
+
+Just storing documents would be no fun. We now want to select some of
+the stored documents again.  In order to select all elements of a
+collection, one can use the `all` operator. Because this might return
+a lot of data, we switch on pretty printing before.
+
+    arangosh> start_pretty_print();
+    use pretty printing
+
+The command `stop_pretty_print` will switch off pretty printing again.
+Now extract all elements.
+
+    arangosh> db.example.all().toArray()
+    [
+      { 
+	_id : "4538791/6308263", 
+	_rev : 6308263, 
+	age : 31, 
+	name : "Musterfrau"
+       }, 
+      { 
+	_id : "4538791/6242727", 
+	_rev : 6242727, 
+	age : 29, 
+	name : "Mustermann"
+       }, 
+      { 
+	_id : "4538791/5980583", 
+	_rev : 5980583, 
+	Hallo : "World"
+       }
+    ]
+
+The last document is was a mistake, so let's delete it
+
+    arangosh> db.example.remove("4538791/5980583")
+    true
+    arangosh> db.example.all().toArray()
+    [
+      { 
+	_id : "4538791/6308263", 
+	_rev : 6308263, 
+	age : 31, 
+	name : "Musterfrau"
+       }, 
+      { 
+	_id : "4538791/6242727", 
+	_rev : 6242727, 
+	age : 29, 
+	name : "Mustermann"
+       }
+    ]
+
+Now we want to look for a person with a given name, we can use
+`by-example` for this. The methods returns a list of documents
+matching a given example.
+
+    arangosh> db.example.byExample({ name: "Musterfrau" }).toArray()
+    [
+      { 
+	_id : "4538791/6308263", 
+	_rev : 6308263, 
+	age : 31, 
+	name : "Musterfrau"
+       }
+    ]
+
+While the `byExample` works very well for simple queries where you
+`and` conditions together, the above syntax becomes messy for joins
+and `or` conditions. Therefore, ArangoDB also supports a full-blown
+query language.
+
+    arangosh> db._query('FOR user IN example FILTER user.name == "Musterfrau" return user').toArray()
+    [
+      { 
+	_id : "4538791/6308263", 
+	_rev : 6308263, 
+	age : 31, 
+	name : "Musterfrau"
+       }
+    ]
+
+Search for all persons over 30.
+
+    arangosh> db._query('FOR user IN example FILTER user.age > 30" return user').toArray()
+    [
+      { 
+	_id : "4538791/6308263", 
+	_rev : 6308263, 
+	age : 31, 
+	name : "Musterfrau"
+       }
+    ]
+
+Note that `_query` is a short-cut for `_createStatement` and `execute`.

arangod/Documentation/FirstStepsArangoDBTOC.md

@@ -0,0 +1,7 @@
+TOC {#FirstStepsArangoDBTOC}
+============================
+
+- @ref FirstStepsArangoDB
+  - @ref FirstStepsArangoDBIntro
+  - @ref FirstStepsArangoDBServerStart
+  - @ref FirstStepsArangoDBFirstSteps

arangod/Documentation/first-steps-arangodb.dox

@@ -1,121 +0,0 @@
-////////////////////////////////////////////////////////////////////////////////
-/// @brief user guide guide
-///
-/// @file
-///
-/// DISCLAIMER
-///
-/// Copyright 2012 triagens GmbH, Cologne, Germany
-///
-/// Licensed under the Apache License, Version 2.0 (the "License");
-/// you may not use this file except in compliance with the License.
-/// You may obtain a copy of the License at
-///
-///     http://www.apache.org/licenses/LICENSE-2.0
-///
-/// Unless required by applicable law or agreed to in writing, software
-/// distributed under the License is distributed on an "AS IS" BASIS,
-/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-/// See the License for the specific language governing permissions and
-/// limitations under the License.
-///
-/// Copyright holder is triAGENS GmbH, Cologne, Germany
-///
-/// @author Dr. Frank Celler
-/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
-////////////////////////////////////////////////////////////////////////////////
-
-////////////////////////////////////////////////////////////////////////////////
-/// @page FirstStepsArangoDBTOC
-///
-/// <ul>
-///  <li>@ref FirstStepsArangoDB
-///   <ul>
-///    <li>@ref FirstStepsArangoDBServerStart</li>
-///    <li>@ref FirstStepsArangoDBFirstSteps</li>
-///   </ul>
-///  </li>
-/// </ul>
-////////////////////////////////////////////////////////////////////////////////
-
-////////////////////////////////////////////////////////////////////////////////
-/// @page FirstStepsArangoDB First Steps with ArangoDB
-///
-/// @EMBEDTOC{FirstStepsArangoDBTOC}
-///
-/// @section FirstStepsArangoDBServerStart Starting the ArangoDB server
-///////////////////////////////////////////////////////////////////////
-///
-/// Create an empty directory, which will hold the database:
-///
-/// @LIT{> mkdir /tmp/vocbase}
-///
-/// First start the ArangoDB server. You can start it as daemon and
-/// redirect the output to a file as follows:
-///
-/// @LIT{> ./arangod --daemon --pid-file /tmp/arangod.pid --log.file /tmp/arangod.log /tmp/vocbase}
-///
-/// This will start the ArangoDB server process, store its process
-/// identifier in the file @LIT{/tmp/arangod.pid} and write the output
-/// to @LIT{/tmp/arangod.log}. The database files will live in
-/// @LIT{/tmp/vocbase}.
-///
-/// @section FirstStepsArangoDBFirstSteps First Steps using arangosh
-////////////////////////////////////////////////////////////////////
-///
-/// @subsection FirstStepsArangoDBConnecting Connecting to the server
-/////////////////////////////////////////////////////////////////////
-///
-/// Start the ArangoDB JavaScript shell.
-///
-/// @TINYEXAMPLE{arangosh-start,starting the shell}
-///
-/// This gives you a prompt, where you can issue JavaScript commands.
-///
-/// You might need to specify the endpoint, username and password in order
-/// to run the shell on your system. You can use the options --server.endpoint,
-/// --server.username and --server.password for this. If you do not specify
-/// a password, arangosh will prompt for one.
-///
-/// @verbinclude arangosh-start-full
-///
-/// @subsection FirstStepsArangoDBQuerying Querying
-///////////////////////////////////////////////////
-///
-/// All documents are stored in collections. All collections are stored in a
-/// database.
-///
-/// @verbinclude arangosh-db
-///
-/// Creating a collection is simple. You can use the @FN{_create} method
-/// of the @LIT{db} variable.
-///
-/// @verbinclude arangosh-create-collection
-///
-/// After the collection has been create you can easily access it using the path
-/// @LIT{db.example}.  The collection currently shows as @LIT{loaded}, meaning
-/// that its loaded into memory. If you restart the server and access the
-/// collection again, it will now show as @LIT{unloaded}. You can also manually
-/// unload a collection
-///
-/// @verbinclude arangosh-unload-collection
-///
-/// In order to create new documents in a collection, use the @FN{save}
-/// operator. If the collection is currently unloaded, it will automatically be
-/// loaded into memory.
-///
-/// @verbinclude arangosh-save-documents
-///
-/// In order to select all elements of a collection, one can use the @FN{all}
-/// operator.
-///
-/// @verbinclude arangosh-all-documents
-///
-/// This will select and print all documents.
-////////////////////////////////////////////////////////////////////////////////
-
-// Local Variables:
-// mode: c++
-// mode: outline-minor
-// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
-// End: