Ticket #13426: doc.diff

File doc.diff, 6.6 KB (added by kirk.kelsey@…, 17 years ago)

configuration and templates for headerdoc

  • doc/toctemplate.html 

    Property changes on: doc
___________________________________________________________________
Name: svn:ignore
   + HTML
     
     1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
     2   "http://www.w3.org/TR/html4/strict.dtd">
     3
     4<html>
     5        <head>
     6
     7        <title>MacPorts.Framework API</title>
     8
     9        <style type="text/css">
     10        #pagehead {
     11            FONT-WEIGHT: bold;
     12            FONT-SIZE: 32px;
     13            COLOR: #000000;
     14            FONT-FAMILY: lucida grande, geneva, helvetica, arial, sans-serif;
     15        }
     16        td {
     17            font-size: 10px;
     18        }
     19        a:link {
     20            text-decoration: none;
     21            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     22            color: #0000ff;
     23        }
     24        a:visited {
     25            text-decoration: none;
     26            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     27            color: #0000ff;
     28        }
     29        a:visited:hover {
     30            text-decoration: underline;
     31            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     32            color: #ff6600;
     33        }
     34        a:active {
     35            text-decoration: none;
     36            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     37            color: #ff6600;
     38        }
     39        a:hover {
     40            text-decoration: underline;
     41            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     42            color: #ff6600;
     43        }
     44        h4 {
     45            text-decoration: none;
     46            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     47            font-size: tiny;
     48            font-weight: bold;
     49        }
     50        body {
     51            text-decoration: none;
     52            font-family: lucida grande, geneva, helvetica, arial, sans-serif;
     53            font-size: 10pt;
     54            background: white;
     55        }
     56    </style>
     57        <Meta name="ROBOTS" content="NOINDEX">
     58        </head>
     59       
     60<body>
     61
     62        <div><a name="MYTAG"></a></div>
     63
     64        <div style="text-align: center">
     65
     66<!-- start of header -->
     67<!--#include virtual="/path/to/header.html"-->
     68<!-- end of header -->
     69
     70        <table border="0" cellpadding="0" cellspacing="0" width="600">
     71                <tr>
     72                        <td><br></td>
     73                </tr>
     74                <tr>
     75                        <td>
     76                                <div id="pagehead">$$framework@@</div>
     77                        </td>
     78                </tr>
     79                <tr>
     80                        <td><br></td>
     81                </tr>
     82                <tr>
     83                        <td valign="top">
     84                                <span id="bodytext">
     85                                        $$frameworkdiscussion@@
     86                                </span>
     87                        </td>
     88                </tr>
     89                <tr>
     90                        <td></td>
     91                </tr>
     92                <tr>
     93                        <td>
     94                                <hr>
     95                                <br>
     96                        </td>
     97                </tr>
     98                <tr>
     99                        <td align="center" valign="top">
     100                                <H2>Headers</H2>
     101$$headerlist cols=3 order=down atts=border="0" cellpadding="1" cellspacing="0" width="420"@@
     102                                <H2>Functions</H2>
     103$$functionlist cols=3 order=down atts=border="0" cellpadding="1" cellspacing="0" width="420"@@
     104                        </td>
     105                </tr>
     106        </table>
     107
     108       
     109<!-- start of footer -->
     110<!--#include virtual="/includes/reflibfeedback" -->
     111
     112<!-- START FOOTER TABLE -->
     113        <table width="600" border="0" cellspacing="0" cellpadding="0">
     114                <tr><td><img width="1" height="48" src="/images/1dot.gif" alt=""></td></tr>
     115                <tr><td style="background: #919699;" colspan="2">
     116                        <img width="600" height="1" src="/images/1dot.gif" alt="">
     117                </td></tr>
     118                <tr><td><img src="/images/1dot.gif" width="1" height="17" alt=""></td></tr>
     119                <tr>
     120                        <td>
     121                                <div style="text-align: center;">
     122                                        <p>
     123This page is Copyright &copy; 2007 MacPorts Project.<br>
     124All rights reserved.
     125                                        </p>
     126                                </div>
     127                        </td>
     128                </tr>
     129        </table>
     130<!-- END FOOTER TABLE -->
     131
     132<!-- end of footer -->
     133       
     134</div>
     135       
     136
     137</body>
     138
     139</html>
     140

  • doc/headerDoc2HTML.config

     
     1# Configuration file for HeaderDoc
     2# $Revision: 1.5.4.1.2.34 $
     3###########################################################
     4
     5# These options set various parameters used in content generation.
     6copyrightOwner => MacPorts project
     7defaultFrameName => index.html
     8masterTOCName => masterTOC.html
     9
     10# This controls the unique ID prefix used at the start of API references.
     11# Use this to control the API UID of generated refs.  If you need to
     12# support linking to documents with multiple API UID prefixes, define
     13# the externalAPIUIDPrefixes variable with a space-separaed list of
     14# valid prefixes.
     15apiUIDPrefix => apple_ref
     16
     17# This is a legacy way of ignoring junk at the start of a line.
     18# The current preferred mechanism is to define it out of existence
     19# with C preprocessor macros.
     20ignorePrefixes =>
     21
     22# To include information at the top or bottom of every page,
     23# either include a string in htmlHeader/htmlFooter or a filename
     24# in htmlHeaderFile or htmlFooterFile
     25htmlHeader =>
     26htmlHeaderFile =>
     27htmlFooter =>
     28htmlFooterFile =>
     29stripDotH => 1
     30
     31# The TOC template file list can contain multiple template files, separated by spaces, e.g.
     32# TOCTemplateFile => toctemplate.html functions.tmpl constants.tmpl datatypes.tmpl mpindex.tmpl
     33
     34TOCTemplateFile => toctemplate.html
     35
     36# The date format is specified in the same format as strftime.  See the
     37# man page for strftime for more info.
     38dateFormat => %A, %B %d, %Y
     39
     40# You can include additional stylesheet bits with any of the following:
     41# styleSheetExtrasFile =>
     42# externalStyleSheets => /Resources/CSS/frameset_styles.css
     43# externalTOCStyleSheets => /Resources/CSS/frameset_styles.css
     44# styleImports => @import "/Resources/CSS/frameset_styles.css";
     45# tocStyleImports => @import "/Resources/CSS/frameset_styles.css";
     46# tocStyleImports => @import "/Resources/CSS/adcstyle.css";
     47
     48# These are CSS Styles for various bits of code declarations.
     49textStyle =>
     50commentStyle => background:#ffffff; color:#236e25
     51preprocessorStyle => background:#ffffff; color:#236e25
     52funcNameStyle => background:#ffffff; color:#000000;
     53stringStyle => background: #ffffff; color:#891315;
     54charStyle => background: #ffffff; color:#0000ff;
     55numberStyle => background: #ffffff; color:#0000ff;
     56keywordStyle => background:#ffffff; color:#761550;
     57typeStyle => background:#ffffff; color:#761550;
     58paramStyle => background:#ffffff; color:#000000;
     59varStyle => background:#ffffff; color:#000000;
     60templateStyle => background:#ffffff; color:#761550;
     61
     62# These control the automatic generation of hierarchical jump links in large
     63# index pages.  You can set these limits higher or lower as desired.
     64groupHierLimit => 100
     65groupHierSubgroupLimit => 30
     66