README.rdoc in menu_builder-0.4.3 vs README.rdoc in menu_builder-0.4.4
- old
+ new
@@ -1,38 +1,33 @@
= menu_builder
-With this gem/plugin you get a helper to define menus and also can control the current item of menu
-in controller. Easy like always should be!
+A simple helper to make easier the process of highlighting menu items based on current
+url. The goal here is to reduce the amount of if/elses you would typically need in your
+views to achieve the same results.
== Instalation
-Rail2
-
- gem.config "menu_builder", :version => '0.2.1'
-
-Rails3
+ gem "menu_builder"
- gem "menu_builder", '>=0.4.1'
-
== Usage
-Just install the plugin and see the example below:
+First flag at class level in your Controller which item should be highlighted
-== Example
-
=== Controller
class DashboardController < ApplicationController
menu_item :mydashboard
...
end
-You can also change to menu item in action level instead of class level:
+You can also change to menu item at action level instead of class level. This
+option is helpful when you have most of the actions pointing to one menu item
+but a few actions pointing to another.
class DashboardController < ApplicationController
menu_item :mydashboard
-
+
def prices
menu_item :prices
...
end
end
@@ -57,89 +52,14 @@
<li><a href="/projects">Projects</a></li>
</ul>
==== Blocks for content
-Also is possible to pass blocks instead of simple strings for content.
-In this way you can create menu item with icons. Like below:
+You can also pass blocks:
<%= menu do |m| %>
<% m.account account_path do %>
<%= image_tag "icon.jpg" /> Accounts
<% end %>
<%= m.users "Users", users_path %>
<%= m.posts "Posts", posts_path %>
<% end %>
-
-== CSS and HTML
-
-This plugin don't came with any kind of asset like image or css.
-The layout of menu depends of your css. You can use any kind of CSS technique you want,
-like below:
-
- <html>
- <head>
- <style type="text/css" charset="utf-8">
- #header ul { font-family:Tahoma; position: absolute; margin:0; list-style:none; }
- #header li { display:inline; margin:0; padding:0; }
-
- #header a {
- float:left;
- background: url(corner_left.jpg) no-repeat left top;
- margin:0;
- padding:0 0 0 4px;
- text-decoration:none;
- }
- #header a span {
- float:left;
- display:block;
- background: url(corner_right.jpg) no-repeat right top;
- padding:4px 14px 4px 6px;
- color:#FFF;
- }
-
- #header a:hover span { color:#FFF; }
- #header a:hover { background-position:0% -43px; }
- #header a:hover span { background-position:100% -43px; }
- #header #current a { background-position:0% -43px; }
- #header #current a span { background-position:100% -43px; }
- </style>
- </head>
-
- <body>
- <div id="header">
- <ul>
- <li><a href="#"><span>Home</span></a></li>
- <li><a href="#"><span>Quem Somos</span></a></li>
- <li><a href="#"><span>Portifólio</span></a></li>
- <li><a href="#"><span>Contato</span></a></li>
- </ul>
- </div>
- </body>
- </html>
-
-You can read a full tutorial and see a working demo of above in this
-{link}[http://www.google.com/translate?langpair=pt|en&u=http://blog.areacriacoes.com.br//2009/1/23/bordas-arredondas-para-menus-em-abas]
-
-== Author
-
-Authors:: Daniel Lopes
-Blog:: {http://blog.areacriacoes.com.br}[http://blog.areacriacoes.com.br]
-Github:: {http://github.com/danielvlopes}[http://github.com/danielvlopes]
-Twitter:: {danielvlopes}[http://blog.areacriacoes.com.br]
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
- future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-* Send me a pull request :)
-
-== License
-
-MenuBuilder is released under the MIT License.
-
-== Copyright
-
-Copyright (c) 2010 Daniel Lopes. See LICENSE for details.
\ No newline at end of file