Chapter 3 Building your own Extensions

1. Chapter 3 Building your own Extensions

2. Development Environment

3. Must Haves ・Text Editor 　（UTF-8 compatible） ・File Archiver 　（ZIP compatible）

4. Nice to Have ・JavaScript debugger　（Venkman） ・Hidden preferences for development

5. Text Editor

6. Hidemaru Editor http://hide.maruo.co.jp/ TeraPad http://www5f.biglobe.ne.jp/~t-susumu/

7. File Archiver

8. 7-Zip http://www.7-zip.org/

9. Debugger

10. Venkman JavaScript debugger https://addons.mozilla.org/firefox/216 Japanese language package http://piro.sakura.ne.jp/latest/blosxom.cgi/mozilla/extension/2005-09-30_venkman-ja.htm

11. Hidden Preferences

12. ・browser.dom.window.dump.enabled 　Enables dump output to console 　→true ・javascript.options.showInConsole 　Enables errors to be reported to console 　→true

13. Create a new profile for development work

14. ・firefox.exe -p 　Start profile manager ・firefox.exe -p "foobar" 　Start up using specific profile ・firefox.exe -p "foobar" -no-remote 　Start multiple Firefox instances using different profiles

16. Now, on to actually building an Extension

17. …… But

18. Try modifying the Firefox code first

19. C:\Program Files \Mozilla Firefox \chrome\browser.jar

21. Implementation steps for the Firefox browser

22. Step1. Extract browser.jar Step2. Modify browser.xul Step3. Compress browser.jar Step4. Double check * It's a good idea to back up a copy of browser.jar

23. Displaying a “Hello, world!!” message

24. content\browser\browser.xul <menuitem observes="blockedPopupAllowSite"/> <menuitem observes="blockedPopupEditSettings"/> <menuitem observes="blockedPopupDontShowMessage"/> <menuseparator observes="blockedPopupsSeparator"/> </menupopup> </statusbarpanel> </statusbar> <label value="Hello, world!!"/> </window> Add this to the end of the file

25. Restart Firefox

27. Display “Hello, world!!” in the “Tools” menu

28. content\browser\browser.xul <menu id="tools-menu" label="&toolsMenu.label;" accesskey="&toolsMenu.accesskey;"> <menupopup id="menu_ToolsPopup"> <menuitem label="&search.label;" accesskey="&search.accesskey;" key="key_search" command="Tools:Search"/> (snipped)‏ <menuitem accesskey="&pageInfoCmd.accesskey;" label="&page...l;" command="View:PageInfo"/> <menuitem id="hellloworldMenuitem" label="Hello, world!"/> <menuseparator id="sanitizeSeparator"/> <menuitem id="sanitizeItem" accesskey="&clearPrivateDataCmd.accesskey;" label="&clearPrivateDataCmd.label;" key="key_sanitize" command="Tools:Sanitize"/> (snipped)‏ </menupopup> </menu> Add this to the file

29. Restart Firefox

32. Turn these modifications into an Extension

33. Upload your work to ftp://sfc-ftp.ai3.net/ ~incoming/mozilla24-ws/

34. http://piro.sakura.ne.jp/ xul/doc/20070726keio/XUL3-1.zip

35. Step1. Prepare files and folders Step2. Create manifest file Step3. Create XPI package

36. Preparing files and folders

37. helloworld chrome content overlay.xul install.rdf chrome.manifest

38. Isolate the XUL modifications for the overlay file

39. (snipped)‏ <menu id="tools-menu" label="&toolsMenu.label;" accesskey="&toolsMenu.accesskey;"> <menupopup id="menu_ToolsPopup"> (snipped)‏ <menuitem id="hellloworldMenuitem" label="Hello, world!"/> (snipped)‏ </menupopup> </menu> (snipped)‏ overlay.xul <?xml version="1.0" encoding="UTF-8"?> <overlay id="helloworldOverlay" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"> <menupopup id="menu_ToolsPopup"> <menuitem id="helloworldMenuitem" label="Hello, world!" insertbefore="sanitizeSeparator"/> </menupopup> </overlay>

40. overlay.xul <?xml version="1.0" encoding="UTF-8"?> <overlay id="helloworldOverlay" xmlns="http://www.mozilla.org/ keymaster/gatekeeper/there.is.only.xul"> <menupopup id="menu_ToolsPopup"> <menuitem id="helloworldMenuitem" label="Hello, world!" insertbefore="sanitizeSeparator"/> </menupopup> </overlay>

41. Creating a manifest file

42. 1 install.rdf extension metadata

43. install.rdf <?xml version="1.0" encoding="UTF-8"?> <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <Description about="urn:mozilla:install-manifest"> <em:id>helloworld@piro.sakura.ne.jp</em:id> <em:type>2</em:type> <em:name>Hellow, world!</em:name> <em:version>0.1</em:version> <em:description>My first extension.</em:description> <em:creator>SHIMODA Hiroshi</em:creator> <em:homepageURL>http://piro.sakura.ne.jp/xul/</em:homepageURL> <em:targetApplication> <Description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minVersion>2.0</em:minVersion> <em:maxVersion>2.0.0.*</em:maxVersion> </em:targetApplication> </Description> </RDF>

44. install.rdf (1)‏ <?xml version="1.0" encoding="UTF-8"?> <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <Description about="urn:mozilla:install-manifest"> <em:id>helloworld@piro.sakura.ne.jp</em:id> <em:type>2</em:type> <em:name>Hellow, world!</em:name> <em:version>0.1</em:version> <em:description>My first extension.</em:description> <em:creator>SHIMODA Hiroshi</em:creator> <em:homepageURL>http://piro.sakura.ne.jp/xul/</em:homepageURL>

45. install.rdf (2)‏ <em:targetApplication> <Description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minVersion>2.0</em:minVersion> <em:maxVersion>2.0.0.*</em:maxVersion> </em:targetApplication> </Description> </RDF> IDs that can be assigned to targetApplication Firefox :{ec8030f7-c20a-464f-9b0e-13a3a9e97384} Thunderbird :{3550f703-e582-4d05-9a08-453d09bdfdc6}

46. 2 chrome.manifest file path and designating overlay

47. chrome.manifest content helloworld chrome/content/ overlay chrome://browser/content/browser.xul chrome://helloworld/content/overlay.xul

48. chrome.manifest(1)‏ content helloworld chrome/content/ chrome://helloworld/content/ Chrome URL

49. chrome.manifest(2)‏ overlay chrome://browser/content/browser.xul chrome://helloworld/content/overlay.xul browser.xul

50. chrome.manifest(2)‏ overlay chrome://browser/content/browser.xulchrome://helloworld/content/overlay.xul overlay.xul browser.xul