tonyair/silverstripe-widgets
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-widgets synced 2024-10-22 17:05:54 +02:00
Code Issues Projects Releases Wiki Activity

MINOR updated README.md to reference the simple theme and clarify the installation steps

Browse Source
This commit is contained in:
Mike Parkhill 2012-08-21 16:27:39 +12:00
parent 37e556a58e
commit 2d58a9e351
1 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -21,49 +21,61 @@ the sidebar of your website. To check out a what a [Widget](http://silverstripe.
packaging instructions at the bottom of the page about how to make your widget package. packaging instructions at the bottom of the page about how to make your widget package.
### Installing the Widgets Module
Download and unzip the [Widgets Module](http://www.silverstripe.org/widgets-module/) to the main folder of your website and ensure the folder is named `widgets`.
### Installing a widget ### Installing a widget
By following the "Packaging" rules below, widgets are easily installed. By following the "Packaging" rules below, widgets are easily installed. This example uses the Blog module which by default has widgets already enabled.
* Install the [blog module](http://www.silverstripe.org/blog-module/) (by default only the Blog has widgets enabled) * Install the [blog module](http://www.silverstripe.org/blog-module/).
* Download the file and unzip to the main folder of your SilverStripe website, e.g. to `/widget_<widget-name>/`. The folder * Download the widget and unzip to the main folder of your SilverStripe website, e.g. to `/widget_<widget-name>/`. The folder
will contain a few files, which generally won't need editing or reading. will contain a few files, which generally won't need editing or reading.
* Run `http://my-website.com/dev/build` * Run `http://my-website.com/dev/build`
* Login to the CMS and go to the 'Blog' page. Choose the "widgets" tab and drag n drop the new widget to activate it. * Login to the CMS and go to the 'Blog' page. Choose the "widgets" tab and click the new widget to activate it.
* Your blog will now have the widget shown * Your blog will now have the widget shown
### Adding widgets to other pages ### Adding widgets to other pages
You have to do a couple things to get a Widget to work on a page. You have to do a couple things to get a Widget to work on a page.
First step is to add an WidgetArea to the Database to store the widget details. Then you have to edit the CMS to add a * Install the Widgets Module, see above.
Widget Form to manage the widgets. An example of this is below * Add a WidgetArea field to your Page.
* Add a new tab to the CMS with a WidgetAreaEditor field for managing the widgets.
e.g.
**mysite/code/Page.php** **mysite/code/Page.php**
class Page extends SiteTree { class Page extends SiteTree {
... ...
static $has_one = array( static $has_one = array(
"Sidebar" => "WidgetArea", "MyWidgetArea" => "WidgetArea",
); );
public function getCMSFields() { public function getCMSFields() {
$fields = parent::getCMSFields(); $fields = parent::getCMSFields();
$fields->addFieldToTab("Root.Content.Widgets", new WidgetAreaEditor("Sidebar")); $fields->addFieldToTab("Root.Widgets", new WidgetAreaEditor("MyWidgetArea"));
return $fields; return $fields;
} }
.... ...
} }
Then in your Template you need to call $SideBar wherever you want to render the widget * Then in your Template you need to call $MyWidgetArea wherever you want to render the widget
For example: using the blackcandy theme I put this piece of code above the closing `</div>` e.g. using the simple theme, add the `$MyWidgetArea` variable above the closing `</aside>`
**themes/blackcandy/templates/Includes/Sidebar.ss** **themes/simple/templates/Includes/Sidebar.ss**
$Sidebar <aside>
<% if Menu(2) %>
...
<% end_if %>
$MyWidgetArea
</aside>
## Writing your own widgets ## Writing your own widgets
@ -272,13 +284,13 @@ Page class). One way to fix this is to comment out line 30 in BlogHolder.php and
........ ........
static $has_one = array( static $has_one = array(
// "SideBar" => "WidgetArea", COMMENT OUT // "Sidebar" => "WidgetArea", COMMENT OUT
'Newsletter' => 'NewsletterType' 'Newsletter' => 'NewsletterType'
....... .......
public function getCMSFields() { public function getCMSFields() {
$fields = parent::getCMSFields(); $fields = parent::getCMSFields();
$fields->removeFieldFromTab("Root.Content","Content"); $fields->removeFieldFromTab("Root.Content","Content");
// $fields->addFieldToTab("Root.Content.Widgets", new WidgetAreaEditor("SideBar")); COMMENT OUT // $fields->addFieldToTab("Root.Widgets", new WidgetAreaEditor("Sidebar")); COMMENT OUT
........ ........