-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix readme markdown and add more doc
- Loading branch information
Showing
1 changed file
with
61 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,78 @@ | ||
sfAdminThemejRollerPlugin | ||
========================= | ||
# sfAdminThemejRoller plugin | ||
|
||
## Overview | ||
The `sfAdminThemejRollerPlugin` packages a new admin generator theme based on jQuery UI ThemeRoller (http://jqueryui.com/themeroller/). | ||
|
||
This plugin allows to change the default admin generator theme to one based on the theme roller from jQuery UI team. | ||
It is very convenient to change themes and keep UI consistency all around or even create your own theme. | ||
It is very convenient to change themes and keep UI consistency all around or even create your own theme. This admin generator theme | ||
is only targeting the actual element of the admin generator (table, forms...), it does not modify your overall layout. | ||
|
||
Installation | ||
------------ | ||
Here are some screenshots: [Table list and themes](http://lh5.ggpht.com/_HlYBk55Czxc/SovPBjZPmsI/AAAAAAAAAyw/sp28Wi_hFCw/jroller-list-themes.png?imgmax=800) | [Filters and action menu](http://lh6.ggpht.com/_HlYBk55Czxc/SpIBG_3Mw4I/AAAAAAAAAy8/6YlRs4ciikM/jroller-list-filters.png?imgmax=800) | [Form](http://lh4.ggpht.com/_HlYBk55Czxc/SpICgt-bCwI/AAAAAAAAAzI/m107vadkdJg/jroller-form.png?imgmax=800) | ||
|
||
* Install the plugin | ||
## Installation | ||
|
||
$ symfony plugin:install sfAdminThemejRollerPlugin --stability=beta | ||
1.Download and install the plugin | ||
|
||
* Clear the cache | ||
./symfony plugin:install sfAdminThemejRollerPlugin --stability=beta | ||
|
||
$ symfony cache:clear | ||
2.Clear the cache | ||
|
||
How to use it | ||
------------- | ||
./symfony cc | ||
|
||
3.Publish the plugin's assets: | ||
|
||
./symfony plugin:publish-assets | ||
|
||
|
||
## How to use it | ||
|
||
Generate an admin generator: | ||
{{{ | ||
./symfony --theme=jroller doctrine:generate-admin | ||
}}} | ||
|
||
if you already have an admin generator, you can simply change the theme inside your generator.yml | ||
{{{ | ||
theme: jroller | ||
}}} | ||
|
||
Configuration | ||
------------- | ||
|
||
You can use your own jQuery/jQueryUI and your own theme (based on ThemeRoller) and configure all this inside your app.yml: | ||
{{{ | ||
sf_admin_theme_jroller_plugin: | ||
web_dir: /sfAdminThemejRollerPlugin # specify specific folder where to pick your jquery stuff, ui and themes. | ||
|
||
./symfony --theme=jroller doctrine:generate-admin | ||
|
||
**OR** if you already have an admin generator, you can simply change the theme inside your generator.yml | ||
|
||
theme: jroller | ||
|
||
In any case don't forget the traditional: | ||
|
||
./symfony cc | ||
|
||
That's it! You are ready to use your new admin generator face. | ||
|
||
## Configuration | ||
|
||
You can use your own jQuery/jQueryUI and your own theme (based on ThemeRoller) and configure all this inside your *app.yml*: | ||
|
||
sf_admin_theme_jroller_plugin: | ||
web_dir: /sfAdminThemejRollerPlugin # specify your folder where to pick jquery stuff, ui and themes. | ||
use_jquery: true # default. use the packaged jquery/UI | ||
theme: redmond # default. | ||
css_reset: true # default. reset default css (from Blueprint CSS) | ||
}}} | ||
|
||
|
||
To add icons on your buttons/links you can use those proposed by ThemeRoller and include them in your generator.yml: | ||
{{{ | ||
actions: | ||
_new: { ui-icon: plus } | ||
object_actions: | ||
_edit: { ui-icon: pencil } | ||
}}} | ||
|
||
Note: you only need to use the specific part of each icon, not the all name, e.g. 'ui-icon-plus'. | ||
|
||
Links | ||
----- | ||
* [jQuery library](http://jquery.com/) | ||
* [jQuery UI](http://jqueryui.com/) | ||
* [jQuery UI ThemeRoller](http://jqueryui.com/themeroller/) | ||
|
||
|
||
TODO | ||
---- | ||
- fix bugs (no kidding ;-) | ||
- clean up css | ||
Export to CSV http://boedesign.com/2008/07/02/database-csv/ | ||
Import CSV to DB http://boedesign.com/2008/02/20/csv-2-php-2-mysql-insert/ | ||
|
||
actions: | ||
_new: { ui-icon: plus } | ||
object_actions: | ||
_edit: { ui-icon: pencil } | ||
|
||
Note: you only need to use the specific part of each icon name, not the all name, e.g. for 'ui-icon-plus' you only type 'plus'. | ||
|
||
## Links | ||
|
||
* [jQuery library](http://jquery.com/) | ||
* [jQuery UI](http://jqueryui.com/) | ||
* [jQuery UI ThemeRoller](http://jqueryui.com/themeroller/) | ||
|
||
|
||
## TODO | ||
|
||
* fix bugs (no kidding ;-) | ||
* clean up css | ||
* add new features: show view, print view, export and , live search | ||
* get git and svn repositories for your great contributions | ||
* setup a live demo | ||
* rule the world, do good not evil | ||
* make it works with Propel (so far it should be very easy since it does not really use ORM yet) |