Merge pull request #16 from l0o0/bootstrap

Add AddonLocale class for different language

README.md

@@ -148,7 +148,7 @@ This section shows the directory structure of a template.
 - All `.js/.ts` code files are in `./src`;
 - Addon config files: `./addon/chrome.manifest`, `./addon/install.rdf`;
 - UI files: `./addon/chrome/content/*.xul`. The `overlay.xul` also defines the main entrance;
-- Locale files: `./addon/chrome/locale/*.dtd`;
+- Locale files: `./addon/chrome/locale/[*.dtd, *.properties]`;
 - Resource files: `./addon/chrome/skin/default/__addonRef__/*.dtd`;
 - Preferences file: `./addon/chrome/defaults/preferences/defaults.js`;
   > Don't break the lines in the `defaults.js`
@@ -182,9 +182,11 @@ This section shows the directory structure of a template.
 │      └─locale     # locale
 │         ├─en-US
 │         │      overlay.dtd
+│         │      addontemplate.properties
 │         │
 │         └─zh-CN
-│                overlay.dtd
+│         |      overlay.dtd
+│         │      addontemplate.properties
 │
 ├─builds            # build dir
 │  └─.xpi
@@ -195,6 +197,7 @@ This section shows the directory structure of a template.
     │  addon.ts     # base class
     │  events.ts    # events class
     │  views.ts     # UI class
+    │  locale.ts    # Locale class for properties files
     └─ prefs.ts     # preferences class
 
 ```

addon/chrome/content/preferences.xhtml

@@ -3,7 +3,7 @@
   onload="Zotero.AddonTemplate.prefs.initPreferences(window)"
 >
   <groupbox>
-    <label><html:h2>Addon Template Example</html:h2></label>
+    <label><html:h2>&zotero.__addonRef__.pref.title;</html:h2></label>
     <checkbox
       id="zotero-prefpane-__addonRef__-enable"
       label="&zotero.__addonRef__.pref.enable.label;"
@@ -21,3 +21,6 @@
     </hbox>
   </groupbox>
 </vbox>
+<vbox>
+    <label value="&zotero.__addonRef__.help.version.label;  &zotero.__addonRef__.help.releasetime.label;"></label>
+</vbox>

addon/chrome/locale/en-US/addontemplate.properties

@@ -0,0 +1,5 @@
+menuitem.label=Addon Template: Menuitem
+menupopup.label=Addon Template: Menupopup
+menuitem.submenulabel=Addon Template
+menuitem.filemenulabel=Addon Template: File Menuitem
+prefs.title=Template

addon/chrome/locale/en-US/overlay.dtd

@@ -1,3 +1,4 @@
+<!ENTITY zotero.__addonRef__.pref.title "Addon Template Example">
 <!ENTITY zotero.__addonRef__.itemmenu.test.label "addon template">
 <!ENTITY zotero.__addonRef__.pref.enable.label "Enable">
 <!ENTITY zotero.__addonRef__.pref.input.label "Input">

addon/chrome/locale/zh-CN/addontemplate.properties

@@ -0,0 +1,5 @@
+menuitem.label=Addon Template: 菜单
+menupopup.label=Addon Template: 弹出菜单
+menuitem.submenulabel=Addon Template
+menuitem.filemenulabel=Addon Template: 文件菜单
+prefs.title=插件模板

addon/chrome/locale/zh-CN/overlay.dtd

@@ -1,3 +1,4 @@
+<!ENTITY zotero.__addonRef__.pref.title "插件模板设置示例">
 <!ENTITY zotero.__addonRef__.itemmenu.test.label "插件模板">
 <!ENTITY zotero.__addonRef__.pref.enable.label "开启">
 <!ENTITY zotero.__addonRef__.pref.input.label "输入">

src/addon.ts

@@ -1,14 +1,17 @@
 import AddonEvents from "./events";
 import AddonPrefs from "./prefs";
 import AddonViews from "./views";
+import AddonLocale from "./locale";
 
 import ZoteroToolkit from "zotero-plugin-toolkit";
+import Locale from "./locale";
 
 class Addon {
   public Zotero!: _ZoteroConstructable;
   public events: AddonEvents;
   public views: AddonViews;
   public prefs: AddonPrefs;
+  public locale: AddonLocale;
   public toolkit: ZoteroToolkit;
   // root path to access the resources
   public rootURI!: string;
@@ -17,6 +20,7 @@ class Addon {
     this.events = new AddonEvents(this);
     this.views = new AddonViews(this);
     this.prefs = new AddonPrefs(this);
+    this.locale = new AddonLocale(this);
     this.toolkit = new ZoteroToolkit();
   }
 }

src/events.ts

@@ -61,7 +61,7 @@ class AddonEvents extends AddonModule {
     const prefOptions = {
       pluginID: config.addonID,
       src: this._Addon.rootURI + "chrome/content/preferences.xhtml",
-      label: "Template",
+      label: this._Addon.locale.getString("prefs.title"),
       image: `chrome://${config.addonRef}/content/icons/favicon.png`,
       extraDTD: [`chrome://${config.addonRef}/locale/overlay.dtd`],
       defaultXUL: true,

src/locale.ts

@@ -0,0 +1,19 @@
+import Addon from "./addon";
+import AddonModule from "./module";
+
+
+class AddonLocale extends AddonModule {
+    private stringBundle: any;
+    constructor(parent: Addon) {
+        super(parent);
+        this.stringBundle = Components.classes['@mozilla.org/intl/stringbundle;1']
+            .getService(Components.interfaces.nsIStringBundleService)
+            .createBundle('chrome://addontemplate/locale/addontemplate.properties');
+    }
+
+    public getString(localString: string): string {
+        return this.stringBundle.GetStringFromName(localString);
+    }
+}
+
+export default AddonLocale;

src/views.ts

@@ -24,7 +24,7 @@ class AddonViews extends AddonModule {
     this._Addon.toolkit.UI.insertMenuItem("item", {
       tag: "menuitem",
       id: "zotero-itemmenu-addontemplate-test",
-      label: "Addon Template: Menuitem",
+      label: this._Addon.locale.getString("menuitem.label"),
       oncommand: "alert('Hello World! Default Menuitem.')",
       icon: menuIcon,
     });
@@ -33,11 +33,11 @@ class AddonViews extends AddonModule {
       "item",
       {
         tag: "menu",
-        label: "Addon Template: Menupopup",
+        label: this._Addon.locale.getString("menupopup.label"),
         subElementOptions: [
           {
             tag: "menuitem",
-            label: "Addon Template",
+            label: this._Addon.locale.getString("menuitem.submenulabel"),
             oncommand: "alert('Hello World! Sub Menuitem.')",
           },
         ],
@@ -53,7 +53,7 @@ class AddonViews extends AddonModule {
     // menu->File menuitem
     this._Addon.toolkit.UI.insertMenuItem("menuFile", {
       tag: "menuitem",
-      label: "Addon Template: File Menuitem",
+      label: this._Addon.locale.getString("menuitem.filemenulabel"),
       oncommand: "alert('Hello World! File Menuitem.')",
     });