docjs 0.1

data/templates/resources/scss/_helpers.scss

@@ -0,0 +1,91 @@
+$golden_ratio: 1.618;
+
+@mixin transition($property, $time) {
+	-webkit-transition: $property $time ease-in-out;
+	-moz-transition: $property $time ease-in-out;
+	-o-transition: $property $time ease-in-out;
+	-ms-transition: $property $time ease-in-out;
+	transition: $property $time ease-in-out;
+}
+
+/* Kudos to http://www.colorzilla.com/gradient-editor/ */
+@mixin gradient($from, $to, $from_pos: 0%, $to_pos: 100%, $fallback: $to) {
+  background: $fallback; /* Old browsers */
+  background: -moz-linear-gradient(top, $from $from_pos, $to $to_pos); /* FF3.6+ */
+  background: -webkit-gradient(linear, left top, left bottom, color-stop($from_pos, $from), color-stop($to_pos, $to)); /* Chrome,Safari4+ */
+  background: -webkit-linear-gradient(top, $from $from_pos,$to $to_pos); /* Chrome10+,Safari5.1+ */
+  background: -o-linear-gradient(top, $from $from_pos,$to $to_pos); /* Opera11.10+ */
+  background: -ms-linear-gradient(top, $from $from_pos,$to $to_pos); /* IE10+ */
+  background: linear-gradient(top, $from $from_pos,$to $to_pos); /* W3C */
+}
+
+@mixin gradient-horizontal($from, $to, $from_pos: 0%, $to_pos: 100%) {
+  background: $from; /* Old browsers */
+  background: -moz-linear-gradient(left, $from $from_pos, $to $to_pos); /* FF3.6+ */
+  background: -webkit-gradient(linear, left top, right top, color-stop($from_pos, $from), color-stop($to_pos, $to)); /* Chrome,Safari4+ */
+  background: -webkit-linear-gradient(left, $from $from_pos,$to $to_pos); /* Chrome10+,Safari5.1+ */
+  background: -o-linear-gradient(left, $from $from_pos,$to $to_pos); /* Opera11.10+ */
+  background: -ms-linear-gradient(left, $from $from_pos,$to $to_pos); /* IE10+ */
+  background: linear-gradient(left, $from $from_pos,$to $to_pos); /* W3C */
+}
+
+/* inspired by http://docs.sencha.com/ext-js/4-0/ */
+@mixin scrollbars() {
+  &::-webkit-scrollbar { width: 7px; height: 9px; }
+  &::-webkit-scrollbar-button:start:decrement, .iScroll ::-webkit-scrollbar-button:end:increment { display: block; height: 0; background-color: transparent; }
+  &::-webkit-scrollbar-track-piece { -webkit-border-radius: 0; -webkit-border-bottom-right-radius: 4px; -webkit-border-bottom-left-radius: 4px; }
+  &::-webkit-scrollbar-thumb:vertical { height: 50px; background-color: rgba(0, 0, 0, 0.15); -webkit-border-radius: 4px; }
+  &::-webkit-scrollbar-thumb:horizontal { width: 50px; background-color: rgba(0, 0, 0, 0.15); -webkit-border-radius: 4px; }
+}
+
+@mixin columns($count: 2, $gap: 20px) {
+  -moz-column-count: $count;
+	-moz-column-gap: $gap;
+	-webkit-column-count: $count;
+	-webkit-column-gap: $gap;
+	column-count: $count;
+	column-gap: $gap;
+}
+
+@mixin center() {
+  display: block;
+  margin: 0 auto;
+}
+
+@mixin clearfix() {
+  display: block;
+  overflow: hidden;
+}
+
+@mixin reset-list() {
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+
+@mixin double-border($size, $color1, $color2, $position:all) {
+  @if $position == all {
+    box-shadow: inset 0px 0px 0px $size $color1;
+    border: $size solid $color2;
+  } @else {
+    border-#{$position}: $size solid $color2;
+  
+    @if $position == bottom {
+      box-shadow: inset 0 $size*-1 0 $color1;
+    }
+    @if $position == top {
+      box-shadow: inset 0 $size 0 $color1;
+    }
+    @if $position == left {
+      box-shadow: inset $size 0 0 $color1;
+    }
+    @if $position == right {
+      box-shadow: inset $size*-1 0 0 $color1;
+    }
+  }
+}
+
+@mixin float($direction) {
+  display: block;
+  float: $direction;
+}

data/templates/resources/scss/_print.scss

@@ -0,0 +1,20 @@
+/*
+ * Print styles.
+ *
+ * Inlined to avoid required HTTP connection: www.phpied.com/delay-loading-your-print-css/
+ */
+@media print {
+  * { background: transparent !important; color: black !important; text-shadow: none !important; filter:none !important;
+  -ms-filter: none !important; } /* Black prints faster: sanbeiji.com/archives/953 */
+  a, a:visited { color: #444 !important; text-decoration: underline; }
+  a[href]:after { content: " (" attr(href) ")"; }
+  abbr[title]:after { content: " (" attr(title) ")"; }
+  .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; }  /* Don't show links for images, or javascript/internal links */
+  pre, blockquote { border: 1px solid #999; page-break-inside: avoid; }
+  thead { display: table-header-group; } /* css-discuss.incutio.com/wiki/Printing_Tables */
+  tr, img { page-break-inside: avoid; }
+  img { max-width: 100% !important; }
+  @page { margin: 0.5cm; }
+  p, h2, h3 { orphans: 3; widows: 3; }
+  h2, h3{ page-break-after: avoid; }
+}

data/templates/resources/scss/_resets.scss

@@ -0,0 +1,132 @@
+/**
+ * HTML5 ✰ Boilerplate
+ *
+ * style.css contains a reset, font normalization and some base styles.
+ *
+ * Credit is left where credit is due.
+ * Much inspiration was taken from these projects:
+ * - yui.yahooapis.com/2.8.1/build/base/base.css
+ * - camendesign.com/design/
+ * - praegnanz.de/weblog/htmlcssjs-kickstart
+ */
+
+
+/**
+ * html5doctor.com Reset Stylesheet (Eric Meyer's Reset Reloaded + HTML5 baseline)
+ * v1.6.1 2010-09-17 | Authors: Eric Meyer & Richard Clark
+ * html5doctor.com/html-5-reset-stylesheet/
+ */
+
+html, body, body div, span, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+abbr, address, cite, code, del, dfn, em, img, ins, kbd, q, samp,
+small, strong, sub, sup, var, b, i, dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  vertical-align: baseline;
+}
+
+article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section {
+  display: block;
+}
+
+blockquote, q { quotes: none; }
+
+blockquote:before, blockquote:after,
+q:before, q:after { content: ""; content: none; }
+
+ins { background-color: #ff9; color: #000; text-decoration: none; }
+
+mark { background-color: #ff9; color: #000; font-style: italic; font-weight: bold; }
+
+del { text-decoration: line-through; }
+
+abbr[title], dfn[title] { border-bottom: 1px dotted; cursor: help; }
+
+table { border-collapse: collapse; border-spacing: 0; }
+
+hr { display: block; height: 1px; border: 0; border-top: 1px solid #ccc; margin: $element-margin 0; padding: 0; }
+
+
+/* Font normalization inspired by YUI Library's fonts.css: developer.yahoo.com/yui/ */
+body { font:13px/1.231 $default-fonts; *font-size:small; } /* Hack retained to preserve specificity */
+
+/* Normalize monospace sizing: en.wikipedia.org/wiki/MediaWiki_talk:Common.css/Archive_11#Teletype_style_fix_for_Chrome */
+pre, code, kbd, samp { 
+  font-family: monospace, sans-serif; 
+  white-space: pre-wrap;
+}
+
+/* 1) Always force a scrollbar in non-IE 
+   2) Remove iOS text size adjust without disabling user zoom: www.456bereastreet.com/archive/201012/controlling_text_size_in_safari_for_ios_without_disabling_user_zoom/ */
+html { overflow-y: scroll; -webkit-text-size-adjust:100%; -ms-text-size-adjust:100%; }
+  
+/* j.mp/webkit-tap-highlight-color */
+a:link { -webkit-tap-highlight-color: #FF5E99; }
+
+/* Accessible focus treatment: people.opera.com/patrickl/experiments/keyboard/test */
+a:hover, a:active { outline: none; }
+
+ul, ol { 
+  margin-left: 2em; 
+  margin-bottom: $element-margin;
+}
+ol { list-style-type: decimal; }
+
+dl {
+  margin-bottom: $element-margin;
+}
+
+/* Remove margins for navigation lists */
+nav ul, nav li { margin: 0; list-style:none; list-style-image: none; }
+
+small { font-size: 85%; }
+b, strong, th { font-weight: bold; }
+
+td { vertical-align: top; }
+
+/* Set sub, sup without affecting line-height: gist.github.com/413930 */
+sub, sup { font-size: 75%; line-height: 0; position: relative; }
+sup { top: -0.5em; }
+sub { bottom: -0.25em; }
+
+pre {
+  /* www.pathf.com/blogs/2008/05/formatting-quoted-code-in-blog-posts-css21-white-space-pre-wrap/ */
+  white-space: pre; white-space: pre-wrap; word-wrap: break-word;
+  padding: 15px;
+}
+
+.oldie legend { *margin-left: -7px; } 
+
+/* 1) Make inputs and buttons play nice in IE: www.viget.com/inspire/styling-the-button-element-in-internet-explorer/
+   2) WebKit browsers add a 2px margin outside the chrome of form elements. 
+      Firefox adds a 1px margin above and below textareas 
+   3) Set font-size to match <body>'s, and font-family to sans-serif 
+   4) Align to baseline */
+button, input, select, textarea { width: auto; overflow: visible; margin: 0; font-size: 100%; font-family: sans-serif; vertical-align: baseline; }
+
+/* 1) Remove default scrollbar in IE: www.sitepoint.com/blogs/2010/08/20/ie-remove-textarea-scrollbars/
+   2) Align to text-top */
+textarea { overflow: auto; vertical-align:text-top; }
+
+/* Hand cursor on clickable input elements */
+label, input[type="button"], input[type="submit"], input[type="image"], button { cursor: pointer; }
+
+/* Remove extra padding and inner border in Firefox */
+input::-moz-focus-inner,
+button::-moz-focus-inner { border: 0; padding: 0; }
+
+/* Colors for form validity */
+input:valid, textarea:valid {  }
+input:invalid, textarea:invalid { border-radius: 1px; -moz-box-shadow: 0px 0px 5px red; -webkit-box-shadow: 0px 0px 5px red; box-shadow: 0px 0px 5px red; }
+.no-boxshadow input:invalid, .no-boxshadow textarea:invalid { background-color: #f0dddd; }
+
+/* Bicubic resizing in IE7 for non-native sized IMG:
+   code.flickr.com/blog/2008/11/12/on-ui-quality-the-little-things-client-side-image-resizing/ */
+.oldie img { -ms-interpolation-mode: bicubic; }

data/templates/resources/scss/_tooltip.scss

@@ -0,0 +1,26 @@
+.tooltip {
+  /*@include double-border(1px, #fff, #ccc);*/
+  @include gradient(#333, #555);
+  @include reset-fonts;
+    
+  display: none;
+  position: absolute;
+  padding: 0.5em;
+  max-width: 200px;
+  z-index: 50;  
+  
+  font-size: 9pt;
+  color: #eee;
+  border: 1px solid #fff;
+  border-radius: $radius/2;
+  box-shadow: 0 0 10px rgba(0,0,0,0.15);
+  
+  a {
+    color: lighten($blue, 20%);
+  }
+  
+  .types {
+    @include terminal;
+    padding: 0 0.2em;
+  }
+} 

data/templates/resources/scss/application.scss

@@ -0,0 +1,442 @@
+$default-fonts: Arial, sans-serif;
+$font-size: 10pt;
+
+
+/* Global Colors */
+$blue: #4183C2;
+$orange: #D84B0F;
+$grey: #333;
+$lightgrey: #a0a0a0;
+$codegrey: #F3F3F3;
+
+/* Header-colors */
+$button-color-from: #88B5E2;
+$button-color-to: darken($button-color-from, 15%); /*#4096ee;*/
+
+/* Content-colors */
+$signature-color: lighten($blue,45%);
+$flag-color: lighten($orange,45%);
+
+/* Dimensions */
+$pagesize: 1000px;
+$page-indent: 20px;
+$page-padding: 20px;
+$box-spacing: 12px;
+$radius: 10px;
+$element-margin: 1.33em;
+
+@import 'resets';
+@import 'print';
+@import 'helpers';
+
+@mixin terminal() {
+  font-family: "Consolas", "monospace";
+}
+
+@mixin page-center() {
+  @include center;
+  max-width: $pagesize;
+}
+
+@mixin headline() {
+  font-family: 'Terminal Dosis Light', 'Helvetica', 'Arial', 'sans-serif';      
+  font-weight: normal;
+  text-shadow: 1px 1px #fff;
+}
+
+@mixin page-padding() {
+  padding-left: $page-padding;
+  padding-right: $page-padding;
+}
+
+@mixin typography() { 
+  h1 { 
+    font-size: 24pt; 
+    color: $orange;
+  }
+  h2 { 
+    font-size: 16pt; 
+    margin: 1.25em 0 0.25em;
+    border-bottom: 1px solid #EFEFEF;
+  }
+  h3 { 
+    font-size: $font-size; 
+    font-weight: bold;
+  }
+  p {
+    line-height: $golden_ratio*1em;
+    margin: 0.5em 0 1.33em;
+  }
+}
+
+
+@mixin reset-fonts() {
+  font-family: $default-fonts;
+  font-size: $font-size;
+}
+
+@mixin code-box() {
+  @include double-border(1px, #ffffff, darken($codegrey, 10%));
+  @include terminal;
+  background: $codegrey;
+}
+
+@mixin signature-box($color:$signature-color, $fontcolor:$signature-color, $terminal:true) {
+  @if $terminal == true {
+    @include terminal;
+  }
+  display: block;
+  background: $color;
+  border: 1px solid darken($color, 8%);
+  color: darken($fontcolor, 40%);
+  border-radius: $radius/2;
+  padding: 0.4em 1em;
+}
+
+@import 'header';
+@import 'footer';
+@import 'tooltip';
+
+body, select, input, textarea {
+  @include reset-fonts;
+  background-color: #FBFBFB;
+  color: #444;
+}
+
+h1, h2, h3, h4, h5, h6 { font-weight: normal; }
+
+/* No text-shadow: twitter.com/miketaylr/status/12228805301 */
+::-moz-selection { background: $orange; color:#fff; text-shadow: none; }
+::selection { background: $orange; color:#fff; text-shadow: none; }
+
+a {
+  color: $blue;  
+  text-decoration: none;
+  
+  &:active, &:visited { color: $blue; }
+  &:hover { color: $blue; text-decoration: underline; } 
+}
+
+.icon {
+  @each $icon in function, object, constructor, prototype, arrow_right, arrow_up, arrow_down {    
+    &.#{$icon} { 
+      background: url(../img/#{$icon}.png) no-repeat left center;
+      padding-left: 24px;
+    }
+  }
+}
+
+.level-one-heading {
+  @include headline;
+  padding-top: $page-padding;
+  margin-bottom: $box-spacing;
+  font-size: 40pt;
+}
+
+div#main {
+  @include gradient(#f2f2f2, #ffffff, 0px, 40px);
+  @include page-center;
+  @include typography;
+  @include clearfix;
+
+  margin-top: -$page-indent;
+
+  border-radius: 10px 10px 0 0;
+  box-shadow: 0px -0px 5px rgba(0,0,0,0.1);
+
+  border-top: 1px solid #eee;
+  
+  > * {
+    @include page-padding;
+  }
+  
+  header h1 {
+    @extend .level-one-heading;
+    
+    .flag {
+      @include signature-box($flag-color);
+      @include float(right);
+      font-size: 8pt;
+      text-shadow: none;
+    }
+  }
+}
+
+
+div#main nav.sidebar {
+
+  @include float(right);
+  @include code-box;
+      
+  margin: 2*$page-padding 0 $box-spacing $box-spacing;
+  padding: 0;
+  border-radius: 5px;
+  font-size: 8pt;
+  color: #999;
+  
+  > * {
+    padding: 8px;
+    margin: 0;
+  }
+  
+  > * + * {
+    @include double-border(1px, #ffffff, darken($codegrey, 10%), top);
+  }
+  
+  h3 {      
+    text-transform: uppercase;
+    padding-bottom: 0.5em;
+    font-size: 8pt;
+  }
+  
+  .hierarchy {
+    list-style: none;
+         
+    ul { 
+      @include reset-list; 
+      padding-left: 1em;
+    }
+    
+    /* first node */
+    > ul {
+      padding-left: 0;  
+    }
+    
+    .this > a { font-weight: bold; }
+  }
+  
+  .method-list ul {
+    @include reset-list;
+  }
+  
+  .subsection {
+    p {
+      margin: 0;
+    }
+  }
+}
+
+
+div#main .body {
+
+  > section {
+    margin-bottom: $box-spacing;
+    
+    > h2 {
+      margin-top: $box-spacing;
+      margin-bottom: $box-spacing / $golden_ratio;
+      font-size: 14pt;      
+    }
+  }
+  
+  .summary {
+    @include reset-list;
+    @include clearfix;
+    
+    margin-bottom: $element-margin;
+    
+    li { @include float(left); }
+    
+    a {
+      @include signature-box;
+      margin: 0.25em;
+      
+      &:hover {
+        text-decoration: none;
+        color: darken($signature-color, 50%);
+      }
+    }    
+  }
+  
+  code.block {
+    @include code-box;
+    display: block;      
+    padding: 0.5em;      
+    color: #555;
+    margin-bottom: $element-margin;
+  }
+  
+  .section {
+    padding-bottom: $box-spacing;    
+  }
+  
+  .subsection { 
+      
+      > ul { 
+        margin-left: 0;
+        border: 1px solid #efefef;
+        
+        li {
+          list-style: none;
+          padding: 5px 15px;
+        }
+        
+        /* all but first li */
+        > * + li {
+          border-top: 1px solid #efefef;
+        }
+        
+        ul, p {
+          margin: 0;
+        }
+      }  
+      
+      h4 {        
+        font-weight: bold;
+        display: inline;
+      }
+      
+      .types {
+        @include terminal;
+        padding: 0 0.2em;
+      }    
+    }
+  
+  .source {
+    @extend .icon.arrow_down; 
+    cursor: pointer;   
+    &.collapsed { 
+      @extend .icon.arrow_right; 
+      border-bottom: 1px solid darken($codegrey, 10%);
+      margin-bottom: $element-margin;
+    }
+  }
+  
+  .signature {
+    @include signature-box;
+    color: #000;
+    font-size: 12pt;
+    font-weight: normal;
+    margin-bottom: $element-margin;
+    
+    &.constructor {
+      @include signature-box($flag-color);
+      color: #000;
+    }
+    
+    .name {
+      font-weight: bold;
+      padding-left: 0.2em;
+    }
+    
+    .params {
+      padding: 0 0.2em;
+      
+      .param {
+        cursor: help;
+      }        
+    }
+  }
+}
+
+div#main .notification  {
+
+  display: table;
+  
+  section {
+    @include signature-box(#f3f3f3, #ccc, false);
+    
+    margin-bottom: 0.5em;
+    
+    &.deprecated {
+      @include signature-box(#ccc, #ccc, false);
+    }
+    
+    &.todo {
+      @include signature-box(#fef377, #ee3, false);
+    }
+    
+    &.warn {
+      @include signature-box(#f54, #e63, false);
+    }
+    
+    ul {
+      @include reset-list;
+    }
+    
+    p {
+      margin: 0 0 0.25em;
+    }
+    
+    pre {
+      padding-top: 0;
+      padding-bottom: 0;
+      margin-bottom: 0.25em;
+    }
+  }
+
+}
+
+
+div#main .documentation {
+  
+  h1 { @extend .level-one-heading; }
+  
+  nav {
+  
+    .table-of-contents {
+      
+      @include reset-fonts;
+      
+      ul { 
+        @include reset-list; 
+        padding-left: 2em;
+        margin: 0.25em 0 0.5em;
+      }
+      
+      ul ul li {
+        list-style: decimal-leading-zero;
+      }
+      
+      > ul { padding-left: 0; }
+      
+      li {
+        margin-bottom: 0.25em;        
+      }
+    }
+  
+  }  
+}
+
+.api-index {
+  .api-list {
+    @include columns(2);
+    
+    ul {
+      @include reset-list;
+    }
+  }
+}
+
+/* API-Treebrowser */
+$iconsize: 16px;
+.treeview {
+
+  ul {
+    @include reset-list;
+    margin: 4px 0 0 0;
+  }
+
+  li { 
+	  margin: 0;
+	  padding: 3px 0pt 3px $iconsize;	  
+	  a {
+	  
+	    display: block;
+	    padding-left: $iconsize + 5px;
+	    height: $iconsize;
+	  }
+  }  
+  li.function > a { @extend .icon.function }
+  li.object > a { @extend .icon.object }
+  
+  .hitarea {
+    @include float(left);
+    height: $iconsize;
+	  width: $iconsize;
+	  margin-left: -$iconsize;
+	  cursor: pointer;
+	  background: url(../img/bullet_toggle_minus.png) no-repeat left center;
+  }
+  .expandable-hitarea { background-image: url(../img/bullet_toggle_plus.png); }
+}