Recent changes to AddonDevs

WikiPage AddonDevs modified by Kevin Cox

Kevin Cox — Thu, 05 Jul 2012 00:17:24 -0000

--- v4
+++ v5
@@ -1,6 +1,6 @@
 # Enabling ADIC for your Addon
 
-There are currently two methods for using ADIC in your addon.  Via an API or through our GUI.  Either way it is recommended that you have an `adic.json` file.  If you are using the GUI method all you need is an `adic.json` file.
+There are currently two methods for using ADIC in your addon.  Via an API or through our GUI.  Either way it is recommended that you have an `adic.json` file.  If you are using the GUI method all you need is an `adic.jsm` file.
 
 [adic.jsm](ADIC_jsm)

WikiPage AddonDevs modified by Kevin Cox

Kevin Cox — Wed, 04 Jul 2012 23:52:20 -0000

--- v3
+++ v4
@@ -2,6 +2,6 @@
 
 There are currently two methods for using ADIC in your addon.  Via an API or through our GUI.  Either way it is recommended that you have an `adic.json` file.  If you are using the GUI method all you need is an `adic.json` file.
 
-[adic.json](ADIC_json)
+[adic.jsm](ADIC_jsm)
 
 [ADIC API](ADIC_API)

WikiPage AddonDevs modified by Kevin Cox

Kevin Cox — Fri, 13 Jan 2012 22:58:44 -0000

--- v2 
+++ v3 
@@ -1,49 +1,7 @@
 # Enabling ADIC for your Addon
 
-## Basic Usage
-All addons can already use ADIC with limited functionality.  Simply put your addon id in the id field and the value that would make the following code return your addon's preference prefix.
-
-    "extensions."+code+"."
-
-With that information ADIC will return the value of all your preferences, OS and system information as well as a list of installed addons and their versions.
-
-## Advanced Usage
-If you want to personalize the information returned by ADIC and provide an easier interface for your users you can include an `adic.json` file in the root for your extension (not chrome:// but the extension package).  This way users only need to enter your extension ID and everything else is handled automatically.  This file also offers you more control over what information ADIC gathers.
-
-### Intro to `adic.json`
-`adic.json` is imported as a JavaScript module and exports one object with all of the info ADIC needs.  It is important to note that it is not strictly JSON so the language is more flexibleADIC_info.  You can include comments as well as commas after the last element.  A template file is shown here.
-
-    var EXPORTED_SYMBOLS = ["ADIC_info"];
-
-    var ADIC_info = {
-    	/* Include prefrences from here down. */
-    	prefs: ["extensions.adic."],
-    
-    	/* true for system info */
-    	system: true,
-    
-    	/* Should we include a list of installed extensions? */
-    	extensions: true,
-    
-        /* A list of file names to include. */
-    	files: [],
-    
-    	/* A list of things to include in the output */
-    	constants: {
-    		key: "value",
-    	},
-    };
-
-This is actually the `adic.json` that ADIC uses.  It is fairly straight forward.  The name `ADIC_info` is important and must be changed or else ADIC will not be able to find your settings.
-
-### prefs
-`ADIC_info.prefs` is an array of prefixes to be included.  If you want every preference you can put `[""]` or `[]` for none.  This value defaults to `"extensions."+code+"."` if the code is given (it isn't asked for if `adic.json` exists) otherwise `[]`.
-
-### system
-`ADIC_info.system` is a boolean value specifying whether or not system info should be included.  This is a dump of `Services.appinfo`.
-
-### files
-`ADIC_info.files` is a list of files to include verbatim into the output.  The file name will be provided then the contents in a delimited section.  The user will be prompted for conformation if you ask for strange files (like `file:///etc/passwd`).  I will get you a better definition for strange files when this feature gets implemented.
-
-### constants
-`ADIC_info.constants` is an object of key/value pairs to spit out.
+There are currently two methods for using ADIC in your addon.  Via an API or through our GUI.  Either way it is recommended that you have an `adic.json` file.  If you are using the GUI method all you need is an `adic.json` file.
+
+[adic.json](ADIC_json)
+
+[ADIC API](ADIC_API)

WikiPage AddonDevs modified by Kevin Cox

Kevin Cox — Fri, 13 Jan 2012 21:35:49 -0000

--- v1 
+++ v2 
@@ -1,6 +1,6 @@
 # Enabling ADIC for your Addon
 
-## Basic Useage
+## Basic Usage
 All addons can already use ADIC with limited functionality.  Simply put your addon id in the id field and the value that would make the following code return your addon's preference prefix.
 
     "extensions."+code+"."

WikiPage AddonDevs modified by Kevin Cox

Kevin Cox — Fri, 13 Jan 2012 21:35:28 -0000

# Enabling ADIC for your Addon ## Basic Useage All addons can already use ADIC with limited functionality. Simply put your addon id in the id field and the value that would make the following code return your addon's preference prefix. "extensions."+code+"." With that information ADIC will return the value of all your preferences, OS and system information as well as a list of installed addons and their versions. ## Advanced Usage If you want to personalize the information returned by ADIC and provide an easier interface for your users you can include an `adic.json` file in the root for your extension (not chrome:// but the extension package). This way users only need to enter your extension ID and everything else is handled automatically. This file also offers you more control over what information ADIC gathers. ### Intro to `adic.json` `adic.json` is imported as a JavaScript module and exports one object with all of the info ADIC needs. It is important to note that it is not strictly JSON so the language is more flexibleADIC_info. You can include comments as well as commas after the last element. A template file is shown here. var EXPORTED_SYMBOLS = ["ADIC_info"]; var ADIC_info = { /* Include prefrences from here down. */ prefs: ["extensions.adic."], /* true for system info */ system: true, /* Should we include a list of installed extensions? */ extensions: true, /* A list of file names to include. */ files: [], /* A list of things to include in the output */ constants: { key: "value", }, }; This is actually the `adic.json` that ADIC uses. It is fairly straight forward. The name `ADIC_info` is important and must be changed or else ADIC will not be able to find your settings. ### prefs `ADIC_info.prefs` is an array of prefixes to be included. If you want every preference you can put `[""]` or `[]` for none. This value defaults to `"extensions."+code+"."` if the code is given (it isn't asked for if `adic.json` exists) otherwise `[]`. ### system `ADIC_info.system` is a boolean value specifying whether or not system info should be included. This is a dump of `Services.appinfo`. ### files `ADIC_info.files` is a list of files to include verbatim into the output. The file name will be provided then the contents in a delimited section. The user will be prompted for conformation if you ask for strange files (like `file:///etc/passwd`). I will get you a better definition for strange files when this feature gets implemented. ### constants `ADIC_info.constants` is an object of key/value pairs to spit out.