Labs/Ubiquity/Ubiquity 0.1 Development Tutorial: Difference between revisions

outdated info correction
(outdated info correction)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
'''Note: these instructions cover development through current versions of Ubiquity, including versions 0.5.x.'''
If you just want to write new commands for Ubiquity, you should read [https://wiki.mozilla.org/Labs/Ubiquity/Ubiquity_0.1_Author_Tutorial the Command Author Tutorial] instead.  This page is about how to do development on the Ubiquity core.
If you just want to write new commands for Ubiquity, you should read [https://wiki.mozilla.org/Labs/Ubiquity/Ubiquity_0.1_Author_Tutorial the Command Author Tutorial] instead.  This page is about how to do development on the Ubiquity core.


Line 68: Line 70:
   ubiquity/chrome/content/
   ubiquity/chrome/content/


To get started, you may want to first take a look at the built-in commands and built-in noun types, which are in the files:
To get started, you may want to first take a look at the built-in and standard commands, which are in the files:


   ubiquity/builtin-feeds/en/builtincmds.js
   ubiquity/builtin-feeds/builtincmds.js
   ubiquity/modules/nountypes.js
   ubiquity/standard-feeds/*.js
  ubiquity/standard-feeds/*.xhtml


These files are dynamically loaded, so if you make any changes to them, all you have to do is save the file, then go back to Firefox and hit alt-space to bring up Ubiquity again.  Your changes will be reflected immediately.  There's no need to rebuild your extension or restart Firefox.
The feeds are dynamically loaded, so if you make any changes to them, all you have to do is save the file, then go back to Firefox and bring up Ubiquity again.  Your changes will be reflected immediately.  There's no need to rebuild your extension or restart Firefox.


If you make changes to other files -- parts of the core, such as the parser, that are not dynamically loaded -- you will have to restart Firefox.  Even in this case, there is no need for you to keep on rebuilding your extension.  Once you've run python manage.py for the first time to install the extension, as described above, you shouldn't need to run it again.  Just save the source file and restart Firefox and whatever changes you've made will be reflected in Ubiquity.
If you make changes to other files -- parts of the core such as the parser or built-in nountypes, that are not dynamically loaded -- you will have to restart Firefox.  Even in this case, there is no need for you to keep on rebuilding your extension.  Once you've run python manage.py for the first time to install the extension, as described above, you shouldn't need to run it again.  Just save the source file and restart Firefox and whatever changes you've made will be reflected in Ubiquity.


== Don't Forget to Test ==
== Don't Forget to Test ==
73

edits