Commit bd81f29a authored by John Bonn's avatar John Bonn
Browse files

Updated doxygen configuration to reference ISIS .css files per Doxygen manual... 

Updated doxygen configuration to reference ISIS .css files per Doxygen manual instead of using custom header files.  .css files were not being referenced corrently. Fixed some css problems so appearance is similar to old format. Simplified css configuration in favor of Doxygen config files.

git-svn-id: http://subversion.wr.usgs.gov/repos/prog/isis3/trunk@7506 41f8697f-d340-4b68-9986-7bafba869bb8
parent 0c4066ab

isis/src/docsys/Object/Makefile

+1 −10
Original line number Diff line number Diff line
@@ -55,7 +55,7 @@ conf: 
	echo "HTML_HEADER      = build/IsisObjectHeaderApps.html"   >> build/apps_tag_temp.conf

	echo "HTML_FOOTER      = build/IsisObjectFooter.html"       >> build/apps_tag_temp.conf

	echo "HTML_OUTPUT      = apps"                              >> build/apps_tag_temp.conf

	echo "HTML_STYLESHEET  = build/doxygen_apps.css"            >> build/apps_tag_temp.conf

	echo "HTML_STYLESHEET  = build/doxygen.css"            >> build/apps_tag_temp.conf



	if [[ "$(DOT_PATH)" != "" ]];                                          \

	then                                                                   \
@@ -65,16 +65,10 @@ conf: 
	echo "        ...building Programmer configuration"

	cat build/Programmer.conf                                        >  build/Programmer_temp.conf

	echo "OUTPUT_DIRECTORY = $(ISISROOT)/doc/Object/"                >> build/Programmer_temp.conf

	echo "FILE_PATTERNS    = *objs*.h \ "                            >> build/Programmer_temp.conf

	echo "                   *objs*.cpp \ "                          >> build/Programmer_temp.conf

	echo "                   *build/isisDoxyDefs.doxydef"            >> build/Programmer_temp.conf

	echo "STRIP_FROM_PATH  = $(ISISROOT)/"                           >> build/Programmer_temp.conf

	echo "INPUT            = build/isisDoxyDefs.doxydef $(ISISROOT)/src/ " >> build/Programmer_temp.conf

	echo "HTML_HEADER      = build/IsisObjectHeaderProgrammers.html" >> build/Programmer_temp.conf

	echo "HTML_FOOTER      = build/IsisObjectFooter.html"            >> build/Programmer_temp.conf

	echo "HTML_OUTPUT      = Programmer"                             >> build/Programmer_temp.conf

	echo "TAGFILES         = build/apps/apps_fix.tag"                >> build/Programmer_temp.conf

	echo "HTML_STYLESHEET  = build/doxygen_prog.css"                 >> build/Programmer_temp.conf



	if [ "$(findstring LOUD,$(MODE))" = "LOUD" ]; \

	then \
@@ -92,11 +86,8 @@ conf: 
	echo "STRIP_FROM_PATH  = $(ISISROOT)/"                      >> build/Developer_temp.conf

	echo "INPUT            = $(ISISROOT)/src/ \\"               >> build/Developer_temp.conf

	echo "                   build/isisDoxyDefs.doxydef"        >> build/Developer_temp.conf

	echo "HTML_HEADER      = build/IsisObjectHeader.html"       >> build/Developer_temp.conf

	echo "HTML_FOOTER      = build/IsisObjectFooter.html"       >> build/Developer_temp.conf

	echo "HTML_OUTPUT      = Developer"                         >> build/Developer_temp.conf

	echo "TAGFILES         = build/apps/apps_fix.tag"           >> build/Developer_temp.conf

	echo "HTML_STYLESHEET  = build/doxygen.css"                 >> build/Developer_temp.conf

	if [ "$(findstring LOUD,$(MODE))" = "LOUD" ]; \

	then \

	  echo "QUIET                  = NO"                         >> build/Developer_temp.conf; \

isis/src/docsys/Object/assets/styles/IsisObjectAPIDocStyle.css

+40 −3
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
   */





    /* ----------------------------------------------------------------

    /* -----------IsisObjectAPIDocStyle.css-----------------------------------------------------

     * HEADINGS */



     H1       {
@@ -34,7 +34,7 @@ 
     body     {

                background-repeat: repeat ;

                background-attachment: fixed ;

                background-image: URL('../../../assets/banners/isis_bg.jpg');

                background-image: URL('../../../doc/assets/banners/isis_bg.jpg');

              }



     small    {
@@ -97,6 +97,7 @@ DIV.ah { 
  margin-top: 3px

}





TD.md {

  background-color: #FFEEDD;

  font-weight: bold;
@@ -161,7 +162,7 @@ IMG.formulaDsp { } 
IMG.formulaInl { vertical-align: middle; }



img {

  background-color: white ;

/*  background-color: white ; */

  border: 2px solid black ;

  padding: 5px;

  margin: 5px;
@@ -209,6 +210,7 @@ SPAN.charliteral { color: #008080 } 
        margin: 0px;

}

.memItemLeft {

        white-space: normal;

        padding: 1px 0px 0px 8px;

        margin: 4px;

        border-top-width: 1px;
@@ -259,3 +261,38 @@ INPUT.search { font-size: 75%; 
               background-color: #ffeeee;

}

TD.tiny      { font-size: 75%;}



#nav-tree {

  background-image: inherit;

  background-repeat:inherit;

  background-color: inherit;

}



#nav-tree img {

  background-color: inherit;

}



div.header {

    background-image: inherit;

    background-color: inherit;

}



#side-nav {

    left: inherit;

}



.memdoc {

    background-color: inherit;

}



dd {

    background-image: inherit;

    background-color: inherit;

}

.directory tr.even {

    background-color: #FFFFF0;

}



dl.reflist dd {

    background-color: inherit;

}

isis/src/docsys/Object/build/Developer.conf

+5 −5
Original line number Diff line number Diff line
@@ -51,7 +51,7 @@ PROJECT_BRIEF = 
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy

# the logo to the output directory.



PROJECT_LOGO           =

PROJECT_LOGO           = ../../docsys/assets/icons/USGS_logo55h.png



# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path

# into which the generated documentation will be written. If a relative path is
@@ -1098,7 +1098,7 @@ HTML_FILE_EXTENSION = .html 
# of the possible markers and block names see the documentation.

# This tag requires that the tag GENERATE_HTML is set to YES.



HTML_HEADER            =

HTML_HEADER            = build/IsisObjectHeader.html



# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each

# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1108,7 +1108,7 @@ HTML_HEADER = 
# that doxygen normally uses.

# This tag requires that the tag GENERATE_HTML is set to YES.



HTML_FOOTER            =

HTML_FOOTER            = build/IsisObjectFooter.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 fine-tune the look of
@@ -1133,7 +1133,7 @@ HTML_STYLESHEET = 
# list). For an example see the documentation.

# This tag requires that the tag GENERATE_HTML is set to YES.



HTML_EXTRA_STYLESHEET  =

HTML_EXTRA_STYLESHEET  = ../assets/styles/IsisStyleCommon.css assets/styles/IsisObjectAPIDocStyle.css 



# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or

# other source files which should be copied to the HTML output directory. Note

isis/src/docsys/Object/build/IsisObjectFooter.html

+14 −2
Original line number Diff line number Diff line 
<!-- FOOTER FILE for Isis API/Object documentation (used by doxygen)  -->

<!-- HTML footer for doxygen 1.8.14-->

<!-- start footer part -->

<!--BEGIN GENERATE_TREEVIEW-->

<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

  <ul>

    $navpath

  </ul>

</div>

<!--END GENERATE_TREEVIEW-->

<!--BEGIN !GENERATE_TREEVIEW-->

<hr class="footer"/><address class="footer"><small>

</small></address>

<!--END !GENERATE_TREEVIEW-->



<script type="text/javascript" language="JavaScript" src="../../assets/scripts/footer.js"></script>

</body>

</html>

isis/src/docsys/Object/build/IsisObjectHeader.html

+48 −60
Original line number Diff line number Diff line 
<!-- HEADER FILE for Isis API/Object documentation (used by doxygen)  -->

<!-- See doxygen -w  commmand for regenerating header with necessary doxygen info -->



<!-- HTML header for doxygen 1.8.14-->

<!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"/>

<meta name="generator" content="Doxygen $doxygenversion"/>

<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>

$treeview

$search

$mathjax

<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />

$extrastylesheet

<meta name="viewport" content="width=device-width, initial-scale=1"/>



<title>USGS Astrogeology Isis API</title>

<link rel="stylesheet" href="doxygen.css">

<link rel="stylesheet" href="tabs.css">

<link rel="stylesheet" href="../../assets/styles/IsisStyleCommon.css">

<link rel="stylesheet" href="../assets/styles/IsisObjectAPIDocStyle.css">

<!--link rel="stylesheet" href="../assets/styles/tabs.css"-->

<!-- Start USGS customized -->

<meta name="keywords" content="Isis, image processing, API, object, class documentation">

<meta name="author" content="USGS Astrogeology Research Program">

<meta name="description" content="Documentation for Isis Objects, the Isis API">
@@ -30,53 +18,53 @@ $extrastylesheet 
<meta name="county" content="Coconino">

<meta name="city" content="Flagstaff">

<meta name="zip" content="86001">

<style type="text/css">



    /* ----------------------------------------------------------------

     * HEADINGS */



     H1       {

               color:           #663333 ;

              }



     H2       {

               background-color: #CCAA99 ;

              }



     H3       {

               color: #663333 ;

              }



<!-- End USGS customized -->



     HR       {

               color: #990000 ;

              }





</style>

<!--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>

$treeview

$search

$mathjax

<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />

$extrastylesheet

</head>

<body>

<a href="http://www.usgs.gov"><img class="noborder" src="../../assets/icons/littleVIS.gif" width="80" height="22" border="0" alt="USGS"></a>

<br>

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->



<table width="100%" cellpadding="0" border="0" cellspacing="0">

<tr valign="top">

  <td align="left">

<p style="margin-top:10px; margin-bottom:0px;">

Isis 3 Developer's Reference (<abbr title="Application Program Interface">API</abbr>)</p>

<!--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 id="projectalign" 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>

  <td align="right" class="caption">

  <script language="javascript" type="text/javascript">

    //<!--

      // create back link if javascript is available

      if (history.length > 1) {

        document.write ("<a href='javascript:history.back();'>Back</a> | ") ;

      }

    //-->

  </script>

  <a href="../../index.html" target="_top">Home</a></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-->

  <!--BEGIN DISABLE_INDEX-->

   <!--BEGIN SEARCHENGINE-->

   <td>$searchbox</td>

   <!--END SEARCHENGINE-->

  <!--END DISABLE_INDEX-->

 </tr>

 </tbody>

</table>



<hr>

</div>

<!--END TITLEAREA-->

<!-- end header part -->