origen_doc_helpers 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6d464f725c392838e29ed436e67b9f774fcbf609
4
- data.tar.gz: 71856ff7ab2a8a1541b5ec888782570528955a67
3
+ metadata.gz: cf34c91d486dacbfe803df15a92f61e2ee123721
4
+ data.tar.gz: 36464708c9f146c5bb996b61fda903fb762835ff
5
5
  SHA512:
6
- metadata.gz: a8d4a476b525cd30887bfcf84b8c250ee09d4eb7df1cfbf4b9a8d2aa968ac15c23405af4e495e0662e489130b6bd0a1929a1f0bd5dd6c8eda91b1b2bbd739e1d
7
- data.tar.gz: 14fe243108aade7cb9aa3353e510f4f13f3f7242cd58e86574fdeb992c0c067858c843a7c9ec03fbd1919d5cc7cb5443af76029ca809aad34857b2fda6dbe87e
6
+ metadata.gz: f245397db0e418b8ec7cf6d2d64aead841829301867fffbe4dc38397aa6a3f2d4be23927eb18a6f443b8ae5f8a2d00c0d43c68a5c40876d6b5baedc6710fed53
7
+ data.tar.gz: 672d1a50f6cbce7a43364de6ea8d84af5cd9b0907f88bf9a552510e4658c287dd32d378a882b5551d42db61eeece9492f349dad356ac64271924c5874fd2b6f8
data/config/version.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  module OrigenDocHelpers
2
2
  MAJOR = 0
3
3
  MINOR = 2
4
- BUGFIX = 0
4
+ BUGFIX = 1
5
5
  DEV = nil
6
6
 
7
7
  VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
data/lib/helpers.rb CHANGED
@@ -57,6 +57,11 @@ END
57
57
  disqus_shortname: Origen.app.config.disqus_shortname || 'origen-sdk'
58
58
  }.merge(options)
59
59
 
60
+ # Created this other channel in error, don't use it
61
+ if options[:disqus_shortname].to_s == 'origensdk'
62
+ options[:disqus_shortname] = 'origen-sdk'
63
+ end
64
+
60
65
  <<END
61
66
  <div style="position: relative">
62
67
  <hr>
@@ -1,6 +1,6 @@
1
1
  module OrigenDocHelpers
2
2
  class DocInterface
3
- include Origen::Tester::Doc::Generator
3
+ include OrigenTesters::Doc::Generator
4
4
 
5
5
  def initialize(_options = {})
6
6
  end
@@ -7,7 +7,7 @@
7
7
  <div id="search">
8
8
  <form style="margin-bottom: 15px;">
9
9
  <div class="input-group">
10
- <input class="form-control" type="search" placeholder="Search these docs..."/>
10
+ <input class="form-control" type="search" placeholder="<%= options[:prompt] || 'Search these docs...' %>"/>
11
11
  <span class="input-group-btn">
12
12
  <button type="submit" class="btn btn-search">GO!</button>
13
13
  </span>
@@ -57,6 +57,7 @@ The <code>:index</code> option is mandatory, but the following are optional:
57
57
  :tab - the helper should automatically work out what tab to select for each document, however
58
58
  if it is struggling for some reason you can force it by supplying the hash key from the
59
59
  index that the given document should be associated with, e.g. :topic1_item1
60
+ :prompt - the search box prompt, by default is "Search these docs..."
60
61
  ~~~
61
62
 
62
63
  ### Incorporating in Your Own Layout
@@ -6,7 +6,7 @@ Documentation of an Origen-generated test program can be created as follows (req
6
6
  documentation interface to be setup):
7
7
 
8
8
  ~~~eruby
9
- <%= "%" %> prog = Origen::Tester::Doc.generate_program_model("program/probe_1.rb", :target => "default")
9
+ <%= "%" %> prog = OrigenTesters::Doc.generate_program_model("program/probe_1.rb", :target => "default")
10
10
 
11
11
  <%= "<" + "%= render \"doc_helpers/test/flow.md\", :heading => \"Probe 1\", :program => prog, :flow => :probe_1_flow %" + ">" %>
12
12
  ~~~
@@ -28,7 +28,7 @@ Additionally these options are available to customize the output:
28
28
 
29
29
  Here is a live example:
30
30
 
31
- % prog = Origen::Tester::Doc.generate_program_model("program/probe_1.rb", :target => "debug")
31
+ % prog = OrigenTesters::Doc.generate_program_model("program/probe_1.rb", :target => "debug")
32
32
 
33
33
  <%= render "templates/shared/test/flow.md", :heading => "Probe 1", :program => prog, :flow => :probe_1_flow %>
34
34
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: origen_doc_helpers
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stephen McGinty
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-07-23 00:00:00.000000000 Z
11
+ date: 2015-09-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: origen
@@ -30,6 +30,20 @@ dependencies:
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
32
  version: 0.2.1
33
+ - !ruby/object:Gem::Dependency
34
+ name: origen_testers
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: '0'
40
+ type: :development
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
33
47
  description:
34
48
  email:
35
49
  - stephen.f.mcginty@gmail.com
@@ -93,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
93
107
  version: 1.8.11
94
108
  requirements: []
95
109
  rubyforge_project:
96
- rubygems_version: 2.4.5
110
+ rubygems_version: 2.2.2
97
111
  signing_key:
98
112
  specification_version: 4
99
113
  summary: Snippets and helpers for creating Origen web documents