origen_doc_helpers 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e54b98be52c3c109ba512fb7a63fa6767b7b57d
-  data.tar.gz: 25ba92c48b8cf8a858d6d53968d5f0d28f682bbc
+  metadata.gz: 48520b052df0e116bbf93270ef15f94264871673
+  data.tar.gz: 0973fb0a443a176ecb3496ef4ac45345b6482e2e
 SHA512:
-  metadata.gz: acffc77fa08ae7e206e7c18fb4b123596611a0c3a949b6fb6a3294cb3d91ae5740400ad71cf768960d921a8f23f3b61fd642621a2f92e30fcf122678e0ce2caf
-  data.tar.gz: e3e12e2e3a7311e37914a762f18eaa60aef34bda254b2212a67df5f8c5d9df7c5ba9510ee2696309e6ed829a079bf345c50838d7a9ebfbdc6f24d7d7d08b60cc
+  metadata.gz: e71e63f47668884cd275a504c194bc7f474f2751b66e307d21f0cab105147a380f16185d07f7192f7df916c5b64bfb1940210bed9c0f2c21b44e0c7f6a53f7d4
+  data.tar.gz: 53eebddf7b35d85d714c6342046ea9cb8c394db4f8fcbcfd49c809f834f5d09f6ff539a6fbac8cedd3200043ce1d8169eeb2ecb1ff5c4af8ab6cf6e84dc8f69d

data/config/version.rb

@@ -1,7 +1,7 @@
 module OrigenDocHelpers
   MAJOR = 0
   MINOR = 4
-  BUGFIX = 2
+  BUGFIX = 3
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/templates/shared/_searchable.html.erb

@@ -1,4 +1,5 @@
 % options[:root] ||= "docs"
+% options[:path_separator] ||= "_"
 % pdf_filename = ::OrigenDocHelpers::PDF.register(options)
 
 <div class="row">
@@ -28,7 +29,7 @@
               <div class="panel-body">
                 <ul class="nav nav-list">
 %     sections.each do |tab, section|
-% paths = tab.to_s.split("_")
+% paths = tab.to_s.split(options[:path_separator])
 <li class="<%= tab == _resolve_tab(options) ? 'active' : '' %>"><a href="<%= path "/#{_root_path(options)}/#{paths[0]}/#{paths[1]}" %>"><%= section %></a></li>
 %     end          
                 </ul>
@@ -38,7 +39,7 @@
 %   else          
           <ul class="nav nav-list">
 %     sections.each do |tab, section|
-% paths = tab.to_s.split("_")
+% paths = tab.to_s.split(options[:path_separator])
 <li class="<%= tab == _resolve_tab(options) ? 'active' : '' %>"><a href="<%= path "/#{_root_path(options)}/#{paths[0]}/#{paths[1]}" %>"><%= section %></a></li>
 %     end          
            </ul>

data/templates/web/helpers/searchable/intro.md.erb

@@ -30,6 +30,20 @@ the document with title "Second Item" should live in <code>_documents_root_/topi
 By default the root is <code>"#{Origen.root}/templates/web/docs"</code> but this can be overridden
 by supplying a <code>:root</code> option which should describe the relative path from <code>"#{Origen.root}/templates/web"</code>.
 
+By default, the sub_hash key will be split by the '_' character to find the <code>_directory_/_file_</code>
+as shown above but this can be overridden by supplying the <code>:path_separator</code> option.  For example,
+using <code>path_separator: '__'</code> (double underscore) with the index used below would result in the
+the document with title "Second Item" living now at <code>_documents_root_/topic1/second_item.md.erb</code>
+
+~~~ruby
+index = {}
+index["Topic 1"] = {
+  topic1__first_item: "First Item",
+  topic1__second_item: "Second Item",
+}
+~~~
+
+
 ### The Layout Helper
 
 A layout helper is provided to include a document in the search and wrap it
@@ -47,17 +61,22 @@ The <code>:index</code> option is mandatory, but the following are optional:
 
 ~~~text
 %#:pdf_title - PDF creation is enabled by providing a title via this option, e.g. "My Application Guides"
-:heading   - Each wrapped document will have the heading (e.g. "First Item") inserted at the top of the page,
-             to override it supply this option. A common example would be if the topic is long and
-             so an abbreviated version has been used in the index. e.g. "First Item and Other Stuff"
-:topic     - Each wrapped document will have the topic (e.g. "Topic 1") inserted at the top of the page,
-             to override it supply this option. A common example would be if the topic is long and
-             so an abbreviated version has been used in the index. e.g. "Topic 1 and Other Stuff"
-:root      - override the top-level folder containing your documents, e.g. "tutorials/guides"
-:tab       - the helper should automatically work out what tab to select for each document, however
-             if it is struggling for some reason you can force it by supplying the hash key from the
-             index that the given document should be associated with, e.g. :topic1_item1
-:prompt    - the search box prompt, by default is "Search these docs..."
+:heading           - Each wrapped document will have the heading (e.g. "First Item") inserted at 
+                     the top of the page, to override it supply this option. A common example would 
+                     be if the topic is long and so an abbreviated version has been used in the 
+                     index. e.g. "First Item and Other Stuff"
+:topic             - Each wrapped document will have the topic (e.g. "Topic 1") inserted at the top
+                     of the page, to override it supply this option. A common example would be if 
+                     the topic is long and so an abbreviated version has been used in the 
+                     index. e.g. "Topic 1 and Other Stuff"
+:root              - override the top-level folder containing your documents, e.g. "tutorials/guides"
+:tab               - the helper should automatically work out what tab to select for each document, 
+                     however if it is struggling for some reason you can force it by supplying the
+                     hash key from the index that the given document should be associated 
+                     with, e.g. :topic1_item1
+:prompt            - the search box prompt, by default is "Search these docs..."
+:path_separator    - override how the sub-hash key in the index will be split (which character will 
+                     be used) to generate the location of the document
 ~~~
 
 ### Incorporating in Your Own Layout

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen