From d11d992e936299a726c9d35db92ccd2e39de5bb1 Mon Sep 17 00:00:00 2001
From: colymba <thierry@colymba.com>
Date: Thu, 19 Jul 2012 15:00:11 +0300
Subject: [PATCH] DOC: Updated README with samples

---
 README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 76 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index fbd93c3..9231ddf 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-GridFieldBulkImageUpload
-========================
+GridField Bulk Image Upload
+===========================
 
-SilverStripe 3 GridField component for uploading images in bulk into the managed DataObject relation, with option to edit fields on the fly.
+SilverStripe 3 GridField component for uploading images in bulk into the managed Model relation, with option to edit fields on the fly.
 This component takes bit and pieces around from CMSFileAddController, GridFieldDetailForm_ItemRequest, UploadField, and it overrides and adds some behaviors, templates and styles.
 
 ## Requirments
@@ -12,26 +12,88 @@ This component takes bit and pieces around from CMSFileAddController, GridFieldD
 * Run dev/build?flush=all to regenerate the manifest
 * run ?flush=all in CMS to force the templates to regenerate
 
-## Usage 1
-Simplest usage, add the component to your GridField as below. The component will find the first Image has_one relation on the managed object and it's editable db fields
-		
-		:::php
+## Usage
+
+### Usage 1
+Simplest usage, add the component to your GridField as below. The component will find the first Image has_one relation on the managed Model and it's editable db fields
+				
 		$config->addComponent(new GridFieldBulkImageUpload());
 
-## Usage 2
-Same as 1 but you can specify which Image field to use and which fields are editable
-$imageField: string: The name of the image field to use (should have 'ID' at the end: If your relation is set has 'MyImage' => 'Image', the parameter should be 'MyImageID')
-$editableFields: array: list of db fields name as string that will be editable like: array('myTextField', 'myVarcharField', 'myEnumField')
-		
-		:::php
+### Usage 2
+You can specify which Image field to use and which fields are editable from the managed Model
+$imageField (string): The name of the image field to use (should have 'ID' at the end: If your relation is set has 'MyImage' => 'Image', the parameter should be 'MyImageID')
+$editableFields (array): list of db fields name as string that will be editable like: array('myTextField', 'myVarcharField', 'myEnumField')
+				
 		$config->addComponent(new GridFieldBulkImageUpload( $imageField, $editableFields ));
 
+### Sample Files
+
+Page Model
+
+		class Page extends SiteTree {
+
+			public static $db = array(
+			);
+
+			public static $has_many = array(
+					'Visuals' => 'Visual'
+			);
+
+			public function getCMSFields() {
+				$fields = parent::getCMSFields();
+
+				$config = GridFieldConfig_RelationEditor::create();	
+				$config->addComponent(new GridFieldBulkImageUpload());		
+				$f = new GridField('Visuals', 'Case Study Visuals', $this->Visuals(), $config);
+				$fields->addFieldToTab('Root.Visuals', $f);
+
+				return $fields;
+			}
+
+		}
+
+Visual Model
+('Image', 'Type', 'Title' and 'Embed' Fields will be picked up automatically by the component)
+
+		class Visual extends DataObject
+		{
+			public static $db = array(
+					'Type' => "Enum('Image,Embed','Image')",
+					'Title' => 'Text',
+					'Embed' => 'HTMLText'
+			);
+
+			public static $has_one = array(
+					'Page' => 'Page',
+					'Image' => 'Image'
+			);
+
+			public function getCMSFields() {
+				$fields = new FieldList();
+
+				$fields->push( new DropdownField(
+					'Type',
+					'Type of visual',
+					singleton('Visual')->dbObject('Type')->enumValues()
+				));
+
+				$fields->push( new TextField('Title', 'Title and Caption for images (useful for SEO)') );
+				$fields->push( new TextareaField('Embed', 'HTML Embed code') );		
+
+				$f = new UploadField('Image', 'Image file');				
+				$fields->push($f);
+
+				return $fields;
+			}
+		}
+
 ## Notes
 * The HTML form fields for each editable fields are taken from the DataObject's getCMSFields() method
 * Only (HTML)Text/Varchar and Enum fields are picked up by the automatic config
 
 ## @TODO
 * Add option to specify upload folder
-* Styles: fade back progress to blue once updated
+* Add individual actions for each upload (update + cancel)
+* Styles: fade back progress to blue once updated, add .loading class to buttons when saving/canceling
 * Handle and display errors better for: creation, update, cancel
 * Make it work not only for images -> might need to rename this component then?
\ No newline at end of file