mirror of https://gitee.com/bigwinds/arangodb
fixed title for website output
This commit is contained in:
Frank Celler
parent
4800deb389
commit
aaf74fe8f6
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:<div class="title">\([^<]*\)</div>:<h1>\1</h1>: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:<div class="title">\([^<]*\)</div>:<h1>\1</h1>: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
|
||||
|
|
|
|||
|
|
@ -222,8 +222,9 @@ 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" \
|
||||
"EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else<a href=\1>\2</a> @endif" \
|
||||
"S_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 <a href= \1>\2</a>@endif" \
|
||||
"INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif" \
|
||||
"SPC= " \
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<ulink url="http://www.arangodb.org/manuals">here</ulink>.
|
||||
@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}.
|
||||
|
|
@ -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 <a href="http://www.arangodb.org/">here</a>.
|
||||
///
|
||||
/// 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 <ulink url="http://www.arangodb.org/manuals">here</ulink>. @endxmlonly
|
||||
///
|
||||
/// @warning
|
||||
/// The documentation is still far from complete. Please contact <a
|
||||
/// href="http://www.arangodb.org/connect">us</a>, if you have any
|
||||
/// questions.
|
||||
///
|
||||
/// @section ArangoDBUserManual ArangoDB's User Manuals
|
||||
////////////////////////////////////////////////////////
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref UserManual @ifnot XML @SPC[<a href="user-manual.pdf">pdf</a>] @endif</li>
|
||||
/// <li>@ref DbaManual @ifnot XML @SPC[<a href="dba-manual.pdf">pdf</a>] @endif</li>
|
||||
/// <li>@ref ImpManual @ifnot XML @SPC[<a href="imp-manual.pdf">pdf</a>] @endif</li>
|
||||
/// <li>@ref Glossary</li>
|
||||
/// @ifnot XML <li><a href="arangodb_1.0_shell_reference_card.pdf">Cheat Sheet</a></li> @endif
|
||||
/// </ul>
|
||||
///
|
||||
/// @section ArangoDBAdminManual ArangoDB's Administrator Manuals
|
||||
/////////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref InstallManual @ifnot XML @SPC[<a href="install-manual.pdf">pdf</a>] @endif</li>
|
||||
/// <li>@ref Glossary</li>
|
||||
/// </ul>
|
||||
///
|
||||
/// @section ArangoDBAPIManual ArangoDB's Developer Manuals
|
||||
///////////////////////////////////////////////////////////
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref ImplementorManual @ifnot XML @SPC[<a href="implementor-manual.pdf">pdf</a>] @endif</li>
|
||||
/// <li>@ref RefManual @ifnot XML @SPC[<a href="ref-manual.pdf">pdf</a>] @endif</li>
|
||||
/// <li>@ref Glossary</li>
|
||||
/// </ul>
|
||||
///
|
||||
/// @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 <a
|
||||
/// href="http://www.twitter.com/fceller">@@fceller</a>. We've also a "generic"
|
||||
/// twitter account mainly for announcements called <a
|
||||
/// href="http://www.twitter.com/arangodb">@@arangodb</a>
|
||||
///
|
||||
/// You can also subscribe to a low traffic announcement list on the <a
|
||||
/// href="http://www.arangodb.org/connect">connect page</a>.
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
||||
// End:
|
||||
Loading…
Reference in New Issue