navGATE 0.1.08 → 0.1.09.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b26ae709b4597d50421cf3055f65fe31d447312
-  data.tar.gz: 674abf588d84a3fa2a79e293195bb6a833c3681b
+  metadata.gz: abaeaa3dc78a47c962d5960c71cfc334d8788a63
+  data.tar.gz: fad4de942712038782d6377748a6982361b8c262
 SHA512:
-  metadata.gz: d3d98b92d2ccfabc90036fadd952f8e91f7df1085cf80bc7ae3deec7e9afac55a2b24682f75855e2b3d8ce8c8869fb16d1da68627c6655ed84a750857fa1ed65
-  data.tar.gz: b24768f38eb22aa1a27ed38163c588970a00a718922d3269fa29610c1556eaef7efba41419131ca873a76530e5d2325693a526571809883a1d640eff652c587d
+  metadata.gz: 337d06a572b0b81a662aa2c514c34ab00394f68920655b13e1b65a9f1dc4beac8060119bb3d70435d760732943d4ec101daa3c522319b85bca77382fba99d7df
+  data.tar.gz: d952047b11e3221e5721d52d64d05b0f6c935e7311cf238ee759149c7d27c99b96661fb3d92528600cc1f955865dc6d85c6488e530c4c1bd819f98cb5a0cdd5e

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'echoe'
 
 
-Echoe.new('navGATE','0.1.08') do |p|
+Echoe.new('navGATE','0.1.09.1') do |p|
   p.summary = "Allows the easy creation of navigation with config files"
   p.description = "Can create navigation from objects using the nav builder,from database tables or from a yaml file"
   p.url = "https://github.com/Thermatix/navGATE"

data/lib/navgate.rb

@@ -64,7 +64,7 @@ class Navgate
 
       def styling options
         if options
-          return "<br>" if options[:styling] == :verticle
+          return "<br>" if options[:styling] == :vertical
           return options[:styling] if options[:styling]
         end
         " "

data/lib/readme.rdoc

@@ -1,12 +1,11 @@
 = navGATE
 
-This gem is provided as is, please read through the intializer file "build_menu.rb" for examples on how you can use this gem to build a nav menu.
+This gem is provided as is, please read through the initializer file "build_menu.rb" for examples on how you can use this gem to build a nav menu.
 
 This gem was built with Rails in mind.
 
-note: this is my first gem, I am still trying to set it up, so be carefull when downloading this.
-Also I've included the extra files needed to get it working in there respective directories, eg, the code in 'Applicationhelper' needs to go in 'Applicationhelper'.
-I've tried to to make it easy to install but I'm still not sure how to get those things into the right files automaticly, if some one could point me in the right direction, I'd be happy to make the needed changes.
+note: this is my first gem, I am still trying to set it up, so be careful when downloading this.
+
 lastly the gem is up on rubygems.org
 ==Building the menus
 
@@ -17,20 +16,20 @@ There are several options you can pass through, if you are building the menu wit
 Also note, you can pass multiple Navgate::builders as you need, just match them to there controllers and they should render properly.
 ===Options
 
-selection: This is used to build the menu options.
+<b>selection</b>: This is used to build the menu options.
 There are two ways to use this, the first is to use an array of strings containing the menu options a person can select; the second is to pull from a database table, to do this pass a hash with the key being the name of the model and it's value being the field containing it's name
 
-default: This is used to give the menu a default selection for when the user has not selected anything. Pass a string containing the name of the defualt selection, if no string is passed then the first item from selection is used.
+<b>Default</b>: This is used to give the menu a default selection for when the user has not selected anything. Pass a string containing the name of the default selection, if no string is passed then the first item from selection is used.
 
-prefix: This is used when you have a prefix before the target in the url, eg: if your links render out as "host.com/books" without a prefix; with a prefix of 'shelf' it will render out as "host.com/shelf/books". This is not for namespacing, for namespacing see the namespace option.
+<b>prefix</b>: This is used when you have a prefix before the target in the URL, eg: if your links render out as "host.com/books" without a prefix; with a prefix of 'shelf' it will render out as "host.com/shelf/books". This is not for name spacing, for name spacing see the namespace option.
 
-namespace: This is used for when you have namespacing. It works like prefix however unlike prefix it will also search for the controller within the namespace unlike prefix which doesn't.
+<b>namespace</b>: This is used for when you have name spacing. It works like prefix however unlike prefix it will also search for the controller within the namespace unlike prefix, which doesn't.
 
-controller: This is used to match the menu to a controller, when deciding which menu to render, it matches this attribute to the current controller. If you have namespacing, the 'namespace' options MUST be used before the 'controller' option otherwise it won't recognise the namespace
+<b>controller</b>: This is used to match the menu to a controller, when deciding which menu to render, it matches this attribute to the current controller. If you have name spacing, the 'namespace' options <em>MUST</em> be used before the 'controller' option otherwise it won't recognize the namespace
 
-by_id: This is used when you are using a database model to build the menu and you want to link with IDs rather then the selection list. To use it simply set it to true.
+<b>by_id</b>: This is used when you are using a database model to build the menu and you want to link with IDs rather then the selection list. To use it simply set it to true.
 
-css_class: This is used when you want to hard code the CSS class selector into the menu rather then from the view
+<b>css_class</b>: This is used when you want to hard code the CSS class selector into the menu rather then from the view
 
 examples:
 
@@ -62,7 +61,7 @@ Be sure to pass it as {model_name: :field}
 
 
 === Using a yml file to build the menu
-There is also a third option to build the menu, you can use a structured yml file, there is an example yaml file in the config dirrectory called "build_menu.yml".
+There is also a third option to build the menu, you can use a structured yml file, there is an example yaml file in the config directory called "build_menu.yml".
 when using this method you are unable to use a database model to create the menu.
 
 ===Building from yaml file,
@@ -87,16 +86,18 @@ The yaml file:
 
 ==Rendering the menu
 
-To render the menu use the provided helper "render_navigation(options)"
+To render the menu use the provided helper <tt>render_navigation(options)</tt>;
 options is a hash that is used to build any html options you might want such as
-class, it can also take two extra options, 'styling:' and 'wrap:'.
+'class='some_css_class', it can also take two extra options, 'styling:' and 'wrap:'.
 
 ===Options
 
-Styling: This is how the navigation can be styled it can either be ':verticle' or a character that you wish to use for spacing such as '|' or ':' and so on, it can only be verticle or a spaceing character.
+Styling: This is how the navigation can be styled, it can either be ':vertical’ or a character that you wish to use for spacing such as '|' or ':' and so on, it can only be vertical or a spacing character.
+
 Wrap: This allows you to wrap each link in a html tag, wrap can itself take two differant options, either a string containing the tag's name (without "<>", only the tag name) or an Array containing the tag name and it's class.
 
 example:
-  render_navigation({:class => "'nav button'", styling: :verticle, wrap: ['li','test']}) %>
+  render_navigation({:class => "'nav button'", styling: :vertical, wrap: ['li','test']}) %>
 
 note: There is no point in passing a class here if you have one set when you first build the menu, it will just be overridden.
+

data/navGATE.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "navGATE"
-  s.version = "0.1.08"
+  s.version = "0.1.09.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Becker"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navGATE
 version: !ruby/object:Gem::Version
-  version: 0.1.08
+  version: 0.1.09.1
 platform: ruby
 authors:
 - Martin Becker