summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Wall <richard@aziz>2010-08-22 00:38:24 +0100
committerRichard Wall <richard@aziz>2010-08-22 00:38:24 +0100
commit5c1f11e97068c8df787a9eef987ec486431c7baf (patch)
treed555ced10646e3bb2e500eed7f0971715bcdbeb7
parent25dde2983b3f9f5733a41eb6b2adbb837d5d0bc0 (diff)
customise the yuidoc templates
Diffstat
-rw-r--r--build/yuidoc_template/assets/api.css14
-rw-r--r--build/yuidoc_template/assets/yui.pngbin7648 -> 0 bytes
-rw-r--r--build/yuidoc_template/main.tmpl126
3 files changed, 70 insertions, 70 deletions
diff --git a/build/yuidoc_template/assets/api.css b/build/yuidoc_template/assets/api.css
index 5468b2a..878a0b1 100644
--- a/build/yuidoc_template/assets/api.css
+++ b/build/yuidoc_template/assets/api.css
@@ -7,7 +7,7 @@ a:link { color: #003399; }
a:visited { color: #003399;}
#doc3 #hd { margin-bottom:1em; position: relative; zoom: 1; }
-#doc3 #hd h1 { color: #545454; font-size: 170%; padding: 0px 0 8px 150px; background: url(yui.png) 15px 9px no-repeat; height: 60px; font-weight: bold; }
+#doc3 #hd h1 { color: #545454; font-size: 170%; padding: 0; height: 60px; font-weight: bold; text-align: center;}
#doc3 #hd h1 a { position: relative; top: 14px; }
#doc3 #hd a { text-decoration: none; color: black; }
#doc3 #hd h3 {
@@ -81,7 +81,7 @@ a:visited { color: #003399;}
#doc3 .nav .module UL.content A { text-decoration: none; color: black; display: block; padding: 2px 4px 2px 4px; }
#doc3 .nav .module LI,
#doc3 .nav .module LI A {
- zoom: 1;
+ zoom: 1;
}
#doc3 .nav .module LI.selected A,
#doc3 .nav .module LI A:hover {
@@ -170,17 +170,17 @@ body.show_protected .protected {
}
#splash_classList ul {
- margin: 1em;
- margin-left:2em;
+ margin: 1em;
+ margin-left:2em;
}
#splash_classList ul li {
- list-style: disc outside;
+ list-style: disc outside;
}
/* source code view */
-#srcout {min-width: 580px; }
-*html #srcout { width: 100%; padding-bottom:1em; overflow-x:auto }
+#srcout {min-width: 580px; }
+*html #srcout { width: 100%; padding-bottom:1em; overflow-x:auto }
.highlight .c { color: #60a0b0; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
diff --git a/build/yuidoc_template/assets/yui.png b/build/yuidoc_template/assets/yui.png
deleted file mode 100644
index 65905e4..0000000
--- a/build/yuidoc_template/assets/yui.png
+++ /dev/null
Binary files differ
diff --git a/build/yuidoc_template/main.tmpl b/build/yuidoc_template/main.tmpl
index 7c7b50b..74de127 100644
--- a/build/yuidoc_template/main.tmpl
+++ b/build/yuidoc_template/main.tmpl
@@ -4,10 +4,10 @@
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>API: $modulename #if $classname# $classname #end if# #if $filename# $filename #end if# (YUI Library)</title>
+ <title>API: $modulename #if $classname# $classname #end if# #if $filename# $filename #end if#</title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=$timestamp" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=$timestamp" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=$timestamp" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=$timestamp" />
<script type="text/javascript" src="assets/api-js?stamp=$timestamp"></script>
<script type="text/javascript" src="assets/ac-js?stamp=$timestamp"></script>
@@ -16,10 +16,10 @@
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
- <div id="hd">
- <h1><a href="$projecturl" title="$projectname">$projectname</a></h1>
+ <div id="hd">
+ <h1><a href="$projecturl" title="$projectname">$projectname v$version API Documentation</a></h1>
<h3>$moduletitle&nbsp; <span class="subtitle">$version</span></h3>
- <a href="./index.html" title="$projectname">$projectname</a>
+ <a href="./index.html" title="$projectname">$projectname</a>
#if $modulename
&gt; <a href="./${cleansedmodulename}.html" title="$modulename">$modulename</a>
#if $classname# &gt; $classname #end if#
@@ -33,11 +33,11 @@
</div>
</div>
</form>
- </div>
+ </div>
- <div id="bd">
- <div id="yui-main">
- <div class="yui-b">
+ <div id="bd">
+ <div id="yui-main">
+ <div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
@@ -49,8 +49,8 @@
#if $index
<div class="summary description">
- This is the API documentation for the
- <a href="http://developer.yahoo.com/yui/">Yahoo! User Interface Library</a>.
+ This is the API documentation for
+ <a href="$projecturl">$projectname</a>.
<p>Choose a module name from the list for more information.</p>
</div>
@@ -63,7 +63,7 @@
</style>
#include raw $filepath_highlighted
</div>
- #else if $classname
+ #else if $classname
<h2>
#if $access#<code>$access</code>#end if#
@@ -78,19 +78,19 @@
#if $uses
<span class="extends" rel="yui:extends">
- - uses
+ - uses
#set $i=0
#for $provider in $uses##if $i > 0#, #end if#
<span rel="extend" resource="${provider}.html">
<a href="${provider}.html" property="yui:name" title="$provider">$provider</a>#set $i=$i+1#
</span>
#end for#
-
+
</span>
#end if
</h2>
<!-- class tree goes here -->
-
+
#if $subclasses
<dl class="subclasses" rel="yui:subclasses">
<dt>Known Subclasses:</dt>
@@ -103,11 +103,11 @@
</dd>
</dl>
#end if
-
+
#if $deprecated
<div class="deprecated"><strong>Deprecated:</strong> $deprecated</div>
#end if
-
+
#if $see
<div class="deprecated"><strong>See also:</strong> $see</div>
#end if
@@ -127,7 +127,7 @@
#if $constructor.params
#set $i=0
#set $current=""
-
+
#for $param in $constructor.params#
#if $current != $param.name
#if $i > 0#, #end if#
@@ -153,7 +153,7 @@
#end for
</dl>
#end if
-
+
#if $constructor.return
<dl>
<dt>Returns:</dt>
@@ -161,14 +161,14 @@
$constructor.return
</dd>
</dl>
- #end if
-
+ #end if
+
</div>
</div>
</div>
</div>
#end if
-
+
<div rel="yui:properties" resource="#properties">
#if $properties
<div class="section field details">
@@ -184,18 +184,18 @@
$property.description
</div>
</div>
-
-
+
+
#if $property.default
<div class="default" property="yui:defaultValue">
Default Value: $property.default
- </div>
+ </div>
#end if
#if $property.deprecated
<div class="deprecated" property="yui:deprecated">
<strong>Deprecated:</strong> $property.deprecated
- </div>
+ </div>
#end if
<hr />
@@ -259,7 +259,7 @@
#end if
)
</code>
-
+
<div class="description" property="yui:description">
$method.description
</div>
@@ -293,14 +293,14 @@
#if $method.chainable
<div class="chainable">
<strong>Chainable:</strong> This method is chainable.
- </div>
+ </div>
#end if
-
+
#if $method.deprecated
<div class="deprecated">
<strong>Deprecated</strong> $method.deprecated
- </div>
+ </div>
#end if
</div>
@@ -314,7 +314,7 @@
#end if
#if $inherited.methods
- <div rel="yui:inheritance">
+ <div rel="yui:inheritance">
#for $superclassname in $inherited.methods
<div class="section field inheritance" rel="yui:superclass" resource="${superclassname}.html">
<h4>Methods inherited from <a href="${superclassname}.html" property="yui:name" title="$superclassname">$superclassname</a>:</h4>
@@ -323,7 +323,7 @@
#set i=0
#set l=len($inherited.methods[$superclassname])-1
#for $method in $inherited.methods[$superclassname]
- <span rel="yui:method" resource="${superclassname}.html#method_$method.name">
+ <span rel="yui:method" resource="${superclassname}.html#method_$method.name">
<a class="$method.access#if $method.deprecated# deprecated#end if#" href="${superclassname}.html#method_$method.name" property="yui:name" title="$method.name">$method.name</a>#if $i<$l#<span class="$method.access#if $method.deprecated# deprecated#end if#">,</span>#end if#
</span>
#set i=i+1
@@ -368,7 +368,7 @@
)
</code>
-
+
<div class="description" property="yui:description">
$event.description
</div>
@@ -386,7 +386,7 @@
</code>
<span property="yui:description">$param.description</span>
</dd>
-
+
#end for
</dl>
#end if
@@ -394,18 +394,18 @@
#if $event.bubbles
<div class="bubbles">
<strong>Bubbles:</strong> This event bubbles to <a href="${event.bubbles}.html" title="$event.bubbles">$event.bubbles</a>.
- </div>
+ </div>
#end if
#if $event.preventable
<div class="preventable">
<strong>Preventable:</strong> This event is preventable by method: $event.preventable.
- </div>
+ </div>
#end if
#if $event.deprecated
<div class="deprecated">
<strong>Deprecated</strong> $event.deprecated
- </div>
+ </div>
#end if
</div>
@@ -419,7 +419,7 @@
#if $inherited.events
- <div rel="yui:inheritance">
+ <div rel="yui:inheritance">
#for $superclassname in $inherited.events
<div class="section field inheritance" rel="yui:superclass" resource="${superclassname}.html">
<h4>Events inherited from <a href="${superclassname}.html" property="yui:name" title="$superclassname">$superclassname</a>:</h4>
@@ -456,21 +456,21 @@
$config.description
</div>
</div>
-
+
#if $config.deprecated
<div class="deprecated">
<strong>Deprecated</strong> $config.deprecated
- </div>
+ </div>
#end if
-
+
#if $config.default
<div class="default">
Default Value: $config.default
- </div>
+ </div>
#end if
<hr />
- </div>
+ </div>
#end for
</div>
@@ -478,7 +478,7 @@
#end if
#if $inherited.configs
- <div rel="yui:inheritance">
+ <div rel="yui:inheritance">
#for $superclassname in $inherited.configs
<div class="section field inheritance" rel="yui:superclass" resource="${superclassname}.html">
<h4>Configuration attributes inherited from <a href="${superclassname}.html" property="yui:name" title="$superclassname">$superclassname</a>:</h4>
@@ -488,7 +488,7 @@
#set l=len($inherited.methods[$superclassname])-1
#for $config in $inherited.configs[$superclassname]
#set i=i+1
- <span rel="yui:attribute" resource="${superclassname}.html#config_$config.name">
+ <span rel="yui:attribute" resource="${superclassname}.html#config_$config.name">
<a class="$config.access#if $config.deprecated# deprecated#end if#" href="${superclassname}.html#config_$config.name" property="yui:name" title="$config.name">$config.name</a>#if $i<$l#<span class="$config.access#if $config.deprecated# deprecated#end if#">,</span>#end if#
</span>
#set i=i+1
@@ -502,9 +502,9 @@
</div>
#else if $modulename
-
+
<h3>Module: $modulename
-
+
#if $beta
<span class="description"><em>Beta</em></span>
#end if
@@ -554,9 +554,9 @@
#for $info in $submodules
#set count = count + 1
#end for
- #if count != 0
+ #if count != 0
<div class="submodules">
- <h4>Submodules:</h4>
+ <h4>Submodules:</h4>
<dl>
#for $info in $submodules
<dt><code><a href="${$subdata[$info].name}.html" title="$info">$info</a></code></dt>
@@ -570,9 +570,9 @@
</div>
#end if
- </div>
- </div>
- <div class="yui-b">
+ </div>
+ </div>
+ <div class="yui-b">
<div class="nav">
#if $modulenames
@@ -608,7 +608,7 @@
#if $filenames
<div id="fileList" class="module">
<h4>Files</h4>
- <ul class="content">
+ <ul class="content">
#for $filedef in $filenames
#set $css = ""
#if $filedef == $filename
@@ -623,7 +623,7 @@
#if $properties
<div id="propertyList" class="module">
<h4>Properties</h4>
- <ul class="content">
+ <ul class="content">
#for $prop in $properties
<li class="${prop.access}#if $prop.deprecated# deprecated#end if#"><a href="#property_${prop.name}" title="$prop.name">$prop.name</a></li>
#end for
@@ -634,7 +634,7 @@
#if $methods
<div id="methodsList" class="module">
<h4>Methods</h4>
- <ul class="content">
+ <ul class="content">
#for $method in $methods
<li class="${method.access}#if $method.deprecated# deprecated#end if#"><a href="#method_${method.name}" title="$method.name">$method.name</a></li>
#end for
@@ -645,7 +645,7 @@
#if $events
<div id="eventsList" class="module">
<h4>Events</h4>
- <ul class="content">
+ <ul class="content">
#for $event in $events
<li class="${event.access}#if $event.deprecated# deprecated#end if#"><a href="#event_${event.name}" title="$event.name">$event.name</a></li>
#end for
@@ -656,7 +656,7 @@
#if $configs
<div id="configList" class="module">
<h4>Configuration Attributes</h4>
- <ul class="content">
+ <ul class="content">
#for $config in $configs
<li class="${config.access}#if $config.deprecated# deprecated#end if#"><a href="#config_${config.name}" title="$config.name">$config.name</a></li>
#end for
@@ -665,12 +665,12 @@
#end if
</div>
- </div>
- </div>
- <div id="ft">
+ </div>
+ </div>
+ <div id="ft">
<hr />
- Copyright &copy; $year Yahoo! Inc. All rights reserved.
- </div>
+ Copyright &copy; $year Richard Wall. All rights reserved.
+ </div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = $allprops;
generated by cgit v1.1-4-g5e80 at 2024-05-17 09:41:53 +0000