{"id":1041,"date":"2010-07-03T16:58:10","date_gmt":"2010-07-03T20:58:10","guid":{"rendered":"http:\/\/www.dr-chuck.com\/csev-blog\/?p=1041"},"modified":"2011-12-17T12:33:47","modified_gmt":"2011-12-17T16:33:47","slug":"adding-a-new-feature-to-shiding-for-learning","status":"publish","type":"post","link":"https:\/\/www.dr-chuck.com\/csev-blog\/2010\/07\/adding-a-new-feature-to-shiding-for-learning\/","title":{"rendered":"Adding a New Feature to Shiding for Learning"},"content":{"rendered":"

In this exercise, we add a new feature to Shindig. I may have jacked-in at the wrong place – but this will get you started.<\/p>\n

First we move into the feature directory:<\/p>\n

\r\ncd features\/src\/main\/javascript\/features\r\n<\/pre>\n
Create a new directory named  learning<\/b> and put three files into it.<\/p>\n
learning_client.js<\/b><\/p>\n
\r\ngadgets['learning'] = (function() {\r\n\r\n    return {\r\n       getContextLabel : function() {\r\n            return 'SI124';\r\n        },\r\n    \r\n        getContextName : function() {\r\n            return 'Social Computing';\r\n        },\r\n    \r\n        setOutcome : function(data) {\r\n            alert('setOutcome belongs here');\r\n        }\r\n    };\r\n\r\n})();\r\n<\/pre>\n
This creates our client code and defines three methods in the client.  For now they are simple stubs to keep life simple.<\/p>\n
taming.js<\/b><\/p>\n
\r\nvar tamings___ = tamings___ || [];\r\ntamings___.push(function(imports) {\r\n  ___.grantRead(gadgets.learning, 'getContextLabel');\r\n  ___.grantRead(gadgets.learning, 'getContextName');\r\n  ___.grantRead(gadgets.learning, 'setOutcome');\r\n});\r\n<\/pre>\n
I am a little foggy on this file – it basically works with Caja to make sure that you are explicit as to what you want to really expose to JavaScript callers.  <\/p>\n
feature.xml<\/b><\/p>\n
\r\n<feature>\r\n  <name>learning<\/name>\r\n  <dependency>globals<\/dependency>\r\n  <gadget>\r\n    <script src=\"learning_client.js\"\/>\r\n    <script src=\"taming.js\"\/>\r\n  <\/gadget>\r\n  <container>\r\n    <script src=\"learning_client.js\"\/>\r\n    <script src=\"taming.js\"\/>\r\n  <\/container>\r\n<\/feature>\r\n<\/pre>\n
This file names your feature and defines the source files that make it up.<\/p>\n
Then edit the file features.txt<\/b> and add a line:<\/p>\n
\r\nfeatures\/xmlutil\/feature.xml\r\nfeatures\/com.google.gadgets.analytics\/feature.xml\r\nfeatures\/learning\/feature.xml<\/b>\r\n<\/pre>\n
There is a way to do this using a script, but for now, lets just jack-in directly.<\/p>\n
At this point you need to rebuild Shindig.   And you might get syntax errors during the build which you need to fix.  Somehow the Javascript for features is compiled \/ processed at mvn<\/b> time and put into a more run-time format.<\/p>\n
\r\nmvn\r\n<\/pre>\n
once it compiles and installs, start Jetty again<\/p>\n
\r\nmvn -Prun\r\n<\/pre>\n
And navigate to http:\/\/localhost:8080\/samplecontainer\/samplecontainer.html<\/a><\/p>\n
You should see the “Social Hello World” gadget.   Now lets edit this file:<\/p>\n
\r\nvi .\/target\/work\/webapp\/samplecontainer\/examples\/SocialHelloWorld.xml\r\n<\/pre>\n
And add two lines:<\/p>\n
\r\n   <Require feature=\"osapi\"><\/Require>\r\n   <Require feature=\"learning\"><\/Require><\/b>\r\n   <Require feature=\"settitle\"\/><\/Require>\r\n\u2026\r\n\r\n   gadgets.window.setTitle('Social Hello World');\r\n   alert(gadgets.learning.getContextLabel());<\/b>\r\n     var hellos = new Array('Hello World', 'Hallo Welt', 'Ciao a tutti',\r\n...\r\n<\/pre>\n
This requests that the container load the new learning<\/b> feature and then we call the learning feature when the JavaScript starts up in the gadget and you should see the dialog box pop up once you save the SampleHelloworld.xml<\/b> and do a refresh.<\/p>\n
<\/a>
\nUp next – talking to code inside the server…<\/p>\n


\nNext post in the series<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
In this exercise, we add a new feature to Shindig. I may have jacked-in at the wrong place – but this will get you started. First we move into the feature directory: cd features\/src\/main\/javascript\/features Create a new directory named learning and put three files into it. learning_client.js gadgets[‘learning’] = (function() { return { getContextLabel : […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1041","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts\/1041","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/comments?post=1041"}],"version-history":[{"count":14,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts\/1041\/revisions"}],"predecessor-version":[{"id":2842,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts\/1041\/revisions\/2842"}],"wp:attachment":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/media?parent=1041"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/categories?post=1041"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/tags?post=1041"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}