Action definition: include meta info to auto generate the editor menu

[andrewxhill]

hey @javisantana,

we are going to need an easy way to expand the editor drop down menu for actions. i'm sure you are thinking about it, do you have a planned method? If not, I was thinking, why not include a description element in the Action object (e.g. https://github.com/CartoDB/odyssey.js/blob/master/lib/odyssey/actions/sleep.js) that would be read in at build time to generate the menu?

something like,

var Action = require('../story').Action;

function Sleep(ms) {

  return Action({

    enter: function() {
      setTimeout(this.finish, ms);
      return true;
    },
    describe: function() {
      return {
         name: "Sleep",
         description: "Invoke javascript sleep function",
         example: "Sleep(500)",
         addToEditor: true,
         group: "core" // or some way of allowing sub-menus later
      };
    }

  });
}

module.exports = Sleep;

[javisantana]

the current way is doing this:

https://github.com/CartoDB/odyssey.js/blob/master/editor/torque.html#L99

each template adds it's own actions you can perform

[andrewxhill]

gotcha

On Thu, May 29, 2014 at 11:32 AM, javi santana notifications@github.comwrote:

the current way is doing this:

https://github.com/CartoDB/odyssey.js/blob/master/editor/torque.html#L99

each template adds it's own actions you can perform

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/45#issuecomment-44545365
.

andrew@vizzuality.com
http://www.vizzuality.com