diff --git a/Documentation/Makefile.files b/Documentation/Makefile.files index 0591bbac2b..90f70da2ab 100644 --- a/Documentation/Makefile.files +++ b/Documentation/Makefile.files @@ -148,7 +148,7 @@ Doxygen/arango-html.doxy: Documentation/arango.template doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN) doxygen Doxygen/arango-html.doxy > /dev/null - @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh 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/images @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html Doxygen/html/$$w.html Doxygen/doc/$$w.html; done diff --git a/Documentation/Scripts/html2html.sh b/Documentation/Scripts/html2html.sh index aa42bb78ca..5fe97f8275 100755 --- a/Documentation/Scripts/html2html.sh +++ b/Documentation/Scripts/html2html.sh @@ -1,6 +1,7 @@ #!/bin/sh FULL_HTML=0 +KEEP_TITLE=0 while [ "$#" -gt 0 ]; do case "$1" in @@ -8,6 +9,10 @@ while [ "$#" -gt 0 ]; do FULL_HTML=1 ;; + --keep-title) + KEEP_TITLE=1 + ;; + --*) echo "$0: unknown option '$1'" exit 1 @@ -37,10 +42,10 @@ else fi rm -f $OUTPUT.tmp -touch $OUTPUT.tmp +touch $OUTPUT.tmp || exit 1 if test -n "$HEADER"; then - echo $HEADER >> $OUTPUT.tmp + echo $HEADER >> $OUTPUT.tmp || exit 1 fi cat $INPUT \ @@ -48,11 +53,16 @@ cat $INPUT \ | sed -e 's:<\(/*\)h4>:<\1h5>:g' \ | sed -e 's:<\(/*\)h3>:<\1h4>:g' \ | sed -e 's:<\(/*\)h2>:<\1h3>:g' \ - | sed -e 's:<\(/*\)h1>:<\1h2>:g' \ - | sed -e 's:
\([^<]*\)
:

\1

:g' >> $OUTPUT.tmp + | sed -e 's:<\(/*\)h1>:<\1h2>:g' >> $OUTPUT.tmp || exit 1 -if test -n "$FOOTER"; then - echo $FOOTER >> $OUTPUT.tmp +if test "x$KEEP_TITLE" == "x0"; then + mv $OUTPUT.tmp $OUTPUT.tmp1 || exit 1 + sed -e 's:
\([^<]*\)
:

\1

:g' < $OUTPUT.tmp1 >> $OUTPUT.tmp || exit 1 + rm $OUTPUT.tmp1 || exit 1 fi -mv $OUTPUT.tmp $OUTPUT +if test -n "$FOOTER"; then + echo $FOOTER >> $OUTPUT.tmp || exit 1 +fi + +mv $OUTPUT.tmp $OUTPUT || exit 1 diff --git a/Documentation/arango.template.in b/Documentation/arango.template.in index 712b28b93d..79cde1d5c0 100644 --- a/Documentation/arango.template.in +++ b/Documentation/arango.template.in @@ -222,8 +222,9 @@ ALIASES = \ "EMBEDTOC{1}=@if LATEX@else
@copydoc \1\n
@endif" \ "RESTHEADER{2}=@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else
\1 (\2)

@endif" \ "LATEXBREAK=@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" \ - "EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else\2 @endif" \ "EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" \ + "EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else\2 @endif" \ + "S_EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else \2@endif" \ "EXTRES{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else \2@endif" \ "INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif" \ "SPC= " \ diff --git a/Installation/Makefile.local b/Installation/Makefile.local index 93712c0170..cf2c51267c 100644 --- a/Installation/Makefile.local +++ b/Installation/Makefile.local @@ -9,9 +9,12 @@ OUTPUT_FOLDER=Doxygen/manuals/$(PACKAGE_VERSION) ## publish ################################################################################ -.PHONY: publish publish-wiki publish-html publish-pdf +.PHONY: publish publish-wiki publish-html publish-pdf publish-copy publish: publish-wiki publish-html publish-pdf + make publish-copy + +publish-copy: cd Doxygen/manuals && scp -r "$(PACKAGE_VERSION)" $(MANUAL_DST) publish-wiki: @@ -21,7 +24,7 @@ publish-wiki: publish-html: $(OUTPUT_FOLDER) $(MAKE) doxygen - @for w in $(WIKI); do cp Doxygen/html/$$w.html $(OUTPUT_FOLDER); done + @for w in $(WIKI); do cp Doxygen/website/$$w.html $(OUTPUT_FOLDER); done @for i in `ls Doxygen/doc/images/*.png`; do cp $$i $(OUTPUT_FOLDER)/images; done publish-pdf: $(OUTPUT_FOLDER) diff --git a/arangod/Documentation/Home.md b/arangod/Documentation/Home.md new file mode 100644 index 0000000000..f731098cfe --- /dev/null +++ b/arangod/Documentation/Home.md @@ -0,0 +1,73 @@ +ArangoDB (@VERSION) {#Home} +=========================== + +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. It focuses on durability of the data +taking advantage of new technologies like SSD, support for graph and +geo algorithms needed in social networks, ease of use for the +developer and minimal effort to operate for the administrator. The +design goals are described @EXTREF{http://www.arangodb.org/,here}. + +The ArangoDB package consists of a server, a separate shell, which +allows you to administrate the server, and a set of client API (or +sometimes called drivers) for various languages including the Big-P +(PHP, Python, Perl) and Ruy. + +@xmlonly +The HTML and PDF versions of the manual can be found +here. +@endxmlonly + +Please contact @EXTREF_S{http://www.arangodb.org/connect,us} if you +have any questions. + +ArangoDB's User Manuals {#ArangoDBUserManual} +============================================= + +- @ref UserManual @ifnot XML @EXTREF{user-manual.pdf,pdf} @endif + +- @ref DbaManual @ifnot XML @EXTREF{dba-manual.pdf,pdf} @endif + +- @ref ImpManual @ifnot XML @EXTREF{imp-manual.pdf,pdf} @endif + +- @ref Glossary + +@ifnot XML +- @EXTREF{arangodb_1.0_shell_reference_card.pdf,Cheat Sheet} +@endif + +ArangoDB's Administrator Manuals {#ArangoDBAdminManual} +======================================================= + +- @ref InstallManual @ifnot XML @EXTREF{install-manual.pdf,pdf} @endif + +- @ref Glossary + +ArangoDB's Developer Manuals {#ArangoDBAPIManual} +================================================= + +- @ref ImplementorManual @ifnot XML @EXTREF{implementor-manual.pdf,pdf} @endif + +- @ref RefManual @ifnot XML @EXTREF{ref-manual.pdf,pdf} @endif + +- @ref Glossary + +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}. + +Stay in Contact {#HomeStayInContact} +==================================== + +Frank is twittering for the project on Twitter using +@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} + +You can also subscribe to a low traffic announcement list on the +@EXTREF{http://www.arangodb.org/connect,connect page}. diff --git a/arangod/Documentation/home.dox b/arangod/Documentation/home.dox deleted file mode 100644 index 20474f9e22..0000000000 --- a/arangod/Documentation/home.dox +++ /dev/null @@ -1,102 +0,0 @@ -//////////////////////////////////////////////////////////////////////////////// -/// @brief indexes -/// -/// @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 Home ArangoDB (@VERSION) -/// -/// @if XML -/// @section ArangoDBVersion ArangoDB Version @VERSION -/// @endif -/// -/// My colleagues and I started developing a document-store, which focuses on -/// durability of the data taking advantage of new technologies like SSD, -/// support for graph and geo algorithms needed in social networks, ease of use -/// for the developer and minimal effort to operate for the administrator. The -/// design goals are described here. -/// -/// The ArangoDB consists of a server, a separate shell, which allows you to -/// administrate the server, and a set of client API for various languages. -/// -/// @xmlonly The HTML and PDF versions of the manual can be found here. @endxmlonly -/// -/// @warning -/// The documentation is still far from complete. Please contact us, if you have any -/// questions. -/// -/// @section ArangoDBUserManual ArangoDB's User Manuals -//////////////////////////////////////////////////////// -/// -/// -/// -/// @section ArangoDBAdminManual ArangoDB's Administrator Manuals -///////////////////////////////////////////////////////////////// -/// -/// -/// -/// @section ArangoDBAPIManual ArangoDB's Developer Manuals -/////////////////////////////////////////////////////////// -/// -/// -/// -/// @section HomeApi API -//////////////////////// -/// -/// Though arangoDB is yet a young project, a couple of people started -/// to add APIs for different programming languages/frameworks. See -/// http://www.arangodb.org/api -/// -/// @section HomeStayInContact Stay in Contact -////////////////////////////////////////////// -/// -/// Frank is twittering for the project on Twitter using @@fceller. We've also a "generic" -/// twitter account mainly for announcements called @@arangodb -/// -/// You can also subscribe to a low traffic announcement list on the connect page. -//////////////////////////////////////////////////////////////////////////////// - -// Local Variables: -// mode: c++ -// mode: outline-minor -// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)" -// End: