Commit fe470612 authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Improve look'n feel of general documentation.

	* doc/Doxyfile.in: Make use of bibliography.

	* doc/bibliography.dox: Add references.

	* doc/DoxygenLayout.xml,
	* doc/doc.css,
	* doc/doxygen.css,
	* doc/footer.html,
	* doc/header.html,
	* doc/subdoc_footer.html: Improve rendering.
parent 98e0ae26
2013-03-08 Guillaume Lazzara <z@lrde.epita.fr>
Improve look'n feel of general documentation.
* doc/Doxyfile.in: Make use of bibliography.
* doc/bibliography.dox: Add references.
* doc/DoxygenLayout.xml,
* doc/doc.css,
* doc/doxygen.css,
* doc/footer.html,
* doc/header.html,
* doc/subdoc_footer.html: Improve rendering.
2012-02-28 Guillaume Lazzara <z@lrde.epita.fr>
Fix links and location of documentation.
......
# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE)
# Copyright (C) 2011, 2012 EPITA Research and Development Laboratory
# (LRDE)
#
# This file is part of Olena.
#
......@@ -34,7 +35,7 @@ INLINE_INHERITED_MEMB = YES
FULL_PATH_NAMES = NO
STRIP_FROM_PATH = @top_srcdir@
STRIP_FROM_INC_PATH =
SHORT_NAMES = YES
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
......@@ -74,7 +75,6 @@ GENERATE_DEPRECATEDLIST= NO
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = NO # Disabled for light doc
SHOW_DIRECTORIES = NO # Disabled for light doc
SHOW_FILES = NO # Disabled for light doc
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
......@@ -112,7 +112,8 @@ INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
INPUT_ENCODING = ISO-8859-1
CITE_BIB_FILES = @abs_top_srcdir@/doc/olena.bib
CITE_BIB_FILES = @abs_top_srcdir@/doc/doc.bib \
@abs_top_srcdir@/doc/olena.bib
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
......@@ -139,8 +140,8 @@ HTML_FILE_EXTENSION = .html
HTML_HEADER = @top_srcdir@/doc/header.html
HTML_FOOTER = @top_srcdir@/doc/footer.html
HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css
HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/doc.css
LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
......@@ -353,7 +354,8 @@ DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
# Local Variables:
......
......@@ -18,7 +18,6 @@
<tab type="files" visible="no" title=""/>
<tab type="globals" visible="no" title=""/>
</tab>
<tab type="dirs" visible="no" title=""/>
<tab type="examples" visible="no" title=""/>
</navindex>
......
......@@ -9,9 +9,9 @@
\li \ref olnpublisposters
\li \ref olnpublistechreps
\li \ref{burrus.03.mpool}
\li \ref{darbon.02.ismm}
\li \ref{darbon.04.ecoopphd}
\li \cite burrus.03.mpool
\li \cite darbon.02.ismm
\li \cite darbon.04.ecoopphd
\li \cite duret.00.gcse
\li \cite geraud.00.icpr
\li \cite geraud.01.ai
......@@ -34,4 +34,6 @@
\subsection olnpublistechreps Student Technical Reports
\cite sauvola00pr
\cite besl.1992.pami
*/
table.itable th
{
font-size: 17px;
}
table.itable li
{
font-size: 16px;
}
table.itable td
{
font-size: 17px;
vertical-align: top;
}
address.div
{
font-size: 10px;
}
table.itable
{
width:850px;
table-layout:fixed;
}
/* The standard CSS for doxygen */
/* The standard CSS for doxygen 1.8.2-20120930 */
body, table, div, p, dl {
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
font-size: 12px;
font: 400 14px/19px Roboto,sans-serif;
}
/* @group Heading Levels */
h1 {
h1.groupheader {
font-size: 150%;
}
......@@ -17,14 +16,34 @@ h1 {
margin: 10px 2px;
}
h2 {
font-size: 120%;
h2.groupheader {
border-bottom: 1px solid #879ECB;
color: #354C7B;
font-size: 150%;
font-weight: normal;
margin-top: 1.75em;
padding-top: 8px;
padding-bottom: 4px;
width: 100%;
}
h3 {
h3.groupheader {
font-size: 100%;
}
h1, h2, h3, h4, h5, h6 {
-webkit-transition: text-shadow 0.5s linear;
-moz-transition: text-shadow 0.5s linear;
-ms-transition: text-shadow 0.5s linear;
-o-transition: text-shadow 0.5s linear;
transition: text-shadow 0.5s linear;
margin-right: 15px;
}
h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
text-shadow: 0 0 15px cyan;
}
dt {
font-weight: bold;
}
......@@ -72,8 +91,6 @@ div.qindex, div.navtab{
background-color: #EBEFF6;
border: 1px solid #A3B4D7;
text-align: center;
margin: 2px;
padding: 2px;
}
div.qindex, div.navpath {
......@@ -123,11 +140,11 @@ a.el {
a.elRef {
}
a.code {
a.code, a.code:visited {
color: #4665A2;
}
a.codeRef {
a.codeRef, a.codeRef:visited {
color: #4665A2;
}
......@@ -137,11 +154,6 @@ dl.el {
margin-left: -1cm;
}
.fragment {
font-family: monospace, fixed;
font-size: 105%;
}
pre.fragment {
border: 1px solid #C4CFE5;
background-color: #FBFCFD;
......@@ -151,6 +163,63 @@ pre.fragment {
word-wrap: break-word;
font-size: 9pt;
line-height: 125%;
font-family: monospace, fixed;
font-size: 105%;
}
div.fragment {
padding: 4px;
margin: 4px;
background-color: #FBFCFD;
border: 1px solid #C4CFE5;
}
div.line {
font-family: monospace, fixed;
font-size: 13px;
min-height: 13px;
line-height: 1.0;
text-wrap: unrestricted;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
text-indent: -53px;
padding-left: 53px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
-webkit-transition-duration: 0.5s;
-moz-transition-property: background-color, box-shadow;
-moz-transition-duration: 0.5s;
-ms-transition-property: background-color, box-shadow;
-ms-transition-duration: 0.5s;
-o-transition-property: background-color, box-shadow;
-o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
div.line.glow {
background-color: cyan;
box-shadow: 0 0 10px cyan;
}
span.lineno {
padding-right: 4px;
text-align: right;
border-right: 2px solid #0F0;
background-color: #E8E8E8;
white-space: pre;
}
span.lineno a {
background-color: #D8D8D8;
}
span.lineno a:hover {
background-color: #C8C8C8;
}
div.ah {
......@@ -183,15 +252,15 @@ div.groupText {
}
body {
background: white;
background-color: white;
color: black;
margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 10px;
margin-right: 5px;
margin-left: 12px;
margin-right: 8px;
}
td.indexkey {
......@@ -200,6 +269,8 @@ td.indexkey {
border: 1px solid #C4CFE5;
margin: 2px 0px 2px 0;
padding: 2px 10px;
white-space: nowrap;
vertical-align: top;
}
td.indexvalue {
......@@ -292,6 +363,13 @@ span.vhdllogic {
color: #ff0000
}
blockquote {
background-color: #F7F8FB;
border-left: 2px solid #9CAFD4;
margin: 0 24px 0 4px;
padding: 0 12px 0 16px;
}
/* @end */
/*
......@@ -345,6 +423,24 @@ table.memberdecls {
padding: 0px;
}
.memberdecls td, .fieldtable tr {
-webkit-transition-property: background-color, box-shadow;
-webkit-transition-duration: 0.5s;
-moz-transition-property: background-color, box-shadow;
-moz-transition-duration: 0.5s;
-ms-transition-property: background-color, box-shadow;
-ms-transition-duration: 0.5s;
-o-transition-property: background-color, box-shadow;
-o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
.memberdecls td.glow, .fieldtable tr.glow {
background-color: cyan;
box-shadow: 0 0 15px cyan;
}
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
......@@ -359,8 +455,11 @@ table.memberdecls {
color: #555;
}
.memItemLeft, .memItemRight, .memTemplParams {
border-top: 1px solid #C4CFE5;
.memSeparator {
border-bottom: 1px solid #DEE4F0;
line-height: 1px;
margin: 0px;
padding: 0px;
}
.memItemLeft, .memTemplItemLeft {
......@@ -374,6 +473,7 @@ table.memberdecls {
.memTemplParams {
color: #4665A2;
white-space: nowrap;
font-size: 80%;
}
/* @end */
......@@ -406,15 +506,29 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
-webkit-transition: box-shadow 0.5s linear;
-moz-transition: box-shadow 0.5s linear;
-ms-transition: box-shadow 0.5s linear;
-o-transition: box-shadow 0.5s linear;
transition: box-shadow 0.5s linear;
display: table !important;
width: 100%;
}
.memitem.glow {
box-shadow: 0 0 15px cyan;
}
.memname {
white-space: nowrap;
font-weight: bold;
margin-left: 6px;
}
.memproto {
.memname td {
vertical-align: bottom;
}
.memproto, dl.reflist dt {
border-top: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
......@@ -422,45 +536,55 @@ table.memberdecls {
color: #253555;
font-weight: bold;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
background-image:url('nav_f.png');
background-repeat:repeat-x;
background-color: #E2E8F2;
/* opera specific markup */
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
border-top-right-radius: 8px;
border-top-left-radius: 8px;
border-top-right-radius: 4px;
border-top-left-radius: 4px;
/* firefox specific markup */
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
-moz-border-radius-topright: 8px;
-moz-border-radius-topleft: 8px;
-moz-border-radius-topright: 4px;
-moz-border-radius-topleft: 4px;
/* webkit specific markup */
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-webkit-border-top-right-radius: 8px;
-webkit-border-top-left-radius: 8px;
background-image:url('nav_f.png');
background-repeat:repeat-x;
background-color: #E2E8F2;
-webkit-border-top-right-radius: 4px;
-webkit-border-top-left-radius: 4px;
}
.memdoc {
.memdoc, dl.reflist dd {
border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
padding: 2px 5px;
padding: 6px 10px 2px 10px;
background-color: #FBFCFD;
border-top-width: 0;
background-image:url('nav_g.png');
background-repeat:repeat-x;
background-color: #FFFFFF;
/* opera specific markup */
border-bottom-left-radius: 8px;
border-bottom-right-radius: 8px;
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
/* firefox specific markup */
-moz-border-radius-bottomleft: 8px;
-moz-border-radius-bottomright: 8px;
-moz-border-radius-bottomleft: 4px;
-moz-border-radius-bottomright: 4px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7);
/* webkit specific markup */
-webkit-border-bottom-left-radius: 8px;
-webkit-border-bottom-right-radius: 8px;
-webkit-border-bottom-left-radius: 4px;
-webkit-border-bottom-right-radius: 4px;
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7));
}
dl.reflist dt {
padding: 5px;
}
dl.reflist dd {
margin: 0px 0px 10px 0px;
padding: 5px;
}
.paramkey {
......@@ -478,9 +602,13 @@ table.memberdecls {
.paramname em {
font-style: normal;
}
.paramname code {
line-height: 14px;
}
.params, .retval, .exception, .tparams {
border-spacing: 6px 2px;
margin-left: 0px;
padding-left: 0px;
}
.params .paramname, .retval .paramname {
......@@ -498,105 +626,116 @@ table.memberdecls {
vertical-align: top;
}
table.mlabels {
border-spacing: 0px;
}
td.mlabels-left {
width: 100%;
padding: 0px;
}
td.mlabels-right {
vertical-align: bottom;
padding: 0px;
white-space: nowrap;
}
/* @end */
/* @group Directory (tree) */
/* for the tree view */
span.mlabels {
margin-left: 8px;
}
.ftvtree {
font-family: sans-serif;
margin: 0px;
span.mlabel {
background-color: #728DC1;
border-top:1px solid #5373B4;
border-left:1px solid #5373B4;
border-right:1px solid #C4CFE5;
border-bottom:1px solid #C4CFE5;
text-shadow: none;
color: white;
margin-right: 4px;
padding: 2px 3px;
border-radius: 3px;
font-size: 7pt;
white-space: nowrap;
vertical-align: middle;
}
/* these are for tree view when used as main index */
.directory {
font-size: 9pt;
font-weight: bold;
margin: 5px;
}
.directory h3 {
margin: 0px;
margin-top: 1em;
font-size: 11pt;
}
/* @end */
/*
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.
*/
/* these are for tree view when not used as main index */
/*
.directory h3.swap {
height: 61px;
background-repeat: no-repeat;
background-image: url("yourimage.gif");
}
.directory h3.swap span {
display: none;
div.directory {
margin: 10px 0px;
border-top: 1px solid #A8B8D9;
border-bottom: 1px solid #A8B8D9;
width: 100%;
}
*/
.directory > h3 {
margin-top: 0;
.directory table {
border-collapse:collapse;
}
.directory p {
.directory td {
margin: 0px;
white-space: nowrap;
padding: 0px;
vertical-align: top;
}
.directory div {
display: none;
margin: 0px;
.directory td.entry {
white-space: nowrap;
padding-right: 6px;
}
.directory img {
vertical-align: -30%;
.directory td.entry a {
outline:none;
}
/* these are for tree view when not used as main index */
.directory-alt {
font-size: 100%;
font-weight: bold;
.directory td.entry a img {
border: none;
}
.directory-alt h3 {
margin: 0px;
margin-top: 1em;
font-size: 11pt;
.directory td.desc {
width: 100%;
padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
}
.directory-alt > h3 {
margin-top: 0;
.directory tr.even {
padding-left: 6px;
background-color: #F7F8FB;
}
.directory-alt p {
margin: 0px;
white-space: nowrap;
.directory img {
vertical-align: -30%;
}
.directory-alt div {
display: none;
margin: 0px;
.directory .levels {
white-space: nowrap;
width: 100%;
text-align: right;
font-size: 9pt;
}