imedo-css_doc 0.0.2 → 0.0.3

data/bin/cssdoc

@@ -8,7 +8,8 @@ class CSSDocCli
     options = {
       :input_dir => '.',
       :skip_files => [],
-      :output_dir => 'doc'
+      :output_dir => 'doc',
+      :template_path => File.expand_path(File.dirname(__FILE__) + "/../src/templates/default")
     }
     OptionParser.new do |opts|
       opts.banner = "Usage: cssdoc [options] [input-dir/input-files]"
@@ -24,6 +25,13 @@ class CSSDocCli
       opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
         options[:verbose] = v
       end
+      opts.on("-t", "--template=name/path", "Specify template or template path") do |name|
+        if File.directory?(name)
+          options[:template_path] = name
+        else
+          options[:template_path] = File.expand_path(File.dirname(__FILE__) + "/../src/templates/#{name}")
+        end
+      end
     end.parse!
     options[:input_dir] = ARGV.first if ARGV.first
     

data/src/css_doc/document_template.rb

@@ -1,6 +1,7 @@
 module CSSDoc
   class DocumentTemplate < Template
-    def initialize(document)
+    def initialize(document, options = {})
+      super(options)
       @document = document
     end
 

data/src/css_doc/driver.rb

@@ -23,7 +23,7 @@ module CSSDoc
         FileUtils.mkdir_p("#{@options[:output_dir]}/#{File.dirname(relative_path)}")
         doc = CSSDoc::Document.parse(File.read(file_name), relative_path)
 
-        html = CSSDoc::DocumentTemplate.new(doc).render
+        html = CSSDoc::DocumentTemplate.new(doc, @options).render
         File.open("#{@options[:output_dir]}/#{doc.output_file_name}", 'w') { |file| file.puts html }
 
         @collection.documents << doc
@@ -33,17 +33,17 @@ module CSSDoc
     def generate_index_documentation
       log "Generating Selector Index ..."
 
-      html = CSSDoc::SelectorIndexTemplate.new(@collection).render
+      html = CSSDoc::SelectorIndexTemplate.new(@collection, @options).render
       File.open("#{@options[:output_dir]}/selector_index.html", 'w') { |file| file.puts html }
 
       log "Generating File Index ..."
 
-      html = CSSDoc::FileIndexTemplate.new(@collection).render
+      html = CSSDoc::FileIndexTemplate.new(@collection, @options).render
       File.open("#{@options[:output_dir]}/file_index.html", 'w') { |file| file.puts html }
 
       log "Generating Section Index ..."
 
-      html = CSSDoc::SectionIndexTemplate.new(@collection).render
+      html = CSSDoc::SectionIndexTemplate.new(@collection, @options).render
       File.open("#{@options[:output_dir]}/section_index.html", 'w') { |file| file.puts html }
 
       log "Generating Index Page ..."
@@ -62,7 +62,7 @@ module CSSDoc
     def copy_additional_files
       log "Copying Additional Files ..."
 
-      FileUtils.cp(File.dirname(__FILE__) + '/../templates/default/css_doc.css', "#{@options[:output_dir]}/")
+      FileUtils.cp("#{@options[:template_path]}/css_doc.css", "#{@options[:output_dir]}/")
     end
     
     def log(string)

data/src/css_doc/file_index_template.rb

@@ -1,6 +1,7 @@
 module CSSDoc
   class FileIndexTemplate < Template
-    def initialize(collection)
+    def initialize(collection, options = {})
+      super(options)
       @collection = collection
     end
 

data/src/css_doc/index_template.rb

@@ -1,6 +1,7 @@
 module CSSDoc
   class IndexTemplate < Template
     def initialize(options)
+      super
       @project_name = options[:project_name]
     end
     

data/src/css_doc/section_index_template.rb

@@ -1,6 +1,7 @@
 module CSSDoc
   class SectionIndexTemplate < Template
-    def initialize(collection)
+    def initialize(collection, options = {})
+      super(options)
       @collection = collection
     end
 

data/src/css_doc/selector_index_template.rb

@@ -1,6 +1,7 @@
 module CSSDoc
   class SelectorIndexTemplate < Template
-    def initialize(collection)
+    def initialize(collection, options = {})
+      super(options)
       @collection = collection
     end
 

data/src/css_doc/template.rb

@@ -2,9 +2,10 @@ require 'erb'
 
 module CSSDoc
   class Template
-    @@template_path = File.dirname(__FILE__) + '/../templates/default'
+    @@default_template_path = File.dirname(__FILE__) + '/../templates/default'
     
-    def initialize
+    def initialize(options = {})
+      @options = options
     end
 
     def render
@@ -16,12 +17,16 @@ module CSSDoc
       
     end
     
+    def template_path
+      @options[:template_path] || @@default_template_path
+    end
+    
     def template
-      File.read("#{@@template_path}/#{template_name}.html.erb")
+      File.read("#{template_path}/#{template_name}.html.erb")
     end
     
     def layout
-      File.read("#{@@template_path}/layout.html.erb")
+      File.read("#{template_path}/layout.html.erb")
     end
     
     def relative_root

data/src/rake/css_doc_task.rb

@@ -10,6 +10,7 @@ module Rake
       @name = name
       @input_dir = 'public/stylesheets'
       @output_dir = 'css_doc'
+      @template_path = File.expand_path(File.dirname(__FILE__) + '/../templates/default')
 
       yield self if block_given?
       define

data/src/templates/default/layout.html.erb

@@ -1,5 +1,8 @@
-<html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<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 %> - CSS Documentation</title>
     <link rel="stylesheet" media="all" href="<%= relative_root %>/css_doc.css" />
     <link rel="stylesheet" media="all" href="<%= relative_root %>/styles.css" />

data/src/templates/simple/css_doc.css

@@ -0,0 +1,282 @@
+/**
+* @file css_doc.css
+* @author Thomas Kadauke
+* @css-for Safari 4, Firefox 3
+*/
+
+/**
+* @section Reset styles
+* These styles reset the default style sheet that comes with the user agent.
+*/
+
+/**
+* Set margins and paddings to 0, and font-properties to a default value.
+*/
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  outline: 0;
+  font-weight: inherit;
+  font-style: inherit;
+  font-size: 100%;
+  font-family: inherit;
+  vertical-align: baseline;
+}
+/**
+* Reset focus styles to nothing.
+* Remember to define focus styles in after this declaration.
+*/
+:focus {
+  outline: 0;
+}
+/**
+* Reset text color and line height.
+*/
+body {
+  line-height: 1;
+  color: black;
+  background: white;
+}
+/**
+* Remove default list decoration.
+*/
+ol, ul {
+  list-style: none;
+}
+/*
+* Remove default table styling.
+* Tables still need 'cellspacing="0"' in the markup.
+*/
+table {
+  border-collapse: separate;
+  border-spacing: 0;
+}
+/**
+* Reset text alignment and typography for special tags.
+*/
+caption, th, td {
+  text-align: left;
+  font-weight: normal;
+}
+/**
+* Remove CSS generated content around citation tags.
+*/
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: "";
+}
+blockquote, q {
+  quotes: "" "";
+}
+
+/**
+* @section Typography
+*/
+
+/**
+* A font size of 100.01% on the html tag makes it possible to easily convert
+* em's to pixels with default font size settings in all major browsers.
+*/
+html {
+  font-size: 100.01%;
+}
+
+/**
+* Reset font size so that 1 em is 10 pixels.
+*/
+body {
+  font-size: 62.5%;
+  font-family: Arial, Verdana, Tahoma, 'Bitstream Vera Sans', sans serif;
+}
+
+/**
+* Set font size and spacing.
+*/
+#canvas {
+  font-size: 1.2em;
+  line-height: 1.3;
+}
+
+p {
+  margin-bottom: 0.5em;
+}
+
+/**
+* Use typewriter font for code examples.
+*/
+pre {
+  font-family: Courier;
+  width: 100%;
+  overflow: auto;
+}
+
+/**
+* @section Headers
+*/
+
+/**
+* All headers use the same font, same margins, but different font sizes.
+*/
+h1, h2, h3, h4, h5, h6                      { font-family: 'Arial', sans serif; font-weight: normal; line-height: 1; margin: 0 0 .5em 0; padding: 0; }
+h1                                          { font-size: 1.9em; }
+h2                                          { font-size: 1.8333333em; }
+h3                                          { font-size: 1.6em; }
+h4                                          { font-size: 1.4em; }
+h5                                          { font-size: 1em; }
+h6                                          { font-size: 1em; }
+
+/**
+* @section Layout
+*/
+
+body {
+  padding: 1em;
+}
+
+/**
+* Navigation is on the top, and items are inlined.
+*/
+.navigation {
+  text-align: center;
+  margin-bottom: 1em;
+}
+
+.navigation li {
+  display: inline;
+}
+
+.navigation li a {
+  border-right: 1px solid #000;
+  padding: 0 1em;
+}
+
+.navigation li:last-child a {
+  border: none;
+}
+
+/**
+* @section Lists
+*/
+
+dl {
+  margin-bottom: 0.5em;
+}
+
+dt {
+  font-weight: bold;
+}
+
+/**
+* Use nice indentation to make definition items more distinguishable from the
+* terms.
+*/
+dd {
+  padding-left: 2em;
+}
+
+/**
+* @section Indexes
+*/
+
+/**
+* Index list items should be next to each other.
+*/
+dl.index ul li {
+  display: inline;
+}
+
+/**
+* Separate index list items by commas via CSS.
+*/
+dl.index ul li:after {
+  content: ', ';
+}
+
+/**
+* No comma for the last index list item.
+*/
+dl.index ul li:last-child:after {
+  content: '';
+}
+
+/**
+* Actually use bullets for the file index.
+*/
+ul.file-index {
+  list-style-type: disc;
+}
+
+ul.file-index li {
+  margin-left: 3em;
+}
+
+/**
+* @section Document page
+*/
+
+ul.rule-sets, ul.sections {
+  margin-bottom: 0.5em;
+}
+
+/**
+* Like index lists, the table of contents lists on the document page should be
+* inlined.
+*/
+ul.sections li, ul.rule-sets li {
+  display: inline;
+}
+
+/**
+* Again, use CSS-generated commas to separate the items.
+*/
+ul.sections li:after, ul.rule-sets li:after {
+  content: ', ';
+}
+
+/**
+* No comma for the last one.
+*/
+ul.sections li:last-child:after, ul.rule-sets li:last-child:after {
+  content: '';
+}
+
+/**
+* Give section headers a visual emphasis.
+*/
+h2.section {
+  border-top: 1px solid #000;
+  border-bottom: 1px solid #000;
+  margin-top: 1em;
+  margin-bottom: 1em;
+}
+
+/**
+* Examples are surrounded by a thick border. Also there is a rather large
+* padding to make it clear where the example starts. This selector is the
+* namespace for generated CSS, which is used to style the example in the box.
+*/
+div.example {
+  margin: 1em 0 1em 2em;
+  border: 2px solid #000;
+  padding: 1em;
+}
+
+/**
+* @section Footer
+*/
+
+/**
+* Center footer line.
+*/
+#footer {
+  margin-top: 2em;
+  text-align: center;
+}

data/src/templates/simple/document.html.erb

@@ -0,0 +1,58 @@
+<h1>Document <%= @document.name %></h1>
+<% if @document.documentation %>
+  <dl>
+    <% if @document.documentation.author %>
+      <dt>Author</dt>
+      <dd><%= @document.documentation.author %></dd>
+    <% end %>
+    <% if @document.documentation.appdef %>
+      <dt>Application</dt>
+      <dd><%= @document.documentation.appdef %></dd>
+    <% end %>
+    <% if @document.documentation.link %>
+      <dt>URL</dt>
+      <dd><%= @document.documentation.link %></dd>
+    <% end %>
+    <% if @document.documentation.copyright %>
+      <dt>Copyright</dt>
+      <dd><%= @document.documentation.copyright %></dd>
+    <% end %>
+    <% if @document.documentation.css_for %>
+      <dt>Compatible browsers</dt>
+      <dd><%= @document.documentation.css_for %></dd>
+    <% end %>
+    <% if @document.documentation.author %>
+      <dt>Version</dt>
+      <dd><%= @document.documentation.author %></dd>
+    <% end %>
+  </dl>
+  
+  <%= @document.documentation.sections.to_html %>
+<% end %>
+
+<% @document.sections.each do |section| %>
+  <% if section.name %>
+    <h2 class="section" id="section-<%= section.object_id %>"><%= section.name %></h2>
+  <% end %>
+  
+  <%= section.documentation.sections.to_html %>
+  
+  <dl>
+    <% section.rule_sets.each do |rule_set| %>
+      <dt class="rule-set" id="rule-set-<%= rule_set.object_id %>">Rule set <%= rule_set.documentation.name || "(unnamed)" %></dt>
+      <dd>
+        <p><%= rule_set.selector_css %> <%= rule_set.declaration_css %></p>
+
+        <% if rule_set.documentation.formerly %>
+          <p>Formerly: <%= rule_set.documentation.formerly %></p>
+        <% end %>
+      
+        <% if rule_set.documentation.deprecated %>
+          <p>Deprecated: <%= rule_set.documentation.deprecated %></p>
+        <% end %>
+        
+        <%= rule_set.documentation.sections.to_html %>
+      </dd>
+    <% end %>
+  </dl>
+<% end %>

data/src/templates/simple/file_index.html.erb

@@ -0,0 +1,7 @@
+<h1>File Index</h1>
+
+<ul class="file-index">
+  <% @collection.documents.sort_by {|doc| doc.name}.each do |document| %>
+    <li><a href="<%= document.output_file_name %>"><%= document.name %></a></li>
+  <% end %>
+</ul>

data/src/templates/simple/index.html.erb

@@ -0,0 +1,3 @@
+<h1><%= @project_name || 'CSS Documentation' %></h1>
+
+<p>Use the navigation to find documentation for this project</p>

data/src/templates/simple/layout.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<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 %> - CSS Documentation</title>
+    <link rel="stylesheet" media="all" href="<%= relative_root %>/css_doc.css" />
+    <link rel="stylesheet" media="all" href="<%= relative_root %>/styles.css" />
+  </head>
+  <body>
+    <div id="canvas">
+      <ul class="navigation">
+        <li><a href="<%= relative_root %>/index.html">Home</a></li>
+        <li><a href="<%= relative_root %>/file_index.html">File Index</a></li>
+        <li><a href="<%= relative_root %>/selector_index.html">Selector Index</a></li>
+        <li><a href="<%= relative_root %>/section_index.html">Section Index</a></li>
+      </ul>
+
+      <div class="content">
+        <%= content %>
+      </div>
+      
+      <p id="footer">
+        Generated by css_doc. css_doc is Copyright (2009) Thomas Kadauke, imedo.de, das <a href="http://www.imedo.de">Gesundheitsportal</a>.
+      </p>
+    </div>
+  </body>
+</html>
+

data/src/templates/simple/section_index.html.erb

@@ -0,0 +1,14 @@
+<h1>Section Index</h1>
+
+<dl class="index">
+  <% @collection.section_hash.sort.each do |name, sections| %>
+    <dt><%= name %></dt>
+    <dd>
+      <ul>
+        <% sections.each do |section| %>
+          <li><a href="<%= section.document.output_file_name %>#section-<%= section.object_id %>"><%= section.document.name %></a></li>
+        <% end %>
+      </ul>
+    </dd>
+  <% end %>
+</dt>

data/src/templates/simple/selector_index.html.erb

@@ -0,0 +1,14 @@
+<h1>Selector Index</h1>
+
+<dl class="index">
+  <% @collection.selector_hash.sort.each do |name, selectors| %>
+    <dt><%= name %></dt>
+    <dd>
+      <ul>
+        <% selectors.each do |selector| %>
+          <li><a href="<%= selector.rule_set.document.output_file_name %>#rule-set-<%= selector.rule_set.object_id %>"><%= selector.rule_set.document.name %></a></li>
+        <% end %>
+      </ul>
+    </dd>
+  <% end %>
+</dt>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: imedo-css_doc
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Thomas Kadauke
@@ -49,6 +49,13 @@ files:
 - src/templates/default/layout.html.erb
 - src/templates/default/section_index.html.erb
 - src/templates/default/selector_index.html.erb
+- src/templates/simple/css_doc.css
+- src/templates/simple/document.html.erb
+- src/templates/simple/file_index.html.erb
+- src/templates/simple/index.html.erb
+- src/templates/simple/layout.html.erb
+- src/templates/simple/section_index.html.erb
+- src/templates/simple/selector_index.html.erb
 has_rdoc: false
 homepage: http://www.imedo.de
 post_install_message: