renamed Manual to UserManual, fixed references, removed First section

Documentation/UserManual/FirstStepsArangoDB.md

@@ -1,7 +1,7 @@
 First Steps with ArangoDB {#FirstStepsArangoDB}
 ===============================================
 
-@NAVIGATE{UserManualBasics,UserManual,UserManualArangosh}
+@NAVIGATE_FIRST{UserManual,UserManualArangosh}
 @EMBEDTOC{FirstStepsArangoDBTOC}
 
 What is ArangoDB? {#FirstStepsArangoDBIntro}
@@ -90,11 +90,11 @@ The ArangoDB database package comes with the following programs:
 - `arangod`: The ArangoDB database daemon. This server program is
   intended to run as daemon process and to server the various clients
   connection to the server via TCP / HTTP. See @ref
-  UserManualServerStartStop.
+  FirstStepsServerStartStop.
 - `arango-update`: Used to initialize or update the database.
 - `arangosh`: The ArangoDB shell. A client that implements a
   read-eval-print loop (REPL) and provides functions to access and
-  administrate the ArangoDB server. See @ref UserManualShellStartStop.
+  administrate the ArangoDB server. See @ref FirstStepsShellStartStop.
 - `arangoimp`: A bulk importer for the ArangoDB server.
   See @ref ImpManual
 
@@ -304,8 +304,26 @@ You can learn all about the query language @ref Aql "here". Note that
 `_query` is a short-cut for `_createStatement` and `execute`. We will
 come back to these functions when we talk about cursors.
 
-Details about Starting the ArangoDB Server {#FirstStepsServerStartStop}
+ArangoDB's Front-End {#FirstStepsArangoDBFE}
-=======================================================================
+--------------------------------------------
+
+The ArangoDB server has a graphical front-end, which allows you to
+inspect the current state of the server from within your browser. You
+can use the front-end using the following URL:
+
+    http://localhost:8529/_admin
+
+Unless you have loaded an application into the ArangoDB server, which remaps
+the paths, the front-end will also be available under
+
+    http://localhost:8529/
+
+The front-end allows you to browse through the collections and
+documents. If you need to administrate the database, please use
+the ArangoDB shell described in the next section.
+
+Details about the ArangoDB Server {#FirstStepsServerStartStop}
+==============================================================
 
 The ArangoDB database server has two modes of operation: as server, where it
 will answer to client requests, and an emergency console, in which you can
@@ -398,3 +416,44 @@ more information see @ref CommandLineLogging "here".
 @CMDOPT{\--daemon}
 
 Runs the server as a daemon (as a background process).
+
+Details about the ArangoDB Shell {#FirstStepsShellStartStop}
+============================================================
+
+After the server has been @ref FirstStepsServerStartStop "started",
+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
+@ref UserManualArangosh. You might need to set additional options
+(endpoint, username, and password) when connecting:
+
+    unix> ./arangosh --server.endpoint tcp://127.0.0.1:8529 --server.username root
+
+The shell will print its own version number and, if successfully connected
+to a server, the version number of the ArangoDB server.
+
+Command-Line Options {#FirstStepsShellStartStopOptions}
+-------------------------------------------------------
+
+Use @LIT{--help} to get a list of command-line options:
+
+    > ./arangosh --help
+    STANDARD options:
+      --help                                     help message
+      --javascript.modules-path <string>         one or more directories separated by cola (default: "...")
+      --javascript.startup-directory <string>    startup paths containing the JavaScript files; multiple directories can be separated by cola
+      --javascript.unit-tests <string>           do not start as shell, run unit tests instead
+      --jslint <string>                          do not start as shell, run jslint instead
+      --log.level <string>                       log level (default: "info")
+      --max-upload-size <uint64>                 maximum size of import chunks (in bytes) (default: 500000)
+      --no-auto-complete                         disable auto completion
+      --no-colors                                deactivate color support
+      --pager <string>                           output pager (default: "less -X -R -F -L")
+      --pretty-print                             pretty print values
+      --quiet                                    no banner
+      --server.connect-timeout <int64>           connect timeout in seconds (default: 3)
+      --server.endpoint <string>                 endpoint to connect to, use 'none' to start without a server (default: "tcp://127.0.0.1:8529")
+      --server.password <string>                 password to use when connecting (leave empty for prompt)
+      --server.request-timeout <int64>           request timeout in seconds (default: 300)
+      --server.username <string>                 username to use when connecting (default: "root")
+      --use-pager                                use pager

Documentation/UserManual/FirstStepsArangoDBTOC.md

@@ -7,5 +7,8 @@ TOC {#FirstStepsArangoDBTOC}
   - @ref FirstStepsArangoDBFirstSteps
     - @ref FirstStepsArangoDBConnecting
     - @ref FirstStepsArangoDBQuerying
+    - @ref FirstStepsArangoDBFE
   - @ref FirstStepsServerStartStop
     - @ref FirstStepsServerStartStopOptions
+  - @ref FirstStepsShellStartStop
+    - @ref FirstStepsShellStartStopOptions

Documentation/arango.template.in

@@ -221,6 +221,7 @@ ALIASES               += \
 # navigation
 ALIASES               += \
   "NAVIGATE{3}=@htmlonly<div class=\"navigate\"><a href=\"\1.html\">prev</a> | <a href=\"\2.html\">home</a> | <a href=\"\3.html\">next</a></div>@endhtmlonly" \
+  "NAVIGATE_FIRST{2}=@htmlonly<div class=\"navigate\">prev | <a href=\"\1.html\">home</a> | <a href=\"\2.html\">next</a></div>@endhtmlonly" \
   "EMBEDTOC{1}=@if LATEX@else@htmlonly <div class=\"toc\">@endhtmlonly@copydoc \1\n@htmlonly</div>@endhtmlonly@endif"
 
 # glossary
@@ -713,7 +714,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @srcdir@/Documentation/Manual \
+INPUT                  = @srcdir@/Documentation/UserManual \
 			 @srcdir@/Doxygen/js \
                          @srcdir@/arangod \
                          @srcdir@/lib
@@ -1833,7 +1834,7 @@ MSCFILE_DIRS           =
 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
 
-DOT_GRAPH_MAX_NODES    = 50
+DOT_GRAPH_MAX_NODES    = 100
 
 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
 # graphs generated by dot. A depth value of 3 means that only nodes reachable

Documentation/arangodb.css

@@ -85,6 +85,10 @@
   margin-bottom: 0px;
 }
 
+#content div.arangodb ul ul {
+  margin-bottom: 0px;
+}
+
 /* ************************************************************************** */
 /* pre                                                                        */
 /* ************************************************************************** */

arangod/Documentation/dba-manual.dox

@@ -37,6 +37,7 @@
 ///  <li>@ref DbaManualBasics</li>
 ///  <li>@ref DbaManualAuthentication</li>
 ///  <li>@ref DbaManualDatafileDebugger</li>
+///  <li>@ref DbaManualEmergencyConsole</li>
 ///  <li>@ref ShellCollection</li>
 ///  <li>@ref ShellIndex</li>
 ///  <li>@ref IndexCap</li>
@@ -51,6 +52,7 @@
 /// @copydetails DbaManualBasicsTOC
 /// @copydetails DbaManualAuthenticationTOC
 /// @copydetails DbaManualDatafileDebuggerTOC
+/// @copydetails DbaManualEmergencyConsoleTOC
 /// @copydetails ShellCollectionTOC
 /// @copydetails ShellIndexTOC
 /// @copydetails IndexesTOC
@@ -203,6 +205,33 @@
 /// in order to check the consistency of the datafiles and journals.
 ////////////////////////////////////////////////////////////////////////////////
 
+// -----------------------------------------------------------------------------
+// --SECTION--                                      DBA MANUAL EMERGENCY CONSOLE
+// -----------------------------------------------------------------------------
+
+////////////////////////////////////////////////////////////////////////////////
+/// @page DbaManualEmergencyConsoleTOC
+///
+/// <ul>
+///  <li>@ref DbaManualEmergencyConsole
+///  </li>
+/// </ul>
+////////////////////////////////////////////////////////////////////////////////
+
+////////////////////////////////////////////////////////////////////////////////
+/// @page DbaManualEmergencyConsole Emergency Console
+///
+/// @EMBEDTOC{DbaManualEmergencyConsoleTOC}
+///
+/// The following command starts a emergency console. See below for a list of
+/// frequently used options, see @ref CommandLine "here" for a complete list.
+///
+/// @note Never start the emergency console for a database which also has a
+/// server attached to it. In general the ArangoDB shell is what you want.
+///
+/// @EXAMPLE{start-emergency-console,emergency console}
+////////////////////////////////////////////////////////////////////////////////
+
 // -----------------------------------------------------------------------------
 // --SECTION--                                                       END-OF-FILE
 // -----------------------------------------------------------------------------

arangod/Documentation/user-manual.dox

@@ -34,7 +34,6 @@
 ///
 /// @if LATEX
 /// <ul>
-///  <li>@ref UserManualBasics</li>
 ///  <li>@ref FirstStepsArangoDB</li>
 ///  <li>@ref UserManualArangosh</li>
 ///  <li>@ref ShellCollection</li>
@@ -49,7 +48,6 @@
 ///  <li>@ref Glossary</li>
 /// </ul>
 /// @else
-/// @copydetails UserManualBasicsTOC
 /// @copydetails FirstStepsArangoDBTOC
 /// @copydetails UserManualArangoshTOC
 /// @copydetails ShellCollectionTOC
@@ -62,95 +60,6 @@
 /// @endif
 ////////////////////////////////////////////////////////////////////////////////
 
-// -----------------------------------------------------------------------------
-// --SECTION--                                                USER MANUAL BASICS
-// -----------------------------------------------------------------------------
-
-////////////////////////////////////////////////////////////////////////////////
-/// @page UserManualBasicsTOC
-///
-/// <ul>
-///  <li>@ref UserManualBasics
-///   <ul>
-///    <li>@ref UserManualServerStartStop
-///     <ul>
-///      <li>@ref UserManualServerStartStopOptions</li>
-///     </ul>
-///    </li>
-///    <li>@ref UserManualServerFE</li>
-///    <li>@ref UserManualShellStartStop
-///     <ul>
-///      <li>@ref UserManualShellStartStopOptions</li>
-///     </ul>
-///    </li>
-///    <li>@ref UserManualServerStartStopDebug
-///    </li>
-///   </ul>
-///  </li>
-/// </ul>
-////////////////////////////////////////////////////////////////////////////////
-
-////////////////////////////////////////////////////////////////////////////////
-/// @page UserManualBasics About ArangoDB
-///
-/// @EMBEDTOC{UserManualBasicsTOC}
-///
-/// @section UserManualServerFE ArangoDB's Front-End
-////////////////////////////////////////////////////
-///
-/// The ArangoDB server has a graphical front-end, which allows you to inspect
-/// the current state of the server from within your browser. You can use the 
-/// front-end using the following URL:
-///
-/// @LIT{http://localhost:8529/_admin}
-///
-/// Unless you have loaded an application into the ArangoDB server, which remaps
-/// the paths, the front-end will also be available under
-///
-/// @LIT{http://localhost:8529/}.
-///
-/// The front-end allows you to browse through the collections and
-/// documents. If you need to administrate the database, please use
-/// the ArangoDB shell described in the next section.
-///
-/// @section UserManualShellStartStop Starting the ArangoDB Shell
-/////////////////////////////////////////////////////////////////
-///
-/// After the server has been @ref UserManualServerStartStop "started",
-/// 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 @ref
-/// UserManualArangosh.
-///
-/// @TINYEXAMPLE{arangosh-start,starting the shell}
-///
-/// You might need to set additional options (endpoint, username, and password)
-/// when connecting:
-///
-/// @verbinclude arangosh-start-full
-///
-/// The shell will print its own version number and, if successfully connected
-/// to a server, the version number of the ArangoDB server.
-///
-/// @subsection UserManualShellStartStopOptions Command-Line Options
-////////////////////////////////////////////////////////////////////
-///
-/// Use @LIT{\-\-help} to get a list of command-line options:
-///
-/// @TINYEXAMPLE{arangosh-options,shell options}
-///
-/// @section UserManualServerStartStopDebug Starting the ArangoDB Emergency Console
-///////////////////////////////////////////////////////////////////////////////////
-///
-/// The following command starts a emergency console. See below for a list of
-/// frequently used options, see @ref CommandLine "here" for a complete list.
-///
-/// @note Never start the emergency console for a database which also has a
-/// server attached to it. In general the ArangoDB shell is what you want.
-///
-/// @EXAMPLE{start-emergency-console,emergency console}
-////////////////////////////////////////////////////////////////////////////////
-
 // -----------------------------------------------------------------------------
 // --SECTION--                                              USER MANUAL ARANGOSH
 // -----------------------------------------------------------------------------