publish_my_data 1.2.4 → 1.3.0

data/app/assets/stylesheets/publish_my_data/core/5000-styling.scss

@@ -100,4 +100,37 @@ code.scrolling{
 .uri{
 	font-family: Monaco, Consolas, "Lucida Console", monospace;
 	word-break: break-all;
+}
+
+/* 5100 - DOCUMENTATION
+   ========================================================================== */
+
+.pmd.documentation{
+
+	header ul{
+		list-style-type: none;
+		padding:0;
+	}
+	
+	section {
+		padding: 0 0 $pmdconfig_space_vertical 0;
+	}
+
+	section ul {
+		padding: 0 0 0 10px;
+	}
+
+	.subsubsection{
+		margin-left:2em;
+	}
+
+	h2{
+		width:100%;
+		border-bottom:2px solid black;
+	}
+
+	h4{
+		margin-top: 22px;
+	}
+
 }

data/app/helpers/publish_my_data/application_helper.rb

@@ -1,6 +1,12 @@
 module PublishMyData
   module ApplicationHelper
 
+    def inside_layout(layout, &block)
+      layout = "layouts/#{layout}" unless layout =~ %r[\Alayouts/]
+      content_for :publish_my_data_content, capture(&block)
+      render template: layout
+    end
+
     def bodyclass(c)
       @bodyclass = c;
     end

data/app/helpers/publish_my_data/documentation_helper.rb

@@ -0,0 +1,70 @@
+module PublishMyData
+  module DocumentationHelper
+
+    def documentation_section(title, &block)
+      # update global data structure
+      if (@documentation_sections.nil?)
+        @documentation_sections = Array.new()
+      end
+      @documentation_sections.push({name:title,subsections:[]})
+      # output html
+      content_tag :section, id:section_title_to_id(title) do
+        concat content_tag :h2, title
+        concat capture &block
+      end
+    end
+
+    def documentation_subsection(title, &block)
+      # update global data structure
+      @documentation_sections.last[:subsections].push({name:title,subsubsections:[]})
+      # output html
+      content_tag :div, class:"subsection", id:section_title_to_id(title) do
+        concat content_tag :h3, title
+        concat capture &block
+      end
+    end
+
+    def documentation_subsubsection(title, &block)
+      # update global data structure
+      @documentation_sections.last[:subsections].last[:subsubsections].push({name:title,subsubsections:[]})
+      # output html
+      content_tag :div, class:"subsubsection", id:section_title_to_id(title) do
+        concat content_tag :h4, title
+        concat capture &block
+      end
+    end
+
+    # generate a block level code element - if you want inline code just do <code> whatever </code>
+    # note that language isn't used as yet
+    def codeblock(language, &block)
+      content_tag :code, class:"block #{language}" do
+        capture &block
+      end
+    end
+
+    # generate a *multiline* block of code with indentation.
+    # eg
+    #
+    #     = codeblock_pre "c" do
+    #       = preserve do
+    #        :escaped
+    #           void main(){
+    #             ...indented code ...
+    #           }
+    # use codeblock(language, &block) if you don't need to preserve whitespace
+    def codeblock_pre(language, &block)
+      content_tag :code, class:"block #{language} pre" do
+        capture &block
+      end
+    end
+
+    def section_title_to_id(title)
+      title.parameterize
+    end
+
+    def docs_inline_link(clickable,title)
+      link_to clickable, "##{section_title_to_id(title)}"
+    end
+
+  end
+end

data/app/views/layouts/publish_my_data/application.html.haml

@@ -1,3 +1,12 @@
-You need to make an layouts/publish_my_data/application.html.haml (or erb) template in your app!
+= inside_layout 'application' do
 
-= render template: 'layouts/publish_my_data/pmd_layout'
+	%main.pmd
+		= render 'publish_my_data/stripes/subnav'
+		= render 'publish_my_data/stripes/status'
+		
+		%article
+			= yield
+			= render 'publish_my_data/stripes/formats'
+		
+		= render 'publish_my_data/stripes/footer'
+		= render 'publish_my_data/shared/google_analytics'

data/app/views/layouts/publish_my_data/docs.html.haml

@@ -0,0 +1,19 @@
+= inside_layout 'application' do
+
+	%main.pmd.documentation
+		= render 'publish_my_data/stripes/subnav'
+		= render 'publish_my_data/stripes/status'
+
+		%article
+			%header
+				=fullwidth do
+					= yield :docs_intro
+				=fullwidth do
+					- # for now, inline - in future, perhaps in a sidebar or something...
+					= yield :docs_contents
+			.content
+				=fullwidth do
+					= yield
+
+		= render 'publish_my_data/stripes/footer'
+		= render 'publish_my_data/shared/google_analytics'