removed the sections from the menu to provide more flexibility in tab ordering

1 files changed, 19 insertions, 17 deletions

diff --git a/mod/embed/README.txt b/mod/embed/README.txt
index c7ce2e528..cecee08c0 100644
--- a/mod/embed/README.txt
+++ b/mod/embed/README.txt
@@ -13,8 +13,9 @@ CONTENTS:
 	their personal network content or third party resources in any text area.
 
 	The Embed plugin adds a menu item to the longtext menu. Clicking on this
-	link pops up a lightbox. The lightbox has two types of tabs: one for
-	selecting content to embed and one for uploading new content.
+	link pops up a lightbox. The lightbox supports lists of content for insertion
+	and uploading new content.
+
 
 2. Adding a Tab
 	The Embed plugin uses the menu system to manage its tabs. Use
@@ -23,7 +24,7 @@ CONTENTS:
 	$item = ElggMenuItem::factory(array(
 		'name' => 'file',
 		'text' => elgg_echo('file'),
-		'section' => 'select',
+		'priority' => 10,
 		'data' => array(
 			'options' => array(
 				'type' => 'object',
@@ -36,32 +37,33 @@ CONTENTS:
 	Parameters:
 		name: The unique name of the tab.
 		text: The text shown on the tab
-		section: 'select' for embed selection or 'upload' for uploading new content
-		data: an array of parameters for creating the tab and its content. See
-			the two sections below for data key values for the two tab types.
-
-	Select tab data parameters:
-		options: array of options passed to elgg_list_entities()
-
-	Upload tab data parameters:
-		view: the view used to render the tab content
+		priority: Placement of the tab.
+		data: An array of parameters for creating the tab and its content.
+			When listing content using the embed list view, pass the options for the
+			elgg_list_entities() function as 'options'.
+			When using a custom view for listing content or for uploading new
+			content, pass the view name as 'view'.
 
 	See the file plugin for examples of registering both tab types.
 
 
-3. Populating a Select Tab
+3. Populating a Content Select Tab
 	Nothing should be required other than setting the options parameter array
 	when registering the tab. See the view embed/item to see how an entity is
 	rendered.
 
+	If creating a custom list, the <li> elements must have a class of .embed-item.
+	The HTML content that is inserted must use the class .elgg-image.
+
+
 4. Populating an Upload Tab
 	The view that is registered must be defined. It must include a form for
-	uploading the content. The form must be wrapped in a div with the class
-	.embed-upload. Somewhere in the view must be a hidden input field with the
-	name embed_hidden with its value be the name of the tab to forward the user
-	to when uploading is complete.
+	uploading the content. The form must .elgg-form-embed. Somewhere in the view
+	must be a hidden input field with the name embed_hidden with its value be
+	the name of the tab to forward the user to when uploading is complete.
 
 	See the view embed/file_upload/content for an example
+
 	
 5. Other WYSIWYG Editors and Embed
 	Embed ships with support for the default input/longtext textarea.