diff --git a/apps/web_theme/media b/apps/web_theme/media deleted file mode 160000 index c4159791f9..0000000000 --- a/apps/web_theme/media +++ /dev/null @@ -1 +0,0 @@ -Subproject commit c4159791f935311e800303a80e7deef0e7b99d21 diff --git a/apps/web_theme/media/LICENSE b/apps/web_theme/media/LICENSE new file mode 100644 index 0000000000..886955c85a --- /dev/null +++ b/apps/web_theme/media/LICENSE @@ -0,0 +1,21 @@ +== MIT License + +Copyright (c) 2009, Andrea Franz - (http://gravityblast.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/apps/web_theme/media/README.md b/apps/web_theme/media/README.md new file mode 100644 index 0000000000..0946094ea9 --- /dev/null +++ b/apps/web_theme/media/README.md @@ -0,0 +1,159 @@ +Web App Theme +============= + +Web App Theme is a rails generator by [Andrea Franz](http://gravityblast.com) that you can use to generate admin panels quickly. +Inspired by cool themes like [Lighthouse](http://lighthouseapp.com/), [Basecamp](http://basecamphq.com/), [RadiantCMS](http://radiantcms.org/) and others, +it wants to be an idea to start developing a complete web application layout. + +Installation +------------ + +You can use web-app-theme >= 0.6.2 with Rails 3. If you want to use it with rails 2, use web-app-theme 0.5.3 +Specify the web-app-theme gem in your Gemfile, only for :development and :test + + group :development, :test do + gem 'web-app-theme', '>= 0.6.2' + end + +Usage +----- + +### Theme Generator + +Used without parameters, it generates the layout inside the application.html.erb file using the default theme. + + rails g web_app_theme:theme + +You can specify the layout file name in the first parameter: + + rails g web_app_theme:theme admin # it will generate a layout called `admin.html.erb` + +If you want to use another theme, instead of the default, you can use the `--theme` option: + + rails g web_app_theme:theme admin --theme="drastic-dark" + +You can specify the template engine with `--engine=name` option, where name can be erb (default) or haml: + + rails g web_app_theme:theme --engine=haml # you must specify haml in your Gemfile + +If you want to generate the stylesheets of a specific theme without changing the previously generated layout you can pass the `--no-layout` option: + + rails g web_app_theme:theme --theme=bec --no-layout + + +You can specify the text used in the header with the `--app-name` option: + + rails g web_app_theme:theme --app-name="My New Application" + +If you need a layout for login and signup pages, you can use the `--type` option with `sign` as value. Ìf not specified, the default value is `administration` + + rails g web_app_theme:theme sign --layout-type=sign + +### Themed Generator + +Start creating your controllers manually or with a scaffold, and then use the `themed generator` to overwrite the previously generated views. + +If you have a controller named like the plural of the used model you can specify just the first parameter: + + rails g web_app_theme:themed posts # you have a model named Post and a controller named PostsController + + rails g web_app_theme:themed admin/gallery_pictures # you have a model named GalleryPicture and a controller named Admin::GalleryPicturesController + +Use the `--layout` option specifying the previously generated layout to add a link to the controller you are working on: + + rails g web_app_theme:themed posts --layout=admin # you will see the `Posts` link in the navigation + +If the controller has a name different to the model used, specify the controller path in the first parameter and the model name in the second one: + + rails g web_app_theme:themed items post + + rails g web_app_theme:themed admin/items post + +If you use `will_paginate` for pagination use the `--will-paginate`: + + rails g web_app_theme:themed items post --will-paginate + +You can specify the template engine with `--engine=name` option, where name can be erb (default) or haml: + + rails g web_app_theme:themed posts --engine=haml + +If you have something like `map.resource :dashboard` in your `routes.rb` file, you can use the `--type=text` to generate a view with just text: + + rails g web_app_theme:themed dashboards --themed-type=text + +If you want to show form error messages inside the generated forms, use the following code inside your `environment.rb` + + ActionView::Base.field_error_proc = Proc.new do |html_tag, instance| + if html_tag =~ /