summaryrefslogtreecommitdiff
path: root/jarmonbuild/yuidoc_template/main.tmpl
diff options
context:
space:
mode:
Diffstat (limited to 'jarmonbuild/yuidoc_template/main.tmpl')
-rw-r--r--jarmonbuild/yuidoc_template/main.tmpl160
1 files changed, 85 insertions, 75 deletions
diff --git a/jarmonbuild/yuidoc_template/main.tmpl b/jarmonbuild/yuidoc_template/main.tmpl
index d21fd0a..15dce3e 100644
--- a/jarmonbuild/yuidoc_template/main.tmpl
+++ b/jarmonbuild/yuidoc_template/main.tmpl
@@ -1,25 +1,24 @@
#encoding UTF-8
-#filter EncodeUnicode
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<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#</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" />
- <link rel="stylesheet" type="text/css" href="assets/api.css" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css#if $timestamp#?stamp=$timestamp#end if#" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css#if $timestamp#?stamp=$timestamp#end if#" />
- <script type="text/javascript" src="assets/api-js"></script>
- <script type="text/javascript" src="assets/ac-js"></script>
+ <script type="text/javascript" src="assets/api-js#if $timestamp#?stamp=$timestamp#end if#"></script>
+ <script type="text/javascript" src="assets/ac-js#if $timestamp#?stamp=$timestamp#end if#"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
- <div id="hd">
+ <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 +32,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>
@@ -61,9 +60,9 @@
<style>
#doc3 .classopts { display:none; }
</style>
- #include raw $filepath_highlighted
+ $highlightcontent
</div>
- #else if $classname
+ #else if $classname
<h2>
#if $access#<code>$access</code>#end if#
@@ -78,19 +77,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 +102,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 +126,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 +152,7 @@
#end for
</dl>
#end if
-
+
#if $constructor.return
<dl>
<dt>Returns:</dt>
@@ -161,14 +160,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 +183,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 +258,7 @@
#end if
)
</code>
-
+
<div class="description" property="yui:description">
$method.description
</div>
@@ -280,11 +279,13 @@
</dl>
#end if
- #if $method.return.type
+ #if $method.return.description
<dl>
<dt>Returns:
<code property="yui:return">
- $method.return.type
+ #if $method.return.type
+ $method.return.type
+ #end if
</code></dt>
<dd property="yui:returnInfo">$method.return.description</dd>
</dl>
@@ -293,14 +294,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 +315,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 +324,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 +369,7 @@
)
</code>
-
+
<div class="description" property="yui:description">
$event.description
</div>
@@ -386,7 +387,7 @@
</code>
<span property="yui:description">$param.description</span>
</dd>
-
+
#end for
</dl>
#end if
@@ -394,18 +395,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>
+ <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is $event.preventable.
+ </div>
#end if
#if $event.deprecated
<div class="deprecated">
<strong>Deprecated</strong> $event.deprecated
- </div>
+ </div>
#end if
</div>
@@ -419,7 +420,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 +457,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,17 +479,17 @@
#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>
<div class="content" rel="yui:attributes">
<code>
#set i=0
- #set l=len($inherited.methods[$superclassname])-1
+ #set l=len($inherited.configs[$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 +503,9 @@
</div>
#else if $modulename
-
+
<h3>Module: $modulename
-
+
#if $beta
<span class="description"><em>Beta</em></span>
#end if
@@ -554,12 +555,12 @@
#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>
+ <dt><code>$info</code></dt>
<dd>$subdata[$info].description</dd>
#end for
</dl>
@@ -570,9 +571,9 @@
</div>
#end if
- </div>
- </div>
- <div class="yui-b">
+ </div>
+ </div>
+ <div class="yui-b">
<div class="nav">
#if $modulenames
@@ -584,7 +585,8 @@
#if $moduledef == $modulename
#set $css = "selected"
#end if
- <li class="$css"><a href="module_${moduledef}.html" title="$moduledef">$moduledef</a></li>
+ #set $cleansedname = $cleansedmodulenames[$moduledef]
+ <li class="$css"><a href="${cleansedname}.html" title="$moduledef">$moduledef</a></li>
#end for
</ul>
</div>
@@ -608,7 +610,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 +625,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 +636,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 +647,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 +658,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,21 +667,29 @@
#end if
</div>
- </div>
- </div>
- <div id="ft">
+ </div>
+ </div>
+ <div id="ft">
<hr />
- Copyright &copy; $year Richard Wall. All rights reserved.
- </div>
+ Copyright &copy; $year $copyrighttag All rights reserved.
+ </div>
</div>
<script type="text/javascript">
- ALL_YUI_PROPS = $allprops;
+ #if $index
+ YAHOO.yuidoc.init();
+ #end if
+
+ var ALL_YUI_PROPS = $allprops;
</script>
#if $ydn
-<!--MyBlogLog instrumentation-->
-<script type="text/javascript"
-src="http://track2.mybloglog.com/js/jsserv.php?mblID=2007020704011645"></script>
+<!-- Yahoo! Web Analytics - All rights reserved -->
+<script type="text/javascript" src="http://d.yimg.com/mi/ywa.js"></script>
+<script type="text/javascript">
+YWA.getTracker("10001393677061").submit();
+</script>
+<noscript>
+<div><img src="http://a.analytics.yahoo.com/p.pl?a=10001393677061&amp;js=no" width="1" height="1" alt="" /></div>
+</noscript>
#end if
</body>
</html>
-#end filter