version 0.7.2

author: Andreas Rumpf <rumpf_a@web.de> 2008-12-12 14:02:27 +0100
committer: Andreas Rumpf <rumpf_a@web.de> 2008-12-12 14:02:27 +0100
commit: ddaedab835fa7ea3457f21a772d636921defdc46 (patch)
tree: 8f96b5a3a6700704e0a64bdcdedee1d2caf68517 /config/nimdoc.cfg
parent: 2cd136cf7a0210e3cfde7a6f8ba32c9f09560047 (diff)
download: Nim-ddaedab835fa7ea3457f21a772d636921defdc46.tar.gz
1 files changed, 293 insertions, 0 deletions
diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg
new file mode 100644
index 000000000..a2a638a89
--- /dev/null
+++ b/config/nimdoc.cfg
@@ -0,0 +1,293 @@
+# This is the config file for the documentation generator.
+# (c) 2008 Andreas Rumpf
+# Feel free to edit the templates as you need.
+
+split.item.toc = "20"  
+# too long entries in the table of contents get truncated
+# after this number of characters
+
+doc.section = """
+<div class="section" id="$sectionID">
+<h1><a class="toc-backref" href="#$sectionTitleID">$sectionTitle</a></h1>
+<dl class="item">
+$content
+</dl></div>
+"""
+
+doc.section.toc = """
+<li>
+  <a class="reference" href="#$sectionID" id="$sectionTitleID">$sectionTitle</a>
+  <ul class="simple">
+    $content
+  </ul>
+</li>
+"""
+
+doc.item = """
+<dt id="$itemID"><pre>$header</pre></dt>
+<dd>
+$desc
+</dd>
+"""
+
+doc.item.toc = """
+  <li><a class="reference" href="#$itemID">$name</a></li>
+"""
+
+doc.toc = """
+<div class="navigation">
+<p class="topic-title first">Navigation</p>
+<ul class="simple">
+$content
+</ul>
+</div>"""
+
+doc.body_toc = """
+$tableofcontents
+<div class="content">
+$moduledesc
+$content
+</div>
+"""
+
+doc.body_no_toc = """
+$moduledesc
+$content
+"""
+
+doc.file = """<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--  This file is generated by Nimrod. -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>$title</title>
+<style type="text/css">
+
+span.DecNumber {color: blue}
+span.BinNumber {color: blue}
+span.HexNumber {color: blue}
+span.OctNumber {color: blue}
+span.FloatNumber {color: blue}
+span.Identifier  {color: black}
+span.Keyword {font-weight: bold}
+span.StringLit {color: blue}
+span.LongStringLit {color: blue}
+span.CharLit {color: blue}
+span.EscapeSequence {color: black}
+span.Operator {color: black}
+span.Punctation {color: black}
+span.Comment, span.LongComment {font-style:italic; color: green}
+span.RegularExpression  {color: pink}
+span.TagStart {color: yellow}
+span.TagEnd {color: yellow}
+span.Key  {color: blue}
+span.Value  {color: black}
+span.RawData {color: blue}
+span.Assembler  {color: blue}
+span.Preprocessor {color: yellow}
+span.Directive  {color: yellow}
+span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference, 
+span.Other  {color: black}
+
+div.navigation {
+  float: left; 
+  width: 27%;  //25em;
+  margin: 0; padding: 0; /*
+  border: 1px dashed gold; */
+  outline: 3px outset #7F7F7F; //#99ff99; //gold;
+  background-color: #7F7F7F;
+}
+
+div.navigation ul {list-style-type: none;}
+div.navigation ul li a, div.navigation ul li a:visited {
+  font-weight: bold;
+  color: #FFFFFF; // #CC0000;
+  text-decoration: none;
+}
+div.navigation ul li a:hover {
+  font-weight: bold;
+  text-decoration: none;
+  /*outline: 2px outset #7F7F7F;*/
+  color: gold;
+  /* background-color: #FFFFFF; // #1A1A1A; // #779977;*/
+}
+
+div.content {
+  margin-left: 27%; // 25em;
+  padding: 0 1em; 
+  /*border: 1px dashed #1A1A1A;*/
+  min-width: 16em;
+}
+
+dl.item dd, dl.item dd p {
+  margin-top:3px;
+}
+dl.item dd pre {
+  margin-left: 15pt;
+  border: 0px;
+}
+dl.item dt, dl.item dt pre {
+  margin:  20pt 0 0 0;
+}
+
+pre, span.tok {
+  background-color:#F9F9F9;
+  border:1px dotted #2F6FAB;
+  color:black;
+}
+
+/*
+:Author: David Goodger
+:Contact: goodger@python.org
+:Date: Date: 2006-05-21 22:44:42 +0200 (Sun, 21 May 2006)
+:Revision: Revision: 4564
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th { border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first { margin-top: 0 ! important }
+.last, .with-subtitle { margin-bottom: 0 ! important }
+.hidden { display: none }
+a.toc-backref { text-decoration: none ; color: black }
+blockquote.epigraph { margin: 2em 5em ; }
+dl.docutils dd { margin-bottom: 0.5em }
+div.abstract { margin: 2em 5em }
+div.abstract p.topic-title { font-weight: bold ; text-align: center }
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ; border: medium outset ; padding: 1em }
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title { font-weight: bold ; font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title { color: red ; font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication { margin: 2em 5em ; text-align: center ; font-style: italic }
+div.dedication p.topic-title { font-weight: bold ; font-style: normal }
+div.figure { margin-left: 2em ; margin-right: 2em }
+div.footer, div.header { clear: both; font-size: smaller }
+div.line-block { display: block ; margin-top: 1em ; margin-bottom: 1em }
+div.line-block div.line-block { margin-top: 0 ; margin-bottom: 0 ;
+  margin-left: 1.5em }
+div.sidebar { margin-left: 1em ; border: medium outset ;
+  padding: 1em ; background-color: #ffffee ; width: 40% ; float: right ;
+  clear: right }
+
+div.sidebar p.rubric { font-family: sans-serif ; font-size: medium }
+div.system-messages { margin: 5em }
+div.system-messages h1 { color: red }
+div.system-message { border: medium outset ; padding: 1em }
+div.system-message p.system-message-title { color: red ; font-weight: bold }
+div.topic { margin: 2em;}
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+h1.title { text-align: center }
+h2.subtitle { text-align: center }
+hr.docutils { width: 75% }
+img.align-left { clear: left }
+img.align-right { clear: right }
+ol.simple, ul.simple { margin-bottom: 1em }
+ol.arabic { list-style: decimal }
+ol.loweralpha { list-style: lower-alpha }
+ol.upperalpha { list-style: upper-alpha }
+ol.lowerroman { list-style: lower-roman }
+ol.upperroman { list-style: upper-roman }
+p.attribution { text-align: right ; margin-left: 50% }
+p.caption { font-style: italic }
+p.credits { font-style: italic ; font-size: smaller }
+p.label { white-space: nowrap }
+p.rubric { font-weight:bold;font-size:larger;color:maroon;text-align:center}
+p.sidebar-title {font-family: sans-serif ;font-weight: bold ;font-size: larger }
+p.sidebar-subtitle {font-family: sans-serif ; font-weight: bold }
+p.topic-title { font-weight: bold }
+pre.address { margin-bottom: 0;margin-top:0;font-family:serif;font-size:100% }
+pre.literal-block, pre.doctest-block {margin-left: 2em ;margin-right: 2em }
+span.classifier {font-family: sans-serif;font-style: oblique }
+span.classifier-delimiter {font-family: sans-serif;font-weight: bold }
+span.interpreted {font-family: sans-serif }
+span.option {white-space: nowrap }
+span.pre {white-space: pre }
+span.problematic {color: red }
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation { border-left: solid 1px gray; margin-left: 1px }
+table.docinfo {margin: 2em 4em }
+table.docutils {margin-top: 0.5em;margin-bottom: 0.5em }
+table.footnote {border-left: solid 1px black;margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {padding-left: 0.5em;padding-right: 0.5em;
+  vertical-align: top}
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold;text-align: left;white-space: nowrap;padding-left: 0 }
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {font-size: 100% }
+ul.auto-toc { list-style-type: none }
+/*a.reference { color: #E00000; font-weight:bold;}
+a.reference:hover {color: #E00000;background-color: #ffff00;display: margin;
+  font-weight:bold;}*/
+
+</style>
+<script type="text/javascript">
+  //<![CDATA[
+    function toggleElem(id) {
+      var e = document.getElementById(id);
+      e.style.display = e.style.display == 'none' ? 'block' : 'none';
+    }
+
+    var gOpen = 'none'
+    function toggleAll() {
+      gOpen = gOpen == 'none' ? 'block' : 'none';
+      var i = 1
+      while (1) {
+        var e = document.getElementById("m"+i)
+        if (!e) break;
+        e.style.display = gOpen
+        i++;
+      }
+      document.getElementById('toggleButton').value =
+        gOpen == 'none' ? 'Show Details' : 'Hide Details';
+    }
+  //]]>
+</script>
+
+</head>
+<body>
+<div class="document" id="documentId">
+<h1 class="title">$title</h1>
+$content
+<small>Generated: $date $time UTC</small>
+</div>
+</body>
+</html>
+"""
+
author	Andreas Rumpf <rumpf_a@web.de>	2008-12-12 14:02:27 +0100
committer	Andreas Rumpf <rumpf_a@web.de>	2008-12-12 14:02:27 +0100
commit	ddaedab835fa7ea3457f21a772d636921defdc46 (patch)
tree	8f96b5a3a6700704e0a64bdcdedee1d2caf68517 /config/nimdoc.cfg
parent	2cd136cf7a0210e3cfde7a6f8ba32c9f09560047 (diff)
download	Nim-ddaedab835fa7ea3457f21a772d636921defdc46.tar.gz