This page tracks documentation status and work progress for Add-ons documentation. Feel free to contribute!
Summary
Pages | No tags | Needs* tags | Missing tags | Editorial reviews | Technical reviews | Outdated pages | Dev-doc-needed bugs | Documentation requests |
---|---|---|---|---|---|---|---|---|
876 | 175 (20%) | 15 (2%) | 0 (0%) | 6 (1%) | 42 (5%) | 74 (9%) | 54 (7%) | 30 (4%) |
See also localization status of this section.
No tags
Found 175 pages. Learn more about how to tag pages.
- AddonType
- TypeListener
- Builder
- Communicating With Other Scripts
- Communicating using "port"
- Loading Content Scripts
- port
- self
- Contributor's Guide
- Private Properties
- Program ID
- SDK API Lifecycle
- SDK and XUL Comparison
- Two Types of Scripts
- Working with Events
- XUL Migration Guide
- webextension
- Low-Level APIs
- /loader
- chrome
- console/plain-text
- console/traceback
- content/content
- content/loader
- content/mod
- content/symbiont
- content/worker
- core/heritage
- core/namespace
- core/promise
- dev/panel
- event/core
- event/target
- frame/hidden-frame
- frame/utils
- fs/path
- io/byte-streams
- io/file
- io/text-streams
- lang/functional
- lang/type
- loader/sandbox
- net/url
- net/xhr
- places/bookmarks
- places/favicon
- places/history
- platform/xpcom
- stylesheet/style
- stylesheet/utils
- system/child_process
- system/environment
- system/events
- system/runtime
- system/unload
- system/xul-app
- tabs/utils
- test/harness
- test/httpd
- test/runner
- test/utils
- ui/button/action
- ui/button/toggle
- ui/frame
- ui/id
- ui/sidebar
- ui/toolbar
- util/array
- util/collection
- util/deprecate
- util/list
- util/match-pattern
- util/object
- util/uuid
- window/utils
- Chrome Authority
- Creating Event Targets
- Getting started (cfx)
- Listening for Load and Unload
- Troubleshooting
- Debugging (before Firefox 50)
- Extending the developer tools
- alarms
- browsingData
- commands
- notifications
- runtime.getBrowserInfo()
- sessions
- sidebarAction
- topSites
- clear()
- Prerequisites
- Tips and Tricks
- Bundled web pages
- devtools_page
- Customizing the download progress bar
- Examples and demos from articles
- IsDefaultNamespace
- LookupNamespaceURI
- LookupPrefix
- Modules
- Tabbox
- URI parsing
- View Source for XUL Applications
- XPath
- Hotfix Extension
- Legacy extensions for Firefox for Android
- API
- Accounts.jsm
- addTab
- closeTab
- deck
- getBrowserForDocument
- getBrowserForWindow
- getTabForBrowser
- getTabForId
- getTabForWindow
- loadURI
- HelperApps.jsm
- Home.jsm
- HomeProvider.jsm
- HomeStorage
- NativeWindow
- remove
- Notifications.jsm
- PageActions.jsm
- Prompt.jsm
- RuntimePermissions.jsm
- Snackbars.jsm
- Sound.jsm
- Code snippets
- Creating a User Interface
- Firefox Hub Walkthrough
- Initialization and Cleanup
- Appendix: What you should know about open-source software licenses
- Chapter 1: Introduction to Extensions
- Chapter 2: Technologies used in developing extensions
- Chapter 4: Using XPCOM—Implementing advanced processes
- Chapter 6: Firefox extensions and XUL applications
- License and authors
- Adding sidebars
- Adding windows and dialogs
- Appendix B: Install and Uninstall Scripts
- Appendix C: Avoiding using eval in Add-ons
- Appendix E: DOM Building and Insertion (HTML & XUL)
- Appendix F: Monitoring DOM changes
- Connecting to Remote Content
- Custom XUL Elements with XBL
- Intercepting Page Loads
- Introduction
- Mozilla Documentation Roadmap
- Observer Notifications
- Setting Up a Development Environment
- The Box Model
- The Essentials of an Extension
- Useful Mozilla Community Sites
- User Notifications and Alerts
- XPCOM Objects
- Signing and distributing your add-on
- Techniques
- Create Your Own Firefox Background Theme
- Frequently Asked Questions for Lightweight themes
- Obsolete
- Adding items to the Folder Pane
- Adding views to the Folder Pane
- Building a Thunderbird extension 6: Adding JavaScript
- Demo Addon
- Styling the Folder Pane
- Activity Manager examples
- Add Toolbar Button
- Thunderbird developer reference docs
- customDBHeaders Preference
- Updates
- Working with multiprocess Firefox
- Using the message manager from Firefox extensions
Needs* tags
Found 15 pages. Learn more about how to deal with meta-tags.
- NeedsContent
- NeedsUpdate
- NeedsBetterPlace
- NeedsHelp
- NeedsExample
Editorial reviews
Found 6 pages. Learn more about how to do an editorial review.
Technical reviews
Found 42 pages. Learn more about how to do a technical review.
- AddonListener
- AddonScreenshot
- AddonUpdateChecker
- InstallListener
- UpdateCheckListener
- UpdateInfo
- UpdateListener
- Private Properties
- simple-storage
- system
- dev/panel
- net/xhr
- Creating Event Targets
- Using XPCOM without chrome
- Differences between desktop and Android WebExtensions
- StorageArea.get()
- tabs.onCreated
- tabs.onRemoved
- clear()
- Tips and Tricks
- User interface
- Address bar suggestions
- File I/O
- JavaScript Daemons Management
- Preferences
- Sidebar
- View Source for XUL Applications
- Windows
- Creating custom Firefox extensions with the Mozilla build system
- Extension Etiquette
- Installing extensions
- show
- XUL School Tutorial
- Adding Toolbars and Toolbar Buttons
- Adding windows and dialogs
- Getting Started with Firefox Extensions
- Create Your Own Firefox Background Theme
- Thunderbird extensions
- Building a Thunderbird extension 1: introduction
- Building a Thunderbird extension 3: install manifest
- Folders and message lists
- Updates
Outdated pages
Found 74 pages. These pages haven't been updated in over a year. Outdated pages can have problems with both content and format. Look at these pages and consider: Is this page talking about the Web of today? Does it look consistent with newer pages in this topic area? If not, make any needed changes.
- QuerySelector
1202 days old - Extensions support in SeaMonkey 2
549 days old - Hotfix Extension
549 days old - Index
549 days old - Firefox addons developer guide
378 days old - Chapter 1: Introduction to Extensions
378 days old - Chapter 2: Technologies used in developing extensions
378 days old - Chapter 3: Introduction to XUL—How to build a more intuitive UI
378 days old - Chapter 4: Using XPCOM—Implementing advanced processes
378 days old - Chapter 5: Let's build a Firefox extension
378 days old - Chapter 6: Firefox extensions and XUL applications
378 days old - License and authors
378 days old - XUL School Tutorial
378 days old - Adding Events and Commands
378 days old - Adding Toolbars and Toolbar Buttons
378 days old - Adding menus and submenus
378 days old - Adding sidebars
378 days old - Adding windows and dialogs
378 days old - Appendix A: Add-on Performance
378 days old - Appendix B: Install and Uninstall Scripts
378 days old - Appendix C: Avoiding using eval in Add-ons
378 days old - Appendix D: Loading Scripts
378 days old - Connecting to Remote Content
378 days old - Custom XUL Elements with XBL
378 days old - Getting Started with Firefox Extensions
378 days old - Handling Preferences
378 days old - Intercepting Page Loads
378 days old - Introduction
378 days old - JavaScript Object Management
378 days old - Local Storage
378 days old - Mozilla Documentation Roadmap
378 days old - Observer Notifications
378 days old - Setting Up a Development Environment
378 days old - The Box Model
378 days old - The Essentials of an Extension
378 days old - Useful Mozilla Community Sites
378 days old - User Notifications and Alerts
378 days old - XPCOM Objects
378 days old - Source Code Submission
509 days old - Techniques
549 days old - Create Your Own Firefox Background Theme
502 days old - Adding items to the Folder Pane
549 days old - Adding views to the Folder Pane
549 days old - Building a Thunderbird extension 1: introduction
549 days old - Building a Thunderbird extension 3: install manifest
549 days old - Building a Thunderbird extension 5: XUL
549 days old - Building a Thunderbird extension 6: Adding JavaScript
549 days old - Building a Thunderbird extension 8: packaging
549 days old - Building a Thunderbird extension 9: distributing
549 days old - Creating a Custom Column
549 days old - Error reporting tools
549 days old - FAQ
549 days old - Styling the Folder Pane
549 days old - Activity Manager examples
549 days old - Common Thunderbird Extension Techniques
549 days old - Access StringBundle from Overlay
549 days old - Access Window
549 days old - Access Window Area
549 days old - Add New Tab
549 days old - Add Option to Context Menu
549 days old - Add Tab
549 days old - Add Toolbar Button
549 days old - Create Custom Column
549 days old - Detect Opening Folder
549 days old - Filter Incoming Mail
549 days old - Get Thunderbird version
549 days old - Modify Folder Pane Display
549 days old - Modify Message List
549 days old - Use SQLite
549 days old - Folders and message lists
549 days old - Thunderbird developer reference docs
549 days old - Tips and Tricks from the newsgroups
549 days old - Working with the Folder Pane
549 days old - customDBHeaders Preference
549 days old
Dev-doc-needed bugs
Found 54 bugs. Learn more about how to resolve a dev-doc-needed bug.
Bug | Summary | Release |
---|---|---|
630874 | about:home doesn't work with unpacked omnijar | --- |
648664 | Create an MDC page listing all known XPCOM interface changes from Firefox 4 to 5 | --- |
934311 | Javascript modules don't share definition of Array (and probably all other standard classes like String etc.) | --- |
1198590 | Disable dom.ipc.plugins.asyncInit in Firefox 40.0.3 | --- |
1282768 | Convert permission notifications to use two buttons instead of the drop-down menu | Firefox 53 |
1171746 | Some panels stay open when switching or closing tabs | Firefox 51 |
1160200 | Add image/apng MIME type so it can be used with `picture` type switching. | mozilla48 |
1014185 | Remove the about:customizing preloading hack | Firefox 47 |
1208715 | Impose size restriction on extension icons | Firefox 44 |
968923 | Implement some equivalent of Chrome's use counters (on top of telemetry?) | mozilla43 |
467729 | RFE: Add font autoinstallation support | Firefox 38 |
914596 | Support building with Visual C++ 2013 | mozilla36 |
714675 | Fullscreen API should restore sidebar if it was open before entering fullscreen | Firefox 36 |
1050944 | Get Firefox to launch with the new .app bundle structure | Firefox 35 |
1047738 | Make distribution code look for the distribution directory under Contents/Resources due to v2 signing requirements | Firefox 35 |
1032573 | Implement Element.getAnimationPlayers | mozilla33 |
998246 | Add document.timeline interface | mozilla32 |
947344 | Australis - Show shortcuts for all widgets | Firefox 32 |
987492 | CustomizableUI.jsm should provide convenience APIs around windows | Firefox 31 |
970321 | UITour: Menu panel broken if tour tab is opened in new window | Firefox 30 |
952568 | [australis-measuring] Determine if Australis Update experience tab is active | Firefox 30 |
949471 | Firefox v26 history.data returns undefined when it should return null | mozilla29 |
942393 | Document CustomizableUI | Firefox 29 |
944947 | Label truncation is not fully supported in Australis menu widgets | Firefox 29 |
956162 | UITour: When highlighting app menu button, highlight is offset to the left (Implement @flip="none") | Firefox 29 |
819900 | Please add a File constructor | mozilla28 |
943683 | Annotate buttons when we migrate them from the add-on bar to the toolbar. | Firefox 28 |
752434 | Stop hiding toolbars for about:addons & Co. | Firefox 28 |
770135 | New PanelUI and toolbar customization (Milestone 1) | Firefox 28 |
927605 | Refactor keyboard-shortcut-to-text-string code into a JSM or otherwise reusable module | Firefox 27 |
602006 | Remove Error Console Menu Items | Firefox 24 |
650295 | Add support for speech input | mozilla22 |
844604 | Text is too small on hidpi displays | Firefox 22 |
831428 | ContentChild's nsIConsoleListener should have threadsafe addref/release methods | mozilla21 |
822367 | Implement Mixed Content Blocker Doorhanger - Backend Changes | mozilla21 |
815743 | Backout the UA changes in bug 588909 and its follow-ups from all branches | mozilla20 |
737153 | Enable mounting storage through USB from a host machine | mozilla15 |
758812 | Break up browser.js into smaller pieces, Phase 1 | Firefox 15 |
641892 | Support showing multiple popup notification icons at the same time | Firefox 15 |
736495 | Some scripts are importing modules with resource:///gre instead of resource:/// and vice-versa | Firefox 14 |
704400 | Implement --enable-dmd | mozilla11 |
706958 | Add ClearOnShutdown() function which will clear a smart pointer on shutdown | mozilla11 |
675553 | Switch from PRBool to bool | mozilla10 |
480735 | Startup timeline | mozilla1.9.3a5 |
462222 | getZOrderDOMWindowEnumerator broken on Linux and Mac | Firefox 3.6 |
627386 | Add more wildcards to match-pattern | 1.0 |
643156 | No mechanism to perform cross-domain HTTP HEAD request with add-on builder | --- |
773297 | widget ui doesn't get updated after customization of toolbar | --- |
1002229 | Add anonymous parameter to Request API | --- |
994280 | It would be nice to have ability to add badge over button | mozilla35 |
1026543 | expose the document.readyState property on tab instances (e10s) | mozilla33 |
892203 | Expose TextEncoder TextDecoder in SDK | mozilla26 |
852687 | nsIDOMWindowUtils should expose getInnerWindowWithId too | mozilla24 |
642447 | change default contentScriptWhen to new 'end' option that fires on 'load' event | 1.0b5 |
Browse as bug list.
Documentation requests
Found 30 bugs. Documentation request bugs can contain various kinds work related to MDN pages. Read through the bug and ask questions in the bug if in doubt.
Bug | Summary |
---|---|
384348 | should have documentation on how to sign an extension |
1133353 | Broken Theme Tutorial Page FR |
1162606 | Update add-on docs to cover AMO's automatic signing of extensions |
1189770 | document-element-inserted documentation is confusing at best |
1207849 | Add "deprecated" tags and markup to classic add-ons documents |
1245339 | explain the difference between dev-addons and dev-extensions mailing lists |
1256176 | typo in SDK-addon localization javascript code example |
1257261 | selected createProperties for tabs.create should be marked as deprecated |
1259260 | chrome.manifest is not registered until startup() |
1280032 | Availability of options pages for webextensions on Firefox Mobile |
1287590 | Webpage can override WebExtension frames |
1292539 | The SDK add-on localization documentation about options in preferences is not clear |
1315123 | Tutorial on MDN for the emoji substitution WebExtension example |
1317797 | Write a guide to storage in WebExtensions |
1321519 | manifest.json creator(s), developer(s), contributor(s), translator(s) properties, do they exist, are they documented? |
1322213 | Add-on version format consistency between docs, AMO, web-ext and browser? |
1322750 | Write a tutorial on building WebExtension UIs using React |
1324310 | AddonManager documentation broken due to missing AMInterface template |
1324375 | Clarify behavior of tabs.remove() Promise when beforeunload blocks removal |
1325831 | Need clear documentation for sending extension messages in WebExtensions (content script <-> extension) |
1329043 | WebExtensions resource page |
1338153 | Add an MDN doc about installing WebExtensions in enterprise environments |
1340402 | Add-on documentation for how to access external data sources |
1343038 | Documentation for new themes |
1346941 | tabs.executeScript() 'frameId' and 'allFrames' are mutually exclusive |
1352962 | How to develop WebExtensions for mobile (Firefox for Android, Fennec) |
1359229 | Make clear if an API is available from content scripts or not |
1373152 | Use arrow functions rather than separate functions for "then" of examples |
1375432 | Contradictory text |
1380729 | Document all the sensitive requests that webRequest API doesn't grant access to |
Browse as bug list.
Localizations
Please help us to localize this documentation into different languages. Read more about how to translate.
Language | Pages | Translated | Translations up to date |
---|---|---|---|
af | 869 | 2 (0%) | 1 (50%) |
bn-BD | 869 | 13 (1%) | 0 (0%) |
de | 869 | 48 (5%) | 4 (8%) |
es | 869 | 73 (8%) | 3 (4%) |
fa | 869 | 5 (0%) | 1 (20%) |
fr | 869 | 42 (4%) | 17 (40%) |
it | 869 | 16 (1%) | 3 (18%) |
ja | 869 | 159 (18%) | 23 (14%) |
ko | 869 | 25 (2%) | 1 (4%) |
pl | 869 | 22 (2%) | 0 (0%) |
pt-BR | 869 | 49 (5%) | 5 (10%) |
pt-PT | 869 | 13 (1%) | 0 (0%) |
ro | 869 | 2 (0%) | 0 (0%) |
ru | 869 | 58 (6%) | 7 (12%) |
zh-CN | 869 | 95 (10%) | 25 (26%) |
zh-TW | 869 | 32 (3%) | 1 (3%) |
Notes
Tagging standard
- TBD
Other tasks to do
- TBD
Tutorial to-do list
- TBD
Notes for translators
Any notes here? Where do we expect updates, so that localizers don't translate and update too often?
Macros
These macros are maintained and actively used in the MDN Add-ons area.
- AddonSidebar: the main sidebar used for all Add-ons pages
- WebExtAPISidebar: the piece of the main sidebar used in WebExtension API reference pages
- WebExtAPIRef: used for cross-references in WebExtension API reference pages
- WebExtChromeCompat: used to insert Chrome compatibility information into WebExtension API reference pages
- WebExtExamples: generates links of applicable examples in WebExtension API reference pages
- WebExtAPIEmbedType: used to insert the details of a WebExtension "type" into another page
- WebExtBrowserCompat: generates browser compatibility tables from JSON data
- WebExtBrowserCompatTable: generates a single compat table for a whole API or a single API item
- WebExtBrowserCompatSummaryTable: generates a summary compatibility table for a module from JSON data
- WebExtAllCompatTables: generate a list of all API compat tables
- WebExtAPIOverview: generates an overview page for WebExtension APIs