Set up custom HTML header and footer for Doxy documentation.
authorJustin Seyster <jseyster@cs.sunysb.edu>
Thu, 9 Sep 2010 23:50:40 +0000 (19:50 -0400)
committerJustin Seyster <jseyster@cs.sunysb.edu>
Thu, 9 Sep 2010 23:50:40 +0000 (19:50 -0400)
Doxyfile
web/doxy-footer.html [new file with mode: 0644]
web/doxy-header.html [new file with mode: 0644]
web/doxygen.css [new file with mode: 0644]

index 9c2f5ae2c3dfc87c17d64b3cf920cbeec0e81781..bb6cc554943668afbb61e41ab0973c5580f3be84 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -779,13 +779,13 @@ HTML_FILE_EXTENSION    = .html
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard header.
 
-HTML_HEADER            =
+HTML_HEADER            = web/doxy-header.html
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard footer.
 
-HTML_FOOTER            =
+HTML_FOOTER            = web/doxy-footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 # style sheet that is used by each HTML page. It can be used to
@@ -794,7 +794,7 @@ HTML_FOOTER            =
 # the style sheet file to the HTML output directory, so don't put your own
 # stylesheet in the HTML output directory as well, or it will be erased!
 
-HTML_STYLESHEET        =
+HTML_STYLESHEET        = web/doxygen.css
 
 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 # files or namespaces will be aligned in HTML using tables. If set to
diff --git a/web/doxy-footer.html b/web/doxy-footer.html
new file mode 100644 (file)
index 0000000..178b4ed
--- /dev/null
@@ -0,0 +1,5 @@
+Generated on $datetime for $projectname by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion
+
+</div>
+</body>
+</html>
diff --git a/web/doxy-header.html b/web/doxy-header.html
new file mode 100644 (file)
index 0000000..9c9b475
--- /dev/null
@@ -0,0 +1,61 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+
+<!-- this template was designed by http://www.tristarwebdesign.co.uk - please visit for more templates & information - thank you. -->
+
+<head>
+
+<meta http-equiv="Content-Language" content="en-us" />
+
+<title>$title</title>
+<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
+
+<!-- style sheet links -->
+<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
+<link href="$relpath$search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="$relpath$search/search.js"></script>
+<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css"/>
+
+<!--[if IE 6]>
+<link rel="stylesheet" type="text/css" href="ie.css" />
+<![endif]-->
+
+</head>
+
+<body onload='searchBox.OnSelectItem(0);'>
+
+<div id="menu">
+
+  <div id="menutop"><a title="home" href="index.html"><img alt="home" src="constellations.jpg" width="200" height="200" /></a></div>
+
+  <div class="navcontainer">
+    <ul class="navlist">
+      <li><a title="home" href="index.html">home</a></li>
+      <li><a title="publications" href="index.html">publications</a></li>
+      <li><a title="download" href="index.html">download</a></li>
+      <li><a title="documentation" href="index.html">documentation</a></li>
+    </ul>
+  </div>
+
+  <br />
+
+  <div class="navcontainer">
+    <ul class="navlist">
+      <li><a id="topmenu" title="valid xhtml strict" href="index.html">valid xhtml strict</a></li>
+      <li><a title="valid css" href="index.html">valid css</a></li>
+      <li><a title="derby web design" href="http://www.tristarwebdesign.co.uk">webdesign by tri-star</a></li>
+    </ul>
+  </div>
+
+  <br />
+
+  <div class="simplenavcontainer">
+    <div class="navtext">
+      Photo by <a href="http://www.flickr.com/photos/pchee/">Phillip Chee</a>
+    </div>
+  </div>
+
+</div>
+
+<div id="main">
+
diff --git a/web/doxygen.css b/web/doxygen.css
new file mode 100644 (file)
index 0000000..8fb0993
--- /dev/null
@@ -0,0 +1,609 @@
+/* From menu.css in the original web template. */
+
+.navcontainer { width: 200px; }
+.simplenavcontainer { width: 200px; }
+
+.navcontainer ul
+{
+margin-left: 0;
+margin-top: 0;
+padding-left: 0;
+list-style-type: none;
+}
+
+.navcontainer a
+{
+display: block;
+padding: 3px 15px;
+width: 170px;
+background-color: #555;
+border-bottom: 1px dashed #999;
+}
+
+.navcontainer a:link, .navlist a:visited
+{
+color: #EEE;
+text-decoration: none;
+}
+
+.navcontainer a:hover
+{
+background-color: #444;
+color: #fff;
+}
+
+.navtext
+{
+padding: 3px 15px;
+width: 170px;
+color: #999999
+}
+
+.navtext a, .navtext a:visited
+{
+color:#bbbbbb
+}
+
+.navtext a:hover
+{
+color:#ffffff
+}
+
+#topmenu
+{
+       border-top: 1px dashed #999;
+}
+
+/* From style.css in the original template. */
+
+body
+{
+       margin: 0;
+       padding: 0;
+       background-color: #FFF;
+       font-family: trebuchet ms, verdana, tahoma, arial;
+       font-size: 75%;
+       line-height: 200%;
+}
+
+img
+{
+       border: 0px;
+}
+
+body > #menu
+{
+       position: fixed;
+}
+
+a:active, a:visited, a:link
+{
+       color: #5E8E3E;
+       text-decoration: underline;
+}
+
+a:hover
+{
+       color: #000000;
+       text-decoration: none;
+}
+
+#menu
+{
+       position: absolute;
+       top: 0;
+       left: 0;
+       width: 200px;
+       height: 100%;
+       overflow: auto;
+       background-color: #555;
+       border-right:1px solid #000;
+}
+
+#menutop
+{
+       width: 200px;
+       height: 200px;
+       border-bottom:1px solid #808080;
+       background-color: #444;
+}
+
+#main
+{
+       width: 540px;
+       margin-left: 200px;
+       padding: 20px;
+}
+
+
+#main h2
+{
+       border-bottom: 1px solid #808080;
+       font-family: arial;
+       font-weight: 100;
+       letter-spacing: 8px;
+       font-size: 200%;
+       text-align: right;
+}
+
+/* The standard CSS for doxygen */
+
+body, table, div, p, dl {
+       font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
+       font-size: 12px;
+}
+
+/* @group Heading Levels */
+
+div.multicol {
+       -moz-column-gap: 1em;
+       -webkit-column-gap: 1em;
+       -moz-column-count: 3;
+       -webkit-column-count: 3;
+}
+
+p.startli, p.startdd {
+       margin-top: 2px;
+}
+
+p.endli {
+       margin-bottom: 0px;
+}
+
+p.enddd {
+       margin-bottom: 4px;
+}
+
+/* @end */
+
+caption {
+       font-weight: bold;
+}
+
+span.legend {
+        font-size: 70%;
+        text-align: center;
+}
+
+div.qindex, div.navtab{
+       background-color: #e8eef2;
+       border: 1px solid #84b0c7;
+       text-align: center;
+       margin: 2px;
+       padding: 2px;
+}
+
+div.qindex, div.navpath {
+       width: 100%;
+       line-height: 140%;
+}
+
+div.navtab {
+       margin-right: 15px;
+}
+
+/* @group Link Styling */
+
+a {
+       color: #153788;
+       font-weight: normal;
+       text-decoration: none;
+}
+
+.contents a:visited {
+       color: #1b77c5;
+}
+
+a:hover {
+       text-decoration: underline;
+}
+
+a.qindex {
+       font-weight: bold;
+}
+
+a.qindexHL {
+       font-weight: bold;
+       background-color: #6666cc;
+       color: #ffffff;
+       border: 1px double #9295C2;
+}
+
+.contents a.qindexHL:visited {
+        color: #ffffff;
+}
+
+a.el {
+       font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code {
+}
+
+a.codeRef {
+}
+
+/* @end */
+
+dl.el {
+       margin-left: -1cm;
+}
+
+.fragment {
+       font-family: monospace, fixed;
+       font-size: 105%;
+}
+
+pre.fragment {
+       border: 1px solid #CCCCCC;
+       background-color: #f5f5f5;
+       padding: 4px 6px;
+       margin: 4px 8px 4px 2px;
+}
+
+div.ah {
+       background-color: black;
+       font-weight: bold;
+       color: #ffffff;
+       margin-bottom: 3px;
+       margin-top: 3px
+}
+
+div.groupHeader {
+       margin-left: 16px;
+       margin-top: 12px;
+       margin-bottom: 6px;
+       font-weight: bold;
+}
+
+div.groupText {
+       margin-left: 16px;
+       font-style: italic;
+}
+
+body {
+       background: white;
+       color: black;
+       margin-right: 20px;
+       margin-left: 20px;
+}
+
+td.indexkey {
+       background-color: #e8eef2;
+       font-weight: bold;
+       border: 1px solid #CCCCCC;
+       margin: 2px 0px 2px 0;
+       padding: 2px 10px;
+}
+
+td.indexvalue {
+       background-color: #e8eef2;
+       border: 1px solid #CCCCCC;
+       padding: 2px 10px;
+       margin: 2px 0px;
+}
+
+tr.memlist {
+       background-color: #f0f0f0;
+}
+
+p.formulaDsp {
+       text-align: center;
+}
+
+img.formulaDsp {
+       
+}
+
+img.formulaInl {
+       vertical-align: middle;
+}
+
+div.center {
+       text-align: center;
+        margin-top: 0px;
+        margin-bottom: 0px;
+        padding: 0px;
+}
+
+div.center img {
+       border: 0px;
+}
+
+img.footer {
+       border: 0px;
+       vertical-align: middle;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+       color: #008000
+}
+
+span.keywordtype {
+       color: #604020
+}
+
+span.keywordflow {
+       color: #e08000
+}
+
+span.comment {
+       color: #800000
+}
+
+span.preprocessor {
+       color: #806020
+}
+
+span.stringliteral {
+       color: #002080
+}
+
+span.charliteral {
+       color: #008080
+}
+
+span.vhdldigit { 
+       color: #ff00ff 
+}
+
+span.vhdlchar { 
+       color: #000000 
+}
+
+span.vhdlkeyword { 
+       color: #700070 
+}
+
+span.vhdllogic { 
+       color: #ff0000 
+}
+
+/* @end */
+
+.search {
+       color: #003399;
+       font-weight: bold;
+}
+
+form.search {
+       margin-bottom: 0px;
+       margin-top: 0px;
+}
+
+input.search {
+       font-size: 75%;
+       color: #000080;
+       font-weight: normal;
+       background-color: #e8eef2;
+}
+
+td.tiny {
+       font-size: 75%;
+}
+
+.dirtab {
+       padding: 4px;
+       border-collapse: collapse;
+       border: 1px solid #84b0c7;
+}
+
+th.dirtab {
+       background: #e8eef2;
+       font-weight: bold;
+}
+
+hr {
+       height: 0;
+       border: none;
+       border-top: 1px solid #666;
+}
+
+/* @group Member Descriptions */
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+       background-color: #FAFAFA;
+       border: none;
+       margin: 4px;
+       padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+       padding: 0px 8px 4px 8px;
+       color: #555;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
+       border-top: 1px solid #ccc;
+}
+
+.memItemLeft, .memTemplItemLeft {
+        white-space: nowrap;
+}
+
+.memTemplParams {
+       color: #606060;
+        white-space: nowrap;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtemplate {
+       font-size: 80%;
+       color: #606060;
+       font-weight: normal;
+       margin-left: 3px;
+}
+
+.memnav {
+       background-color: #e8eef2;
+       border: 1px solid #84b0c7;
+       text-align: center;
+       margin: 2px;
+       margin-right: 15px;
+       padding: 2px;
+}
+
+.memitem {
+       padding: 0;
+       margin-bottom: 10px;
+}
+
+.memname {
+       white-space: nowrap;
+       font-weight: bold;
+}
+
+.memproto, .memdoc {
+       border: 1px solid #84b0c7;      
+}
+
+.memproto {
+       padding: 0;
+       background-color: #d5e1e8;
+       font-weight: bold;
+       -webkit-border-top-left-radius: 8px;
+       -webkit-border-top-right-radius: 8px;
+        -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+       -moz-border-radius-topleft: 8px;
+       -moz-border-radius-topright: 8px;
+        -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+
+}
+
+.memdoc {
+       padding: 2px 5px;
+       background-color: #eef3f5;
+       border-top-width: 0;
+       -webkit-border-bottom-left-radius: 8px;
+       -webkit-border-bottom-right-radius: 8px;
+        -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+       -moz-border-radius-bottomleft: 8px;
+       -moz-border-radius-bottomright: 8px;
+        -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+}
+
+.paramkey {
+       text-align: right;
+}
+
+.paramtype {
+       white-space: nowrap;
+}
+
+.paramname {
+       color: #602020;
+       white-space: nowrap;
+}
+.paramname em {
+       font-style: normal;
+}
+
+/* @end */
+
+/* @group Directory (tree) */
+
+/* for the tree view */
+
+.ftvtree {
+       font-family: sans-serif;
+       margin: 0.5em;
+}
+
+/* these are for tree view when used as main index */
+
+.directory {
+       font-size: 9pt;
+       font-weight: bold;
+}
+
+.directory h3 {
+       margin: 0px;
+       margin-top: 1em;
+       font-size: 11pt;
+}
+
+/*
+The following two styles can be used to replace the root node title
+with an image of your choice.  Simply uncomment the next two styles,
+specify the name of your image and be sure to set 'height' to the
+proper pixel height of your image.
+*/
+
+/*
+.directory h3.swap {
+       height: 61px;
+       background-repeat: no-repeat;
+       background-image: url("yourimage.gif");
+}
+.directory h3.swap span {
+       display: none;
+}
+*/
+
+.directory > h3 {
+       margin-top: 0;
+}
+
+.directory p {
+       margin: 0px;
+       white-space: nowrap;
+}
+
+.directory div {
+       display: none;
+       margin: 0px;
+}
+
+.directory img {
+       vertical-align: -30%;
+}
+
+/* these are for tree view when not used as main index */
+
+.directory-alt {
+       font-size: 100%;
+       font-weight: bold;
+}
+
+.directory-alt h3 {
+       margin: 0px;
+       margin-top: 1em;
+       font-size: 11pt;
+}
+
+.directory-alt > h3 {
+       margin-top: 0;
+}
+
+.directory-alt p {
+       margin: 0px;
+       white-space: nowrap;
+}
+
+.directory-alt div {
+       display: none;
+       margin: 0px;
+}
+
+.directory-alt img {
+       vertical-align: -30%;
+}
+
+/* @end */
+
+address {
+       font-style: normal;
+       color: #333;
+}