origen_doc_helpers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d89354a4f13aed042c3fdbb0fb42ef325db4612f
-  data.tar.gz: 19c9c7af0631ba313222d0d485b8e8707b7bdf0f
+  metadata.gz: 6d464f725c392838e29ed436e67b9f774fcbf609
+  data.tar.gz: 71856ff7ab2a8a1541b5ec888782570528955a67
 SHA512:
-  metadata.gz: 278a9668b54e8a4bd8243be6e994bc168c23130d5b31025c3c26b28051ab521c6d843e6c52337895f80b2d98dce79725400c24dea783f368907e37a3d45b17bc
-  data.tar.gz: 4ec1d7913206ac96248ebe5cc602d7c8c5d1be984dedf28f316c2ffa880c350833be4fb768830a82a442da689a5658a79b5f3ff5aa553abf58d6c89ace470c8e
+  metadata.gz: a8d4a476b525cd30887bfcf84b8c250ee09d4eb7df1cfbf4b9a8d2aa968ac15c23405af4e495e0662e489130b6bd0a1929a1f0bd5dd6c8eda91b1b2bbd739e1d
+  data.tar.gz: 14fe243108aade7cb9aa3353e510f4f13f3f7242cd58e86574fdeb992c0c067858c843a7c9ec03fbd1919d5cc7cb5443af76029ca809aad34857b2fda6dbe87e

data/config/application.rb

@@ -9,6 +9,7 @@ class OrigenDocHelpersApplication < Origen::Application
   # command) fill in these attributes.
   config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/doc_helpers"
   config.web_domain = "http://origen-sdk.org/doc_helpers"
+  config.disqus_shortname = "origen-sdk"
 
   config.semantically_version = true
 

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenDocHelpers
   MAJOR = 0
-  MINOR = 1
+  MINOR = 2
   BUGFIX = 0
   DEV = nil
 

data/lib/helpers.rb

@@ -51,6 +51,50 @@ END
         end
         include Yammer
 
+        module Disqus
+          def disqus_comments(options = {})
+            options = {
+              disqus_shortname: Origen.app.config.disqus_shortname || 'origen-sdk'
+            }.merge(options)
+
+            <<END
+<div style="position: relative">
+  <hr>
+  <h4>Comments</h4>
+</div>
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+    /* * * CONFIGURATION VARIABLES * * */
+    var disqus_shortname = '#{options[:disqus_shortname]}';
+    var disqus_title;
+    var disqus_url = 'http://' + window.location.hostname + window.location.pathname;
+
+    disqus_title = $("h1").text();
+    if (disqus_title.length == 0) {
+      disqus_title = $("h2").text();
+    }
+    if (disqus_title.length == 0) {
+      disqus_title = $("h3").text();
+    }
+    if (disqus_title.length == 0) {
+      disqus_title = $("title").text();
+    } else {
+      disqus_title = disqus_title + ' (' + $("title").text() + ')';
+    }
+
+    /* * * DON'T EDIT BELOW THIS LINE * * */
+    (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
+END
+          end
+        end
+        include Disqus
+
         # Helpers for the register diagrams
         module RegisterHelpers
           # Returns true if some portion of the given bits falls

data/templates/web/examples.md.erb

@@ -10,7 +10,8 @@ that should be used to generate it.
 
 * [Searchable Documents](<%= path "/examples/searchable/intro" %>)
 * [Register Descriptions](<%= path "/examples/register" %>)
-* [Yammer Widgets](<%= path "/examples/yammer" %>)
+* [Yammer Comments](<%= path "/examples/yammer" %>)
+* [Disqus Comments](<%= path "/examples/disqus" %>)
 
 ### Test Engineering
 

data/templates/web/examples/disqus.md.erb

@@ -0,0 +1,54 @@
+% render "../layouts/examples.html" do
+
+# Disqus Comments
+
+These helpers make it easy to drop a [Disqus](https://disqus.com/) comments section at the
+bottom of your pages, just like [the one below](<%= path "examples/disqus/#Comments" %>).
+
+Note that such comments will be externally visible and therefore **this should not be used for
+company internal applications/web pages**. For similar functionality within a company you
+can use [Yammer comments](<%= path "examples/yammer" %>) instead if your company uses the
+Office 365 suite.
+
+## Community Selection
+
+Any comments made on a web page will be associated with a specific community on Disqus where
+they can be collectively viewed and moderated, for example here is
+[the Origen SDK Disqus community](https://disqus.com/home/forum/origen-sdk/).
+
+If your web page is about a plugin/application that will be of general interest within the Origen
+community, then you are welcome to use the Origen SDK Disqus community which will be selected
+by default.
+
+If your pages are more about your specific application domain, then you should
+[create you own community channel](https://disqus.com/home/channels/new/) instead.
+
+Your new community can be associated with your application by setting the following
+app configuration attribute:
+
+~~~ruby
+# config/application.rb
+config.disqus_shortname = "my-community"
+~~~
+
+Alternatively this parameter can be passed directly to the comments helper as shown
+below.
+
+## Adding Comments
+
+To include disqus comments simply add this to the bottom of any given page, or your
+layout file to add comments to every page:
+
+~~~eruby
+<%= "<" + "%= disqus_comments %" + ">" %>
+~~~
+
+The following options are available:
+
+~~~text
+:disqus_shortname - Specify the disqus forum to associate your comments with. This will fall back to the value returned by
+                    RGen.app.config.disqus_shortname, and failing that will fall back to 'origen-sdk' to select the Origen
+                    community channel.
+~~~
+
+% end

data/templates/web/examples/yammer.md.erb

@@ -1,6 +1,6 @@
 % render "../layouts/examples.html" do
 
-# Yammer Widgets
+# Yammer Comments
 
 These helpers wrap the [Yammer Embed API](https://developer.yammer.com/connect/)
 which allows Yammer feeds to be embedded in any web page.

data/templates/web/layouts/_basic.html.erb

@@ -1,5 +1,6 @@
 ---
 title: <%= options[:title] || Origen.config.name %>
+analytics: UA-64455560-1
 ---
 <%= render "templates/web/partials/navbar.html", :tab => options[:tab] %>
 

data/templates/web/layouts/_doc.html.erb

@@ -1,5 +1,6 @@
 ---
 title: <%= options[:title] || Origen.config.name %>
+analytics: UA-64455560-1
 ---
 <%= render "partials/navbar.html", :tab => :examples %>
 
@@ -19,4 +20,6 @@ title: <%= options[:title] || Origen.config.name %>
 
 <%= yield %>    
 
+<%= disqus_comments %>
+
 % end

data/templates/web/layouts/_examples.html.erb

@@ -2,4 +2,6 @@
 
 <%= yield %>
 
+<%= disqus_comments %>
+
 % end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.2.1
 description: 
 email:
 - stephen.f.mcginty@gmail.com
@@ -52,6 +58,7 @@ files:
 - templates/shared/_spec.html.erb
 - templates/shared/test/_flow.md.erb
 - templates/web/examples.md.erb
+- templates/web/examples/disqus.md.erb
 - templates/web/examples/register.md.erb
 - templates/web/examples/searchable/intro.md.erb
 - templates/web/examples/searchable/page2.md.erb
@@ -86,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Snippets and helpers for creating Origen web documents