README.md in rails_admin_cms-0.0.6 vs README.md in rails_admin_cms-0.0.7
- old
+ new
@@ -6,32 +6,67 @@
RailsAdmin...
## View helpers
-Seamlessly adds some useful classes to the body tag within your layout in order to scope your css/js : `cms-template-name`, `controller-name`, `controller-name-action-name`, `locale` and `edit-mode`.
+There is an example of a common template using some of the cms view helpers:
```ruby
-# ...
+<!DOCTYPE html>
+<html>
+<head>
+ <title><%= title = cms_title('AppRailsAdminCMS') %></title>
+ <%= cms_meta_data_tags %>
+ <%= cms_meta_og_tags(title) %>
+ <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
+ <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+ <%= csrf_meta_tags %>
</head>
-<body class="<%= cms_body_class 'other-class', 'etc' %>">
-# ...
+<body class="<%= cms_body_class('shop', 'cart') %>">
+
+<%= cms_flash_messages %>
+<div>
+ <%= cms_locale_selector %>
+</div>
+<div>
+ <%= cms_link_to_edit_mode if current_admin? %>
+</div>
+
+<%= yield %>
+
</body>
</html>
```
+What's going on:
+
+1. `cms_title` outputs a title tag defined by either a view element or a default one passed as argument
+1. `cms_meta_data_tags` outputs the meta keywords + description tags defined by either a page/form object or a complete default one passed as argument
+1. `cms_body_class` outputs
+1. `cms_flash_messages`
+1. `cms_locale_selector`
+1. `cms_link_to_edit_mode`
+1. `current_admin?`
+
## TODO
* Documentation
* Generators
-* Setup PaperTrail
+* Setup CanCanCan
* Setup Globalize on Form::Field and Form::Email
+* Improve breadcrumbs functionality
+* Link to image edit in edit form (for cropping)
+* Confirmation email for forms
* Published Pages/Forms
* Mailchimp integration
+* Redirector
+* Setting fetched from Yaml file
+* Pretty Url for Viewable::LinkPresenter#url as file_url
+* Fetch image size based on Screen size
* More Specs
## Notes
gem 'dalli-delete-matched' needed if Memcached is used
-This project rocks and uses MIT-LICENSE.
\ No newline at end of file
+This project rocks and uses MIT-LICENSE.