Module: RDoc::Page

Defined in:: lib/vendor/escape/doc_include/template/qualitysmith.rb

Constant Summary collapse

FONTS =

"\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif"

STYLE =

"a {\n  color: #00F;\n  text-decoration: none;\n}\n\na:hover {\n  color: #77F;\n  text-decoration: underline;\n}\n\nbody, td, p {\n  font-family: %fonts%;\n  background: #FFF;\n  color: #000;\n  margin: 0px;\n  font-size: small;\n}\n\n#content {\n  margin: 2em;\n}\n\n#description p {\n  margin-bottom: 0.5em;\n}\n\n.sectiontitle {\n  margin-top: 1em;\n  margin-bottom: 1em;\n  padding: 0.5em;\n  padding-left: 2em;\n  background: #005;\n  color: #FFF;\n  font-weight: bold;\n  border: 1px dotted black;\n}\n\n.attr-rw {\n  padding-left: 1em;\n  padding-right: 1em;\n  text-align: center;\n  color: #055;\n}\n\n.attr-name {\n  font-weight: bold;\n}\n\n.attr-desc {\n}\n\n.attr-value {\n  font-family: monospace;\n}\n\n.file-title-prefix {\n  font-size: large;\n}\n\n.file-title {\n  font-size: large;\n  font-weight: bold;\n  background: #005;\n  color: #FFF;\n}\n\n.banner {\n  background: #005;\n  color: #FFF;\n  border: 1px solid black;\n  padding: 1em;\n}\n\n.banner td {\n  background: transparent;\n  color: #FFF;\n}\n\nh1 a, h2 a, .sectiontitle a, .banner a {\n  color: #FF0;\n}\n\nh1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {\n  color: #FF7;\n}\n\n.dyn-source {\n  display: none;\n  background: #FFE;\n  color: #000;\n  border: 1px dotted black;\n  margin: 0.5em 2em 0.5em 2em;\n  padding: 0.5em;\n}\n\n.dyn-source .cmt {\n  color: #00F;\n  font-style: italic;\n}\n\n.dyn-source .kw {\n  color: #070;\n  font-weight: bold;\n}\n\n.method {\n  margin-left: 1em;\n  margin-right: 1em;\n  margin-bottom: 1em;\n}\n\n.description pre {\n  padding: 0.5em;\n  border: 1px dotted black;\n  background: #FFE;\n}\n\n.method .title {\n  font-family: monospace;\n  font-size: large;\n  border-bottom: 1px dashed black;\n  margin-bottom: 0.3em;\n  padding-bottom: 0.1em;\n}\n\n.method .description, .method .sourcecode {\n  margin-left: 1em;\n}\n\n.description p, .sourcecode p {\n  margin-bottom: 0.5em;\n}\n\n.method .sourcecode p.source-link {\n  text-indent: 0em;\n  margin-top: 0.5em;\n}\n\n.method .aka {\n  margin-top: 0.3em;\n  margin-left: 1em;\n  font-style: italic;\n  text-indent: 2em;\n}\n\nh1 {\n  padding: 1em;\n  border: 1px solid black;\n  font-size: x-large;\n  font-weight: bold;\n  color: #FFF;\n  background: #007;\n}\n\nh2 {\n  padding: 0.5em 1em 0.5em 1em;\n  border: 1px solid black;\n  font-size: large;\n  font-weight: bold;\n  color: #FFF;\n  background: #009;\n}\n\nh3, h4, h5, h6 {\n  padding: 0.2em 1em 0.2em 1em;\n  border: 1px dashed black;\n  color: #000;\n  background: #AAF;\n}\n\n.sourcecode > pre {\n  padding: 0.5em;\n  border: 1px dotted black;\n  background: #FFE;\n}\n\n"

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 + "<html>\n  <head>\n    <title>%title%</title>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=%charset%\" />\n    <link rel=\"stylesheet\" href=\"%style_url%\" type=\"text/css\" media=\"screen\" />\n\n    <script language=\"JavaScript\" type=\"text/javascript\">\n    // <![CDATA[\n\n        function toggleSource( id )\n        {\n          var elem\n          var link\n\n          if( document.getElementById )\n          {\n            elem = document.getElementById( id )\n            link = document.getElementById( \"l_\" + id )\n          }\n          else if ( document.all )\n          {\n            elem = eval( \"document.all.\" + id )\n            link = eval( \"document.all.l_\" + id )\n          }\n          else\n            return false;\n\n          if( elem.style.display == \"block\" )\n          {\n            elem.style.display = \"none\"\n            link.innerHTML = \"show source\"\n          }\n          else\n          {\n            elem.style.display = \"block\"\n            link.innerHTML = \"hide source\"\n          }\n        }\n\n        function openCode( url )\n        {\n          window.open( url, \"SOURCE_CODE\", \"width=400,height=400,scrollbars=yes\" )\n        }\n      // ]]>\n    </script>\n  </head>\n\n  <body>\n"

FILE_PAGE =

"<table border='0' cellpadding='0' cellspacing='0' width=\"100%\" class='banner'>\n  <tr><td>\n    <table width=\"100%\" border='0' cellpadding='0' cellspacing='0'><tr>\n      <td class=\"file-title\" colspan=\"2\"><span class=\"file-title-prefix\">File</span><br />%short_name%</td>\n      <td align=\"right\">\n        <table border='0' cellspacing=\"0\" cellpadding=\"2\">\n          <tr>\n            <td>Path:</td>\n            <td>%full_path%\nIF:cvsurl\n        &nbsp;(<a href=\"%cvsurl%\">CVS</a>)\nENDIF:cvsurl\n            </td>\n          </tr>\n          <tr>\n            <td>Modified:</td>\n            <td>%dtm_modified%</td>\n          </tr>\n        </table>\n      </td></tr>\n    </table>\n  </td></tr>\n</table><br>\n"

CLASS_PAGE =

"<table width=\"100%\" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>\n  <td class=\"file-title\"><span class=\"file-title-prefix\">%classmod%</span><br />%full_name%</td>\n  <td align=\"right\">\n    <table cellspacing=0 cellpadding=2>\n      <tr valign=\"top\">\n        <td>In:</td>\n        <td>\nSTART:infiles\nHREF:full_path_url:full_path:\nIF:cvsurl\n&nbsp;(<a href=\"%cvsurl%\">CVS</a>)\nENDIF:cvsurl\nEND:infiles\n        </td>\n      </tr>\nIF:parent\n    <tr>\n      <td>Parent:</td>\n      <td>\nIF:par_url\n        <a href=\"%par_url%\">\nENDIF:par_url\n%parent%\nIF:par_url\n         </a>\nENDIF:par_url\n     </td>\n   </tr>\nENDIF:parent\n         </table>\n        </td>\n        </tr>\n      </table>\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>HREF:aref:name:</li>\nEND:requires\n  </ul>\nENDIF:requires\n\nIF:toc\n  <div class=\"sectiontitle\">Contents</div>\n  <ul>\nSTART:toc\n  <li><a href=\"#%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>HREF:aref:name:</li>\nEND:methods\n  </ul>\nENDIF:methods\n\nIF:includes\n<div class=\"sectiontitle\">Included Modules</div>\n<ul>\nSTART:includes\n  <li>HREF:aref:name:</li>\nEND:includes\n</ul>\nENDIF:includes\n\nSTART:sections\nIF:sectitle\n<div class=\"sectiontitle\"><a name=\"%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 class=\"method\">\n  <div class=\"title\">\nIF:callseq\n    <a name=\"%aref%\"></a><b>%callseq%</b>\nENDIF:callseq\nIFNOT:callseq\n    <a name=\"%aref%\"></a><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=\"%aref%\">%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"

FOOTER =

"  </body>\n</html>\n"

BODY =

HEADER + "  !INCLUDE! <!-- banner header -->\n\n  <div id=\"bodyContent\">\n    \#{METHOD_LIST}\n  </div>\n\n  \#{FOOTER}\n"

SRC_PAGE = Source code ##########################

XHTML_PREAMBLE + "<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"

FR_INDEX_BODY = Index ################################

"!INCLUDE!\n"

FILE_INDEX =

XHTML_PREAMBLE + "<html>\n<head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=%charset%\">\n<style>\n<!--\n  body {\n    background-color: #EEE;\n    font-family: \#{FONTS}; \n    color: #000;\n    margin: 0px;\n  }\n  .banner {\n    background: #005;\n    color: #FFF;\n    padding: 0.2em;\n    font-size: small;\n    font-weight: bold;\n    text-align: center;\n  }\n  .entries {\n    margin: 0.25em 1em 0 1em;\n    font-size: x-small;\n  }\n  a {\n    display: block;\n    color: #00F;\n    text-decoration: none;\n    white-space: nowrap;\n  }\n  a:hover {\n    color: #77F;\n    text-decoration: underline;\n  }\n  input#link_search {\n    color: #a00;\n  }\n  input#link_search.default {\n    color: #888;\n  }\n-->\n</style>\n<script type=\"text/javascript\" language=\"javascript\">\nfunction init_frame_select() {\n  var opts = document.getElementById('frame_select').options;\n  for (i = 0; i < opts.length; i++) {\n    opts[i].selected = (location.href.indexOf(opts[i].value) != -1);\n  }\n}\nfunction do_link_search() {\n  var search_box = document.getElementById('link_search');\n  if (search_box.value == search_box.defaultValue) return;\n  var links = document.getElementById('entries').getElementsByTagName('a');\n  search = new RegExp(search_box.value, 'i');\n  for (i = 0; i < links.length; i++) {\n    links[i].style.display = search.exec(links[i].innerHTML) ? 'block' : 'none';\n  }\n}\nfunction clear_link_search() {\n  var search_box = document.getElementById('link_search');\n  if (search_box.value == search_box.defaultValue) search_box.value = '';\n  search_box.className = '';\n}\nfunction reset_link_search() {\n  var search_box = document.getElementById('link_search');\n  if (search_box.value == '') search_box.value = search_box.defaultValue;\n  search_box.className = 'default';\n}\n</script>\n<base target=\"docwin\">\n</head>\n<body onload=\"init_frame_select(); reset_link_search();\">\n<select id=\"frame_select\" onchange=\"location.href=this.value\" style=\"width: 100%;\">\n  <option value=\"fr_class_index.html\">Classes</option>\n  <option value=\"fr_file_index.html\">Files</option>\n  <option value=\"fr_method_index.html\">Methods</option>\n</select>\n<input id=\"link_search\" class=\"default\" type=\"text\" onkeyup=\"do_link_search()\" onfocus=\"clear_link_search()\" onblur=\"reset_link_search()\" style=\"width: 100%;\" value=\"type search here...\" />\n<div class=\"banner\">%list_title%</div>\n<div class=\"entries\" id=\"entries\">\nSTART:entries\n<a href=\"%href%\">%name%</a>\nEND:entries\n</div>\n</body></html>\n"

CLASS_INDEX =

FILE_INDEX

METHOD_INDEX =

FILE_INDEX

INDEX =

XHTML_PREAMBLE + "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n<head>\n  <title>%title%</title>\n  <meta http-equiv=\"Content-Type\" content=\"text/html; charset=%charset%\">\n</head>\n\n<frameset cols=\"200, *\">\n    <frame src=\"fr_class_index.html\"  name=\"framewin\" />\n    <frame src=\"%initial_page%\" name=\"docwin\" />\n</frameset>\n\n<frameset cols=\"200,*\">\n    <frame src=\"fr_class_index.html\" name=\"framewin\" />\nIF:inline_source\n    <frame  src=\"%initial_page%\" name=\"docwin\">\nENDIF:inline_source\nIFNOT:inline_source\n    <frameset rows=\"80%,20%\">\n      <frame  src=\"%initial_page%\" name=\"docwin\">\n      <frame  src=\"blank.html\" name=\"source\">\n    </frameset>\nENDIF:inline_source\n    <noframes>\n          <body bgcolor=\"white\">\n            Click <a href=\"html/index.html\">here</a> for a non-frames\n            version of this page.\n          </body>\n    </noframes>\n</frameset>\n\n</html>\n"