[Abtlinux-svn] SF.net SVN: abtlinux: [87] src/trunk
Status: Alpha
Brought to you by:
eschabell
Menu
▾
▴
[Abtlinux-svn] SF.net SVN: abtlinux: [87] src/trunk
|
From: <esc...@us...> - 2006-05-15 17:50:55
|
Revision: 87 Author: eschabell Date: 2006-05-15 10:50:40 -0700 (Mon, 15 May 2006) ViewCVS: http://svn.sourceforge.net/abtlinux/?rev=87&view=rev Log Message: ----------- Added a template for prettier docs. Updated docGen.sh to use template. Reran doc generation and added to repo so it can be easily hosted. Modified Paths: -------------- src/trunk/docGen.sh Added Paths: ----------- src/trunk/abtTemplate.rb src/trunk/doc/ src/trunk/doc/classes/ src/trunk/doc/classes/Package.html src/trunk/doc/created.rid src/trunk/doc/dot/ src/trunk/doc/dot/f_0.dot src/trunk/doc/dot/f_0.png src/trunk/doc/files/ src/trunk/doc/files/Package_rb.html src/trunk/doc/fr_class_index.html src/trunk/doc/fr_file_index.html src/trunk/doc/fr_method_index.html src/trunk/doc/index.html src/trunk/doc/rdoc-style.css Added: src/trunk/abtTemplate.rb =================================================================== --- src/trunk/abtTemplate.rb (rev 0) +++ src/trunk/abtTemplate.rb 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,590 @@ +module RDoc +module Page + +FONTS = "\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif" + +STYLE = <<CSS +a { + color: #00F; + text-decoration: none; +} + +a:hover { + color: #77F; + text-decoration: underline; +} + +body, td, p { + font-family: %fonts%; + background: #FFF; + color: #000; + margin: 0px; + font-size: small; +} + +#content { + margin: 2em; +} + +#description p { + margin-bottom: 0.5em; +} + +.sectiontitle { + margin-top: 1em; + margin-bottom: 1em; + padding: 0.5em; + padding-left: 2em; + background: #005; + color: #FFF; + font-weight: bold; + border: 1px dotted black; +} + +.attr-rw { + padding-left: 1em; + padding-right: 1em; + text-align: center; + color: #055; +} + +.attr-name { + font-weight: bold; +} + +.attr-desc { +} + +.attr-value { + font-family: monospace; +} + +.file-title-prefix { + font-size: large; +} + +.file-title { + font-size: large; + font-weight: bold; + background: #005; + color: #FFF; +} + +.banner { + background: #005; + color: #FFF; + border: 1px solid black; + padding: 1em; +} + +.banner td { + background: transparent; + color: #FFF; +} + +h1 a, h2 a, .sectiontitle a, .banner a { + color: #FF0; +} + +h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover { + color: #FF7; +} + +.dyn-source { + display: none; + background: #FFE; + color: #000; + border: 1px dotted black; + margin: 0.5em 2em 0.5em 2em; + padding: 0.5em; +} + +.dyn-source .cmt { + color: #00F; + font-style: italic; +} + +.dyn-source .kw { + color: #070; + font-weight: bold; +} + +.method { + margin-left: 1em; + margin-right: 1em; + margin-bottom: 1em; +} + +.description pre { + padding: 0.5em; + border: 1px dotted black; + background: #FFE; +} + +.method .title { + font-family: monospace; + font-size: large; + border-bottom: 1px dashed black; + margin-bottom: 0.3em; + padding-bottom: 0.1em; +} + +.method .description, .method .sourcecode { + margin-left: 1em; +} + +.description p, .sourcecode p { + margin-bottom: 0.5em; +} + +.method .sourcecode p.source-link { + text-indent: 0em; + margin-top: 0.5em; +} + +.method .aka { + margin-top: 0.3em; + margin-left: 1em; + font-style: italic; + text-indent: 2em; +} + +h1 { + padding: 1em; + border: 1px solid black; + font-size: x-large; + font-weight: bold; + color: #FFF; + background: #007; +} + +h2 { + padding: 0.5em 1em 0.5em 1em; + border: 1px solid black; + font-size: large; + font-weight: bold; + color: #FFF; + background: #009; +} + +h3, h4, h5, h6 { + padding: 0.2em 1em 0.2em 1em; + border: 1px dashed black; + color: #000; + background: #AAF; +} + +.sourcecode > pre { + padding: 0.5em; + border: 1px dotted black; + background: #FFE; +} + +CSS + +XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +} + +HEADER = XHTML_PREAMBLE + <<ENDHEADER +<html> + <head> + <title>%title%</title> + <meta http-equiv="Content-Type" content="text/html; charset=%charset%" /> + <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" /> + + <script language="JavaScript" type="text/javascript"> + // <![CDATA[ + + function toggleSource( id ) + { + var elem + var link + + if( document.getElementById ) + { + elem = document.getElementById( id ) + link = document.getElementById( "l_" + id ) + } + else if ( document.all ) + { + elem = eval( "document.all." + id ) + link = eval( "document.all.l_" + id ) + } + else + return false; + + if( elem.style.display == "block" ) + { + elem.style.display = "none" + link.innerHTML = "show source" + } + else + { + elem.style.display = "block" + link.innerHTML = "hide source" + } + } + + function openCode( url ) + { + window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" ) + } + // ]]> + </script> + </head> + + <body> +ENDHEADER + +FILE_PAGE = <<HTML +<table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'> + <tr><td> + <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr> + <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />%short_name%</td> + <td align="right"> + <table border='0' cellspacing="0" cellpadding="2"> + <tr> + <td>Path:</td> + <td>%full_path% +IF:cvsurl + (<a href="%cvsurl%">CVS</a>) +ENDIF:cvsurl + </td> + </tr> + <tr> + <td>Modified:</td> + <td>%dtm_modified%</td> + </tr> + </table> + </td></tr> + </table> + </td></tr> +</table><br> +HTML + +################################################################### + +CLASS_PAGE = <<HTML +<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr> + <td class="file-title"><span class="file-title-prefix">%classmod%</span><br />%full_name%</td> + <td align="right"> + <table cellspacing=0 cellpadding=2> + <tr valign="top"> + <td>In:</td> + <td> +START:infiles +HREF:full_path_url:full_path: +IF:cvsurl + (<a href="%cvsurl%">CVS</a>) +ENDIF:cvsurl +END:infiles + </td> + </tr> +IF:parent + <tr> + <td>Parent:</td> + <td> +IF:par_url + <a href="%par_url%"> +ENDIF:par_url +%parent% +IF:par_url + </a> +ENDIF:par_url + </td> + </tr> +ENDIF:parent + </table> + </td> + </tr> + </table> +HTML + +################################################################### + +METHOD_LIST = <<HTML + <div id="content"> +IF:diagram + <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center"> + %diagram% + </td></tr></table> +ENDIF:diagram + +IF:description + <div class="description">%description%</div> +ENDIF:description + +IF:requires + <div class="sectiontitle">Required Files</div> + <ul> +START:requires + <li>HREF:aref:name:</li> +END:requires + </ul> +ENDIF:requires + +IF:toc + <div class="sectiontitle">Contents</div> + <ul> +START:toc + <li><a href="#%href%">%secname%</a></li> +END:toc + </ul> +ENDIF:toc + +IF:methods + <div class="sectiontitle">Methods</div> + <ul> +START:methods + <li>HREF:aref:name:</li> +END:methods + </ul> +ENDIF:methods + +IF:includes +<div class="sectiontitle">Included Modules</div> +<ul> +START:includes + <li>HREF:aref:name:</li> +END:includes +</ul> +ENDIF:includes + +START:sections +IF:sectitle +<div class="sectiontitle"><a name="%secsequence%">%sectitle%</a></div> +IF:seccomment +<div class="description"> +%seccomment% +</div> +ENDIF:seccomment +ENDIF:sectitle + +IF:classlist + <div class="sectiontitle">Classes and Modules</div> + %classlist% +ENDIF:classlist + +IF:constants + <div class="sectiontitle">Constants</div> + <table border='0' cellpadding='5'> +START:constants + <tr valign='top'> + <td class="attr-name">%name%</td> + <td>=</td> + <td class="attr-value">%value%</td> + </tr> +IF:desc + <tr valign='top'> + <td> </td> + <td colspan="2" class="attr-desc">%desc%</td> + </tr> +ENDIF:desc +END:constants + </table> +ENDIF:constants + +IF:attributes + <div class="sectiontitle">Attributes</div> + <table border='0' cellpadding='5'> +START:attributes + <tr valign='top'> + <td class='attr-rw'> +IF:rw +[%rw%] +ENDIF:rw + </td> + <td class='attr-name'>%name%</td> + <td class='attr-desc'>%a_desc%</td> + </tr> +END:attributes + </table> +ENDIF:attributes + +IF:method_list +START:method_list +IF:methods +<div class="sectiontitle">%type% %category% methods</div> +START:methods +<div class="method"> + <div class="title"> +IF:callseq + <a name="%aref%"></a><b>%callseq%</b> +ENDIF:callseq +IFNOT:callseq + <a name="%aref%"></a><b>%name%</b>%params% +ENDIF:callseq +IF:codeurl +[ <a href="javascript:openCode('%codeurl%')">source</a> ] +ENDIF:codeurl + </div> +IF:m_desc + <div class="description"> + %m_desc% + </div> +ENDIF:m_desc +IF:aka +<div class="aka"> + This method is also aliased as +START:aka + <a href="%aref%">%name%</a> +END:aka +</div> +ENDIF:aka +IF:sourcecode +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('%aref%_source')" id="l_%aref%_source">show source</a> ]</p> + <div id="%aref%_source" class="dyn-source"> +<pre> +%sourcecode% +</pre> + </div> +</div> +ENDIF:sourcecode +</div> +END:methods +ENDIF:methods +END:method_list +ENDIF:method_list +END:sections +</div> +HTML + +FOOTER = <<ENDFOOTER + </body> +</html> +ENDFOOTER + +BODY = HEADER + <<ENDBODY + !INCLUDE! <!-- banner header --> + + <div id="bodyContent"> + #{METHOD_LIST} + </div> + + #{FOOTER} +ENDBODY + +########################## Source code ########################## + +SRC_PAGE = XHTML_PREAMBLE + <<HTML +<html> +<head><title>%title%</title> +<meta http-equiv="Content-Type" content="text/html; charset=%charset%"> +<style> +.ruby-comment { color: green; font-style: italic } +.ruby-constant { color: #4433aa; font-weight: bold; } +.ruby-identifier { color: #222222; } +.ruby-ivar { color: #2233dd; } +.ruby-keyword { color: #3333FF; font-weight: bold } +.ruby-node { color: #777777; } +.ruby-operator { color: #111111; } +.ruby-regexp { color: #662222; } +.ruby-value { color: #662222; font-style: italic } + .kw { color: #3333FF; font-weight: bold } + .cmt { color: green; font-style: italic } + .str { color: #662222; font-style: italic } + .re { color: #662222; } +</style> +</head> +<body bgcolor="white"> +<pre>%code%</pre> +</body> +</html> +HTML + +########################## Index ################################ + +FR_INDEX_BODY = <<HTML +!INCLUDE! +HTML + +FILE_INDEX = XHTML_PREAMBLE + <<HTML +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=%charset%"> +<style> +<!-- + body { + background-color: #EEE; + font-family: #{FONTS}; + color: #000; + margin: 0px; + } + .banner { + background: #005; + color: #FFF; + padding: 0.2em; + font-size: small; + font-weight: bold; + text-align: center; + } + .entries { + margin: 0.25em 1em 0 1em; + font-size: x-small; + } + a { + color: #00F; + text-decoration: none; + white-space: nowrap; + } + a:hover { + color: #77F; + text-decoration: underline; + } +--> +</style> +<base target="docwin"> +</head> +<body> +<div class="banner">%list_title%</div> +<div class="entries"> +START:entries +<a href="%href%">%name%</a><br> +END:entries +</div> +</body></html> +HTML + +CLASS_INDEX = FILE_INDEX +METHOD_INDEX = FILE_INDEX + +INDEX = XHTML_PREAMBLE + <<HTML +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>%title%</title> + <meta http-equiv="Content-Type" content="text/html; charset=%charset%"> +</head> + +<frameset cols="20%,*"> + <frameset rows="15%,35%,50%"> + <frame src="fr_file_index.html" title="Files" name="Files" /> + <frame src="fr_class_index.html" name="Classes" /> + <frame src="fr_method_index.html" name="Methods" /> + </frameset> +IF:inline_source + <frame src="%initial_page%" name="docwin"> +ENDIF:inline_source +IFNOT:inline_source + <frameset rows="80%,20%"> + <frame src="%initial_page%" name="docwin"> + <frame src="blank.html" name="source"> + </frameset> +ENDIF:inline_source + <noframes> + <body bgcolor="white"> + Click <a href="html/index.html">here</a> for a non-frames + version of this page. + </body> + </noframes> +</frameset> + +</html> +HTML + +end +end + Added: src/trunk/doc/classes/Package.html =================================================================== --- src/trunk/doc/classes/Package.html (rev 0) +++ src/trunk/doc/classes/Package.html 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,313 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> + <head> + <title>Class: Package</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> + <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> + + <script language="JavaScript" type="text/javascript"> + // <![CDATA[ + + function toggleSource( id ) + { + var elem + var link + + if( document.getElementById ) + { + elem = document.getElementById( id ) + link = document.getElementById( "l_" + id ) + } + else if ( document.all ) + { + elem = eval( "document.all." + id ) + link = eval( "document.all.l_" + id ) + } + else + return false; + + if( elem.style.display == "block" ) + { + elem.style.display = "none" + link.innerHTML = "show source" + } + else + { + elem.style.display = "block" + link.innerHTML = "hide source" + } + } + + function openCode( url ) + { + window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" ) + } + // ]]> + </script> + </head> + + <body> + <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr> + <td class="file-title"><span class="file-title-prefix">Class</span><br />Package</td> + <td align="right"> + <table cellspacing=0 cellpadding=2> + <tr valign="top"> + <td>In:</td> + <td> +<a href="../files/Package_rb.html">Package.rb</a> + </td> + </tr> + <tr> + <td>Parent:</td> + <td> +Object + </td> + </tr> + </table> + </td> + </tr> + </table> + <!-- banner header --> + + <div id="bodyContent"> + <div id="content"> + <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center"> + <map id="map" name="map"> + <area shape="RECT" coords="9,8,81,56" href="Package.html" alt="Package"> +</map> +<img src="../dot/f_0.png" usemap="#map" border=0 alt="TopLevel"> + </td></tr></table> + + <div class="description"><p> +Package.rb +</p> +<p> +<a href="Package.html">Package</a> class provides an interface to package +creation within AbTLinux. By inheriting from this class (class Fortune < +<a href="Package.html">Package</a>) one picks up all supported standard +functions for the abt package manager to make use of the new package. +</p> +<p> +Created by Eric D. Schabell <er...@ab...> Copyright 2006, GPL. +</p> +<p> +This file is part of AbTLinux. +</p> +<p> +AbTLinux is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2 of the License, or (at your option) +any later version. +</p> +<p> +AbTLinux is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. +</p> +<p> +You should have received a copy of the GNU General Public License along +with AbTLinux; if not, write to the Free Software Foundation, Inc., 51 +Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +</p> +</div> + + + + <div class="sectiontitle">Methods</div> + <ul> + <li><a href="#M000004">build</a></li> + <li><a href="#M000003">configure</a></li> + <li><a href="#M000001">details</a></li> + <li><a href="#M000006">install</a></li> + <li><a href="#M000007">post</a></li> + <li><a href="#M000002">pre</a></li> + <li><a href="#M000005">preinstall</a></li> + </ul> + + + + + + +<div class="sectiontitle">Public Instance methods</div> +<div class="method"> + <div class="title"> + <a name="M000004"></a><b>build</b>() + </div> + <div class="description"> + <p> +Here is where the actual builing of the software starts, for example +running ‘make’. +</p> +<p> +RETURNS: boolean True if the completes sucessfully, otherwise false. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000004_source')" id="l_M000004_source">show source</a> ]</p> + <div id="M000004_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 67</span> +67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span> +68: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +<div class="method"> + <div class="title"> + <a name="M000003"></a><b>configure</b>() + </div> + <div class="description"> + <p> +Here we manage the ./configure step (or equivalent). We need to give +./configure (or autogen.sh, or whatever) the correct options so files are +to be placed later in the right directories, so doc files and man pages are +all in the same common location, etc. Don‘t forget too that +it’s here where we interact with the user in case there are optionnal +dependencies. +</p> +<p> +RETURNS: boolean True if the completes sucessfully, otherwise false. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000003_source')" id="l_M000003_source">show source</a> ]</p> + <div id="M000003_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 59</span> +59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span> +60: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +<div class="method"> + <div class="title"> + <a name="M000001"></a><b>details</b>() + </div> + <div class="description"> + <p> +Provides all the data needed for this package. +</p> +<p> +RETURNS: array containing the package details. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000001_source')" id="l_M000001_source">show source</a> ]</p> + <div id="M000001_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 38</span> +38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">details</span> +39: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +<div class="method"> + <div class="title"> + <a name="M000006"></a><b>install</b>() + </div> + <div class="description"> + <p> +All files to be installed are installed here. +</p> +<p> +RETURNS: boolean True if the completes sucessfully, otherwise false. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000006_source')" id="l_M000006_source">show source</a> ]</p> + <div id="M000006_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 84</span> +84: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">install</span> +85: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +<div class="method"> + <div class="title"> + <a name="M000007"></a><b>post</b>() + </div> + <div class="description"> + <p> +Last bits of installation. adding the service for automatic start in init.d +for example. +</p> +<p> +RETURNS: boolean True if the completes sucessfully, otherwise false. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000007_source')" id="l_M000007_source">show source</a> ]</p> + <div id="M000007_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 92</span> +92: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">post</span> +93: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +<div class="method"> + <div class="title"> + <a name="M000002"></a><b>pre</b>() + </div> + <div class="description"> + <p> +PREliminary work will happen here such as downloading the tarball, +unpacking it, downloading and applying patches. +</p> +<p> +RETURNS: boolean True if completes sucessfully, otherwise false. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000002_source')" id="l_M000002_source">show source</a> ]</p> + <div id="M000002_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 47</span> +47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pre</span> +48: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +<div class="method"> + <div class="title"> + <a name="M000005"></a><b>preinstall</b>() + </div> + <div class="description"> + <p> +Any actions needed before the installation can occur will happen here, such +as creating new user accounts, dealing with existing configuration files, +etc. +</p> +<p> +RETURNS: boolean True if the completes sucessfully, otherwise false. +</p> + </div> +<div class="sourcecode"> + <p class="source-link">[ <a href="javascript:toggleSource('M000005_source')" id="l_M000005_source">show source</a> ]</p> + <div id="M000005_source" class="dyn-source"> +<pre> + <span class="ruby-comment cmt"># File Package.rb, line 76</span> +76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">preinstall</span> +77: <span class="ruby-keyword kw">end</span> +</pre> + </div> +</div> +</div> +</div> + + </div> + + </body> +</html> \ No newline at end of file Added: src/trunk/doc/created.rid =================================================================== --- src/trunk/doc/created.rid (rev 0) +++ src/trunk/doc/created.rid 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1 @@ +Mon May 15 19:45:11 CEST 2006 Added: src/trunk/doc/dot/f_0.dot =================================================================== --- src/trunk/doc/dot/f_0.dot (rev 0) +++ src/trunk/doc/dot/f_0.dot 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,23 @@ +digraph TopLevel { + compound = true + bgcolor = lightcyan1 + fontname = Arial + fontsize = 8 + label = "Package.rb" + node [ + fontname = Arial, + fontsize = 8, + color = black + ] + + Package [ + fontcolor = black, + URL = "classes/Package.html", + shape = ellipse, + color = palegoldenrod, + style = filled, + label = "Package" + ] + +} + Added: src/trunk/doc/dot/f_0.png =================================================================== (Binary files differ) Property changes on: src/trunk/doc/dot/f_0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: src/trunk/doc/files/Package_rb.html =================================================================== --- src/trunk/doc/files/Package_rb.html (rev 0) +++ src/trunk/doc/files/Package_rb.html 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> + <head> + <title>File: Package.rb</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> + <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> + + <script language="JavaScript" type="text/javascript"> + // <![CDATA[ + + function toggleSource( id ) + { + var elem + var link + + if( document.getElementById ) + { + elem = document.getElementById( id ) + link = document.getElementById( "l_" + id ) + } + else if ( document.all ) + { + elem = eval( "document.all." + id ) + link = eval( "document.all.l_" + id ) + } + else + return false; + + if( elem.style.display == "block" ) + { + elem.style.display = "none" + link.innerHTML = "show source" + } + else + { + elem.style.display = "block" + link.innerHTML = "hide source" + } + } + + function openCode( url ) + { + window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" ) + } + // ]]> + </script> + </head> + + <body> + <table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'> + <tr><td> + <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr> + <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />Package.rb</td> + <td align="right"> + <table border='0' cellspacing="0" cellpadding="2"> + <tr> + <td>Path:</td> + <td>Package.rb + </td> + </tr> + <tr> + <td>Modified:</td> + <td>Mon May 15 19:41:08 CEST 2006</td> + </tr> + </table> + </td></tr> + </table> + </td></tr> +</table><br> + <!-- banner header --> + + <div id="bodyContent"> + <div id="content"> + <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center"> + <map id="map" name="map"> + <area shape="RECT" coords="9,8,81,56" href="../classes/Package.html" alt="Package"> +</map> +<img src="../dot/f_0.png" usemap="#map" border=0 alt="TopLevel"> + </td></tr></table> + + <div class="description"><p> +Package.rb +</p> +<p> +<a href="../classes/Package.html">Package</a> class provides an interface +to package creation within AbTLinux. By inheriting from this class (class +Fortune < <a href="../classes/Package.html">Package</a>) one picks up +all supported standard functions for the abt package manager to make use of +the new package. +</p> +<p> +Created by Eric D. Schabell <er...@ab...> Copyright 2006, GPL. +</p> +<p> +This file is part of AbTLinux. +</p> +<p> +AbTLinux is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2 of the License, or (at your option) +any later version. +</p> +<p> +AbTLinux is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. +</p> +<p> +You should have received a copy of the GNU General Public License along +with AbTLinux; if not, write to the Free Software Foundation, Inc., 51 +Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +</p> +</div> + + + + + + + + + +</div> + + </div> + + </body> +</html> \ No newline at end of file Added: src/trunk/doc/fr_class_index.html =================================================================== --- src/trunk/doc/fr_class_index.html (rev 0) +++ src/trunk/doc/fr_class_index.html 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<style> +<!-- + body { + background-color: #EEE; + font-family: "Bitstream Vera Sans", Verdana, Arial, Helvetica, sans-serif; + color: #000; + margin: 0px; + } + .banner { + background: #005; + color: #FFF; + padding: 0.2em; + font-size: small; + font-weight: bold; + text-align: center; + } + .entries { + margin: 0.25em 1em 0 1em; + font-size: x-small; + } + a { + color: #00F; + text-decoration: none; + white-space: nowrap; + } + a:hover { + color: #77F; + text-decoration: underline; + } +--> +</style> +<base target="docwin"> +</head> +<body> +<div class="banner">Classes</div> +<div class="entries"> +<a href="classes/Package.html">Package</a><br> +</div> +</body></html> \ No newline at end of file Added: src/trunk/doc/fr_file_index.html =================================================================== --- src/trunk/doc/fr_file_index.html (rev 0) +++ src/trunk/doc/fr_file_index.html 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<style> +<!-- + body { + background-color: #EEE; + font-family: "Bitstream Vera Sans", Verdana, Arial, Helvetica, sans-serif; + color: #000; + margin: 0px; + } + .banner { + background: #005; + color: #FFF; + padding: 0.2em; + font-size: small; + font-weight: bold; + text-align: center; + } + .entries { + margin: 0.25em 1em 0 1em; + font-size: x-small; + } + a { + color: #00F; + text-decoration: none; + white-space: nowrap; + } + a:hover { + color: #77F; + text-decoration: underline; + } +--> +</style> +<base target="docwin"> +</head> +<body> +<div class="banner">Files</div> +<div class="entries"> +<a href="files/Package_rb.html">Package.rb</a><br> +</div> +</body></html> \ No newline at end of file Added: src/trunk/doc/fr_method_index.html =================================================================== --- src/trunk/doc/fr_method_index.html (rev 0) +++ src/trunk/doc/fr_method_index.html 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<style> +<!-- + body { + background-color: #EEE; + font-family: "Bitstream Vera Sans", Verdana, Arial, Helvetica, sans-serif; + color: #000; + margin: 0px; + } + .banner { + background: #005; + color: #FFF; + padding: 0.2em; + font-size: small; + font-weight: bold; + text-align: center; + } + .entries { + margin: 0.25em 1em 0 1em; + font-size: x-small; + } + a { + color: #00F; + text-decoration: none; + white-space: nowrap; + } + a:hover { + color: #77F; + text-decoration: underline; + } +--> +</style> +<base target="docwin"> +</head> +<body> +<div class="banner">Methods</div> +<div class="entries"> +<a href="classes/Package.html#M000004">build (Package)</a><br> +<a href="classes/Package.html#M000003">configure (Package)</a><br> +<a href="classes/Package.html#M000001">details (Package)</a><br> +<a href="classes/Package.html#M000006">install (Package)</a><br> +<a href="classes/Package.html#M000007">post (Package)</a><br> +<a href="classes/Package.html#M000002">pre (Package)</a><br> +<a href="classes/Package.html#M000005">preinstall (Package)</a><br> +</div> +</body></html> \ No newline at end of file Added: src/trunk/doc/index.html =================================================================== --- src/trunk/doc/index.html (rev 0) +++ src/trunk/doc/index.html 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!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" xml:lang="en" lang="en"> +<head> + <title>AbTLinux Package Manager API</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</head> + +<frameset cols="20%,*"> + <frameset rows="15%,35%,50%"> + <frame src="fr_file_index.html" title="Files" name="Files" /> + <frame src="fr_class_index.html" name="Classes" /> + <frame src="fr_method_index.html" name="Methods" /> + </frameset> + <frame src="files/Package_rb.html" name="docwin"> + <noframes> + <body bgcolor="white"> + Click <a href="html/index.html">here</a> for a non-frames + version of this page. + </body> + </noframes> +</frameset> + +</html> \ No newline at end of file Added: src/trunk/doc/rdoc-style.css =================================================================== --- src/trunk/doc/rdoc-style.css (rev 0) +++ src/trunk/doc/rdoc-style.css 2006-05-15 17:50:40 UTC (rev 87) @@ -0,0 +1,175 @@ +a { + color: #00F; + text-decoration: none; +} + +a:hover { + color: #77F; + text-decoration: underline; +} + +body, td, p { + font-family: "Bitstream Vera Sans", Verdana, Arial, Helvetica, sans-serif; + background: #FFF; + color: #000; + margin: 0px; + font-size: small; +} + +#content { + margin: 2em; +} + +#description p { + margin-bottom: 0.5em; +} + +.sectiontitle { + margin-top: 1em; + margin-bottom: 1em; + padding: 0.5em; + padding-left: 2em; + background: #005; + color: #FFF; + font-weight: bold; + border: 1px dotted black; +} + +.attr-rw { + padding-left: 1em; + padding-right: 1em; + text-align: center; + color: #055; +} + +.attr-name { + font-weight: bold; +} + +.attr-desc { +} + +.attr-value { + font-family: monospace; +} + +.file-title-prefix { + font-size: large; +} + +.file-title { + font-size: large; + font-weight: bold; + background: #005; + color: #FFF; +} + +.banner { + background: #005; + color: #FFF; + border: 1px solid black; + padding: 1em; +} + +.banner td { + background: transparent; + color: #FFF; +} + +h1 a, h2 a, .sectiontitle a, .banner a { + color: #FF0; +} + +h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover { + color: #FF7; +} + +.dyn-source { + display: none; + background: #FFE; + color: #000; + border: 1px dotted black; + margin: 0.5em 2em 0.5em 2em; + padding: 0.5em; +} + +.dyn-source .cmt { + color: #00F; + font-style: italic; +} + +.dyn-source .kw { + color: #070; + font-weight: bold; +} + +.method { + margin-left: 1em; + margin-right: 1em; + margin-bottom: 1em; +} + +.description pre { + padding: 0.5em; + border: 1px dotted black; + background: #FFE; +} + +.method .title { + font-family: monospace; + font-size: large; + border-bottom: 1px dashed black; + margin-bottom: 0.3em; + padding-bottom: 0.1em; +} + +.method .description, .method .sourcecode { + margin-left: 1em; +} + +.description p, .sourcecode p { + margin-bottom: 0.5em; +} + +.method .sourcecode p.source-link { + text-indent: 0em; + margin-top: 0.5em; +} + +.method .aka { + margin-top: 0.3em; + margin-left: 1em; + font-style: italic; + text-indent: 2em; +} + +h1 { + padding: 1em; + border: 1px solid black; + font-size: x-large; + font-weight: bold; + color: #FFF; + background: #007; +} + +h2 { + padding: 0.5em 1em 0.5em 1em; + border: 1px solid black; + font-size: large; + font-weight: bold; + color: #FFF; + background: #009; +} + +h3, h4, h5, h6 { + padding: 0.2em 1em 0.2em 1em; + border: 1px dashed black; + color: #000; + background: #AAF; +} + +.sourcecode > pre { + padding: 0.5em; + border: 1px dotted black; + background: #FFE; +} \ No newline at end of file Modified: src/trunk/docGen.sh =================================================================== --- src/trunk/docGen.sh 2006-05-14 12:52:54 UTC (rev 86) +++ src/trunk/docGen.sh 2006-05-15 17:50:40 UTC (rev 87) @@ -16,12 +16,18 @@ #=============================================================================== FILES=Package.rb +TEMPLATE=./abtTemplate.rb # clean out existing docs directory. rm -rf ./doc # run the actual doc generation. -rdoc --diagram --inline-source --line-numbers --title "AbTLinux Package Manager API" $FILES +rdoc --diagram \ + --template $TEMPLATE \ + --inline-source \ + --line-numbers \ + --title "AbTLinux Package Manager API" \ + $FILES # remove old tarball and refresh with new docs. #rm ./doc.tar.bz2 This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
