aboutsummaryrefslogtreecommitdiff
path: root/mod/ecml/README.txt
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-07-08 18:51:34 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-07-08 18:51:34 +0000
commitcf3752e80273d93964305e43481fabc370888a47 (patch)
tree273451f549351eacd8b0e2374ffb2470567926e7 /mod/ecml/README.txt
parent74c3aaeea871e28b2b1785b9044271d040b84396 (diff)
downloadelgg-cf3752e80273d93964305e43481fabc370888a47.tar.gz
elgg-cf3752e80273d93964305e43481fabc370888a47.tar.bz2
Pulled ECML regex into a constant.
Added ecml_get_keywords(), ecml_parse_string(), ecml_extract_keywords(), ecml_get_keyword_info(). Added callback for resolving ECML given an embed code / URL. Removed unused page setup hook. Added web services support. Updated docs. git-svn-id: http://code.elgg.org/elgg/trunk@6664 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'mod/ecml/README.txt')
-rw-r--r--mod/ecml/README.txt30
1 files changed, 28 insertions, 2 deletions
diff --git a/mod/ecml/README.txt b/mod/ecml/README.txt
index 7d59d6dbc..3c18998cc 100644
--- a/mod/ecml/README.txt
+++ b/mod/ecml/README.txt
@@ -7,7 +7,8 @@ CONTENTS:
3.1 Utility keywords 'entity' and 'view'
3.2 Embedded 3rd party media
4. Custom ECML Keywords
- 5. Hints and Quirks
+ 5. Embed support
+ 6. Hints and Quirks
1. OVERVIEW
@@ -116,6 +117,7 @@ CONTENTS:
function buttonizer_ecml_keywords($hook, $type, $value, $params) {
$value['buttonizer'] = array(
+ 'name' => 'Buttonizer',
'view' => 'buttonizer/ecml/buttonizer',
'description' => 'Makes your text a button! What could be better?',
'usage' => 'Use [buttonizer text="My text"] to make "My text" a button!'
@@ -143,7 +145,31 @@ CONTENTS:
but is much simpler for the user.
-5. HINTS AND QUIRKS
+5. EMBED SUPPORT
+
+ ECML and the Embed plugin are closely related in that Embed serves
+ as a sort of front end for ECML. Especially with 3rd party web
+ services, where URLs and embed codes vary greatly, having a system
+ in place that allows a user to easily generate and insert ECML
+ is benificial.
+
+ Currently, only web services ECML keywords are supported in the
+ embed plugin. Registering a web service keyword looks like this:
+
+ $value[youtube] = array(
+ 'name' => 'Youtube',
+ 'view' => "ecml/keywords/youtube",
+ 'description' => 'Embed YouTube videos',
+ 'usage' => 'Use src="URL".',
+
+ // important bits
+ 'type' => 'web_service',
+ 'params' => array('src', 'width', 'height') // a list of supported params
+ 'embed' => 'src="%s"' // a sprintf string of the require param format. Added automatically to [keyword $here]
+ );
+
+
+6. HINTS AND QUIRKS
* A custom keyword is slightly more complicated to implement, but is
much simpler for the end user to use.