HADOOP-12022. fix site -Pdocs -Pdist in hadoop-project-dist; cleanout remaining forrest bits. Contributed by Allen Wittenauer.
This commit is contained in:
Akira Ajisaka
parent
8f9b97ccce
commit
1371f993a9
|
|
@ -475,7 +475,6 @@
|
||||||
<excludes>
|
<excludes>
|
||||||
<exclude>.idea/**</exclude>
|
<exclude>.idea/**</exclude>
|
||||||
<exclude>src/main/conf/*</exclude>
|
<exclude>src/main/conf/*</exclude>
|
||||||
<exclude>src/main/docs/**</exclude>
|
|
||||||
<exclude>dev-support/jdiff/**</exclude>
|
<exclude>dev-support/jdiff/**</exclude>
|
||||||
<exclude>src/main/native/*</exclude>
|
<exclude>src/main/native/*</exclude>
|
||||||
<exclude>src/main/native/config/*</exclude>
|
<exclude>src/main/native/config/*</exclude>
|
||||||
|
|
|
||||||
|
|
@ -1,170 +0,0 @@
|
||||||
/*
|
|
||||||
* 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;
|
|
||||||
background-color: 73CAFF
|
|
||||||
}
|
|
||||||
#content h1 {
|
|
||||||
font-size: 160%;
|
|
||||||
margin-bottom: .5em;
|
|
||||||
}
|
|
||||||
#menu h1 {
|
|
||||||
margin: 0;
|
|
||||||
padding: 10px;
|
|
||||||
background: #336699;
|
|
||||||
color: white;
|
|
||||||
}
|
|
||||||
h2 {
|
|
||||||
font-size: 120%;
|
|
||||||
background-color: 73CAFF
|
|
||||||
}
|
|
||||||
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%;
|
|
||||||
}
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
/*
|
|
||||||
* 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: Courier New, monospace;
|
|
||||||
font-size: 10pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
font-family: Courier New, monospace;
|
|
||||||
font-size: 10pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
font-family: Courier New, monospace;
|
|
||||||
font-size: 10pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
h3 {
|
|
||||||
font-family: Courier New, monospace;
|
|
||||||
font-size: 10pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:link {
|
|
||||||
color: blue;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:visited {
|
|
||||||
color: purple;
|
|
||||||
}
|
|
||||||
|
|
||||||
li {
|
|
||||||
margin-top: 1em;
|
|
||||||
margin-bottom: 1em;
|
|
||||||
}
|
|
||||||
|
|
@ -1,282 +0,0 @@
|
||||||
#!/usr/bin/perl
|
|
||||||
#
|
|
||||||
# Transforms Lucene Java's CHANGES.txt into Changes.html
|
|
||||||
#
|
|
||||||
# Input is on STDIN, output is to STDOUT
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# 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.
|
|
||||||
#
|
|
||||||
|
|
||||||
use strict;
|
|
||||||
use warnings;
|
|
||||||
|
|
||||||
my $jira_url_prefix = 'http://issues.apache.org/jira/browse/';
|
|
||||||
my $title = undef;
|
|
||||||
my $release = undef;
|
|
||||||
my $sections = undef;
|
|
||||||
my $items = undef;
|
|
||||||
my $first_relid = undef;
|
|
||||||
my $second_relid = undef;
|
|
||||||
my @releases = ();
|
|
||||||
|
|
||||||
my @lines = <>; # Get all input at once
|
|
||||||
|
|
||||||
#
|
|
||||||
# Parse input and build hierarchical release structure in @releases
|
|
||||||
#
|
|
||||||
for (my $line_num = 0 ; $line_num <= $#lines ; ++$line_num) {
|
|
||||||
$_ = $lines[$line_num];
|
|
||||||
next unless (/\S/); # Skip blank lines
|
|
||||||
|
|
||||||
unless ($title) {
|
|
||||||
if (/\S/) {
|
|
||||||
s/^\s+//; # Trim leading whitespace
|
|
||||||
s/\s+$//; # Trim trailing whitespace
|
|
||||||
}
|
|
||||||
$title = $_;
|
|
||||||
next;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (/^(Release)|(Trunk)/) { # Release headings
|
|
||||||
$release = $_;
|
|
||||||
$sections = [];
|
|
||||||
push @releases, [ $release, $sections ];
|
|
||||||
($first_relid = lc($release)) =~ s/\s+/_/g if ($#releases == 0);
|
|
||||||
($second_relid = lc($release)) =~ s/\s+/_/g if ($#releases == 1);
|
|
||||||
$items = undef;
|
|
||||||
next;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Section heading: 2 leading spaces, words all capitalized
|
|
||||||
if (/^ ([A-Z]+)\s*/) {
|
|
||||||
my $heading = $_;
|
|
||||||
$items = [];
|
|
||||||
push @$sections, [ $heading, $items ];
|
|
||||||
next;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Handle earlier releases without sections - create a headless section
|
|
||||||
unless ($items) {
|
|
||||||
$items = [];
|
|
||||||
push @$sections, [ undef, $items ];
|
|
||||||
}
|
|
||||||
|
|
||||||
my $type;
|
|
||||||
if (@$items) { # A list item has been encountered in this section before
|
|
||||||
$type = $items->[0]; # 0th position of items array is list type
|
|
||||||
} else {
|
|
||||||
$type = get_list_type($_);
|
|
||||||
push @$items, $type;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($type eq 'numbered') { # The modern items list style
|
|
||||||
# List item boundary is another numbered item or an unindented line
|
|
||||||
my $line;
|
|
||||||
my $item = $_;
|
|
||||||
$item =~ s/^(\s{0,2}\d+\.\s*)//; # Trim the leading item number
|
|
||||||
my $leading_ws_width = length($1);
|
|
||||||
$item =~ s/\s+$//; # Trim trailing whitespace
|
|
||||||
$item .= "\n";
|
|
||||||
|
|
||||||
while ($line_num < $#lines
|
|
||||||
and ($line = $lines[++$line_num]) !~ /^(?:\s{0,2}\d+\.\s*\S|\S)/) {
|
|
||||||
$line =~ s/^\s{$leading_ws_width}//; # Trim leading whitespace
|
|
||||||
$line =~ s/\s+$//; # Trim trailing whitespace
|
|
||||||
$item .= "$line\n";
|
|
||||||
}
|
|
||||||
$item =~ s/\n+\Z/\n/; # Trim trailing blank lines
|
|
||||||
push @$items, $item;
|
|
||||||
--$line_num unless ($line_num == $#lines);
|
|
||||||
} elsif ($type eq 'paragraph') { # List item boundary is a blank line
|
|
||||||
my $line;
|
|
||||||
my $item = $_;
|
|
||||||
$item =~ s/^(\s+)//;
|
|
||||||
my $leading_ws_width = defined($1) ? length($1) : 0;
|
|
||||||
$item =~ s/\s+$//; # Trim trailing whitespace
|
|
||||||
$item .= "\n";
|
|
||||||
|
|
||||||
while ($line_num < $#lines and ($line = $lines[++$line_num]) =~ /\S/) {
|
|
||||||
$line =~ s/^\s{$leading_ws_width}//; # Trim leading whitespace
|
|
||||||
$line =~ s/\s+$//; # Trim trailing whitespace
|
|
||||||
$item .= "$line\n";
|
|
||||||
}
|
|
||||||
push @$items, $item;
|
|
||||||
--$line_num unless ($line_num == $#lines);
|
|
||||||
} else { # $type is one of the bulleted types
|
|
||||||
# List item boundary is another bullet or a blank line
|
|
||||||
my $line;
|
|
||||||
my $item = $_;
|
|
||||||
$item =~ s/^(\s*$type\s*)//; # Trim the leading bullet
|
|
||||||
my $leading_ws_width = length($1);
|
|
||||||
$item =~ s/\s+$//; # Trim trailing whitespace
|
|
||||||
$item .= "\n";
|
|
||||||
|
|
||||||
while ($line_num < $#lines
|
|
||||||
and ($line = $lines[++$line_num]) !~ /^\s*(?:$type|\Z)/) {
|
|
||||||
$line =~ s/^\s{$leading_ws_width}//; # Trim leading whitespace
|
|
||||||
$line =~ s/\s+$//; # Trim trailing whitespace
|
|
||||||
$item .= "$line\n";
|
|
||||||
}
|
|
||||||
push @$items, $item;
|
|
||||||
--$line_num unless ($line_num == $#lines);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Print HTML-ified version to STDOUT
|
|
||||||
#
|
|
||||||
print<<"__HTML_HEADER__";
|
|
||||||
<!--
|
|
||||||
**********************************************************
|
|
||||||
** WARNING: This file is generated from CHANGES.txt by the
|
|
||||||
** Perl script 'changes2html.pl'.
|
|
||||||
** Do *not* edit this file!
|
|
||||||
**********************************************************
|
|
||||||
|
|
||||||
****************************************************************************
|
|
||||||
* 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.
|
|
||||||
****************************************************************************
|
|
||||||
-->
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>$title</title>
|
|
||||||
<link rel="stylesheet" href="ChangesFancyStyle.css" title="Fancy">
|
|
||||||
<link rel="alternate stylesheet" href="ChangesSimpleStyle.css" title="Simple">
|
|
||||||
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
||||||
<SCRIPT>
|
|
||||||
function toggleList(e) {
|
|
||||||
element = document.getElementById(e).style;
|
|
||||||
element.display == 'none' ? element.display = 'block' : element.display='none';
|
|
||||||
}
|
|
||||||
function collapse() {
|
|
||||||
for (var i = 0; i < document.getElementsByTagName("ul").length; i++) {
|
|
||||||
var list = document.getElementsByTagName("ul")[i];
|
|
||||||
if (list.id != '$first_relid' && list.id != '$second_relid') {
|
|
||||||
list.style.display = "none";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for (var i = 0; i < document.getElementsByTagName("ol").length; i++) {
|
|
||||||
document.getElementsByTagName("ol")[i].style.display = "none";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
window.onload = collapse;
|
|
||||||
</SCRIPT>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<a href="http://hadoop.apache.org/core/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Scalable Computing Platform"></a>
|
|
||||||
<h1>$title</h1>
|
|
||||||
|
|
||||||
__HTML_HEADER__
|
|
||||||
|
|
||||||
my $heading;
|
|
||||||
my $relcnt = 0;
|
|
||||||
my $header = 'h2';
|
|
||||||
for my $rel (@releases) {
|
|
||||||
if (++$relcnt == 3) {
|
|
||||||
$header = 'h3';
|
|
||||||
print "<h2><a href=\"javascript:toggleList('older')\">";
|
|
||||||
print "Older Releases";
|
|
||||||
print "</a></h2>\n";
|
|
||||||
print "<ul id=\"older\">\n"
|
|
||||||
}
|
|
||||||
|
|
||||||
($release, $sections) = @$rel;
|
|
||||||
|
|
||||||
# The first section heading is undefined for the older sectionless releases
|
|
||||||
my $has_release_sections = $sections->[0][0];
|
|
||||||
|
|
||||||
(my $relid = lc($release)) =~ s/\s+/_/g;
|
|
||||||
print "<$header><a href=\"javascript:toggleList('$relid')\">";
|
|
||||||
print "$release";
|
|
||||||
print "</a></$header>\n";
|
|
||||||
print "<ul id=\"$relid\">\n"
|
|
||||||
if ($has_release_sections);
|
|
||||||
|
|
||||||
for my $section (@$sections) {
|
|
||||||
($heading, $items) = @$section;
|
|
||||||
(my $sectid = lc($heading)) =~ s/\s+/_/g;
|
|
||||||
my $numItemsStr = $#{$items} > 0 ? "($#{$items})" : "(none)";
|
|
||||||
|
|
||||||
print " <li><a href=\"javascript:toggleList('$relid.$sectid')\">",
|
|
||||||
($heading || ''), "</a> $numItemsStr\n"
|
|
||||||
if ($has_release_sections);
|
|
||||||
|
|
||||||
my $list_type = $items->[0] || '';
|
|
||||||
my $list = ($has_release_sections || $list_type eq 'numbered' ? 'ol' : 'ul');
|
|
||||||
my $listid = $sectid ? "$relid.$sectid" : $relid;
|
|
||||||
print " <$list id=\"$listid\">\n";
|
|
||||||
|
|
||||||
for my $itemnum (1..$#{$items}) {
|
|
||||||
my $item = $items->[$itemnum];
|
|
||||||
$item =~ s:&:&:g; # Escape HTML metachars
|
|
||||||
$item =~ s:<:<:g;
|
|
||||||
$item =~ s:>:>:g;
|
|
||||||
|
|
||||||
$item =~ s:\s*(\([^)"]+?\))\s*$:<br />$1:; # Separate attribution
|
|
||||||
$item =~ s:\n{2,}:\n<p/>\n:g; # Keep paragraph breaks
|
|
||||||
$item =~ s{(?:${jira_url_prefix})?(HADOOP-\d+)} # Link to JIRA
|
|
||||||
{<a href="${jira_url_prefix}$1">$1</a>}g;
|
|
||||||
print " <li>$item</li>\n";
|
|
||||||
}
|
|
||||||
print " </$list>\n";
|
|
||||||
print " </li>\n" if ($has_release_sections);
|
|
||||||
}
|
|
||||||
print "</ul>\n" if ($has_release_sections);
|
|
||||||
}
|
|
||||||
print "</ul>\n" if ($relcnt > 3);
|
|
||||||
print "</body>\n</html>\n";
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Subroutine: get_list_type
|
|
||||||
#
|
|
||||||
# Takes one parameter:
|
|
||||||
#
|
|
||||||
# - The first line of a sub-section/point
|
|
||||||
#
|
|
||||||
# Returns one scalar:
|
|
||||||
#
|
|
||||||
# - The list type: 'numbered'; or one of the bulleted types '-', or '.' or
|
|
||||||
# 'paragraph'.
|
|
||||||
#
|
|
||||||
sub get_list_type {
|
|
||||||
my $first_list_item_line = shift;
|
|
||||||
my $type = 'paragraph'; # Default to paragraph type
|
|
||||||
|
|
||||||
if ($first_list_item_line =~ /^\s{0,2}\d+\.\s+\S+/) {
|
|
||||||
$type = 'numbered';
|
|
||||||
} elsif ($first_list_item_line =~ /^\s*([-.])\s+\S+/) {
|
|
||||||
$type = $1;
|
|
||||||
}
|
|
||||||
return $type;
|
|
||||||
}
|
|
||||||
|
|
||||||
1;
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,7 +0,0 @@
|
||||||
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
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
#
|
|
||||||
# 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.
|
|
||||||
#
|
|
||||||
|
|
||||||
#=======================================================================
|
|
||||||
# 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=
|
|
||||||
|
|
||||||
|
|
@ -1,327 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
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 is the Apache Cocoon command line configuration file.
|
|
||||||
| Here you give the command line interface details of where
|
|
||||||
| to find various aspects of your Cocoon installation.
|
|
||||||
|
|
|
||||||
| If you wish, you can also use this file to specify the URIs
|
|
||||||
| that you wish to generate.
|
|
||||||
|
|
|
||||||
| The current configuration information in this file is for
|
|
||||||
| building the Cocoon documentation. Therefore, all links here
|
|
||||||
| are relative to the build context dir, which, in the build.xml
|
|
||||||
| file, is set to ${build.context}
|
|
||||||
|
|
|
||||||
| Options:
|
|
||||||
| verbose: increase amount of information presented
|
|
||||||
| to standard output (default: false)
|
|
||||||
| follow-links: whether linked pages should also be
|
|
||||||
| generated (default: true)
|
|
||||||
| precompile-only: precompile sitemaps and XSP pages, but
|
|
||||||
| do not generate any pages (default: false)
|
|
||||||
| confirm-extensions: check the mime type for the generated page
|
|
||||||
| and adjust filename and links extensions
|
|
||||||
| to match the mime type
|
|
||||||
| (e.g. text/html->.html)
|
|
||||||
|
|
|
||||||
| Note: Whilst using an xconf file to configure the Cocoon
|
|
||||||
| Command Line gives access to more features, the use of
|
|
||||||
| command line parameters is more stable, as there are
|
|
||||||
| currently plans to improve the xconf format to allow
|
|
||||||
| greater flexibility. If you require a stable and
|
|
||||||
| consistent method for accessing the CLI, it is recommended
|
|
||||||
| that you use the command line parameters to configure
|
|
||||||
| the CLI. See documentation at:
|
|
||||||
| http://cocoon.apache.org/2.1/userdocs/offline/
|
|
||||||
| http://wiki.apache.org/cocoon/CommandLine
|
|
||||||
|
|
|
||||||
+-->
|
|
||||||
|
|
||||||
<cocoon verbose="true"
|
|
||||||
follow-links="true"
|
|
||||||
precompile-only="false"
|
|
||||||
confirm-extensions="false">
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| The context directory is usually the webapp directory
|
|
||||||
| containing the sitemap.xmap file.
|
|
||||||
|
|
|
||||||
| The config file is the cocoon.xconf file.
|
|
||||||
|
|
|
||||||
| The work directory is used by Cocoon to store temporary
|
|
||||||
| files and cache files.
|
|
||||||
|
|
|
||||||
| The destination directory is where generated pages will
|
|
||||||
| be written (assuming the 'simple' mapper is used, see
|
|
||||||
| below)
|
|
||||||
+-->
|
|
||||||
<context-dir>.</context-dir>
|
|
||||||
<config-file>WEB-INF/cocoon.xconf</config-file>
|
|
||||||
<work-dir>../tmp/cocoon-work</work-dir>
|
|
||||||
<dest-dir>../site</dest-dir>
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| A checksum file can be used to store checksums for pages
|
|
||||||
| as they are generated. When the site is next generated,
|
|
||||||
| files will not be written if their checksum has not changed.
|
|
||||||
| This means that it will be easier to detect which files
|
|
||||||
| need to be uploaded to a server, using the timestamp.
|
|
||||||
|
|
|
||||||
| The default path is relative to the core webapp directory.
|
|
||||||
| An asolute path can be used.
|
|
||||||
+-->
|
|
||||||
<!-- <checksums-uri>build/work/checksums</checksums-uri>-->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Broken link reporting options:
|
|
||||||
| Report into a text file, one link per line:
|
|
||||||
| <broken-links type="text" report="filename"/>
|
|
||||||
| Report into an XML file:
|
|
||||||
| <broken-links type="xml" report="filename"/>
|
|
||||||
| Ignore broken links (default):
|
|
||||||
| <broken-links type="none"/>
|
|
||||||
|
|
|
||||||
| Two attributes to this node specify whether a page should
|
|
||||||
| be generated when an error has occured. 'generate' specifies
|
|
||||||
| whether a page should be generated (default: true) and
|
|
||||||
| extension specifies an extension that should be appended
|
|
||||||
| to the generated page's filename (default: none)
|
|
||||||
|
|
|
||||||
| Using this, a quick scan through the destination directory
|
|
||||||
| will show broken links, by their filename extension.
|
|
||||||
+-->
|
|
||||||
<broken-links type="xml"
|
|
||||||
file="../brokenlinks.xml"
|
|
||||||
generate="false"
|
|
||||||
extension=".error"
|
|
||||||
show-referrers="true"/>
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Load classes at startup. This is necessary for generating
|
|
||||||
| from sites that use SQL databases and JDBC.
|
|
||||||
| The <load-class> element can be repeated if multiple classes
|
|
||||||
| are needed.
|
|
||||||
+-->
|
|
||||||
<!--
|
|
||||||
<load-class>org.firebirdsql.jdbc.Driver</load-class>
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Configures logging.
|
|
||||||
| The 'log-kit' parameter specifies the location of the log kit
|
|
||||||
| configuration file (usually called logkit.xconf.
|
|
||||||
|
|
|
||||||
| Logger specifies the logging category (for all logging prior
|
|
||||||
| to other Cocoon logging categories taking over)
|
|
||||||
|
|
|
||||||
| Available log levels are:
|
|
||||||
| DEBUG: prints all level of log messages.
|
|
||||||
| INFO: prints all level of log messages except DEBUG
|
|
||||||
| ones.
|
|
||||||
| WARN: prints all level of log messages except DEBUG
|
|
||||||
| and INFO ones.
|
|
||||||
| ERROR: prints all level of log messages except DEBUG,
|
|
||||||
| INFO and WARN ones.
|
|
||||||
| FATAL_ERROR: prints only log messages of this level
|
|
||||||
+-->
|
|
||||||
<!-- <logging log-kit="WEB-INF/logkit.xconf" logger="cli" level="ERROR" /> -->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Specifies the filename to be appended to URIs that
|
|
||||||
| refer to a directory (i.e. end with a forward slash).
|
|
||||||
+-->
|
|
||||||
<default-filename>index.html</default-filename>
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Specifies a user agent string to the sitemap when
|
|
||||||
| generating the site.
|
|
||||||
|
|
|
||||||
| A generic term for a web browser is "user agent". Any
|
|
||||||
| user agent, when connecting to a web server, will provide
|
|
||||||
| a string to identify itself (e.g. as Internet Explorer or
|
|
||||||
| Mozilla). It is possible to have Cocoon serve different
|
|
||||||
| content depending upon the user agent string provided by
|
|
||||||
| the browser. If your site does this, then you may want to
|
|
||||||
| use this <user-agent> entry to provide a 'fake' user agent
|
|
||||||
| to Cocoon, so that it generates the correct version of your
|
|
||||||
| site.
|
|
||||||
|
|
|
||||||
| For most sites, this can be ignored.
|
|
||||||
+-->
|
|
||||||
<!--
|
|
||||||
<user-agent>Cocoon Command Line Environment 2.1</user-agent>
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Specifies an accept string to the sitemap when generating
|
|
||||||
| the site.
|
|
||||||
| User agents can specify to an HTTP server what types of content
|
|
||||||
| (by mime-type) they are able to receive. E.g. a browser may be
|
|
||||||
| able to handle jpegs, but not pngs. The HTTP accept header
|
|
||||||
| allows the server to take the browser's capabilities into account,
|
|
||||||
| and only send back content that it can handle.
|
|
||||||
|
|
|
||||||
| For most sites, this can be ignored.
|
|
||||||
+-->
|
|
||||||
|
|
||||||
<accept>*/*</accept>
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| Specifies which URIs should be included or excluded, according
|
|
||||||
| to wildcard patterns.
|
|
||||||
|
|
|
||||||
| These includes/excludes are only relevant when you are following
|
|
||||||
| links. A link URI must match an include pattern (if one is given)
|
|
||||||
| and not match an exclude pattern, if it is to be followed by
|
|
||||||
| Cocoon. It can be useful, for example, where there are links in
|
|
||||||
| your site to pages that are not generated by Cocoon, such as
|
|
||||||
| references to api-documentation.
|
|
||||||
|
|
|
||||||
| By default, all URIs are included. If both include and exclude
|
|
||||||
| patterns are specified, a URI is first checked against the
|
|
||||||
| include patterns, and then against the exclude patterns.
|
|
||||||
|
|
|
||||||
| Multiple patterns can be given, using muliple include or exclude
|
|
||||||
| nodes.
|
|
||||||
|
|
|
||||||
| The order of the elements is not significant, as only the first
|
|
||||||
| successful match of each category is used.
|
|
||||||
|
|
|
||||||
| Currently, only the complete source URI can be matched (including
|
|
||||||
| any URI prefix). Future plans include destination URI matching
|
|
||||||
| and regexp matching. If you have requirements for these, contact
|
|
||||||
| dev@cocoon.apache.org.
|
|
||||||
+-->
|
|
||||||
|
|
||||||
<exclude pattern="**/"/>
|
|
||||||
<exclude pattern="api/**"/>
|
|
||||||
<exclude pattern="jdiff/**"/>
|
|
||||||
<exclude pattern="changes.html"/>
|
|
||||||
<exclude pattern="releasenotes.html"/>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
This is a workaround for FOR-284 "link rewriting broken when
|
|
||||||
linking to xml source views which contain site: links".
|
|
||||||
See the explanation there and in declare-broken-site-links.xsl
|
|
||||||
-->
|
|
||||||
<exclude pattern="site:**"/>
|
|
||||||
<exclude pattern="ext:**"/>
|
|
||||||
<exclude pattern="lm:**"/>
|
|
||||||
<exclude pattern="**/site:**"/>
|
|
||||||
<exclude pattern="**/ext:**"/>
|
|
||||||
<exclude pattern="**/lm:**"/>
|
|
||||||
|
|
||||||
<!-- Exclude tokens used in URLs to ASF mirrors (interpreted by a CGI) -->
|
|
||||||
<exclude pattern="[preferred]/**"/>
|
|
||||||
<exclude pattern="[location]"/>
|
|
||||||
|
|
||||||
<!-- <include-links extension=".html"/>-->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| <uri> nodes specify the URIs that should be generated, and
|
|
||||||
| where required, what should be done with the generated pages.
|
|
||||||
| They describe the way the URI of the generated file is created
|
|
||||||
| from the source page's URI. There are three ways that a generated
|
|
||||||
| file URI can be created: append, replace and insert.
|
|
||||||
|
|
|
||||||
| The "type" attribute specifies one of (append|replace|insert):
|
|
||||||
|
|
|
||||||
| append:
|
|
||||||
| Append the generated page's URI to the end of the source URI:
|
|
||||||
|
|
|
||||||
| <uri type="append" src-prefix="documents/" src="index.html"
|
|
||||||
| dest="build/dest/"/>
|
|
||||||
|
|
|
||||||
| This means that
|
|
||||||
| (1) the "documents/index.html" page is generated
|
|
||||||
| (2) the file will be written to "build/dest/documents/index.html"
|
|
||||||
|
|
|
||||||
| replace:
|
|
||||||
| Completely ignore the generated page's URI - just
|
|
||||||
| use the destination URI:
|
|
||||||
|
|
|
||||||
| <uri type="replace" src-prefix="documents/" src="index.html"
|
|
||||||
| dest="build/dest/docs.html"/>
|
|
||||||
|
|
|
||||||
| This means that
|
|
||||||
| (1) the "documents/index.html" page is generated
|
|
||||||
| (2) the result is written to "build/dest/docs.html"
|
|
||||||
| (3) this works only for "single" pages - and not when links
|
|
||||||
| are followed
|
|
||||||
|
|
|
||||||
| insert:
|
|
||||||
| Insert generated page's URI into the destination
|
|
||||||
| URI at the point marked with a * (example uses fictional
|
|
||||||
| zip protocol)
|
|
||||||
|
|
|
||||||
| <uri type="insert" src-prefix="documents/" src="index.html"
|
|
||||||
| dest="zip://*.zip/page.html"/>
|
|
||||||
|
|
|
||||||
| This means that
|
|
||||||
| (1)
|
|
||||||
|
|
|
||||||
| In any of these scenarios, if the dest attribute is omitted,
|
|
||||||
| the value provided globally using the <dest-dir> node will
|
|
||||||
| be used instead.
|
|
||||||
+-->
|
|
||||||
<!--
|
|
||||||
<uri type="replace"
|
|
||||||
src-prefix="samples/"
|
|
||||||
src="hello-world/hello.html"
|
|
||||||
dest="build/dest/hello-world.html"/>
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| <uri> nodes can be grouped together in a <uris> node. This
|
|
||||||
| enables a group of URIs to share properties. The following
|
|
||||||
| properties can be set for a group of URIs:
|
|
||||||
| * follow-links: should pages be crawled for links
|
|
||||||
| * confirm-extensions: should file extensions be checked
|
|
||||||
| for the correct mime type
|
|
||||||
| * src-prefix: all source URIs should be
|
|
||||||
| pre-pended with this prefix before
|
|
||||||
| generation. The prefix is not
|
|
||||||
| included when calculating the
|
|
||||||
| destination URI
|
|
||||||
| * dest: the base destination URI to be
|
|
||||||
| shared by all pages in this group
|
|
||||||
| * type: the method to be used to calculate
|
|
||||||
| the destination URI. See above
|
|
||||||
| section on <uri> node for details.
|
|
||||||
|
|
|
||||||
| Each <uris> node can have a name attribute. When a name
|
|
||||||
| attribute has been specified, the -n switch on the command
|
|
||||||
| line can be used to tell Cocoon to only process the URIs
|
|
||||||
| within this URI group. When no -n switch is given, all
|
|
||||||
| <uris> nodes are processed. Thus, one xconf file can be
|
|
||||||
| used to manage multiple sites.
|
|
||||||
+-->
|
|
||||||
<!--
|
|
||||||
<uris name="mirrors" follow-links="false">
|
|
||||||
<uri type="append" src="mirrors.html"/>
|
|
||||||
</uris>
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--+
|
|
||||||
| File containing URIs (plain text, one per line).
|
|
||||||
+-->
|
|
||||||
<!--
|
|
||||||
<uri-file>uris.txt</uri-file>
|
|
||||||
-->
|
|
||||||
</cocoon>
|
|
||||||
|
|
@ -1,48 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
|
|
||||||
|
|
||||||
<document>
|
|
||||||
|
|
||||||
<header>
|
|
||||||
<title>Overview</title>
|
|
||||||
</header>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<p>
|
|
||||||
The Hadoop Common Documentation describes the common utilities and libraries that support the other Hadoop subprojects.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
The Hadoop Common Documentation also includes the information you need to get started using Hadoop.
|
|
||||||
Begin with the Hadoop <a href="single_node_setup.html">Single Node Setup</a> which shows you how to set up a single-node Hadoop installation.
|
|
||||||
Then move on to the Hadoop <a href="cluster_setup.html">Cluster Setup</a> to learn how to set up a multi-node Hadoop installation.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
Cluster environments commonly work in tandem with MapReduce applications and distributed file systems.
|
|
||||||
For information about MapReduce see the
|
|
||||||
<a href="http://hadoop.apache.org/mapreduce/docs/current/index.html">MapReduce Documentation</a>.
|
|
||||||
For information about the Hadoop Distributed File System (HDFS) see the
|
|
||||||
<a href="http://hadoop.apache.org/hdfs/docs/current/index.html">HDFS Documentation</a>.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
If you have more questions, you can ask on the <a href="ext:lists">Hadoop Common Mailing Lists</a> or browse the <a href="ext:archive">Mailing List Archives</a>.
|
|
||||||
</p>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</document>
|
|
||||||
|
|
@ -1,263 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--
|
|
||||||
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="Getting Started">
|
|
||||||
<overview label="Overview" href="index.html" />
|
|
||||||
<quickstart label="Single Node Setup" href="single_node_setup.html" />
|
|
||||||
<setup label="Cluster Setup" href="cluster_setup.html" />
|
|
||||||
</docs>
|
|
||||||
|
|
||||||
<docs label="Guides">
|
|
||||||
<deployment label="Deployment Layout" href="deployment_layout.html" />
|
|
||||||
<commands_manual label="Hadoop Commands" href="commands_manual.html" />
|
|
||||||
<fsshell label="File System Shell" href="file_system_shell.html" />
|
|
||||||
<SLA label="Service Level Authorization" href="service_level_auth.html"/>
|
|
||||||
<native_lib label="Native Libraries" href="native_libraries.html" />
|
|
||||||
<superusers label="Superusers Acting On Behalf Of Other Users" href="Superusers.html"/>
|
|
||||||
<http_authentication label="Authentication for Hadoop HTTP web-consoles" href="HttpAuthentication.html"/>
|
|
||||||
</docs>
|
|
||||||
|
|
||||||
<docs label="Miscellaneous">
|
|
||||||
<api label="API Docs" href="ext:api/index" />
|
|
||||||
<jdiff label="API Changes" href="ext:jdiff/changes" />
|
|
||||||
<wiki label="Wiki" href="ext:wiki" />
|
|
||||||
<faq label="FAQ" href="ext:faq" />
|
|
||||||
<relnotes label="Release Notes" href="ext:relnotes" />
|
|
||||||
<changes label="Change Log" href="ext:changes" />
|
|
||||||
</docs>
|
|
||||||
|
|
||||||
<external-refs>
|
|
||||||
<site href="http://hadoop.apache.org/common/"/>
|
|
||||||
<lists href="http://hadoop.apache.org/common/mailing_lists.html"/>
|
|
||||||
<archive href="http://mail-archives.apache.org/mod_mbox/hadoop-common-commits/"/>
|
|
||||||
<releases href="http://hadoop.apache.org/common/releases.html">
|
|
||||||
<download href="#Download" />
|
|
||||||
</releases>
|
|
||||||
<jira href="http://hadoop.apache.org/common/issue_tracking.html"/>
|
|
||||||
<wiki href="http://wiki.apache.org/hadoop/Common" />
|
|
||||||
<faq href="http://wiki.apache.org/hadoop/Common/FAQ" />
|
|
||||||
|
|
||||||
<core-default href="http://hadoop.apache.org/common/docs/current/core-default.html" />
|
|
||||||
<hdfs-default href="http://hadoop.apache.org/hdfs/docs/current/hdfs-default.html" />
|
|
||||||
<mapred-default href="http://hadoop.apache.org/mapreduce/docs/current/mapred-default.html" />
|
|
||||||
|
|
||||||
<mapred-queues href="http://hadoop.apache.org/mapreduce/docs/current/mapred_queues.xml" />
|
|
||||||
<capacity-scheduler href="http://hadoop.apache.org/mapreduce/docs/current/capacity_scheduler.html">
|
|
||||||
<MemoryBasedTaskScheduling href="#Scheduling+Tasks+Considering+Memory+Requirements" />
|
|
||||||
</capacity-scheduler>
|
|
||||||
<mapred-tutorial href="http://hadoop.apache.org/mapreduce/docs/current/mapred_tutorial.html" >
|
|
||||||
<JobAuthorization href="#Job+Authorization" />
|
|
||||||
<ConfiguringMemoryRequirements href="#Configuring+Memory+Requirements+For+A+Job" />
|
|
||||||
</mapred-tutorial>
|
|
||||||
<streaming href="http://hadoop.apache.org/mapreduce/docs/current/streaming.html" />
|
|
||||||
<distcp href="http://hadoop.apache.org/mapreduce/docs/current/distcp.html" />
|
|
||||||
<hadoop-archives href="http://hadoop.apache.org/mapreduce/docs/current/hadoop_archives.html" />
|
|
||||||
|
|
||||||
<zlib href="http://www.zlib.net/" />
|
|
||||||
<gzip href="http://www.gzip.org/" />
|
|
||||||
<bzip href="http://www.bzip.org/" />
|
|
||||||
<osx href="http://www.apple.com/macosx" />
|
|
||||||
|
|
||||||
<relnotes href="releasenotes.html" />
|
|
||||||
<changes href="changes.html" />
|
|
||||||
<jdiff href="jdiff/">
|
|
||||||
<changes href="changes.html" />
|
|
||||||
</jdiff>
|
|
||||||
<api href="api/">
|
|
||||||
<index href="index.html" />
|
|
||||||
<org href="org/">
|
|
||||||
<apache href="apache/">
|
|
||||||
<hadoop href="hadoop/">
|
|
||||||
<conf href="conf/">
|
|
||||||
<configuration href="Configuration.html">
|
|
||||||
<final_parameters href="#FinalParams" />
|
|
||||||
<get href="#get(java.lang.String, java.lang.String)" />
|
|
||||||
<set href="#set(java.lang.String, java.lang.String)" />
|
|
||||||
</configuration>
|
|
||||||
</conf>
|
|
||||||
<filecache href="filecache/">
|
|
||||||
<distributedcache href="DistributedCache.html">
|
|
||||||
<addarchivetoclasspath href="#addArchiveToClassPath(org.apache.hadoop.fs.Path,%20org.apache.hadoop.conf.Configuration)" />
|
|
||||||
<addfiletoclasspath href="#addFileToClassPath(org.apache.hadoop.fs.Path,%20org.apache.hadoop.conf.Configuration)" />
|
|
||||||
<addcachefile href="#addCacheFile(java.net.URI,%20org.apache.hadoop.conf.Configuration)" />
|
|
||||||
<addcachearchive href="#addCacheArchive(java.net.URI,%20org.apache.hadoop.conf.Configuration)" />
|
|
||||||
<setcachefiles href="#setCacheFiles(java.net.URI[],%20org.apache.hadoop.conf.Configuration)" />
|
|
||||||
<setcachearchives href="#setCacheArchives(java.net.URI[],%20org.apache.hadoop.conf.Configuration)" />
|
|
||||||
<createsymlink href="#createSymlink(org.apache.hadoop.conf.Configuration)" />
|
|
||||||
</distributedcache>
|
|
||||||
</filecache>
|
|
||||||
<fs href="fs/">
|
|
||||||
<filesystem href="FileSystem.html" />
|
|
||||||
</fs>
|
|
||||||
<io href="io/">
|
|
||||||
<closeable href="Closeable.html">
|
|
||||||
<close href="#close()" />
|
|
||||||
</closeable>
|
|
||||||
<sequencefile href="SequenceFile.html" />
|
|
||||||
<sequencefilecompressiontype href="SequenceFile.CompressionType.html">
|
|
||||||
<none href="#NONE" />
|
|
||||||
<record href="#RECORD" />
|
|
||||||
<block href="#BLOCK" />
|
|
||||||
</sequencefilecompressiontype>
|
|
||||||
<writable href="Writable.html" />
|
|
||||||
<writablecomparable href="WritableComparable.html" />
|
|
||||||
<compress href="compress/">
|
|
||||||
<compressioncodec href="CompressionCodec.html" />
|
|
||||||
</compress>
|
|
||||||
</io>
|
|
||||||
<mapred href="mapred/">
|
|
||||||
<clusterstatus href="ClusterStatus.html" />
|
|
||||||
<counters href="Counters.html" />
|
|
||||||
<fileinputformat href="FileInputFormat.html">
|
|
||||||
<setinputpaths href="#setInputPaths(org.apache.hadoop.mapred.JobConf,%20org.apache.hadoop.fs.Path[])" />
|
|
||||||
<addinputpath href="#addInputPath(org.apache.hadoop.mapred.JobConf,%20org.apache.hadoop.fs.Path)" />
|
|
||||||
<setinputpathstring href="#setInputPaths(org.apache.hadoop.mapred.JobConf,%20java.lang.String)" />
|
|
||||||
<addinputpathstring href="#addInputPath(org.apache.hadoop.mapred.JobConf,%20java.lang.String)" />
|
|
||||||
</fileinputformat>
|
|
||||||
<fileoutputformat href="FileOutputFormat.html">
|
|
||||||
<getoutputpath href="#getOutputPath(org.apache.hadoop.mapred.JobConf)" />
|
|
||||||
<getworkoutputpath href="#getWorkOutputPath(org.apache.hadoop.mapred.JobConf)" />
|
|
||||||
<setoutputpath href="#setOutputPath(org.apache.hadoop.mapred.JobConf,%20org.apache.hadoop.fs.Path)" />
|
|
||||||
<setcompressoutput href="#setCompressOutput(org.apache.hadoop.mapred.JobConf,%20boolean)" />
|
|
||||||
<setoutputcompressorclass href="#setOutputCompressorClass(org.apache.hadoop.mapred.JobConf,%20java.lang.Class)" />
|
|
||||||
</fileoutputformat>
|
|
||||||
<filesplit href="FileSplit.html" />
|
|
||||||
<inputformat href="InputFormat.html" />
|
|
||||||
<inputsplit href="InputSplit.html" />
|
|
||||||
<isolationrunner href="IsolationRunner.html" />
|
|
||||||
<jobclient href="JobClient.html">
|
|
||||||
<runjob href="#runJob(org.apache.hadoop.mapred.JobConf)" />
|
|
||||||
<submitjob href="#submitJob(org.apache.hadoop.mapred.JobConf)" />
|
|
||||||
</jobclient>
|
|
||||||
<jobconf href="JobConf.html">
|
|
||||||
<setnummaptasks href="#setNumMapTasks(int)" />
|
|
||||||
<setnumreducetasks href="#setNumReduceTasks(int)" />
|
|
||||||
<setoutputkeycomparatorclass href="#setOutputKeyComparatorClass(java.lang.Class)" />
|
|
||||||
<setoutputvaluegroupingcomparator href="#setOutputValueGroupingComparator(java.lang.Class)" />
|
|
||||||
<setcombinerclass href="#setCombinerClass(java.lang.Class)" />
|
|
||||||
<setmapdebugscript href="#setMapDebugScript(java.lang.String)" />
|
|
||||||
<setreducedebugscript href="#setReduceDebugScript(java.lang.String)" />
|
|
||||||
<setmapspeculativeexecution href="#setMapSpeculativeExecution(boolean)" />
|
|
||||||
<setreducespeculativeexecution href="#setReduceSpeculativeExecution(boolean)" />
|
|
||||||
<setmaxmapattempts href="#setMaxMapAttempts(int)" />
|
|
||||||
<setmaxreduceattempts href="#setMaxReduceAttempts(int)" />
|
|
||||||
<setmaxmaptaskfailurespercent href="#setMaxMapTaskFailuresPercent(int)" />
|
|
||||||
<setmaxreducetaskfailurespercent href="#setMaxReduceTaskFailuresPercent(int)" />
|
|
||||||
<setjobendnotificationuri href="#setJobEndNotificationURI(java.lang.String)" />
|
|
||||||
<setcompressmapoutput href="#setCompressMapOutput(boolean)" />
|
|
||||||
<setmapoutputcompressorclass href="#setMapOutputCompressorClass(java.lang.Class)" />
|
|
||||||
<setprofileenabled href="#setProfileEnabled(boolean)" />
|
|
||||||
<setprofiletaskrange href="#setProfileTaskRange(boolean,%20java.lang.String)" />
|
|
||||||
<setprofileparams href="#setProfileParams(java.lang.String)" />
|
|
||||||
<setnumtaskstoexecuteperjvm href="#setNumTasksToExecutePerJvm(int)" />
|
|
||||||
<setqueuename href="#setQueueName(java.lang.String)" />
|
|
||||||
<getjoblocaldir href="#getJobLocalDir()" />
|
|
||||||
<getjar href="#getJar()" />
|
|
||||||
</jobconf>
|
|
||||||
<jobconfigurable href="JobConfigurable.html">
|
|
||||||
<configure href="#configure(org.apache.hadoop.mapred.JobConf)" />
|
|
||||||
</jobconfigurable>
|
|
||||||
<jobcontrol href="jobcontrol/">
|
|
||||||
<package-summary href="package-summary.html" />
|
|
||||||
</jobcontrol>
|
|
||||||
<mapper href="Mapper.html">
|
|
||||||
<map href="#map(K1, V1, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)" />
|
|
||||||
</mapper>
|
|
||||||
<outputcollector href="OutputCollector.html">
|
|
||||||
<collect href="#collect(K, V)" />
|
|
||||||
</outputcollector>
|
|
||||||
<outputcommitter href="OutputCommitter.html" />
|
|
||||||
<outputformat href="OutputFormat.html" />
|
|
||||||
<outputlogfilter href="OutputLogFilter.html" />
|
|
||||||
<sequencefileoutputformat href="SequenceFileOutputFormat.html">
|
|
||||||
<setoutputcompressiontype href="#setOutputCompressionType(org.apache.hadoop.mapred.JobConf,%20org.apache.hadoop.io.SequenceFile.CompressionType)" />
|
|
||||||
</sequencefileoutputformat>
|
|
||||||
<partitioner href="Partitioner.html" />
|
|
||||||
<recordreader href="RecordReader.html" />
|
|
||||||
<recordwriter href="RecordWriter.html" />
|
|
||||||
<reducer href="Reducer.html">
|
|
||||||
<reduce href="#reduce(K2, java.util.Iterator, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)" />
|
|
||||||
</reducer>
|
|
||||||
<reporter href="Reporter.html">
|
|
||||||
<incrcounterEnum href="#incrCounter(java.lang.Enum, long)" />
|
|
||||||
<incrcounterString href="#incrCounter(java.lang.String, java.lang.String, long amount)" />
|
|
||||||
</reporter>
|
|
||||||
<runningjob href="RunningJob.html" />
|
|
||||||
<skipbadrecords href="SkipBadRecords.html">
|
|
||||||
<setmappermaxskiprecords href="#setMapperMaxSkipRecords(org.apache.hadoop.conf.Configuration, long)"/>
|
|
||||||
<setreducermaxskipgroups href="#setReducerMaxSkipGroups(org.apache.hadoop.conf.Configuration, long)"/>
|
|
||||||
<setattemptsTostartskipping href="#setAttemptsToStartSkipping(org.apache.hadoop.conf.Configuration, int)"/>
|
|
||||||
<setskipoutputpath href="#setSkipOutputPath(org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path)"/>
|
|
||||||
<counter_map_processed_records href="#COUNTER_MAP_PROCESSED_RECORDS"/>
|
|
||||||
<counter_reduce_processed_groups href="#COUNTER_REDUCE_PROCESSED_GROUPS"/>
|
|
||||||
</skipbadrecords>
|
|
||||||
<textinputformat href="TextInputFormat.html" />
|
|
||||||
<textoutputformat href="TextOutputFormat.html" />
|
|
||||||
<lib href="lib/">
|
|
||||||
<package-summary href="package-summary.html" />
|
|
||||||
<hashpartitioner href="HashPartitioner.html" />
|
|
||||||
<keyfieldbasedpartitioner href="KeyFieldBasedPartitioner.html" />
|
|
||||||
<keyfieldbasedcomparator href="KeyFieldBasedComparator.html" />
|
|
||||||
<lazyoutputformat href="LazyOutputFormat.html" />
|
|
||||||
<aggregate href="aggregate/">
|
|
||||||
<package-summary href="package-summary.html" />
|
|
||||||
</aggregate>
|
|
||||||
</lib>
|
|
||||||
<pipes href="pipes/">
|
|
||||||
<package-summary href="package-summary.html" />
|
|
||||||
</pipes>
|
|
||||||
</mapred>
|
|
||||||
<net href="net/">
|
|
||||||
<dnstoswitchmapping href="DNSToSwitchMapping.html">
|
|
||||||
<resolve href="#resolve(java.util.List)" />
|
|
||||||
</dnstoswitchmapping>
|
|
||||||
</net>
|
|
||||||
<streaming href="streaming/">
|
|
||||||
<package-summary href="package-summary.html" />
|
|
||||||
</streaming>
|
|
||||||
<util href="util/">
|
|
||||||
<genericoptionsparser href="GenericOptionsParser.html" />
|
|
||||||
<progress href="Progress.html" />
|
|
||||||
<tool href="Tool.html" />
|
|
||||||
<toolrunner href="ToolRunner.html">
|
|
||||||
<run href="#run(org.apache.hadoop.util.Tool, java.lang.String[])" />
|
|
||||||
</toolrunner>
|
|
||||||
</util>
|
|
||||||
</hadoop>
|
|
||||||
</apache>
|
|
||||||
</org>
|
|
||||||
</api>
|
|
||||||
</external-refs>
|
|
||||||
|
|
||||||
</site>
|
|
||||||
|
|
@ -1,37 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN"
|
|
||||||
"http://forrest.apache.org/dtd/tab-cocoon-v10.dtd">
|
|
||||||
|
|
||||||
<tabs software="Hadoop"
|
|
||||||
title="Hadoop"
|
|
||||||
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/common/" />
|
|
||||||
<tab label="Wiki" href="http://wiki.apache.org/hadoop" />
|
|
||||||
<tab label="Common 0.23 Documentation" dir="" />
|
|
||||||
|
|
||||||
</tabs>
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 6.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 766 B |
Binary file not shown.
|
Before Width: | Height: | Size: 125 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
|
|
@ -1,366 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!--
|
|
||||||
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>Hadoop</project-name>
|
|
||||||
<project-description>Scalable Computing Platform</project-description>
|
|
||||||
<project-url>http://hadoop.apache.org/core/</project-url>
|
|
||||||
<project-logo>images/common-logo.jpg</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>2009</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="Common" href="http://hadoop.apache.org/common/"/>
|
|
||||||
</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 " >
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
<!--Headers -->
|
|
||||||
#content h1 {
|
|
||||||
margin-bottom: .5em;
|
|
||||||
font-size: 185%; color: black;
|
|
||||||
font-family: arial;
|
|
||||||
}
|
|
||||||
h2, .h3 { font-size: 175%; color: black; font-family: arial; }
|
|
||||||
h3, .h4 { font-size: 135%; color: black; font-family: arial; margin-bottom: 0.5em; }
|
|
||||||
h4, .h5 { font-size: 125%; color: black; font-style: italic; font-weight: bold; font-family: arial; }
|
|
||||||
h5, h6 { font-size: 110%; color: #363636; font-weight: bold; }
|
|
||||||
|
|
||||||
<!--Code Background -->
|
|
||||||
pre.code {
|
|
||||||
margin-left: 0em;
|
|
||||||
padding: 0.5em;
|
|
||||||
background-color: rgb(241,239,231);
|
|
||||||
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>
|
|
||||||
|
|
@ -1,75 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
<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>
|
|
||||||
|
|
@ -372,7 +372,6 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<exclude>.gitattributes</exclude>
|
<exclude>.gitattributes</exclude>
|
||||||
<exclude>.idea/**</exclude>
|
<exclude>.idea/**</exclude>
|
||||||
<exclude>src/main/conf/*</exclude>
|
<exclude>src/main/conf/*</exclude>
|
||||||
<exclude>src/main/docs/**</exclude>
|
|
||||||
<exclude>dev-support/findbugsExcludeFile.xml</exclude>
|
<exclude>dev-support/findbugsExcludeFile.xml</exclude>
|
||||||
<exclude>dev-support/checkstyle*</exclude>
|
<exclude>dev-support/checkstyle*</exclude>
|
||||||
<exclude>dev-support/jdiff/**</exclude>
|
<exclude>dev-support/jdiff/**</exclude>
|
||||||
|
|
@ -385,7 +384,6 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<exclude>src/test/resources/editsStored*</exclude>
|
<exclude>src/test/resources/editsStored*</exclude>
|
||||||
<exclude>src/test/resources/empty-file</exclude>
|
<exclude>src/test/resources/empty-file</exclude>
|
||||||
<exclude>src/main/webapps/datanode/robots.txt</exclude>
|
<exclude>src/main/webapps/datanode/robots.txt</exclude>
|
||||||
<exclude>src/main/docs/releasenotes.html</exclude>
|
|
||||||
<exclude>src/contrib/**</exclude>
|
<exclude>src/contrib/**</exclude>
|
||||||
<exclude>src/site/resources/images/*</exclude>
|
<exclude>src/site/resources/images/*</exclude>
|
||||||
<exclude>src/main/webapps/static/bootstrap-3.0.2/**</exclude>
|
<exclude>src/main/webapps/static/bootstrap-3.0.2/**</exclude>
|
||||||
|
|
|
||||||
|
|
@ -246,28 +246,12 @@
|
||||||
|
|
||||||
<mkdir dir="${project.build.directory}/docs-src"/>
|
<mkdir dir="${project.build.directory}/docs-src"/>
|
||||||
|
|
||||||
<copy todir="${project.build.directory}/docs-src">
|
|
||||||
<fileset dir="${basedir}/src/main/docs"/>
|
|
||||||
</copy>
|
|
||||||
|
|
||||||
<!-- Docs -->
|
<!-- Docs -->
|
||||||
<copy file="${project.build.directory}/docs-src/releasenotes.html"
|
|
||||||
todir="${project.build.directory}/site"/>
|
|
||||||
<style basedir="${basedir}/src/main/resources"
|
<style basedir="${basedir}/src/main/resources"
|
||||||
destdir="${project.build.directory}/site"
|
destdir="${project.build.directory}/site"
|
||||||
includes="core-default.xml"
|
includes="core-default.xml"
|
||||||
style="${basedir}/src/main/xsl/configuration.xsl"/>
|
style="${basedir}/src/main/xsl/configuration.xsl"/>
|
||||||
|
|
||||||
<!-- Convert 'CHANGES.txt' to 'changes.html" -->
|
|
||||||
<exec executable="perl" input="${basedir}/../CHANGES.txt"
|
|
||||||
output="${project.build.directory}/site/changes.html"
|
|
||||||
failonerror="true">
|
|
||||||
<arg value="${project.build.directory}/docs-src/changes/changes2html.pl"/>
|
|
||||||
</exec>
|
|
||||||
<copy todir="${project.build.directory}/site">
|
|
||||||
<fileset dir="${project.build.directory}/docs-src/changes" includes="*.css"/>
|
|
||||||
</copy>
|
|
||||||
|
|
||||||
<!-- Jdiff -->
|
<!-- Jdiff -->
|
||||||
<mkdir dir="${project.build.directory}/site/jdiff/xml"/>
|
<mkdir dir="${project.build.directory}/site/jdiff/xml"/>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue