diff --git a/Doxygen/Scripts/html2html.sh b/Doxygen/Scripts/html2html.sh index 48c27b6d8c..809b7dd860 100755 --- a/Doxygen/Scripts/html2html.sh +++ b/Doxygen/Scripts/html2html.sh @@ -11,6 +11,6 @@ fi HEADER='ArangoDB Manual
ArangoDB
' FOOTER='
' -sed -e "s~ ~${HEADER}~" $INPUT \ - | sed -e "s~ ~${FOOTER}~" \ +sed -e "s~ ~${HEADER}~" $INPUT \ + | sed -e "s~ ~${FOOTER}~" \ | sed -e "s~
\\([^<]*\\)
~

\\1

~" > $OUTPUT diff --git a/Doxygen/arango-html.doxy b/Doxygen/arango-html.doxy index 9533018d82..e7c225ec08 100644 --- a/Doxygen/arango-html.doxy +++ b/Doxygen/arango-html.doxy @@ -217,6 +217,7 @@ ALIASES += EMBEDTOC{1}="@ifnot LATEX
@copydoc \1
@endif" ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else
\1 (\2)

@endif" ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" +ALIASES += EXTRES{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else \2@endif" ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif" ALIASES += SPC=" " diff --git a/Doxygen/arango-latex.doxy b/Doxygen/arango-latex.doxy index c91e5a093b..78a13206d3 100644 --- a/Doxygen/arango-latex.doxy +++ b/Doxygen/arango-latex.doxy @@ -217,8 +217,10 @@ ALIASES += EMBEDTOC{1}="@ifnot LATEX
@copydoc \1
@endif" ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else
\1 (\2)

@endif" ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" +ALIASES += EXTRES{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else \2@endif" ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif" ALIASES += SPC=" " +ALIASES += CLEARPAGE="@if LATEX @latexonly\clearpage@endlatexonly@endif" # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. diff --git a/Doxygen/arango.template b/Doxygen/arango.template index ce34016d10..ce5f1be008 100644 --- a/Doxygen/arango.template +++ b/Doxygen/arango.template @@ -217,8 +217,10 @@ ALIASES += EMBEDTOC{1}="@ifnot LATEX
@copydoc \1
@endif" ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else
\1 (\2)

@endif" ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" +ALIASES += EXTRES{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else \2@endif" ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif" ALIASES += SPC=" " +ALIASES += CLEARPAGE="@if LATEX @latexonly\clearpage@endlatexonly@endif" # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. diff --git a/Doxygen/arango.template.in b/Doxygen/arango.template.in index b0d9a05d8a..b4edaa28fb 100644 --- a/Doxygen/arango.template.in +++ b/Doxygen/arango.template.in @@ -217,8 +217,10 @@ ALIASES += EMBEDTOC{1}="@ifnot LATEX
@copydoc \1
@endif" ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else
\1 (\2)

@endif" ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" +ALIASES += EXTRES{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else \2@endif" ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif" ALIASES += SPC=" " +ALIASES += CLEARPAGE="@if LATEX @latexonly\clearpage@endlatexonly@endif" # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. diff --git a/Doxygen/latex/imp-manual.tex b/Doxygen/latex/imp-manual.tex new file mode 100644 index 0000000000..4ea3b47edc --- /dev/null +++ b/Doxygen/latex/imp-manual.tex @@ -0,0 +1,18 @@ +\input{header.tex} +\begin{center} +{\Large ArangoDB's Importer Manual }\\ +\vspace*{1cm} +{\large The ArangoDB Team}\\ +\vspace*{0.5cm} +\input{version} +{\small Version \arangodbversion}\\ +\end{center} +\end{titlepage} +\clearemptydoublepage +\pagenumbering{roman} +\tableofcontents +\clearemptydoublepage +\pagenumbering{arabic} +\input{ImpManual.inc} +\printindex +\end{document} diff --git a/arangod/Documentation/glossary.dox b/arangod/Documentation/glossary.dox index 1e32f08abf..1233de6caf 100644 --- a/arangod/Documentation/glossary.dox +++ b/arangod/Documentation/glossary.dox @@ -80,8 +80,9 @@ /// @GE{Collection Name}: A collection name identifies a collection in a /// database. It is an string and is unique within the database. Unlike the /// collection identifier it is supplied by the creator of the collection. The -/// collection name can consist of letters, digits and the characters @LIT{_} and -/// @LIT{-}. However, the first character must be a letter. +/// collection name can consist of letters, digits and the characters @LIT{_} +/// (underscore) and @LIT{-} (dash). However, the first character must be a +/// letter. /// /// @page GlossaryDocument ////////////////////////// diff --git a/arangod/Documentation/home.dox b/arangod/Documentation/home.dox index 2a5394503a..ac7a9b50bf 100644 --- a/arangod/Documentation/home.dox +++ b/arangod/Documentation/home.dox @@ -26,7 +26,7 @@ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// -/// @page Home ArangoDB +/// @page Home ArangoDB @VERSION /// /// My colleagues and I started developing a document-store, which focuses on /// durability of the data taking advantage of new technologies like SSD, @@ -40,13 +40,12 @@ /// @xmlonly The HTML and PDF versions of the manual can be found here. @endxmlonly /// /// @warning -/// ArangoDB is currently pre-alpha. We want to have a version 1 ready by end -/// of May 2012, a multi server version is planned for the third quarter of -/// 2012. The document is still far from complete. Please contact -/// us, if you have any questions. +/// The documentation is still far from complete. Please contact us, if you have any +/// questions. /// -/// @section ArangoDBUserManual ArgangoDB's User Manuals (Version @VERSION) -/////////////////////////////////////////////////////////////////////////// +/// @section ArangoDBUserManual ArgangoDB's User Manuals +//////////////////////////////////////////////////////// /// /// /// -/// @section ArangoDBAdminManual ArangoDB's Administrator Manuals (Version @VERSION) -//////////////////////////////////////////////////////////////////////////////////// +/// @section ArangoDBAdminManual ArangoDB's Administrator Manuals +///////////////////////////////////////////////////////////////// /// /// /// -/// @section ArangoDBAPIManual ArangoDB's Developer Manuals (Version @VERSION) -////////////////////////////////////////////////////////////////////////////// +/// @section ArangoDBAPIManual ArangoDB's Developer Manuals +/////////////////////////////////////////////////////////// /// ///