navGATE 0.1.26 → 0.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec7abf7d93fedce8c746c0e9f3ce13b0484849e0
-  data.tar.gz: fe1dc5feb0b52e1edf3ddabb57a960bdc4f41402
+  metadata.gz: f73da779ffc925061bcf66726faba597354dbf11
+  data.tar.gz: c65d102a4f15a497ae3ed130d689e23b00bc599c
 SHA512:
-  metadata.gz: f603c2b837012a848730dbedcc7106f08221608f3d3da7c08080e6ee035f485f04ff3f65cc6b2dbdea0b5d7aa3a24b41ece2df3a2d77ae8423977303c38edc39
-  data.tar.gz: c980fe5e18d414cd1bb3b0a876e42223d400cac4114fa59a8a430092fd181733de053b849f5d1462bd3f24f8955613da77fda4dd7eb65c9bd139380587a3f5cc
+  metadata.gz: b07cf5303080aea9ba3415ac110183289afb5daa1ce2036fe75cc099144c505cb123927110a23b7b47b5cf193054d40ffe8de85f8d6e3f58cfc82b0efee4c83c
+  data.tar.gz: 581b0cad6e45eca0328a4d0f34d8abe5a81afc827334fbac6ba8d198709c7641bc3d3598b8ae41eb0a693fd7b8e48e10bab166f9b660c0a3c8b42cb427fa5164

data/LICENCE/GPL-2

@@ -0,0 +1,342 @@
+
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., [http://fsf.org/]
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+
+

data/Manifest

@@ -1,3 +1,4 @@
+LICENCE/GPL-2
 Manifest
 Rakefile
 config/build_menu.yml
@@ -8,3 +9,4 @@ lib/navgate/base.rb
 lib/navgate/navgatehelpers.rb
 lib/readme.rdoc
 navGATE.gemspec
+readme.rdoc

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'echoe'
 
 
-Echoe.new('navGATE','0.1.26') do |p|
+Echoe.new('navGATE','0.1.27') 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/navGATE.gemspec

@@ -2,19 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = "navGATE"
-  s.version = "0.1.26"
+  s.version = "0.1.27"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Becker"]
-  s.date = "2013-10-24"
+  s.date = "2013-11-01"
   s.description = "Can create navigation from objects using the nav builder,from database tables or from a yaml file"
   s.email = "mbeckerwork@gmail.com"
   s.extra_rdoc_files = ["lib/navgate.rb", "lib/navgate/base.rb", "lib/navgate/navgatehelpers.rb", "lib/readme.rdoc"]
-  s.files = ["Manifest", "Rakefile", "config/build_menu.yml", "config/initializers/build_menu.rb", "init.rb", "lib/navgate.rb", "lib/navgate/base.rb", "lib/navgate/navgatehelpers.rb", "lib/readme.rdoc", "navGATE.gemspec"]
+  s.files = ["LICENCE/GPL-2", "Manifest", "Rakefile", "config/build_menu.yml", "config/initializers/build_menu.rb", "init.rb", "lib/navgate.rb", "lib/navgate/base.rb", "lib/navgate/navgatehelpers.rb", "lib/readme.rdoc", "navGATE.gemspec", "readme.rdoc"]
   s.homepage = "https://github.com/Thermatix/navGATE"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "navGATE", "--main", "readme.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "navgate"
   s.rubygems_version = "2.0.6"
   s.summary = "Allows the easy creation of navigation with config files"
+  s.license = 'GLP-2'
 end

data/readme.rdoc

@@ -0,0 +1,174 @@
+= navGATE
+
+This gem is provided as is.
+
+This gem allows for the ease of navigation building, from preset lists, from active model databases (eg, categories), from yaml files; but it's not just
+for the ease of use it's also that you can have multiple navigation menus for differant controllers, or the same menu for differant controllers.
+However you want it, it's up to you.
+
+This gem was built with Rails in mind.
+
+
+lastly the gem is up on rubygems.org
+
+==Setup
+in the Application controller you have to <tt> include NavGateHelpers </tt> first.
+
+===For Rails
+You next have to add a before_filter and helper method to the application controller
+
+Just add:
+  helper_method :render_navigation
+  before_filter :make_menu
+
+To your list of filters and helper methods in the application controller, thats it, you can now use the helper method and the gem to build your navigations.
+==For non Rails
+For non rails version of NavGATE the helpers change, instead they work like so:
+
+  make_menu(selection, controller)
+
+  render_navigation(selection, controller, options = nil)
+
+You have to pass the controller (or page it matches) and the current selection,
+in rails they would pass automatically as <tt> params[:controller] </tt> and <tt> params[:selection] </tt> respectively (selection being the currently selected nav item).
+
+==Building the menus
+
+When building the menu there are multiple options available, building the menu is done in  an initializer file in the configs directory.
+
+There are several options you can pass through, if you are building the menu with the object builder directly then two options must be present, those being 'selection' and 'controller', the rest are optional.
+
+Also note, you can pass multiple Navgate::builders as you need, just match them to there controllers and they should render properly.
+===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
+
+<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.
+
+<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". Namespacing is ignored within this gem, it only looks at the controller's name and nothing else when controller matching.
+
+<b>controller</b>: This is used to match the menu to a controller, when deciding which menu to render, it can also be an array of strings; it matches this attribute to the current controller.
+
+<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.
+
+<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.
+
+<b>css_selected</b>: the css override for the selected that's currently selected. if no override is passed then the link is simply not rendered out, as with css_class it overrides the one passed in the view, but only for the selected link
+
+examples:
+
+===Building menu object from scratch
+The default option doesn't have to be the first in the selection list.
+  NAVGATE = Navgate.new do |build|
+    build.navs = [ Navgate::Builder.new do |options|
+            options[:selection] = %w(selection site_settings users images misc)
+            options[:default] = 'users'
+            options[:prefix] = = 'admin'
+            options[:controller] = 'admin_panel'
+            options[:css_class] = 'nav button'
+          end
+    ]
+  end
+
+===Building menu object from database fields
+Be sure to pass it as {model_name: :field}.
+Also note you can pass an array of controllers as well as just a string of one controller which in this case is done via a split command, %w() also works
+
+  NAVGATE = Navgate.new do |build|
+     build.navs = [ Navgate::Builder.new do |options|
+                    options[:selection] = {categories: :title }
+                    options[:prefix] = 'shop_category'
+                    options[:controller] = "front_page side_page about_page".split(" ")
+                    options[:by_id] = true
+                  end
+    ]
+  end
+===Building multiple menus
+
+  NAVGATE = Navgate.new do |build|
+    build.navs = [
+          Navgate::Builder.new do |options|
+            options[:selection] = %w(selection site_settings users images misc)
+            options[:default] = 'users'
+            options[:prefix] = = 'admin'
+            options[:controller] = 'admin_panel'
+            options[:css_class] = 'nav button'
+          end,
+          Navgate::Builder.new do |options|
+            options[:selection] = %w(welcome about_us gallery news)
+            options[:default] = 'news'
+            options[:controller] = 'front_page'
+            options[:css_class] = 'nav button'
+          end
+    ]
+  end
+
+=== 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 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,
+Initializing the object:
+  NAVGATE = Navgate.new do |build|
+    build.navs = "#{Rails.root}/config/build_menu.yml"
+  end
+The yaml file:
+  nav_1:
+    selection: welcome about_us gallery
+    default: welcome
+    prefix: main
+    controller: front_page
+  nav_2:
+    selection: settings users misc
+    default: settings
+    preix: back_end
+    controller: admin_panel
+
+
+==Ignoring Controllers
+Sometimes you're going to want to ignore controllers that don't any gui. Doing that is simple, when you're building the menu just pass an Array to build like so
+  build.ignoring = ['controllers','to','ignore']
+before or after you pass through the navs.
+
+==Rendering the menu
+
+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='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 ':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: :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,
+unless of course you're using multiple menus and some of them don't have css overides then they will take this option up.
+
+==Using the selection to automatically render a matching partial
+
+naveGATE is set up so you can use it to render out a partial using <tt>@selected</tt>, to do this you have to pass a route param of <tt>:selection</tt>
+in the route, then you can use <tt><%= render @selected %></tt> to automatically select either the default selection or the current selection.
+
+That said you don't have use this feature, it will still route to whatever url you set up as a normal url, but <tt>@selected</tt> won't work without <tt>:selection</tt>
+example:
+
+routes.rb
+  get "/:selection", to: "front_page#index"
+  root to: "front_page#index"
+
+front_page/index.html.erb
+  <%= render @selected %>
+
+resulting url
+  host.com/books
+  host.com/games
+
+routes to the root but the partials rendered would be respectively
+  _books.html.erb
+  _games.html.erb
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: navGATE
 version: !ruby/object:Gem::Version
-  version: 0.1.26
+  version: 0.1.27
 platform: ruby
 authors:
 - Martin Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies: []
 description: Can create navigation from objects using the nav builder,from database
   tables or from a yaml file
@@ -21,6 +21,7 @@ extra_rdoc_files:
 - lib/navgate/navgatehelpers.rb
 - lib/readme.rdoc
 files:
+- LICENCE/GPL-2
 - Manifest
 - Rakefile
 - config/build_menu.yml
@@ -31,8 +32,10 @@ files:
 - lib/navgate/navgatehelpers.rb
 - lib/readme.rdoc
 - navGATE.gemspec
+- readme.rdoc
 homepage: https://github.com/Thermatix/navGATE
-licenses: []
+licenses:
+- GLP-2
 metadata: {}
 post_install_message: 
 rdoc_options: