HBASE-436 website

Part 1: Basic documentation.


git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@620246 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2008-02-10 06:50:00 +00:00
parent e1871f874b
commit 7b2a18e5bf
77 changed files with 4357 additions and 0 deletions

2
docs/broken-links.xml Normal file
View File

@ -0,0 +1,2 @@
<broken-links>
</broken-links>

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
docs/images/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 766 B

BIN
docs/images/hadoop-logo.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 B

194
docs/index.html Normal file
View File

@ -0,0 +1,194 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.8">
<meta name="Forrest-skin-name" content="pelt">
<title>HBase Documentation</title>
<link type="text/css" href="skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
<link type="text/css" href="skin/profile.css" rel="stylesheet">
<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
<link rel="shortcut icon" href="images/favicon.ico">
</head>
<body onload="init()">
<script type="text/javascript">ndeSetTextSize();</script>
<div id="top">
<!--+
|breadtrail
+-->
<div class="breadtrail">
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://hadoop.apache.org/">Hadoop</a> &gt; <a href="http://hadoop.apache.org/hbase/">HBase</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
</div>
<!--+
|header
+-->
<div class="header">
<!--+
|start group logo
+-->
<div class="grouplogo">
<a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a>
</div>
<!--+
|end group logo
+-->
<!--+
|start Project Logo
+-->
<div class="projectlogo">
<a href="http://hadoop.apache.org/hbase/"><img class="logoImage" alt="HBase" src="images/hbase_logo_med.gif" title="A distributed storage system for structured data built on top of Hadoop"></a>
</div>
<!--+
|end Project Logo
+-->
<!--+
|start Search
+-->
<div class="searchbox">
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
<input value="hadoop.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
<input name="Search" value="Search" type="submit">
</form>
</div>
<!--+
|end search
+-->
<!--+
|start Tabs
+-->
<ul id="tabs">
<li>
<a class="unselected" href="http://hadoop.apache.org/hbase/">Project</a>
</li>
<li>
<a class="unselected" href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</li>
<li class="current">
<a class="selected" href="index.html">HBase 0.1 Documentation</a>
</li>
</ul>
<!--+
|end Tabs
+-->
</div>
</div>
<div id="main">
<div id="publishedStrip">
<!--+
|start Subtabs
+-->
<div id="level2tabs"></div>
<!--+
|end Endtabs
+-->
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<!--+
|breadtrail
+-->
<div class="breadtrail">
&nbsp;
</div>
<!--+
|start Menu, mainarea
+-->
<!--+
|start Menu
+-->
<div id="menu">
<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Documentation</div>
<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
<div class="menupage">
<div class="menupagetitle">Overview</div>
</div>
<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/hadoop/Hbase/FAQ">FAQ</a>
</div>
<div class="menuitem">
<a href="http://hadoop.apache.org/hbase/mailing_lists.html">Mailing Lists</a>
</div>
</div>
<div id="credit">
<hr>
<a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
</div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
<!--+
|alternative credits
+-->
<div id="credit2"></div>
</div>
<!--+
|end Menu
+-->
<!--+
|start content
+-->
<div id="content">
<div title="Portable Document Format" class="pdflink">
<a class="dida" href="index.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
PDF</a>
</div>
<h1>HBase Documentation</h1>
<p>
The following documents provide concepts and procedures that will help you
get started using HBase. If you have more questions, you can ask the
<a href="http://hadoop.apache.org/hbase/mailing_lists.html">mailing list</a> or browse the archives.
</p>
<ul>
<li>
<a href="api/index.html">API Docs</a>
</li>
<li>
<a href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</li>
<li>
<a href="http://wiki.apache.org/hadoop/Hbase/FAQ">FAQ</a>
</li>
</ul>
</div>
<!--+
|end content
+-->
<div class="clearboth">&nbsp;</div>
</div>
<div id="footer">
<!--+
|start bottomstrip
+-->
<div class="lastmodified">
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<div class="copyright">
Copyright &copy;
2008 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
<div id="logos"></div>
<!--+
|end bottomstrip
+-->
</div>
</body>
</html>

144
docs/index.pdf Normal file
View File

@ -0,0 +1,144 @@
%PDF-1.3
%ª«¬­
4 0 obj
<< /Type /Info
/Producer (FOP 0.20.5) >>
endobj
5 0 obj
<< /Length 740 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
Gat=)a`?,Y(r#;b3$pF574_W&G$DH?WG+3<6dpZ;@7_,83$?n<[kC2YG`g%1n\P3Ts''p\//.L$M?$<n!m0.`LTeohT^[>ZoZ%4,@4\&WOrshJ#5l%/^.]9V#9Rq&l)D9J,3q/"C"'L'brth0Orp-V!?_'+7mnm:@=W#ePa$oW*@C4*U9;JLC'm%e&'W0+D5Glb\PnfN-KA<S8_W5qlSG,VOuj'*12SVs=*8@Wam6&tDkaS2i(fPP;q^_hLjL*rTTG0G4*?e/Zjp:;YauFWe"%.m,G]ru40B(,<Zbq2Za=`+TjHO<I'EN+nQroc2>HhRGU,[2Aq>,$+P,s>J0M[,31<<OJ7-;^YQmt\UUNq:C0?(d!LC^h_'Z:!dtN^sV_VH.8(WI@-r(++"_Nk[?aCHA@9`"6Xt/$4DV^LAEAWb<CPB.Or?oQjnWRidq]N5Ng2R:o,N@#h&K8G=)X*eJAi#G<;)G@D-F8b#8-keVc8*"eo"s7CI%fel;.'6KQkM[re+*WIQTq6).F8cf_Do7r0j1&>*OGS`;AXY+G*apM+M5>%"N+mYL`QE=mLj8t)=?>396HG,XOH$DfT48d3uK+/3t5umBJdA*4<@-3Sh]Hp,9/I(bo[rlb^eb^4fVmQ5JA`^%OlJiq2E-L?m+$)')!NA`V*#,7G6B2jr#u4,)f?/dI;n_@'NE^(I*b!]2,7ZZ4^H,S!OICAc3"`"/Dt<bS?I+SjOIq5A!$B[f~>
endstream
endobj
6 0 obj
<< /Type /Page
/Parent 1 0 R
/MediaBox [ 0 0 612 792 ]
/Resources 3 0 R
/Contents 5 0 R
/Annots 7 0 R
>>
endobj
7 0 obj
[
8 0 R
9 0 R
10 0 R
11 0 R
]
endobj
8 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 370.956 572.6 425.304 560.6 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (http://hadoop.apache.org/hbase/mailing_lists.html)
/S /URI >>
/H /I
>>
endobj
9 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 108.0 555.4 154.992 543.4 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (api/index.html)
/S /URI >>
/H /I
>>
endobj
10 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 108.0 542.2 132.0 530.2 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (http://wiki.apache.org/hadoop/Hbase)
/S /URI >>
/H /I
>>
endobj
11 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 108.0 529.0 132.0 517.0 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (http://wiki.apache.org/hadoop/Hbase/FAQ)
/S /URI >>
/H /I
>>
endobj
12 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F3
/BaseFont /Helvetica-Bold
/Encoding /WinAnsiEncoding >>
endobj
13 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F5
/BaseFont /Times-Roman
/Encoding /WinAnsiEncoding >>
endobj
14 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F1
/BaseFont /Helvetica
/Encoding /WinAnsiEncoding >>
endobj
15 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F2
/BaseFont /Helvetica-Oblique
/Encoding /WinAnsiEncoding >>
endobj
1 0 obj
<< /Type /Pages
/Count 1
/Kids [6 0 R ] >>
endobj
2 0 obj
<< /Type /Catalog
/Pages 1 0 R
>>
endobj
3 0 obj
<<
/Font << /F3 12 0 R /F5 13 0 R /F1 14 0 R /F2 15 0 R >>
/ProcSet [ /PDF /ImageC /Text ] >>
endobj
xref
0 16
0000000000 65535 f
0000002239 00000 n
0000002297 00000 n
0000002347 00000 n
0000000015 00000 n
0000000071 00000 n
0000000902 00000 n
0000001022 00000 n
0000001067 00000 n
0000001265 00000 n
0000001426 00000 n
0000001607 00000 n
0000001792 00000 n
0000001905 00000 n
0000002015 00000 n
0000002123 00000 n
trailer
<<
/Size 16
/Root 2 0 R
/Info 4 0 R
>>
startxref
2459
%%EOF

221
docs/linkmap.html Normal file
View File

@ -0,0 +1,221 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.8">
<meta name="Forrest-skin-name" content="pelt">
<title>Site Linkmap Table of Contents</title>
<link type="text/css" href="skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
<link type="text/css" href="skin/profile.css" rel="stylesheet">
<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
<link rel="shortcut icon" href="images/favicon.ico">
</head>
<body onload="init()">
<script type="text/javascript">ndeSetTextSize();</script>
<div id="top">
<!--+
|breadtrail
+-->
<div class="breadtrail">
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://hadoop.apache.org/">Hadoop</a> &gt; <a href="http://hadoop.apache.org/hbase/">HBase</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
</div>
<!--+
|header
+-->
<div class="header">
<!--+
|start group logo
+-->
<div class="grouplogo">
<a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a>
</div>
<!--+
|end group logo
+-->
<!--+
|start Project Logo
+-->
<div class="projectlogo">
<a href="http://hadoop.apache.org/hbase/"><img class="logoImage" alt="HBase" src="images/hbase_logo_med.gif" title="A distributed storage system for structured data built on top of Hadoop"></a>
</div>
<!--+
|end Project Logo
+-->
<!--+
|start Search
+-->
<div class="searchbox">
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
<input value="hadoop.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
<input name="Search" value="Search" type="submit">
</form>
</div>
<!--+
|end search
+-->
<!--+
|start Tabs
+-->
<ul id="tabs">
<li>
<a class="unselected" href="http://hadoop.apache.org/hbase/">Project</a>
</li>
<li>
<a class="unselected" href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</li>
<li class="current">
<a class="selected" href="index.html">HBase 0.1 Documentation</a>
</li>
</ul>
<!--+
|end Tabs
+-->
</div>
</div>
<div id="main">
<div id="publishedStrip">
<!--+
|start Subtabs
+-->
<div id="level2tabs"></div>
<!--+
|end Endtabs
+-->
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<!--+
|breadtrail
+-->
<div class="breadtrail">
&nbsp;
</div>
<!--+
|start Menu, mainarea
+-->
<!--+
|start Menu
+-->
<div id="menu">
<div onclick="SwitchMenu('menu_1.1', 'skin/')" id="menu_1.1Title" class="menutitle">Documentation</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
<a href="index.html">Overview</a>
</div>
<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</div>
<div class="menuitem">
<a href="http://wiki.apache.org/hadoop/Hbase/FAQ">FAQ</a>
</div>
<div class="menuitem">
<a href="http://hadoop.apache.org/hbase/mailing_lists.html">Mailing Lists</a>
</div>
</div>
<div id="credit"></div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
<!--+
|alternative credits
+-->
<div id="credit2"></div>
</div>
<!--+
|end Menu
+-->
<!--+
|start content
+-->
<div id="content">
<div title="Portable Document Format" class="pdflink">
<a class="dida" href="linkmap.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
PDF</a>
</div>
<h1>Site Linkmap Table of Contents</h1>
<p>
This is a map of the complete site and its structure.
</p>
<ul>
<li>
<a>Hadoop</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>site</em>
</li>
<ul>
<ul>
<li>
<a>Documentation</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>docs</em>
</li>
<ul>
<ul>
<li>
<a href="index.html">Overview</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>overview</em>
</li>
</ul>
<ul>
<li>
<a href="api/index.html">API Docs</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>api</em>
</li>
</ul>
<ul>
<li>
<a href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>wiki</em>
</li>
</ul>
<ul>
<li>
<a href="http://wiki.apache.org/hadoop/Hbase/FAQ">FAQ</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>faq</em>
</li>
</ul>
<ul>
<li>
<a href="http://hadoop.apache.org/hbase/mailing_lists.html">Mailing Lists</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>lists</em>
</li>
</ul>
</ul>
</ul>
</ul>
</ul>
</div>
<!--+
|end content
+-->
<div class="clearboth">&nbsp;</div>
</div>
<div id="footer">
<!--+
|start bottomstrip
+-->
<div class="lastmodified">
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<div class="copyright">
Copyright &copy;
2008 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
<!--+
|end bottomstrip
+-->
</div>
</body>
</html>

94
docs/linkmap.pdf Normal file
View File

@ -0,0 +1,94 @@
%PDF-1.3
%ª«¬­
4 0 obj
<< /Type /Info
/Producer (FOP 0.20.5) >>
endobj
5 0 obj
<< /Length 628 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
GatUpd;GF-'Sc(%$=BYHok\+W\4kXGgXN7(MR8;LW]Vtl<IuYZNV<&Jgr:ZUNPn'`T4;m?mpQ%-8:rRr&.f0\8;dK@Y:MqH*FOE/)hXs4EJe/F@utTEn&;sqndM%P..1[_f;a/RMV9@SnYc$AFlC?,\h^QHm2:-Ol&ST-!DKTc8<-+NjG7!MFJIR("RB\9r`H\h)hAI"U`GqaF?ue5FX`<:BpBcs.ef0d-e4YtQ^M,(iIN"FYd4HZnJh?-+mbD)1$X5ris=*-DSM$5lb40i#2uJ@f:a>e:ln'^-4(QVZoq/O&DfcN$jdh\T4;],^XCeQgT?r!8lp)]65j#a?RXOZB:Aqn5/BeaS3X]7Q-H@mqq4q"KH]Jf%=KXNM@:(6:QR/XIWsQ0C?T^k,-aAX(DF2;8OqgfSY@@??g:e="q&atp&._T'G%*Z;]bJ1Q?W@citjAeb@qm;-9(j^:o12CDZ-_<CZ[9Xe<q\\A&Zks*'X4f"ttVl%L.M^"="-7TSt"%TTPlQmXgARX%>8MmaX%K..aMY1BnN<5S?C!=d_ogs)$83A"3ii&;FIY&;iX>hK[>ZX@;9lpUW&*d<M(EhGsC0$IJ[O/6srC[pCW?mVKub]%6l^@.AlL~>
endstream
endobj
6 0 obj
<< /Type /Page
/Parent 1 0 R
/MediaBox [ 0 0 612 792 ]
/Resources 3 0 R
/Contents 5 0 R
>>
endobj
7 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F3
/BaseFont /Helvetica-Bold
/Encoding /WinAnsiEncoding >>
endobj
8 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F5
/BaseFont /Times-Roman
/Encoding /WinAnsiEncoding >>
endobj
9 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F6
/BaseFont /Times-Italic
/Encoding /WinAnsiEncoding >>
endobj
10 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F1
/BaseFont /Helvetica
/Encoding /WinAnsiEncoding >>
endobj
11 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F2
/BaseFont /Helvetica-Oblique
/Encoding /WinAnsiEncoding >>
endobj
1 0 obj
<< /Type /Pages
/Count 1
/Kids [6 0 R ] >>
endobj
2 0 obj
<< /Type /Catalog
/Pages 1 0 R
>>
endobj
3 0 obj
<<
/Font << /F3 7 0 R /F5 8 0 R /F1 10 0 R /F6 9 0 R /F2 11 0 R >>
/ProcSet [ /PDF /ImageC /Text ] >>
endobj
xref
0 12
0000000000 65535 f
0000001451 00000 n
0000001509 00000 n
0000001559 00000 n
0000000015 00000 n
0000000071 00000 n
0000000790 00000 n
0000000896 00000 n
0000001008 00000 n
0000001117 00000 n
0000001227 00000 n
0000001335 00000 n
trailer
<<
/Size 12
/Root 2 0 R
/Info 4 0 R
>>
startxref
1679
%%EOF

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->
<catalogue>
<message key="Font size:">Schriftgrösse:</message>
<message key="Last Published:">Zuletzt veröffentlicht:</message>
<message key="Search">Suche:</message>
<message key="Search the site with">Suche auf der Seite mit</message>
</catalogue>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->
<catalogue>
<message key="Font size:">Font size:</message>
<message key="Last Published:">Last Published:</message>
<message key="Search">Search</message>
<message key="Search the site with">Search site with</message>
</catalogue>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->
<catalogue>
<message key="Font size:">Tamaño del texto:</message>
<message key="Last Published:">Fecha de publicación:</message>
<message key="Search">Buscar</message>
<message key="Search the site with">Buscar en</message>
</catalogue>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->
<catalogue>
<message key="Font size:">Taille :</message>
<message key="Last Published:">Dernière publication :</message>
<message key="Search">Rechercher</message>
<message key="Search the site with">Rechercher sur le site avec</message>
</catalogue>

166
docs/skin/basic.css Normal file
View File

@ -0,0 +1,166 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* General
*/
img { border: 0; }
#content table {
border: 0;
width: 100%;
}
/*Hack to get IE to render the table at 100%*/
* html #content table { margin-left: -3px; }
#content th,
#content td {
margin: 0;
padding: 0;
vertical-align: top;
}
.clearboth {
clear: both;
}
.note, .warning, .fixme {
border: solid black 1px;
margin: 1em 3em;
}
.note .label {
background: #369;
color: white;
font-weight: bold;
padding: 5px 10px;
}
.note .content {
background: #F0F0FF;
color: black;
line-height: 120%;
font-size: 90%;
padding: 5px 10px;
}
.warning .label {
background: #C00;
color: white;
font-weight: bold;
padding: 5px 10px;
}
.warning .content {
background: #FFF0F0;
color: black;
line-height: 120%;
font-size: 90%;
padding: 5px 10px;
}
.fixme .label {
background: #C6C600;
color: black;
font-weight: bold;
padding: 5px 10px;
}
.fixme .content {
padding: 5px 10px;
}
/**
* Typography
*/
body {
font-family: verdana, "Trebuchet MS", arial, helvetica, sans-serif;
font-size: 100%;
}
#content {
font-family: Georgia, Palatino, Times, serif;
font-size: 95%;
}
#tabs {
font-size: 70%;
}
#menu {
font-size: 80%;
}
#footer {
font-size: 70%;
}
h1, h2, h3, h4, h5, h6 {
font-family: "Trebuchet MS", verdana, arial, helvetica, sans-serif;
font-weight: bold;
margin-top: 1em;
margin-bottom: .5em;
}
h1 {
margin-top: 0;
margin-bottom: 1em;
font-size: 1.4em;
}
#content h1 {
font-size: 160%;
margin-bottom: .5em;
}
#menu h1 {
margin: 0;
padding: 10px;
background: #336699;
color: white;
}
h2 { font-size: 120%; }
h3 { font-size: 100%; }
h4 { font-size: 90%; }
h5 { font-size: 80%; }
h6 { font-size: 75%; }
p {
line-height: 120%;
text-align: left;
margin-top: .5em;
margin-bottom: 1em;
}
#content li,
#content th,
#content td,
#content li ul,
#content li ol{
margin-top: .5em;
margin-bottom: .5em;
}
#content li li,
#minitoc-area li{
margin-top: 0em;
margin-bottom: 0em;
}
#content .attribution {
text-align: right;
font-style: italic;
font-size: 85%;
margin-top: 1em;
}
.codefrag {
font-family: "Courier New", Courier, monospace;
font-size: 110%;
}

View File

@ -0,0 +1,90 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
var PREPREND_CRUMBS=new Array();
var link1="@skinconfig.trail.link1.name@";
var link2="@skinconfig.trail.link2.name@";
var link3="@skinconfig.trail.link3.name@";
if(!(link1=="")&&!link1.indexOf( "@" ) == 0){
PREPREND_CRUMBS.push( new Array( link1, @skinconfig.trail.link1.href@ ) ); }
if(!(link2=="")&&!link2.indexOf( "@" ) == 0){
PREPREND_CRUMBS.push( new Array( link2, @skinconfig.trail.link2.href@ ) ); }
if(!(link3=="")&&!link3.indexOf( "@" ) == 0){
PREPREND_CRUMBS.push( new Array( link3, @skinconfig.trail.link3.href@ ) ); }
var DISPLAY_SEPARATOR=" &gt; ";
var DISPLAY_PREPREND=" &gt; ";
var DISPLAY_POSTPREND=":";
var CSS_CLASS_CRUMB="breadcrumb";
var CSS_CLASS_TRAIL="breadcrumbTrail";
var CSS_CLASS_SEPARATOR="crumbSeparator";
var FILE_EXTENSIONS=new Array( ".html", ".htm", ".jsp", ".php", ".php3", ".php4" );
var PATH_SEPARATOR="/";
function sc(s) {
var l=s.toLowerCase();
return l.substr(0,1).toUpperCase()+l.substr(1);
}
function getdirs() {
var t=document.location.pathname.split(PATH_SEPARATOR);
var lc=t[t.length-1];
for(var i=0;i < FILE_EXTENSIONS.length;i++)
{
if(lc.indexOf(FILE_EXTENSIONS[i]))
return t.slice(1,t.length-1); }
return t.slice(1,t.length);
}
function getcrumbs( d )
{
var pre = "/";
var post = "/";
var c = new Array();
if( d != null )
{
for(var i=0;i < d.length;i++) {
pre+=d[i]+postfix;
c.push(new Array(d[i],pre)); }
}
if(PREPREND_CRUMBS.length > 0 )
return PREPREND_CRUMBS.concat( c );
return c;
}
function gettrail( c )
{
var h=DISPLAY_PREPREND;
for(var i=0;i < c.length;i++)
{
h+='<a href="'+c[i][1]+'" >'+sc(c[i][0])+'</a>';
if(i!=(c.length-1))
h+=DISPLAY_SEPARATOR; }
return h+DISPLAY_POSTPREND;
}
function gettrailXHTML( c )
{
var h='<span class="'+CSS_CLASS_TRAIL+'">'+DISPLAY_PREPREND;
for(var i=0;i < c.length;i++)
{
h+='<a href="'+c[i][1]+'" class="'+CSS_CLASS_CRUMB+'">'+sc(c[i][0])+'</a>';
if(i!=(c.length-1))
h+='<span class="'+CSS_CLASS_SEPARATOR+'">'+DISPLAY_SEPARATOR+'</span>'; }
return h+DISPLAY_POSTPREND+'</span>';
}
if(document.location.href.toLowerCase().indexOf("http://")==-1)
document.write(gettrail(getcrumbs()));
else
document.write(gettrail(getcrumbs(getdirs())));

237
docs/skin/breadcrumbs.js Normal file
View File

@ -0,0 +1,237 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* This script, when included in a html file, builds a neat breadcrumb trail
* based on its url. That is, if it doesn't contains bugs (I'm relatively
* sure it does).
*
* Typical usage:
* <script type="text/javascript" language="JavaScript" src="breadcrumbs.js"></script>
*/
/**
* IE 5 on Mac doesn't know Array.push.
*
* Implement it - courtesy to fritz.
*/
var abc = new Array();
if (!abc.push) {
Array.prototype.push = function(what){this[this.length]=what}
}
/* ========================================================================
CONSTANTS
======================================================================== */
/**
* Two-dimensional array containing extra crumbs to place at the front of
* the trail. Specify first the name of the crumb, then the URI that belongs
* to it. You'll need to modify this for every domain or subdomain where
* you use this script (you can leave it as an empty array if you wish)
*/
var PREPREND_CRUMBS = new Array();
var link1 = "@skinconfig.trail.link1.name@";
var link2 = "@skinconfig.trail.link2.name@";
var link3 = "@skinconfig.trail.link3.name@";
var href1 = "@skinconfig.trail.link1.href@";
var href2 = "@skinconfig.trail.link2.href@";
var href3 = "@skinconfig.trail.link3.href@";
if(!(link1=="")&&!link1.indexOf( "@" ) == 0){
PREPREND_CRUMBS.push( new Array( link1, href1 ) );
}
if(!(link2=="")&&!link2.indexOf( "@" ) == 0){
PREPREND_CRUMBS.push( new Array( link2, href2 ) );
}
if(!(link3=="")&&!link3.indexOf( "@" ) == 0){
PREPREND_CRUMBS.push( new Array( link3, href3 ) );
}
/**
* String to include between crumbs:
*/
var DISPLAY_SEPARATOR = " &gt; ";
/**
* String to include at the beginning of the trail
*/
var DISPLAY_PREPREND = " &gt; ";
/**
* String to include at the end of the trail
*/
var DISPLAY_POSTPREND = "";
/**
* CSS Class to use for a single crumb:
*/
var CSS_CLASS_CRUMB = "breadcrumb";
/**
* CSS Class to use for the complete trail:
*/
var CSS_CLASS_TRAIL = "breadcrumbTrail";
/**
* CSS Class to use for crumb separator:
*/
var CSS_CLASS_SEPARATOR = "crumbSeparator";
/**
* Array of strings containing common file extensions. We use this to
* determine what part of the url to ignore (if it contains one of the
* string specified here, we ignore it).
*/
var FILE_EXTENSIONS = new Array( ".html", ".htm", ".jsp", ".php", ".php3", ".php4" );
/**
* String that separates parts of the breadcrumb trail from each other.
* When this is no longer a slash, I'm sure I'll be old and grey.
*/
var PATH_SEPARATOR = "/";
/* ========================================================================
UTILITY FUNCTIONS
======================================================================== */
/**
* Capitalize first letter of the provided string and return the modified
* string.
*/
function sentenceCase( string )
{ return string;
//var lower = string.toLowerCase();
//return lower.substr(0,1).toUpperCase() + lower.substr(1);
}
/**
* Returns an array containing the names of all the directories in the
* current document URL
*/
function getDirectoriesInURL()
{
var trail = document.location.pathname.split( PATH_SEPARATOR );
// check whether last section is a file or a directory
var lastcrumb = trail[trail.length-1];
for( var i = 0; i < FILE_EXTENSIONS.length; i++ )
{
if( lastcrumb.indexOf( FILE_EXTENSIONS[i] ) )
{
// it is, remove it and send results
return trail.slice( 1, trail.length-1 );
}
}
// it's not; send the trail unmodified
return trail.slice( 1, trail.length );
}
/* ========================================================================
BREADCRUMB FUNCTIONALITY
======================================================================== */
/**
* Return a two-dimensional array describing the breadcrumbs based on the
* array of directories passed in.
*/
function getBreadcrumbs( dirs )
{
var prefix = "/";
var postfix = "/";
// the array we will return
var crumbs = new Array();
if( dirs != null )
{
for( var i = 0; i < dirs.length; i++ )
{
prefix += dirs[i] + postfix;
crumbs.push( new Array( dirs[i], prefix ) );
}
}
// preprend the PREPREND_CRUMBS
if(PREPREND_CRUMBS.length > 0 )
{
return PREPREND_CRUMBS.concat( crumbs );
}
return crumbs;
}
/**
* Return a string containing a simple text breadcrumb trail based on the
* two-dimensional array passed in.
*/
function getCrumbTrail( crumbs )
{
var xhtml = DISPLAY_PREPREND;
for( var i = 0; i < crumbs.length; i++ )
{
xhtml += '<a href="' + crumbs[i][1] + '" >';
xhtml += unescape( crumbs[i][0] ) + '</a>';
if( i != (crumbs.length-1) )
{
xhtml += DISPLAY_SEPARATOR;
}
}
xhtml += DISPLAY_POSTPREND;
return xhtml;
}
/**
* Return a string containing an XHTML breadcrumb trail based on the
* two-dimensional array passed in.
*/
function getCrumbTrailXHTML( crumbs )
{
var xhtml = '<span class="' + CSS_CLASS_TRAIL + '">';
xhtml += DISPLAY_PREPREND;
for( var i = 0; i < crumbs.length; i++ )
{
xhtml += '<a href="' + crumbs[i][1] + '" class="' + CSS_CLASS_CRUMB + '">';
xhtml += unescape( crumbs[i][0] ) + '</a>';
if( i != (crumbs.length-1) )
{
xhtml += '<span class="' + CSS_CLASS_SEPARATOR + '">' + DISPLAY_SEPARATOR + '</span>';
}
}
xhtml += DISPLAY_POSTPREND;
xhtml += '</span>';
return xhtml;
}
/* ========================================================================
PRINT BREADCRUMB TRAIL
======================================================================== */
// check if we're local; if so, only print the PREPREND_CRUMBS
if( document.location.href.toLowerCase().indexOf( "http://" ) == -1 )
{
document.write( getCrumbTrail( getBreadcrumbs() ) );
}
else
{
document.write( getCrumbTrail( getBreadcrumbs( getDirectoriesInURL() ) ) );
}

166
docs/skin/fontsize.js Normal file
View File

@ -0,0 +1,166 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
function init()
{ //embedded in the doc
//ndeSetTextSize();
}
function checkBrowser(){
if (!document.getElementsByTagName){
return true;
}
else{
return false;
}
}
function ndeSetTextSize(chgsize,rs)
{
var startSize;
var newSize;
if (!checkBrowser)
{
return;
}
startSize = parseInt(ndeGetDocTextSize());
if (!startSize)
{
startSize = 16;
}
switch (chgsize)
{
case 'incr':
newSize = startSize + 2;
break;
case 'decr':
newSize = startSize - 2;
break;
case 'reset':
if (rs) {newSize = rs;} else {newSize = 16;}
break;
default:
try{
newSize = parseInt(ndeReadCookie("nde-textsize"));
}
catch(e){
alert(e);
}
if (!newSize || newSize == 'NaN')
{
newSize = startSize;
}
break;
}
if (newSize < 10)
{
newSize = 10;
}
newSize += 'px';
document.getElementsByTagName('html')[0].style.fontSize = newSize;
document.getElementsByTagName('body')[0].style.fontSize = newSize;
ndeCreateCookie("nde-textsize", newSize, 365);
}
function ndeGetDocTextSize()
{
if (!checkBrowser)
{
return 0;
}
var size = 0;
var body = document.getElementsByTagName('body')[0];
if (body.style && body.style.fontSize)
{
size = body.style.fontSize;
}
else if (typeof(getComputedStyle) != 'undefined')
{
size = getComputedStyle(body,'').getPropertyValue('font-size');
}
else if (body.currentStyle)
{
size = body.currentStyle.fontSize;
}
//fix IE bug
if( isNaN(size)){
if(size.substring(size.length-1)=="%"){
return
}
}
return size;
}
function ndeCreateCookie(name,value,days)
{
var cookie = name + "=" + value + ";";
if (days)
{
var date = new Date();
date.setTime(date.getTime()+(days*24*60*60*1000));
cookie += " expires=" + date.toGMTString() + ";";
}
cookie += " path=/";
document.cookie = cookie;
}
function ndeReadCookie(name)
{
var nameEQ = name + "=";
var ca = document.cookie.split(';');
for(var i = 0; i < ca.length; i++)
{
var c = ca[i];
while (c.charAt(0) == ' ')
{
c = c.substring(1, c.length);
}
ctest = c.substring(0,name.length);
if(ctest == name){
return c.substring(nameEQ.length,c.length);
}
}
return null;
}

40
docs/skin/getBlank.js Normal file
View File

@ -0,0 +1,40 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* getBlank script - when included in a html file and called from a form text field, will set the value of this field to ""
* if the text value is still the standard value.
* getPrompt script - when included in a html file and called from a form text field, will set the value of this field to the prompt
* if the text value is empty.
*
* Typical usage:
* <script type="text/javascript" language="JavaScript" src="getBlank.js"></script>
* <input type="text" id="query" value="Search the site:" onFocus="getBlank (this, 'Search the site:');" onBlur="getBlank (this, 'Search the site:');"/>
*/
<!--
function getBlank (form, stdValue){
if (form.value == stdValue){
form.value = '';
}
return true;
}
function getPrompt (form, stdValue){
if (form.value == ''){
form.value = stdValue;
}
return true;
}
//-->

45
docs/skin/getMenu.js Normal file
View File

@ -0,0 +1,45 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* This script, when included in a html file, can be used to make collapsible menus
*
* Typical usage:
* <script type="text/javascript" language="JavaScript" src="menu.js"></script>
*/
if (document.getElementById){
document.write('<style type="text/css">.menuitemgroup{display: none;}</style>')
}
function SwitchMenu(obj, thePath)
{
var open = 'url("'+thePath + 'images/chapter_open.gif")';
var close = 'url("'+thePath + 'images/chapter.gif")';
if(document.getElementById) {
var el = document.getElementById(obj);
var title = document.getElementById(obj+'Title');
if(el.style.display != "block"){
title.style.backgroundImage = open;
el.style.display = "block";
}else{
title.style.backgroundImage = close;
el.style.display = "none";
}
}// end - if(document.getElementById)
}//end - function SwitchMenu(obj)

View File

@ -0,0 +1 @@
The images in this directory are used if the current skin lacks them.

BIN
docs/skin/images/add.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 B

BIN
docs/skin/images/error.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 B

BIN
docs/skin/images/fix.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 932 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

BIN
docs/skin/images/hack.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 743 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 B

BIN
docs/skin/images/info.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 B

BIN
docs/skin/images/label.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 B

BIN
docs/skin/images/page.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 B

BIN
docs/skin/images/pdfdoc.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1008 B

BIN
docs/skin/images/poddoc.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 856 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 603 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 350 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 308 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 197 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 222 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 197 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 390 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 219 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 B

BIN
docs/skin/images/remove.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

BIN
docs/skin/images/rss.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 360 B

BIN
docs/skin/images/spacer.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

BIN
docs/skin/images/txtdoc.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 784 B

BIN
docs/skin/images/update.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 990 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
docs/skin/images/vcss.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

BIN
docs/skin/images/xmldoc.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 992 B

48
docs/skin/menu.js Normal file
View File

@ -0,0 +1,48 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* This script, when included in a html file, can be used to make collapsible menus
*
* Typical usage:
* <script type="text/javascript" language="JavaScript" src="menu.js"></script>
*/
if (document.getElementById){
document.write('<style type="text/css">.menuitemgroup{display: none;}</style>')
}
function SwitchMenu(obj)
{
if(document.getElementById) {
var el = document.getElementById(obj);
var title = document.getElementById(obj+'Title');
if(obj.indexOf("_selected_")==0&&el.style.display == ""){
el.style.display = "block";
title.className = "pagegroupselected";
}
if(el.style.display != "block"){
el.style.display = "block";
title.className = "pagegroupopen";
}
else{
el.style.display = "none";
title.className = "pagegroup";
}
}// end - if(document.getElementById)
}//end - function SwitchMenu(obj)

50
docs/skin/note.txt Normal file
View File

@ -0,0 +1,50 @@
Notes for developer:
--Legend-------------------
TODO -> blocker
DONE -> blocker
ToDo -> enhancement bug
done -> enhancement bug
--Issues-------------------
- the corner images should be rendered through svg with the header color.
-> DONE
-> ToDo: get rid of the images and use only divs!
- the menu points should be displayed "better".
-> DONE
-- Use the krysalis-site menu approach for the overall menu display.
-> DONE
-- Use the old lenya innermenu approch to further enhance the menu .
-> DONE
- the content area needs some attention.
-> DONE
-- introduce the heading scheme from krysalis (<headings type="clean|box|underlined"/>)
-> DONE
-> ToDo: make box with round corners
-> done: make underlined with variable border height
-> ToDo: make underline with bottom round corner
-- introduce the toc for each html-page
-> DONE
-- introduce the external-link-images.
-> DONE
- the publish note should be where now only a border is.
Like <div id="published"/>
-> DONE
, but make it configurable.
-> DONE
- footer needs some attention
-> DONE
-- the footer do not have the color profile! Enable it!
-> DONE
-- the footer should as well contain a feedback link.
See http://issues.apache.org/eyebrowse/ReadMsg?listName=forrest-user@xml.apache.org&msgNo=71
-> DONE
- introduce credits alternativ location
-> DONE
- border for published / breadtrail / menu /tab divs
-> ToDo

54
docs/skin/print.css Normal file
View File

@ -0,0 +1,54 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
body {
font-family: Georgia, Palatino, serif;
font-size: 12pt;
background: white;
}
#tabs,
#menu,
#content .toc {
display: none;
}
#content {
width: auto;
padding: 0;
float: none !important;
color: black;
background: inherit;
}
a:link, a:visited {
color: #336699;
background: inherit;
text-decoration: underline;
}
#top .logo {
padding: 0;
margin: 0 0 2em 0;
}
#footer {
margin-top: 4em;
}
acronym {
border: 0;
}

158
docs/skin/profile.css Normal file
View File

@ -0,0 +1,158 @@
/* ==================== aural ============================ */
@media aural {
h1, h2, h3, h4, h5, h6 { voice-family: paul, male; stress: 20; richness: 90 }
h1 { pitch: x-low; pitch-range: 90 }
h2 { pitch: x-low; pitch-range: 80 }
h3 { pitch: low; pitch-range: 70 }
h4 { pitch: medium; pitch-range: 60 }
h5 { pitch: medium; pitch-range: 50 }
h6 { pitch: medium; pitch-range: 40 }
li, dt, dd { pitch: medium; richness: 60 }
dt { stress: 80 }
pre, code, tt { pitch: medium; pitch-range: 0; stress: 0; richness: 80 }
em { pitch: medium; pitch-range: 60; stress: 60; richness: 50 }
strong { pitch: medium; pitch-range: 60; stress: 90; richness: 90 }
dfn { pitch: high; pitch-range: 60; stress: 60 }
s, strike { richness: 0 }
i { pitch: medium; pitch-range: 60; stress: 60; richness: 50 }
b { pitch: medium; pitch-range: 60; stress: 90; richness: 90 }
u { richness: 0 }
:link { voice-family: harry, male }
:visited { voice-family: betty, female }
:active { voice-family: betty, female; pitch-range: 80; pitch: x-high }
}
a.external {
padding: 0 20px 0px 0px;
display:inline;
background-repeat: no-repeat;
background-position: center right;
background-image: url(images/external-link.gif);
}
#top { background-color: #FFFFFF;}
#top .header .current { background-color: #4C6C8F;}
#top .header .current a:link { color: #ffffff; }
#top .header .current a:visited { color: #ffffff; }
#top .header .current a:hover { color: #ffffff; }
#tabs li { background-color: #E5E4D9 ;}
#tabs li a:link { color: #000000; }
#tabs li a:visited { color: #000000; }
#tabs li a:hover { color: #000000; }
#level2tabs a.selected { background-color: #4C6C8F ;}
#level2tabs a:link { color: #ffffff; }
#level2tabs a:visited { color: #ffffff; }
#level2tabs a:hover { color: #ffffff; }
#level2tabs { background-color: #E5E4D9;}
#level2tabs a.unselected:link { color: #000000; }
#level2tabs a.unselected:visited { color: #000000; }
#level2tabs a.unselected:hover { color: #000000; }
.heading { background-color: #E5E4D9;}
.boxed { background-color: #E5E4D9;}
.underlined_5 {border-bottom: solid 5px #E5E4D9;}
.underlined_10 {border-bottom: solid 10px #E5E4D9;}
table caption {
background-color: #E5E4D9;
color: #000000;
}
#feedback {
color: #FFFFFF;
background: #4C6C8F;
text-align: center;
}
#feedback #feedbackto {
color: #FFFFFF;
}
#publishedStrip {
color: #FFFFFF;
background: #4C6C8F;
}
#publishedStrip {
color: #000000;
background: #E5E4D9;
}
#menu .menupagetitle { background-color: #CFDCED;
color: #000000;}
#menu { border-color: #999999;}
#menu .menupagetitle { border-color: #999999;}
#menu .menupageitemgroup { border-color: #999999;}
#menu { background-color: #4C6C8F;}
#menu { color: #ffffff;}
#menu a:link { color: #ffffff;}
#menu a:visited { color: #ffffff;}
#menu a:hover {
background-color: #4C6C8F;
color: #ffffff;}
#menu h1 {
color: #000000;
background-color: #cfdced;
}
#top .searchbox {
background-color: #E5E4D9 ;
color: #000000;
}
#menu .menupageitemgroup {
background-color: #E5E4D9;
}
#menu .menupageitem {
color: #000000;
}
#menu .menupageitem a:link { color: #000000;}
#menu .menupageitem a:visited { color: #000000;}
#menu .menupageitem a:hover {
background-color: #E5E4D9;
color: #000000;
}
body{
background-color: #ffffff;
color: #000000;
}
a:link { color:#0000ff}
a:visited { color:#009999}
a:hover { color:#6587ff}
.ForrestTable { background-color: #ccc;}
.ForrestTable td { background-color: #ffffff;}
.highlight { background-color: #ffff00;}
.fixme { border-color: #c60;}
.note { border-color: #069;}
.warning { border-color: #900;}
.code { border-color: #a5b6c6;}
#footer { background-color: #E5E4D9;}
/* extra-css */
p.quote {
margin-left: 2em;
padding: .5em;
background-color: #f0f0f0;
font-family: monospace;
}

1257
docs/skin/prototype.js vendored Normal file

File diff suppressed because it is too large Load Diff

587
docs/skin/screen.css Normal file
View File

@ -0,0 +1,587 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
body { margin: 0px 0px 0px 0px; font-family: Verdana, Helvetica, sans-serif; }
h1 { font-size : 160%; margin: 0px 0px 0px 0px; padding: 0px; }
h2 { font-size : 140%; margin: 1em 0px 0.8em 0px; padding: 0px; font-weight : bold;}
h3 { font-size : 130%; margin: 0.8em 0px 0px 0px; padding: 0px; font-weight : bold; }
.h3 { margin: 22px 0px 3px 0px; }
h4 { font-size : 120%; margin: 0.7em 0px 0px 0px; padding: 0px; font-weight : normal; text-align: left; }
.h4 { margin: 18px 0px 0px 0px; }
h4.faq { font-size : 120%; margin: 18px 0px 0px 0px; padding: 0px; font-weight : bold; text-align: left; }
h5 { font-size : 100%; margin: 14px 0px 0px 0px; padding: 0px; font-weight : normal; text-align: left; }
/**
* table
*/
table .title { background-color: #000000; }
.ForrestTable {
color: #ffffff;
background-color: #7099C5;
width: 100%;
font-size : 100%;
empty-cells: show;
}
table caption {
padding-left: 5px;
color: white;
text-align: left;
font-weight: bold;
background-color: #000000;
}
.ForrestTable td {
color: black;
background-color: #f0f0ff;
}
.ForrestTable th { text-align: center; }
/**
* Page Header
*/
#top {
position: relative;
float: left;
width: 100%;
background: #294563; /* if you want a background in the header, put it here */
}
#top .breadtrail {
background: #CFDCED;
color: black;
border-bottom: solid 1px white;
padding: 3px 10px;
font-size: 75%;
}
#top .breadtrail a { color: black; }
#top .header {
float: left;
width: 100%;
background: url("images/header_white_line.gif") repeat-x bottom;
}
#top .grouplogo {
padding: 7px 0 10px 10px;
float: left;
text-align: left;
}
#top .projectlogo {
padding: 7px 0 10px 10px;
float: left;
width: 33%;
text-align: right;
}
#top .projectlogoA1 {
padding: 7px 0 10px 10px;
float: right;
}
html>body #top .searchbox {
bottom: 0px;
}
#top .searchbox {
position: absolute;
right: 10px;
height: 42px;
font-size: 70%;
white-space: nowrap;
text-align: right;
color: white;
background-color: #000000;
z-index:0;
background-image: url(images/rc-t-l-5-1header-2searchbox-3searchbox.png);
background-repeat: no-repeat;
background-position: top left;
bottom: -1px; /* compensate for IE rendering issue */
}
#top .searchbox form {
padding: 5px 10px;
margin: 0;
}
#top .searchbox p {
padding: 0 0 2px 0;
margin: 0;
}
#top .searchbox input {
font-size: 100%;
}
#tabs {
clear: both;
padding-left: 10px;
margin: 0;
list-style: none;
}
/* background: #CFDCED url("images/tab-right.gif") no-repeat right top;*/
#tabs li {
float: left;
background-image: url(images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png);
background-repeat: no-repeat;
background-position: top right;
background-color: #000000;
margin: 0 3px 0 0;
padding: 0;
}
/*background: url("images/tab-left.gif") no-repeat left top;*/
#tabs li a {
float: left;
display: block;
font-family: verdana, arial, sans-serif;
text-decoration: none;
color: black;
white-space: nowrap;
background-image: url(images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png);
background-repeat: no-repeat;
background-position: top left;
padding: 5px 15px 4px;
width: .1em; /* IE/Win fix */
}
#tabs li a:hover {
cursor: pointer;
text-decoration:underline;
}
#tabs > li a { width: auto; } /* Rest of IE/Win fix */
/* Commented Backslash Hack hides rule from IE5-Mac \*/
#tabs a { float: none; }
/* End IE5-Mac hack */
#top .header .current {
background-color: #4C6C8F;
background-image: url(images/rc-t-r-5-1header-2tab-selected-3tab-selected.png);
background-repeat: no-repeat;
background-position: top right;
}
#top .header .current a {
font-weight: bold;
padding-bottom: 5px;
color: white;
background-image: url(images/rc-t-l-5-1header-2tab-selected-3tab-selected.png);
background-repeat: no-repeat;
background-position: top left;
}
#publishedStrip {
padding-right: 10px;
padding-left: 20px;
padding-top: 3px;
padding-bottom:3px;
color: #ffffff;
font-size : 60%;
font-weight: bold;
background-color: #4C6C8F;
text-align:right;
}
#level2tabs {
margin: 0;
float:left;
position:relative;
}
#level2tabs a:hover {
cursor: pointer;
text-decoration:underline;
}
#level2tabs a{
cursor: pointer;
text-decoration:none;
background-image: url('images/chapter.gif');
background-repeat: no-repeat;
background-position: center left;
padding-left: 6px;
margin-left: 6px;
}
/*
* border-top: solid #4C6C8F 15px;
*/
#main {
position: relative;
background: white;
clear:both;
}
#main .breadtrail {
clear:both;
position: relative;
background: #CFDCED;
color: black;
border-bottom: solid 1px black;
border-top: solid 1px black;
padding: 0px 180px;
font-size: 75%;
z-index:10;
}
/**
* Round corner
*/
#roundtop {
background-image: url(images/rc-t-r-15-1body-2menu-3menu.png);
background-repeat: no-repeat;
background-position: top right;
}
#roundbottom {
background-image: url(images/rc-b-r-15-1body-2menu-3menu.png);
background-repeat: no-repeat;
background-position: top right;
}
img.corner {
width: 15px;
height: 15px;
border: none;
display: block !important;
}
.roundtopsmall {
background-image: url(images/rc-t-r-5-1header-2searchbox-3searchbox.png);
background-repeat: no-repeat;
background-position: top right;
}
#roundbottomsmall {
background-image: url(images/rc-b-r-5-1header-2tab-selected-3tab-selected.png);
background-repeat: no-repeat;
background-position: top right;
}
img.cornersmall {
width: 5px;
height: 5px;
border: none;
display: block !important;
}
/**
* Side menu
*/
#menu a { font-weight: normal; text-decoration: none;}
#menu a:visited { font-weight: normal; }
#menu a:active { font-weight: normal; }
#menu a:hover { font-weight: normal; text-decoration:underline;}
#menuarea { width:10em;}
#menu {
position: relative;
float: left;
width: 160px;
padding-top: 0px;
top:-18px;
left:10px;
z-index: 20;
background-color: #f90;
font-size : 70%;
}
.menutitle {
cursor:pointer;
padding: 3px 12px;
margin-left: 10px;
background-image: url('images/chapter.gif');
background-repeat: no-repeat;
background-position: center left;
font-weight : bold;
}
.menutitle:hover{text-decoration:underline;cursor: pointer;}
#menu .menuitemgroup {
margin: 0px 0px 6px 8px;
padding: 0px;
font-weight : bold; }
#menu .selectedmenuitemgroup{
margin: 0px 0px 0px 8px;
padding: 0px;
font-weight : normal;
}
#menu .menuitem {
padding: 2px 0px 1px 13px;
background-image: url('images/page.gif');
background-repeat: no-repeat;
background-position: center left;
font-weight : normal;
margin-left: 10px;
}
#menu .menupage {
margin: 2px 0px 1px 10px;
padding: 0px 3px 0px 12px;
background-image: url('images/page.gif');
background-repeat: no-repeat;
background-position: center left;
font-style : normal;
}
#menu .menupagetitle {
padding: 0px 0px 0px 1px;
font-style : normal;
border-style: solid;
border-width: 1px;
margin-right: 10px;
}
#menu .menupageitemgroup {
padding: 3px 0px 4px 6px;
font-style : normal;
border-bottom: 1px solid ;
border-left: 1px solid ;
border-right: 1px solid ;
margin-right: 10px;
}
#menu .menupageitem {
font-style : normal;
font-weight : normal;
border-width: 0px;
font-size : 90%;
}
#menu #credit {
text-align: center;
}
#menu #credit2 {
text-align: center;
padding: 3px 3px 3px 3px;
background-color: #ffffff;
}
#menu .searchbox {
text-align: center;
}
#menu .searchbox form {
padding: 3px 3px;
margin: 0;
}
#menu .searchbox input {
font-size: 100%;
}
#content {
padding: 20px 20px 20px 180px;
margin: 0;
font : small Verdana, Helvetica, sans-serif;
font-size : 80%;
}
#content ul {
margin: 0;
padding: 0 25px;
}
#content li {
padding: 0 5px;
}
#feedback {
color: black;
background: #CFDCED;
text-align:center;
margin-top: 5px;
}
#feedback #feedbackto {
font-size: 90%;
color: black;
}
#footer {
clear: both;
position: relative; /* IE bugfix (http://www.dracos.co.uk/web/css/ie6floatbug/) */
width: 100%;
background: #CFDCED;
border-top: solid 1px #4C6C8F;
color: black;
}
#footer .copyright {
position: relative; /* IE bugfix cont'd */
padding: 5px;
margin: 0;
width: 45%;
}
#footer .lastmodified {
position: relative; /* IE bugfix cont'd */
float: right;
width: 45%;
padding: 5px;
margin: 0;
text-align: right;
}
#footer a { color: white; }
#footer #logos {
text-align: left;
}
/**
* Misc Styles
*/
acronym { cursor: help; }
.boxed { background-color: #a5b6c6;}
.underlined_5 {border-bottom: solid 5px #4C6C8F;}
.underlined_10 {border-bottom: solid 10px #4C6C8F;}
/* ==================== snail trail ============================ */
.trail {
position: relative; /* IE bugfix cont'd */
font-size: 70%;
text-align: right;
float: right;
margin: -10px 5px 0px 5px;
padding: 0;
}
#motd-area {
position: relative; /* IE bugfix cont'd */
float: right;
width: 35%;
background-color: #f0f0ff;
border-top: solid 1px #4C6C8F;
border-bottom: solid 1px #4C6C8F;
margin-bottom: 15px;
margin-left: 15px;
margin-right: 10%;
padding-bottom: 5px;
padding-top: 5px;
}
#minitoc-area {
border-top: solid 1px #4C6C8F;
border-bottom: solid 1px #4C6C8F;
margin: 15px 10% 5px 15px;
/* margin-bottom: 15px;
margin-left: 15px;
margin-right: 10%;*/
padding-bottom: 7px;
padding-top: 5px;
}
.minitoc {
list-style-image: url('images/current.gif');
font-weight: normal;
}
li p {
margin: 0;
padding: 0;
}
.pdflink {
position: relative; /* IE bugfix cont'd */
float: right;
margin: 0px 5px;
padding: 0;
}
.pdflink br {
margin-top: -10px;
padding-left: 1px;
}
.pdflink a {
display: block;
font-size: 70%;
text-align: center;
margin: 0;
padding: 0;
}
.pdflink img {
display: block;
height: 16px;
width: 16px;
}
.xmllink {
position: relative; /* IE bugfix cont'd */
float: right;
margin: 0px 5px;
padding: 0;
}
.xmllink br {
margin-top: -10px;
padding-left: 1px;
}
.xmllink a {
display: block;
font-size: 70%;
text-align: center;
margin: 0;
padding: 0;
}
.xmllink img {
display: block;
height: 16px;
width: 16px;
}
.podlink {
position: relative; /* IE bugfix cont'd */
float: right;
margin: 0px 5px;
padding: 0;
}
.podlink br {
margin-top: -10px;
padding-left: 1px;
}
.podlink a {
display: block;
font-size: 70%;
text-align: center;
margin: 0;
padding: 0;
}
.podlink img {
display: block;
height: 16px;
width: 16px;
}
.printlink {
position: relative; /* IE bugfix cont'd */
float: right;
}
.printlink br {
margin-top: -10px;
padding-left: 1px;
}
.printlink a {
display: block;
font-size: 70%;
text-align: center;
margin: 0;
padding: 0;
}
.printlink img {
display: block;
height: 16px;
width: 16px;
}
p.instruction {
display: list-item;
list-style-image: url('../images/instruction_arrow.png');
list-style-position: outside;
margin-left: 2em;
}

104
src/docs/forrest.properties Normal file
View File

@ -0,0 +1,104 @@
# Copyright 2002-2004 The Apache Software Foundation
#
# 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.
##############
# Properties used by forrest.build.xml for building the website
# These are the defaults, un-comment them if you need to change them.
##############
# Prints out a summary of Forrest settings for this project
#forrest.echo=true
# Project name (used to name .war file)
#project.name=my-project
# Specifies name of Forrest skin to use
#project.skin=tigris
#project.skin=pelt
# comma separated list, file:// is supported
#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
##############
# behavioural properties
#project.menu-scheme=tab_attributes
#project.menu-scheme=directories
##############
# layout properties
# Properties that can be set to override the default locations
#
# Parent properties must be set. This usually means uncommenting
# project.content-dir if any other property using it is uncommented
#project.status=status.xml
#project.content-dir=src/documentation
#project.raw-content-dir=${project.content-dir}/content
#project.conf-dir=${project.content-dir}/conf
#project.sitemap-dir=${project.content-dir}
#project.xdocs-dir=${project.content-dir}/content/xdocs
#project.resources-dir=${project.content-dir}/resources
#project.stylesheets-dir=${project.resources-dir}/stylesheets
#project.images-dir=${project.resources-dir}/images
#project.schema-dir=${project.resources-dir}/schema
#project.skins-dir=${project.content-dir}/skins
#project.skinconf=${project.content-dir}/skinconf.xml
#project.lib-dir=${project.content-dir}/lib
#project.classes-dir=${project.content-dir}/classes
#project.translations-dir=${project.content-dir}/translations
##############
# validation properties
# This set of properties determine if validation is performed
# Values are inherited unless overridden.
# e.g. if forrest.validate=false then all others are false unless set to true.
#forrest.validate=true
#forrest.validate.xdocs=${forrest.validate}
#forrest.validate.skinconf=${forrest.validate}
#forrest.validate.sitemap=${forrest.validate}
#forrest.validate.stylesheets=${forrest.validate}
#forrest.validate.skins=${forrest.validate}
#forrest.validate.skins.stylesheets=${forrest.validate.skins}
# *.failonerror=(true|false) - stop when an XML file is invalid
#forrest.validate.failonerror=true
# *.excludes=(pattern) - comma-separated list of path patterns to not validate
# e.g.
#forrest.validate.xdocs.excludes=samples/subdir/**, samples/faq.xml
#forrest.validate.xdocs.excludes=
##############
# General Forrest properties
# The URL to start crawling from
#project.start-uri=linkmap.html
# Set logging level for messages printed to the console
# (DEBUG, INFO, WARN, ERROR, FATAL_ERROR)
#project.debuglevel=ERROR
# Max memory to allocate to Java
#forrest.maxmemory=64m
# Any other arguments to pass to the JVM. For example, to run on an X-less
# server, set to -Djava.awt.headless=true
#forrest.jvmargs=
# The bugtracking URL - the issue number will be appended
#project.bugtracking-url=http://issues.apache.org/bugzilla/show_bug.cgi?id=
#project.bugtracking-url=http://issues.apache.org/jira/browse/
# The issues list as rss
#project.issues-rss-url=
#I18n Property only works for the "forrest run" target.
#project.i18n=true

View File

@ -0,0 +1,7 @@
This is the base documentation directory.
skinconf.xml # This file customizes Forrest for your project. In it, you
# tell forrest the project name, logo, copyright info, etc
sitemap.xmap # Optional. This sitemap is consulted before all core sitemaps.
# See http://forrest.apache.org/docs/project-sitemap.html

View File

@ -0,0 +1,37 @@
# Copyright 2002-2004 The Apache Software Foundation
#
# 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.
#=======================================================================
# CatalogManager.properties
#
# This is the default properties file for Apache Forrest.
# This facilitates local configuration of application-specific catalogs.
#
# See the Apache Forrest documentation:
# http://forrest.apache.org/docs/your-project.html
# http://forrest.apache.org/docs/validation.html
# verbosity ... level of messages for status/debug
# See forrest/src/core/context/WEB-INF/cocoon.xconf
# catalogs ... list of additional catalogs to load
# (Note that Apache Forrest will automatically load its own default catalog
# from src/core/context/resources/schema/catalog.xcat)
# use full pathnames
# pathname separator is always semi-colon (;) regardless of operating system
# directory separator is always slash (/) regardless of operating system
#
#catalogs=/home/me/forrest/my-site/src/documentation/resources/schema/catalog.xcat
catalogs=

View File

@ -0,0 +1,39 @@
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
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.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>HBase Documentation</title>
</header>
<body>
<p>
The following documents provide concepts and procedures that will help you
get started using HBase. If you have more questions, you can ask the
<a href="ext:lists">mailing list</a> or browse the archives.
</p>
<ul>
<li><a href="ext:api/index">API Docs</a></li>
<li><a href="ext:wiki">Wiki</a></li>
<li><a href="ext:faq">FAQ</a></li>
</ul>
</body>
</document>

View File

@ -0,0 +1,69 @@
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
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.
-->
<!--
Forrest site.xml
This file contains an outline of the site's information content. It is used to:
- Generate the website menus (though these can be overridden - see docs)
- Provide semantic, location-independent aliases for internal 'site:' URIs, eg
<link href="site:changes"> links to changes.html (or ../changes.html if in
subdir).
- Provide aliases for external URLs in the external-refs section. Eg, <link
href="ext:cocoon"> links to http://xml.apache.org/cocoon/
See http://forrest.apache.org/docs/linking.html for more info.
-->
<site label="Hadoop" href="" xmlns="http://apache.org/forrest/linkmap/1.0">
<docs label="Documentation">
<overview label="Overview" href="index.html" />
<api label="API Docs" href="ext:api/index" />
<wiki label="Wiki" href="ext:wiki" />
<faq label="FAQ" href="ext:faq" />
<lists label="Mailing Lists" href="ext:lists" />
</docs>
<external-refs>
<site href="http://hadoop.apache.org/hbase/"/>
<lists href="http://hadoop.apache.org/hbase/mailing_lists.html"/>
<releases href="http://hadoop.apache.org/hbase/releases.html">
<download href="#Download" />
</releases>
<jira href="http://hadoop.apache.org/hbase/issue_tracking.html"/>
<wiki href="http://wiki.apache.org/hadoop/Hbase" />
<faq href="http://wiki.apache.org/hadoop/Hbase/FAQ" />
<zlib href="http://www.zlib.net/" />
<lzo href="http://www.oberhumer.com/opensource/lzo/" />
<gzip href="http://www.gzip.org/" />
<cygwin href="http://www.cygwin.com/" />
<osx href="http://www.apple.com/macosx" />
<api href="api/">
<index href="index.html" />
<org href="org/">
<apache href="apache/">
<hadoop href="hadoop/">
<hbase href="hbase/">
</hbase>
</hadoop>
</apache>
</org>
</api>
</external-refs>
</site>

View File

@ -0,0 +1,36 @@
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
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.
-->
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN"
"http://forrest.apache.org/dtd/tab-cocoon-v10.dtd">
<tabs software="HBase"
title="HBase"
copyright="The Apache Software Foundation"
xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- The rules are:
@dir will always have /index.html added.
@href is not modified unless it is root-relative and obviously specifies a
directory (ends in '/'), in which case /index.html will be added
-->
<tab label="Project" href="http://hadoop.apache.org/hbase/" />
<tab label="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
<tab label="HBase 0.1 Documentation" dir="" />
</tabs>

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 766 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@ -0,0 +1,345 @@
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
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.
-->
<!--
Skin configuration file. This file contains details of your project,
which will be used to configure the chosen Forrest skin.
-->
<!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.6-3//EN" "http://forrest.apache.org/dtd/skinconfig-v06-3.dtd">
<skinconfig>
<!-- To enable lucene search add provider="lucene" (default is google).
Add box-location="alt" to move the search box to an alternate location
(if the skin supports it) and box-location="all" to show it in all
available locations on the page. Remove the <search> element to show
no search box. @domain will enable sitesearch for the specific domain with google.
In other words google will search the @domain for the query string.
-->
<search name="Lucene" domain="hadoop.apache.org" provider="google"/>
<!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
<disable-print-link>true</disable-print-link>
<!-- Disable the PDF link? -->
<disable-pdf-link>false</disable-pdf-link>
<!-- Disable the POD link? -->
<disable-pod-link>true</disable-pod-link>
<!-- Disable the Text link? FIXME: NOT YET IMPLEMENETED. -->
<disable-txt-link>true</disable-txt-link>
<!-- Disable the xml source link? -->
<!-- The xml source link makes it possible to access the xml rendition
of the source frim the html page, and to have it generated statically.
This can be used to enable other sites and services to reuse the
xml format for their uses. Keep this disabled if you don't want other
sites to easily reuse your pages.-->
<disable-xml-link>true</disable-xml-link>
<!-- Disable navigation icons on all external links? -->
<disable-external-link-image>true</disable-external-link-image>
<!-- Disable w3c compliance links?
Use e.g. align="center" to move the compliance links logos to
an alternate location default is left.
(if the skin supports it) -->
<disable-compliance-links>true</disable-compliance-links>
<!-- Render mailto: links unrecognisable by spam harvesters? -->
<obfuscate-mail-links>false</obfuscate-mail-links>
<!-- Disable the javascript facility to change the font size -->
<disable-font-script>true</disable-font-script>
<!-- project logo -->
<project-name>HBase</project-name>
<project-description>A distributed storage system for structured data built on top of Hadoop</project-description>
<project-url>http://hadoop.apache.org/hbase/</project-url>
<project-logo>images/hbase_logo_med.gif</project-logo>
<!-- group logo -->
<group-name>Hadoop</group-name>
<group-description>Apache Hadoop</group-description>
<group-url>http://hadoop.apache.org/</group-url>
<group-logo>images/hadoop-logo.jpg</group-logo>
<!-- optional host logo (e.g. sourceforge logo)
default skin: renders it at the bottom-left corner -->
<host-url></host-url>
<host-logo></host-logo>
<!-- relative url of a favicon file, normally favicon.ico -->
<favicon-url>images/favicon.ico</favicon-url>
<!-- The following are used to construct a copyright statement -->
<year>2008</year>
<vendor>The Apache Software Foundation.</vendor>
<copyright-link>http://www.apache.org/licenses/</copyright-link>
<!-- Some skins use this to form a 'breadcrumb trail' of links.
Use location="alt" to move the trail to an alternate location
(if the skin supports it).
Omit the location attribute to display the trail in the default location.
Use location="none" to not display the trail (if the skin supports it).
For some skins just set the attributes to blank.
-->
<trail>
<link1 name="Apache" href="http://www.apache.org/"/>
<link2 name="Hadoop" href="http://hadoop.apache.org/"/>
<link3 name="HBase" href="http://hadoop.apache.org/hbase/"/>
</trail>
<!-- Configure the TOC, i.e. the Table of Contents.
@max-depth
how many "section" levels need to be included in the
generated Table of Contents (TOC).
@min-sections
Minimum required to create a TOC.
@location ("page","menu","page,menu", "none")
Where to show the TOC.
-->
<toc max-depth="2" min-sections="1" location="page"/>
<!-- Heading types can be clean|underlined|boxed -->
<headings type="clean"/>
<!-- The optional feedback element will be used to construct a
feedback link in the footer with the page pathname appended:
<a href="@href">{@to}</a>
<feedback to="webmaster@foo.com"
href="mailto:webmaster@foo.com?subject=Feedback&#160;" >
Send feedback about the website to:
</feedback>
-->
<!--
extra-css - here you can define custom css-elements that are
a. overriding the fallback elements or
b. adding the css definition from new elements that you may have
used in your documentation.
-->
<extra-css>
<!--Example of b.
To define the css definition of a new element that you may have used
in the class attribute of a <p> node.
e.g. <p class="quote"/>
-->
p.quote {
margin-left: 2em;
padding: .5em;
background-color: #f0f0f0;
font-family: monospace;
}
</extra-css>
<colors>
<!-- These values are used for the generated CSS files. -->
<!-- Krysalis -->
<!--
<color name="header" value="#FFFFFF"/>
<color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="tab-unselected" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="subtab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="subtab-unselected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="heading" value="#a5b6c6"/>
<color name="subheading" value="#CFDCED"/>
<color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="toolbox" value="#a5b6c6"/>
<color name="border" value="#a5b6c6"/>
<color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="dialog" value="#F7F7F7"/>
<color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
<color name="table" value="#a5b6c6"/>
<color name="table-cell" value="#ffffff"/>
<color name="highlight" value="#ffff00"/>
<color name="fixme" value="#cc6600"/>
<color name="note" value="#006699"/>
<color name="warning" value="#990000"/>
<color name="code" value="#a5b6c6"/>
<color name="footer" value="#a5b6c6"/>
-->
<!-- Forrest -->
<!--
<color name="header" value="#294563"/>
<color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
<color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
<color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
<color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
<color name="heading" value="#294563"/>
<color name="subheading" value="#4a6d8c"/>
<color name="navstrip" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
<color name="toolbox" value="#4a6d8c"/>
<color name="border" value="#294563"/>
<color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff" hlink="#ffcf00"/>
<color name="dialog" value="#4a6d8c"/>
<color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
<color name="table" value="#7099C5"/>
<color name="table-cell" value="#f0f0ff"/>
<color name="highlight" value="#ffff00"/>
<color name="fixme" value="#cc6600"/>
<color name="note" value="#006699"/>
<color name="warning" value="#990000"/>
<color name="code" value="#CFDCED"/>
<color name="footer" value="#cedfef"/>
-->
<!-- Collabnet -->
<!--
<color name="header" value="#003366"/>
<color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
<color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
<color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>
<color name="heading" value="#003366"/>
<color name="subheading" value="#888888"/>
<color name="navstrip" value="#dddddd" font="#555555"/>
<color name="toolbox" value="#dddddd" font="#555555"/>
<color name="border" value="#999999"/>
<color name="menu" value="#ffffff"/>
<color name="dialog" value="#eeeeee"/>
<color name="body" value="#ffffff"/>
<color name="table" value="#ccc"/>
<color name="table-cell" value="#ffffff"/>
<color name="highlight" value="#ffff00"/>
<color name="fixme" value="#cc6600"/>
<color name="note" value="#006699"/>
<color name="warning" value="#990000"/>
<color name="code" value="#003366"/>
<color name="footer" value="#ffffff"/>
-->
<!-- Lenya using pelt-->
<!--
<color name="header" value="#ffffff"/>
<color name="tab-selected" value="#4C6C8F" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
<color name="tab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
<color name="heading" value="#E5E4D9"/>
<color name="subheading" value="#000000"/>
<color name="published" value="#4C6C8F" font="#FFFFFF"/>
<color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
<color name="navstrip" value="#E5E4D9" font="#000000"/>
<color name="toolbox" value="#CFDCED" font="#000000"/>
<color name="border" value="#999999"/>
<color name="menu" value="#4C6C8F" font="#ffffff" link="#ffffff" vlink="#ffffff" hlink="#ffffff" current="#FFCC33" />
<color name="menuheading" value="#cfdced" font="#000000" />
<color name="searchbox" value="#E5E4D9" font="#000000"/>
<color name="dialog" value="#CFDCED"/>
<color name="body" value="#ffffff" />
<color name="table" value="#ccc"/>
<color name="table-cell" value="#ffffff"/>
<color name="highlight" value="#ffff00"/>
<color name="fixme" value="#cc6600"/>
<color name="note" value="#006699"/>
<color name="warning" value="#990000"/>
<color name="code" value="#003366"/>
<color name="footer" value="#E5E4D9"/>
-->
</colors>
<!-- Settings specific to PDF output. -->
<pdf>
<!--
Supported page sizes are a0, a1, a2, a3, a4, a5, executive,
folio, legal, ledger, letter, quarto, tabloid (default letter).
Supported page orientations are portrait, landscape (default
portrait).
Supported text alignments are left, right, justify (default left).
-->
<page size="letter" orientation="portrait" text-align="left"/>
<!--
Margins can be specified for top, bottom, inner, and outer
edges. If double-sided="false", the inner edge is always left
and the outer is always right. If double-sided="true", the
inner edge will be left on odd pages, right on even pages,
the outer edge vice versa.
Specified below are the default settings.
-->
<margins double-sided="false">
<top>1in</top>
<bottom>1in</bottom>
<inner>1.25in</inner>
<outer>1in</outer>
</margins>
<!--
Print the URL text next to all links going outside the file
-->
<show-external-urls>false</show-external-urls>
<!--
Disable the copyright footer on each page of the PDF.
A footer is composed for each page. By default, a "credit" with role=pdf
will be used, as explained below. Otherwise a copyright statement
will be generated. This latter can be disabled.
-->
<disable-copyright-footer>false</disable-copyright-footer>
</pdf>
<!-- Credits are typically rendered as a set of small clickable
images in the page footer.
Use box-location="alt" to move the credit to an alternate location
(if the skin supports it).
-->
<credits>
<credit box-location="alt">
<name>Built with Apache Forrest</name>
<url>http://forrest.apache.org/</url>
<image>images/built-with-forrest-button.png</image>
<width>88</width>
<height>31</height>
</credit>
<!-- A credit with @role="pdf" will be used to compose a footer
for each page in the PDF, using either "name" or "url" or both.
-->
<!--
<credit role="pdf">
<name>Built with Apache Forrest</name>
<url>http://forrest.apache.org/</url>
</credit>
-->
</credits>
</skinconfig>

74
src/docs/status.xml Normal file
View File

@ -0,0 +1,74 @@
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
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.
-->
<status>
<developers>
<person name="Joe Bloggs" email="joe@joescompany.org" id="JB" />
<!-- Add more people here -->
</developers>
<changes>
<!-- Add new releases here -->
<release version="0.1" date="unreleased">
<!-- Some action types have associated images. By default, images are
defined for 'add', 'fix', 'remove', 'update' and 'hack'. If you add
src/documentation/resources/images/<foo>.jpg images, these will
automatically be used for entries of type <foo>. -->
<action dev="JB" type="add" context="admin">
Initial Import
</action>
<!-- Sample action:
<action dev="JB" type="fix" due-to="Joe Contributor"
due-to-email="joec@apache.org" fixes-bug="123">
Fixed a bug in the Foo class.
</action>
-->
</release>
</changes>
<todo>
<actions priority="high">
<action context="docs" dev="JB">
Customize this template project with your project's details. This
TODO list is generated from 'status.xml'.
</action>
<action context="docs" dev="JB">
Add lots of content. XML content goes in
<code>src/documentation/content/xdocs</code>, or wherever the
<code>${project.xdocs-dir}</code> property (set in
<code>forrest.properties</code>) points.
</action>
<action context="feedback" dev="JB">
Mail <link
href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>
with feedback.
</action>
</actions>
<!-- Add todo items. @context is an arbitrary string. Eg:
<actions priority="high">
<action context="code" dev="SN">
</action>
</actions>
<actions priority="medium">
<action context="docs" dev="open">
</action>
</actions>
-->
</todo>
</status>