imedo-css_doc 0.0.2

data/bin/cssdoc

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'css_doc'
+require 'optparse'
+
+class CSSDocCli
+  def self.run(args)
+    options = {
+      :input_dir => '.',
+      :skip_files => [],
+      :output_dir => 'doc'
+    }
+    OptionParser.new do |opts|
+      opts.banner = "Usage: cssdoc [options] [input-dir/input-files]"
+      opts.on("-o", "--output=dir", "Specify output directory") do |dir|
+        options[:output_dir] = dir
+      end
+      opts.on("-s", "--skip=files", "Skip specified files") do |files|
+        options[:skip_files] = files.split(',').collect { |file| file.strip }
+      end
+      opts.on("-p", "--project-name=name", "Specify Project name") do |name|
+        options[:project_name] = name
+      end
+      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options[:verbose] = v
+      end
+    end.parse!
+    options[:input_dir] = ARGV.first if ARGV.first
+    
+    driver = CSSDoc::Driver.new
+    driver.run(options)
+  end
+end
+
+CSSDocCli.run(ARGV)

data/src/css_doc/css_writer.rb

@@ -0,0 +1,20 @@
+module CSSDoc
+  class CSSWriter
+    def initialize(collection)
+      @collection = collection
+    end
+    
+    def write
+      output = ""
+      @collection.rule_sets.each do |rule_set|
+        selectors = rule_set.selectors.collect { |selector| 'div.example ' + selector.to_css }
+        output << selectors.join(', ')
+        output << '{'
+        output << rule_set.declaration_css
+        output << '}'
+        output << "\n"
+      end
+      output
+    end
+  end
+end

data/src/css_doc/document.rb

@@ -0,0 +1,31 @@
+module CSSDoc
+  class Document < CSSPool::CSS::Document
+    attr_accessor :documentation
+    attr_accessor :sections
+    attr_accessor :name
+    
+    def self.parse string, name
+      unless string && string.length > 0
+        return CSSDoc::Document.new(name)
+      end
+      handler = CSSDoc::DocumentHandler.new(name)
+      parser = CSSPool::SAC::Parser.new(handler)
+      parser.parse(string)
+      handler.document
+    end
+    
+    def initialize(name)
+      super()
+      @name = name
+      @sections = [Section.new(self, '')]
+    end
+    
+    def output_file_name
+      name.gsub('.css', '_css.html')
+    end
+    
+    def named_sections
+      sections.reject {|section| section.name.nil?}
+    end
+  end
+end

data/src/css_doc/document_collection.rb

@@ -0,0 +1,33 @@
+module CSSDoc
+  class DocumentCollection < CSSPool::CSS::Document
+    attr_accessor :documents
+    
+    def initialize
+      @documents = []
+    end
+    
+    def rule_sets
+      documents.collect { |document| document.rule_sets }.flatten
+    end
+    
+    def selectors
+      rule_sets.collect { |rule_set| rule_set.selectors }.flatten
+    end
+    
+    def sections
+      documents.collect { |document| document.sections }.flatten
+    end
+    
+    def named_sections
+      sections.reject { |section| section.name.nil? }
+    end
+    
+    def selector_hash
+      selectors.inject({}) { |hash, selector| (hash[selector.to_css] ||= []) << selector; hash }
+    end
+    
+    def section_hash
+      named_sections.inject({}) { |hash, section| (hash[section.name] ||= []) << section; hash }
+    end
+  end
+end

data/src/css_doc/document_documentation.rb

@@ -0,0 +1,19 @@
+module CSSDoc
+  class DocumentDocumentation < Documentation
+    attr_accessor :file, :note, :appdef, :link, :copyright, :author, :css_for, :version
+  
+    def parse(lines)
+      section_text = []
+      lines.each do |line|
+        unless parse_one_liners(line)
+          section_text << line
+        end
+      end
+      sections << TextSection.new(section_text)
+    end
+    
+    def one_liners
+      ['file', 'note', 'appdef', 'link', 'copyright', 'author', 'css-for', 'version']
+    end
+  end
+end

data/src/css_doc/document_handler.rb

@@ -0,0 +1,36 @@
+module CSSDoc
+  class DocumentHandler < CSSPool::CSS::DocumentHandler
+    def initialize(name)
+      super()
+      @name = name
+    end
+    
+    def start_document
+      @document = CSSDoc::Document.new(@name)
+    end
+
+    def comment(comment)
+      if comment =~ /@file/
+        @document.documentation = DocumentDocumentation.new(comment)
+      elsif comment =~ /@section/
+        @document.sections << Section.new(@document, comment)
+      else
+        @last_comment = comment
+      end
+    end
+
+    def start_selector(selector_list)
+      rule_set = CSSDoc::RuleSet.new(
+        selector_list,
+        [],
+        @media_stack.last || []
+      )
+      rule_set.document = @document
+      rule_set.documentation = RuleSetDocumentation.new(@last_comment =~ /^\*/ ? @last_comment : "")
+      @last_comment = nil
+    
+      @document.rule_sets << rule_set
+      @document.sections.last.rule_sets << rule_set
+    end
+  end
+end

data/src/css_doc/document_template.rb

@@ -0,0 +1,23 @@
+module CSSDoc
+  class DocumentTemplate < Template
+    def initialize(document)
+      @document = document
+    end
+
+    def template_name
+      'document'
+    end
+    
+    def title
+      @document.name
+    end
+    
+    def relative_root
+      if @document.name =~ /\//
+        (['..'] * File.dirname(@document.name).split('/').size).join('/')
+      else
+        '.'
+      end
+    end
+  end
+end

data/src/css_doc/documentation.rb

@@ -0,0 +1,81 @@
+module CSSDoc
+  class Documentation
+    class Section
+      attr_accessor :lines
+      def initialize(lines)
+        self.lines = lines
+      end
+
+      def to_s
+        lines.join("\n")
+      end
+    end
+    
+    class TextSection < Section
+      def to_html
+        result = "<p>"
+        result << lines.collect {|l|l.strip}.join("\n").gsub(/\n\n+/, '</p><p>').gsub(/\n/, ' ').strip
+        result << "</p>"
+        result.gsub('<p></p>', '')
+      end
+    end
+      
+    class CodeSection < Section
+      def to_html
+        result = "<pre>" + lines.join("\n").gsub("<", "&lt;").gsub(">", "&gt;").gsub('"', '&quot;') + "</pre>"
+        result << %{<div class="example">#{lines.join("\n")}</div>}
+      end
+    end
+    
+    class Sections < Array
+      def to_html
+        collect {|section| section.to_html}
+      end
+    end
+
+    attr_accessor :comment
+    attr_accessor :sections
+    
+    def initialize(comment)
+      @comment = comment
+      @sections = Sections.new
+      parse_documentation
+    end
+    
+    def to_s
+      @comment
+    end
+    
+    def parse_one_liners(line)
+      one_liners.each do |one_liner|
+        rx = /@#{one_liner}/
+        if line =~ rx
+          instance_variable_set(:"@#{one_liner.gsub('-', '_')}", line.gsub(rx, "").strip)
+          return true
+        end
+      end
+      return false
+    end
+    
+    def one_liners
+      []
+    end
+    
+    def parse_comment
+      @parsed_comment ||= comment.gsub(/\*\/$/, '').split("\n").collect { |line| line.gsub(/^\s*\*/, '') }
+    end
+    
+    def parse_documentation
+      lines = parse_comment
+      parse(lines)
+    end
+    
+    def empty?
+      parse_comment.join("\n").strip.empty?
+    end
+  
+    def parse(lines)
+      raise NotImplementedError
+    end
+  end
+end

data/src/css_doc/driver.rb

@@ -0,0 +1,72 @@
+module CSSDoc
+  class Driver
+    def run(options = {})
+      @options = options
+      
+      @collection = CSSDoc::DocumentCollection.new
+
+      generate_file_documentation
+      generate_index_documentation
+      generate_css
+      copy_additional_files
+    end
+    
+    def generate_file_documentation
+      skip_files = @options[:skip_files] || []
+      
+      Dir.glob("#{@options[:input_dir]}/**/*.css").each do |file_name|
+        relative_path = file_name.gsub("#{@options[:input_dir]}/", '')
+        next if skip_files.include?(relative_path)
+        
+        log "Generating documentation for file #{relative_path} ..."
+
+        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
+        File.open("#{@options[:output_dir]}/#{doc.output_file_name}", 'w') { |file| file.puts html }
+
+        @collection.documents << doc
+      end
+    end
+    
+    def generate_index_documentation
+      log "Generating Selector Index ..."
+
+      html = CSSDoc::SelectorIndexTemplate.new(@collection).render
+      File.open("#{@options[:output_dir]}/selector_index.html", 'w') { |file| file.puts html }
+
+      log "Generating File Index ..."
+
+      html = CSSDoc::FileIndexTemplate.new(@collection).render
+      File.open("#{@options[:output_dir]}/file_index.html", 'w') { |file| file.puts html }
+
+      log "Generating Section Index ..."
+
+      html = CSSDoc::SectionIndexTemplate.new(@collection).render
+      File.open("#{@options[:output_dir]}/section_index.html", 'w') { |file| file.puts html }
+
+      log "Generating Index Page ..."
+
+      html = CSSDoc::IndexTemplate.new(@options).render
+      File.open("#{@options[:output_dir]}/index.html", 'w') { |file| file.puts html }
+    end
+    
+    def generate_css
+      log "Generating Example CSS ..."
+
+      writer = CSSDoc::CSSWriter.new(@collection)
+      File.open("#{@options[:output_dir]}/styles.css", 'w') { |file| file.puts writer.write }
+    end
+    
+    def copy_additional_files
+      log "Copying Additional Files ..."
+
+      FileUtils.cp(File.dirname(__FILE__) + '/../templates/default/css_doc.css', "#{@options[:output_dir]}/")
+    end
+    
+    def log(string)
+      puts string if @options[:verbose]
+    end
+  end
+end

data/src/css_doc/file_index_template.rb

@@ -0,0 +1,15 @@
+module CSSDoc
+  class FileIndexTemplate < Template
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def template_name
+      'file_index'
+    end
+    
+    def title
+      "File Index"
+    end
+  end
+end

data/src/css_doc/index_template.rb

@@ -0,0 +1,15 @@
+module CSSDoc
+  class IndexTemplate < Template
+    def initialize(options)
+      @project_name = options[:project_name]
+    end
+    
+    def template_name
+      'index'
+    end
+    
+    def title
+      "Index"
+    end
+  end
+end

data/src/css_doc/rule_set.rb

@@ -0,0 +1,14 @@
+module CSSDoc
+  class RuleSet < CSSPool::CSS::RuleSet
+    attr_accessor :document
+    attr_accessor :documentation
+    
+    def selector_css
+      @selector_css ||= selectors.collect { |selector| selector.to_css }.join(", ")
+    end
+    
+    def declaration_css
+      @declaration_css ||= declarations.collect { |declaration| declaration.to_css }.join(' ')
+    end
+  end
+end

data/src/css_doc/rule_set_documentation.rb

@@ -0,0 +1,32 @@
+module CSSDoc
+  class RuleSetDocumentation < Documentation
+    attr_accessor :name, :formerly, :deprecated
+  
+    def parse(lines)
+      section_type = TextSection
+      section_text = []
+      lines.each do |line|
+        unless parse_one_liners(line)
+          if line =~ /@code/
+            sections << section_type.new(section_text)
+            section_text = []
+            section_type = CodeSection
+          elsif line =~ /@endcode/
+            sections << section_type.new(section_text)
+            section_text = []
+            section_type = TextSection
+          elsif line =~ /@description/
+            section_text << line.gsub(/@description/, '')
+          else
+            section_text << line
+          end
+        end
+      end
+      sections << section_type.new(section_text)
+    end
+    
+    def one_liners
+      ['name', 'formerly', 'deprecated']
+    end
+  end
+end

data/src/css_doc/section.rb

@@ -0,0 +1,17 @@
+module CSSDoc
+  class Section
+    attr_accessor :document
+    attr_accessor :rule_sets
+    attr_accessor :documentation
+    
+    def initialize(document, comment)
+      @document = document
+      @rule_sets = []
+      @documentation = SectionDocumentation.new(comment)
+    end
+    
+    def name
+      documentation.section
+    end
+  end
+end

data/src/css_doc/section_documentation.rb

@@ -0,0 +1,19 @@
+module CSSDoc
+  class SectionDocumentation < Documentation
+    attr_accessor :section
+  
+    def parse(lines)
+      section_text = []
+      lines.each do |line|
+        unless parse_one_liners(line)
+          section_text << line
+        end
+      end
+      sections << TextSection.new(section_text)
+    end
+    
+    def one_liners
+      ['section']
+    end
+  end
+end

data/src/css_doc/section_index_template.rb

@@ -0,0 +1,15 @@
+module CSSDoc
+  class SectionIndexTemplate < Template
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def template_name
+      'section_index'
+    end
+    
+    def title
+      "Section Index"
+    end
+  end
+end

data/src/css_doc/selector_index_template.rb

@@ -0,0 +1,15 @@
+module CSSDoc
+  class SelectorIndexTemplate < Template
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def template_name
+      'selector_index'
+    end
+    
+    def title
+      "Selector Index"
+    end
+  end
+end

data/src/css_doc/template.rb

@@ -0,0 +1,39 @@
+require 'erb'
+
+module CSSDoc
+  class Template
+    @@template_path = File.dirname(__FILE__) + '/../templates/default'
+    
+    def initialize
+    end
+
+    def render
+      content = ERB.new(template).result(binding)
+      ERB.new(layout).result(binding)
+    end
+    
+    def title
+      
+    end
+    
+    def template
+      File.read("#{@@template_path}/#{template_name}.html.erb")
+    end
+    
+    def layout
+      File.read("#{@@template_path}/layout.html.erb")
+    end
+    
+    def relative_root
+      "."
+    end
+    
+    def truncate(string, length)
+      if string.size > length
+        string[0..(length - 4)] + '...'
+      else
+        string
+      end
+    end
+  end
+end

data/src/css_doc.rb

@@ -0,0 +1,20 @@
+require 'csspool'
+
+require File.dirname(__FILE__) + '/css_doc/document'
+require File.dirname(__FILE__) + '/css_doc/document_handler'
+require File.dirname(__FILE__) + '/css_doc/document_collection'
+require File.dirname(__FILE__) + '/css_doc/section'
+require File.dirname(__FILE__) + '/css_doc/rule_set'
+require File.dirname(__FILE__) + '/css_doc/template'
+require File.dirname(__FILE__) + '/css_doc/document_template'
+require File.dirname(__FILE__) + '/css_doc/selector_index_template'
+require File.dirname(__FILE__) + '/css_doc/file_index_template'
+require File.dirname(__FILE__) + '/css_doc/section_index_template'
+require File.dirname(__FILE__) + '/css_doc/index_template'
+require File.dirname(__FILE__) + '/css_doc/documentation'
+require File.dirname(__FILE__) + '/css_doc/document_documentation'
+require File.dirname(__FILE__) + '/css_doc/rule_set_documentation'
+require File.dirname(__FILE__) + '/css_doc/section_documentation'
+require File.dirname(__FILE__) + '/css_doc/css_writer'
+require File.dirname(__FILE__) + '/css_doc/driver'
+require File.dirname(__FILE__) + '/css_pool/visitors/to_css'

data/src/css_pool/visitors/to_css.rb

@@ -0,0 +1,9 @@
+module CSSPool
+  module Visitors
+    class ToCSS
+      def visit_CSSDoc_RuleSet(*args)
+        visit_CSSPool_CSS_RuleSet(*args)
+      end
+    end
+  end
+end

data/src/rake/css_doc_task.rb

@@ -0,0 +1,27 @@
+module Rake
+  class CSSDocTask < TaskLib
+    attr_accessor :input_dir
+    attr_accessor :output_dir
+    attr_accessor :skip_files
+    attr_accessor :project_name
+    attr_accessor :verbose
+    
+    def initialize(name = :css_doc)
+      @name = name
+      @input_dir = 'public/stylesheets'
+      @output_dir = 'css_doc'
+
+      yield self if block_given?
+      define
+    end
+    
+    def define
+      task @name do
+        require 'css_doc'
+
+        driver = CSSDoc::Driver.new
+        driver.run(:project_name => self.project_name, :input_dir => self.input_dir, :output_dir => self.output_dir, :skip_files => self.skip_files, :verbose => self.verbose)
+      end
+    end
+  end
+end

data/src/templates/default/css_doc.css

@@ -0,0 +1,286 @@
+/**
+* @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;
+}
+
+.content {
+  margin-left: 15em;
+}
+
+/**
+* Push navigation to the left-hand side.
+*/
+.navigation {
+  float: left;
+  width: 9em;
+}
+
+/**
+* @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.
+*/
+h3.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 Table of contents
+*/
+
+ul.navigation li {
+  border-top: 1px solid #000;
+  padding: 0.25em;
+}
+
+ul.navigation li:last-child {
+  border-bottom: 1px solid #000;
+}
+
+/**
+* @section Footer
+*/
+
+/**
+* Center footer line.
+*/
+#footer {
+  margin-top: 2em;
+  text-align: center;
+}

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

@@ -0,0 +1,85 @@
+<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 %>
+
+<h2>Contents</h2>
+
+<% unless @document.named_sections.empty? %>
+  <h3>Sections</h3>
+
+  <ul class="sections">
+    <% @document.named_sections.sort_by {|section| section.name}.each do |section| %>
+      <li><a href="#section-<%= section.object_id %>"><%= section.name %></a></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<h3>Rule sets</h3>
+
+<ul class="rule-sets">
+  <% @document.rule_sets.sort_by {|set| set.selector_css}.each do |rule_set| %>
+    <li><a href="#rule-set-<%= rule_set.object_id %>" title="<%= rule_set.selector_css %>"><%= truncate(rule_set.selector_css, 40) %></a></li>
+  <% end %>
+</ul>
+
+<h2>Documentation</h2>
+
+<% @document.sections.each do |section| %>
+  <% if section.name %>
+    <h3 class="section" id="section-<%= section.object_id %>"><%= section.name %></h3>
+  <% end %>
+  
+  <%= section.documentation.sections.to_html %>
+  
+  <% section.rule_sets.each do |rule_set| %>
+    <h4 class="rule-set" id="rule-set-<%= rule_set.object_id %>">Rule set <%= rule_set.documentation.name || "(unnamed)" %></h4>
+
+    <dl>
+      <dt>Selectors</dt>
+      <dd><%= rule_set.selector_css %></dd>
+
+      <dt>Properties</dt>
+      <dd><%= rule_set.declaration_css %></dd>
+
+      <% if rule_set.documentation.formerly %>
+        <dt>Formerly</dt>
+        <dd><%= rule_set.documentation.formerly %></dd>
+      <% end %>
+      
+      <% if rule_set.documentation.deprecated %>
+        <dt>Deprecated</dt>
+        <dd><%= rule_set.documentation.deprecated %></dd>
+      <% end %>
+    </dl>
+
+    <%= rule_set.documentation.sections.to_html %>
+  <% end %>
+<% end %>

data/src/templates/default/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/default/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/default/layout.html.erb

@@ -0,0 +1,26 @@
+<html>
+  <head>
+    <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/default/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/default/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

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: imedo-css_doc
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Thomas Kadauke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Library and Executable that extracts documentation from CSS files.
+email: thomas.kadauke@imedo.de
+executables: 
+- cssdoc
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- src/css_doc/css_writer.rb
+- src/css_doc/document.rb
+- src/css_doc/document_collection.rb
+- src/css_doc/document_documentation.rb
+- src/css_doc/document_handler.rb
+- src/css_doc/document_template.rb
+- src/css_doc/documentation.rb
+- src/css_doc/driver.rb
+- src/css_doc/file_index_template.rb
+- src/css_doc/index_template.rb
+- src/css_doc/rule_set.rb
+- src/css_doc/rule_set_documentation.rb
+- src/css_doc/section.rb
+- src/css_doc/section_documentation.rb
+- src/css_doc/section_index_template.rb
+- src/css_doc/selector_index_template.rb
+- src/css_doc/template.rb
+- src/css_doc.rb
+- src/css_pool/visitors/to_css.rb
+- src/rake/css_doc_task.rb
+- src/templates/default/css_doc.css
+- src/templates/default/document.html.erb
+- src/templates/default/file_index.html.erb
+- src/templates/default/index.html.erb
+- src/templates/default/layout.html.erb
+- src/templates/default/section_index.html.erb
+- src/templates/default/selector_index.html.erb
+has_rdoc: false
+homepage: http://www.imedo.de
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- src
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Documentation generator for CSS files, similar to Javadoc or RDoc.
+test_files: []
+