songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add installation and remove the unnecessary a hack in header.html at 

least for the top-level package.
This commit is contained in:
Philipp Möller 2012-09-25 15:40:52 +00:00
parent 1dc9a0169b
commit 4535b6b240
5 changed files with 2355 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitattributes vendored
View File

@ -2350,6 +2350,7 @@ Documentation/doc/packages.txt -text
Documentation/doxyassist.xml -text Documentation/doxyassist.xml -text
Documentation/footer.html -text Documentation/footer.html -text
Documentation/header.html -text Documentation/header.html -text
Documentation/header_package.html -text
Documentation/how_to_cite_cgal.bib -text Documentation/how_to_cite_cgal.bib -text
Documentation/jquery.footnotes.min.js -text Documentation/jquery.footnotes.min.js -text
Documentation/pkglist_filter.sh -text Documentation/pkglist_filter.sh -text

2205
Documentation/doc/Installation.txt
View File

File diff suppressed because it is too large Load Diff

3
Documentation/doxyassist.xml
View File

@ -40,6 +40,7 @@ namespace for the XML file to be processed properly. -->
<item>PkgDescriptionBegin{1}=&lt;table cellpadding=&quot;2&quot; cellspacing=&quot;0&quot;&gt;&lt;tr&gt;&lt;td colspan=&quot;2&quot;&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;</item> <item>PkgDescriptionBegin{1}=&lt;table cellpadding=&quot;2&quot; cellspacing=&quot;0&quot;&gt;&lt;tr&gt;&lt;td colspan=&quot;2&quot;&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;</item>
<item>PkgManuals{2}=</item> <item>PkgManuals{2}=</item>
</list> </list>
<string name="HTML_HEADER">header_package.html</string>
</doxygen> </doxygen>
<!-- subprojects --> <!-- subprojects -->
@ -1289,6 +1290,8 @@ namespace for the XML file to be processed properly. -->
<item>*/doc/Developer_manual/*</item> <item>*/doc/Developer_manual/*</item>
</list> </list>
<string name="HTML_HEADER">header.html</string>
<string name="LAYOUT_FILE">DoxygenLayout.xml</string> <string name="LAYOUT_FILE">DoxygenLayout.xml</string>
<string name="GENERATE_TAGFILE">./tags/Manual.tag</string> <string name="GENERATE_TAGFILE">./tags/Manual.tag</string>
<string name="EXAMPLE_PATH">../Convex_hull_2/examples</string> <string name="EXAMPLE_PATH">../Convex_hull_2/examples</string>

29
Documentation/header.html
View File

@ -11,35 +11,6 @@
<script type="text/javascript" src="$relpath$jquery.footnotes.min.js"></script> <script type="text/javascript" src="$relpath$jquery.footnotes.min.js"></script>
$treeview $treeview
$search $search
<!-- throw a stick at the modules array and hijack gotoNode for our own evil purposes -->
<script type="text/javascript">
var head = $("head")[0];
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'modules.js';
script.onload = function() {
NAVTREE[0][2][1][1] = modules[0][1];
NAVTREE[0][2][1][2] = modules[0][2];
}
head.appendChild(script);
gotoNode = function (o,subIndex,root,hash,relpath) {
var nti = navTreeSubIndices[subIndex][root+hash];
if(nti[0] === 1 && nti[0]) {
nti.splice(1, 1);
}
o.breadcrumbs = $.extend(true, [], nti ? nti : navTreeSubIndices[subIndex][root]);
if (!o.breadcrumbs && root!=NAVTREE[0][1]) { // fallback: show index
navTo(o,NAVTREE[0][1],"",relpath);
$('.item').removeClass('selected');
$('.item').removeAttr('id');
}
if (o.breadcrumbs) {
o.breadcrumbs.unshift(0); // add 0 for root node
showNode(o, o.node, 0, hash);
}
}
</script>
<!-- don't use the doxygen include style to specify config parameters --> <!-- don't use the doxygen include style to specify config parameters -->
<script src="$relpath$../../MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script src="$relpath$../../MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

149
Documentation/header_package.html Normal file
View File

@ -0,0 +1,149 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath$jquery.js"></script>
<script type="text/javascript" src="$relpath$dynsections.js"></script>
<script type="text/javascript" src="$relpath$jquery.footnotes.min.js"></script>
$treeview
$search
<!-- throw a stick at the modules array and hijack gotoNode for our own evil purposes -->
<script type="text/javascript">
var head = $("head")[0];
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'modules.js';
script.onload = function() {
NAVTREE[0][2][1][1] = modules[0][1];
NAVTREE[0][2][1][2] = modules[0][2];
}
head.appendChild(script);
gotoNode = function (o,subIndex,root,hash,relpath) {
var nti = navTreeSubIndices[subIndex][root+hash];
if(nti[0] === 1 && nti[0]) {
nti.splice(1, 1);
}
o.breadcrumbs = $.extend(true, [], nti ? nti : navTreeSubIndices[subIndex][root]);
if (!o.breadcrumbs && root!=NAVTREE[0][1]) { // fallback: show index
navTo(o,NAVTREE[0][1],"",relpath);
$('.item').removeClass('selected');
$('.item').removeAttr('id');
}
if (o.breadcrumbs) {
o.breadcrumbs.unshift(0); // add 0 for root node
showNode(o, o.node, 0, hash);
}
}
</script>
<!-- don't use the doxygen include style to specify config parameters -->
<script src="$relpath$../../MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<!-- use the mathjax cdn -->
<!-- <script -->
<!-- type="text/javascript" -->
<!-- src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> -->
<!-- </script> -->
<!-- set-up footnote generation and autotoc -->
<script type="text/javascript">
$(document).ready(function() {
$("#doc-content").append('<ol id="autoFootnotes0" class="footnotesList"></ol>');
$("body").footnotes();
var toc = $("#autotoc").append('<ul></ul>');
if(toc) {
toc = toc.find('ul');
$("h1, h2, h3").each(function(i) {
var current = $(this);
var levelTag = current[0].tagName.charAt(1);
current.attr("id", "title" + i);
toc.append("<li class='level" + levelTag + "'><a id='link" + i + "' href='#title" +
i + "' title='" + current.prop("tagName") + "'>" + current.text() + "</a></li>");
});
}
<!-- trigger a resize event -->
$(window).resize();
});
</script>
<!-- hack around a bug in resize.js. The original resizeHeight is not
considering margins or borders when calculating the div heights. Our
ready hook is run after the original resize. We fixup the footer
variable and then do our thing. -->
<script type="text/javascript">
$(document).ready(function () {
footer = $("#footer");
resizeHeight = function() {
var headerHeight = header.outerHeight(true);
var footerHeight = footer.outerHeight(true);
var windowHeight = $(window).outerHeight(true) - headerHeight - footerHeight;
content.css({height:windowHeight + "px"});
navtree.css({height:windowHeight + "px"});
sidenav.css({height:windowHeight + "px",top: headerHeight+"px"});
}
$(window).resize(resizeHeight);
$(window).resize();
});
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<span style="display:none">\( \newcommand{\E}{\mathrm{E}} \) \( \newcommand{\A}{\mathrm{A}} \)
\( \newcommand{\R}{\mathrm{R}} \) \( \newcommand{\N}{\mathrm{N}} \) \( \newcommand{\Q}{\mathrm{Q}} \) \( \newcommand{\Z}{\mathrm{Z}} \)
\(
\def\ccSum #1#2#3{
\sum_{#1}^{#2}{#3}
}
\def\ccProd #1#2#3{
\sum_{#1}^{#2}{#3}
}\)
</span>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="back-nav">
<ul>
<li><a href="../../CGAL.CGAL/html/index.html">Home</a></li>
<li><a href="../../CGAL.CGAL/html/general_intro.html">Getting Started</a></li>
<li><a href="../../CGAL.CGAL/html/packages.html">Package Overview</a></li>
<li><a href="../../CGAL.CGAL/html/how_to_cite_cgal.html">Acknowledging CGAL</a></li>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<li>$searchbox</li>
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</ul>
</div>
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath$$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td style="padding-left: 0.5em;">
<div id="projectname">$projectname
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td style="padding-left: 0.5em;">
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
</tr>
</tbody>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->