Module: RDoc::Page

Defined in:
lib/generators/templates/application/merb_core/doc/rdoc/generators/template/merb/merb.rb,
lib/generators/templates/application/merb_stack/doc/rdoc/generators/template/merb/merb.rb

Constant Summary collapse

STYLE =
File.read(File.join(File.dirname(__FILE__), 'merb_doc_styles.css'))
FONTS =
""
CLASS_PAGE =
"<div id=\"%class_seq%\">\n<div class='banner'>\n  <span class=\"file-title-prefix\">%classmod%</span><br />%full_name%<br/>\n  In:\nSTART:infiles\n<a href=\"#\" onclick=\"jsHref('%full_path_url%');\">%full_path%</a>\nIF:cvsurl\n&nbsp;(<a href=\"#\" onclick=\"jsHref('%cvsurl%');\">CVS</a>)\nENDIF:cvsurl\nEND:infiles\n\nIF:parent\nParent:&nbsp;\nIF:par_url\n        <a href=\"#\" onclick=\"jsHref('%par_url%');\">\nENDIF:par_url\n%parent%\nIF:par_url\n         </a>\nENDIF:par_url\nENDIF:parent\n</div>\n"
METHOD_LIST =
"  <div id=\"content\">\nIF:diagram\n  <table cellpadding='0' cellspacing='0' border='0' width=\"100%\"><tr><td align=\"center\">\n    %diagram%\n  </td></tr></table>\nENDIF:diagram\n\nIF:description\n  <div class=\"description\">%description%</div>\nENDIF:description\n\nIF:requires\n  <div class=\"sectiontitle\">Required Files</div>\n  <ul>\nSTART:requires\n  <li><a href=\"#\" onclick=\"jsHref('%href%');\">%name%</a></li>\nEND:requires\n  </ul>\nENDIF:requires\n\nIF:toc\n  <div class=\"sectiontitle\">Contents</div>\n  <ul>\nSTART:toc\n  <li><a href=\"#\" onclick=\"jsHref('%href%');\">%secname%</a></li>\nEND:toc\n  </ul>\nENDIF:toc\n\nIF:methods\n  <div class=\"sectiontitle\">Methods</div>\n  <ul>\nSTART:methods\n  <li><a href=\"index.html?a=%href%&name=%name%\" >%name%</a></li>\nEND:methods\n  </ul>\nENDIF:methods\n\nIF:includes\n<div class=\"sectiontitle\">Included Modules</div>\n<ul>\nSTART:includes\n  <li><a href=\"#\" onclick=\"jsHref('%href%');\">%name%</a></li>\nEND:includes\n</ul>\nENDIF:includes\n\nSTART:sections\nIF:sectitle\n<div class=\"sectiontitle\"><a href=\"%secsequence%\">%sectitle%</a></div>\nIF:seccomment\n<div class=\"description\">\n%seccomment%\n</div>\nENDIF:seccomment\nENDIF:sectitle\n\nIF:classlist\n  <div class=\"sectiontitle\">Classes and Modules</div>\n  %classlist%\nENDIF:classlist\n\nIF:constants\n  <div class=\"sectiontitle\">Constants</div>\n  <table border='0' cellpadding='5'>\nSTART:constants\n  <tr valign='top'>\n    <td class=\"attr-name\">%name%</td>\n    <td>=</td>\n    <td class=\"attr-value\">%value%</td>\n  </tr>\nIF:desc\n  <tr valign='top'>\n    <td>&nbsp;</td>\n    <td colspan=\"2\" class=\"attr-desc\">%desc%</td>\n  </tr>\nENDIF:desc\nEND:constants\n  </table>\nENDIF:constants\n\nIF:attributes\n  <div class=\"sectiontitle\">Attributes</div>\n  <table border='0' cellpadding='5'>\nSTART:attributes\n  <tr valign='top'>\n    <td class='attr-rw'>\nIF:rw\n[%rw%]\nENDIF:rw\n    </td>\n    <td class='attr-name'>%name%</td>\n    <td class='attr-desc'>%a_desc%</td>\n  </tr>\nEND:attributes\n  </table>\nENDIF:attributes\n\nIF:method_list\nSTART:method_list\nIF:methods\n<div class=\"sectiontitle\">%type% %category% methods</div>\nSTART:methods\n<div id=\"%m_seq%\" class=\"method\">\n  <div id=\"%m_seq%_title\" class=\"title\">\nIF:callseq\n    <b>%callseq%</b>\nENDIF:callseq\nIFNOT:callseq\n    <b>%name%</b>%params%\nENDIF:callseq\nIF:codeurl\n[ <a href=\"javascript:openCode('%codeurl%')\">source</a> ]\nENDIF:codeurl\n  </div>\nIF:m_desc\n  <div class=\"description\">\n  %m_desc%\n  </div>\nENDIF:m_desc\nIF:aka\n<div class=\"aka\">\n  This method is also aliased as\nSTART:aka\n  <a href=\"index.html?a=%aref%&name=%name%\">%name%</a>\nEND:aka\n</div>\nENDIF:aka\nIF:sourcecode\n<div class=\"sourcecode\">\n  <p class=\"source-link\">[ <a href=\"javascript:toggleSource('%aref%_source')\" id=\"l_%aref%_source\">show source</a> ]</p>\n  <div id=\"%aref%_source\" class=\"dyn-source\">\n<pre>\n%sourcecode%\n</pre>\n  </div>\n</div>\nENDIF:sourcecode\n</div>\nEND:methods\nENDIF:methods\nEND:method_list\nENDIF:method_list\nEND:sections\n</div>\n"
BODY =
"  !INCLUDE! <!-- banner header -->\n\n  <div id=\"bodyContent\" >\n    \#{METHOD_LIST}\n  </div>\n\n"
SRC_BODY =
"  !INCLUDE! <!-- banner header -->\n\n  <div id=\"bodyContent\" >\n    <h2>Source Code</h2>\n    <pre>%file_source_code%</pre>\n    </div>\n"
FILE_PAGE =

File Page ##########################

"<div id=\"fileHeader\">\n    <h1>%short_name%</h1>\n    <table class=\"header-table\">\n    <tr class=\"top-aligned-row\">\n      <td><strong>Path:</strong></td>\n      <td>%full_path%\nIF:cvsurl\n        &nbsp;(<a href=\"%cvsurl%\"><acronym title=\"Concurrent Versioning System\">CVS</acronym></a>)\nENDIF:cvsurl\n      </td>\n    </tr>\n    <tr class=\"top-aligned-row\">\n      <td><strong>Last Update:</strong></td>\n      <td>%dtm_modified%</td>\n    </tr>\n    </table>\n  </div>\n"
SRC_PAGE =

This is not used but kept for historical purposes Source code ########################## Separate page onlye

"<html>\n<head><title>%title%</title>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=%charset%\">\n<style>\n.ruby-comment    { color: green; font-style: italic }\n.ruby-constant   { color: #4433aa; font-weight: bold; }\n.ruby-identifier { color: #222222;  }\n.ruby-ivar       { color: #2233dd; }\n.ruby-keyword    { color: #3333FF; font-weight: bold }\n.ruby-node       { color: #777777; }\n.ruby-operator   { color: #111111;  }\n.ruby-regexp     { color: #662222; }\n.ruby-value      { color: #662222; font-style: italic }\n  .kw { color: #3333FF; font-weight: bold }\n  .cmt { color: green; font-style: italic }\n  .str { color: #662222; font-style: italic }\n  .re  { color: #662222; }\n</style>\n</head>\n<body bgcolor=\"white\">\n<pre>%code%</pre>\n</body>\n</html>\n"
SCR_CODE_BODY =

source page body ###################

"    <div id=\"source\">\n    %source_code%\n    </div>\n\n"
FR_INDEX_BODY =

Index ################################

"!INCLUDE!\n"
FILE_INDEX =
"<ul>\nSTART:entries\n<li><a id=\"%seq_id%_link\" href=\"index.html?a=%seq_id%&name=%name%\" onclick=\"loadIndexContent('%href%','%seq_id%','%name%', '%scope%');\">%name%</a><small>%scope%</small></li>\nEND:entries\n</ul>\n"
CLASS_INDEX =
FILE_INDEX
METHOD_INDEX =
FILE_INDEX
INDEX =
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n  \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n<head>\n  <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>\n    <meta name=\"description\" content=\"A nifty way to interact with the Merb API\" />\n  <meta name=\"author\" content=\"created by Brian Chamberlain. You can contact me using 'blchamberlain' on the gmail.\" />\n  <meta name=\"keywords\" content=\"merb, ruby, purple, monkey, dishwasher\" />\n  <title>Merb | %title% API Documentation</title>\n  <link rel=\"stylesheet\" href=\"http://merbivore.com/documentation/stylesheet.css\" type=\"text/css\" media=\"screen\" />    \n  <script type=\"text/javascript\" src=\"http://merbivore.com/documentation/prototype.js\" ></script>\n  <script type=\"text/javascript\" src=\"http://merbivore.com/documentation/api_grease.js\" ></script>\n</head>\n<body onload=\"setupPage();\">\n<ul id=\"groupType\">\n  <li>methods</li>\n  <li>classes</li>\n  <li>files</li>\n  <li id=\"loadingStatus\" style=\"display:none;\">  loading...</li>\n</ul> \n<div id=\"listFrame\">\n  <div id=\"listSearch\">\n    <form id=\"searchForm\" method=\"get\" action=\"#\" onsubmit=\"return false\">\n      <input type=\"text\" name=\"searchText\" id=\"searchTextField\" size=\"30\" autocomplete=\"off\" />\n     </form>\n  </div>\n  <div id=\"listScroller\">\n      Loading via ajax... this could take a sec.\n  </div> \n</div>\n<div id=\"browserBar\">\n  &nbsp;&nbsp;&nbsp;<span id=\"browserBarInfo\">%title% README</span>\n</div>\n<div id=\"rdocContent\">\n  %content%\n</div>\n<div id=\"floater\">\n<strong>Documentation for %title% </strong><a href=\"#\" onmouseover=\"$('tips').show();\" onmouseout=\"$('tips').hide();\">usage tips</a>\n<div id=\"tips\" style=\"position:absolute;width:350px;top:15px;right:20px;padding:5px;border:1px solid #333;background-color:#fafafa;display:none;\">\n  <p><strong>Some tips</strong> \n    <ul>\n      <li> Up/Down keys move through the search list</li>\n      <li> Return/enter key loads selected item</li>\n      <li> Want to use this RDOC template for your own project? Check out <br /> http://rubyforge.org/projects/jaxdoc</li>\n    </ul>\n  </p>\n</div>\n<div id=\"blowOutListBox\" style=\"display:none;\">&nbsp;</div>\n<script src=\"http://www.google-analytics.com/urchin.js\" type=\"text/javascript\">\n</script>\n<script type=\"text/javascript\">\n_uacct = \"UA-3085184-1\";\nurchinTracker();\n</script>\n</body>\n</html>\n"
API_GREASE_JS =
File.read(File.join(File.dirname(__FILE__), 'api_grease.js'))
PROTOTYPE_JS =
File.read(File.join(File.dirname(__FILE__), 'prototype.js'))