Add-ons/Terminology

From MozillaWiki
< Add-ons
Revision as of 16:33, 28 July 2017 by AmyT (talk | contribs) (→‎Usage Guidelines: small edits)
Jump to navigation Jump to search

WebExtensions/Extensions/Add-ons

As of July 2017, we are moving away from calling extensions built with WebExtensions APIs "WebExtensions", and towards simply calling them "extensions". "WebExtensions" will still be used to describe the API that extensions are built on.

Background

When we first decided to move add-ons to a new API model, we needed a name for it that 1) was searchable 2) was distinguishable from legacy extensions and 3) signals its cross-browser interoperability. “WebExtensions” did all three, and we used it to describe extensions built with this new API.

Now that we’re close to completing the transition and supporting just one API for building extensions, we need to gradually drop the term “WebExtensions” when describing an extension built using the WebExtensions API.

Glossary

  • Add-on: an umbrella term that describes different types of code that extend Firefox. Mostly used on AMO. Includes extensions, themes, plug-ins, dictionaries, etc.
  • Extensions: pieces of code that extend the capabilities of a browser. In Firefox, extensions are a type of add-on.
  • Browser extensions: cross-browser extensions implemented using the Browser Extensions standard. (This article illustrates it nicely).
  • WebExtensions: a deprecated term that describes a Firefox extension built with WebExtensions APIs. Starting in Firefox 57, only extensions built with WebExtensions APIs will be supported. Therefore, we will start referring to them simply as "extensions". "WebExtensions" will remain in use in the context of describing the underlying technology of extensions.
  • Legacy extensions: a Firefox extension built using legacy APIs or the Add-on SDK.

Usage Guidelines

  • Avoid using the terms interchangeably - “Add-ons” and “Extensions” should not be used interchangeably, but in accordance with their definition and befitting the context.
  • "WebExtensions" refers to the technology, and not add-ons built with the technology - For example, “Cool new extensions” rather than “Cool new WebExtensions”
  • "WebExtensions" can still be used as a standalone term - It is ok to use the word "WebExtension(s)" without "API" following it, as long as you are describing the technology and not an add-on built with the technology. For example:
    • To distinguish from a legacy add-on: "Your WebExtension add-on displays a 'compatible with Firefox 57+' banner."
    • To describe the new system: "We're moving to a WebExtensions model for add-on development."
  • "API" or "APIs"? - The system, or the technology underlying add-on development is the WebExtensions API. Comprising it are WebExtensions APIs that expose certain parts of Firefox to add-on developers.
  • "Browser extensions" - For MDN extension documentation, formal cases (like the main title of the page) should say "Browser extensions", and thereafter "extensions" as an informal shorthand

addons.mozilla.org (AMO)

The site where you go to list and download add-ons is "addons.mozilla.org (AMO)" on the first mention, and "AMO" after that.

Questions?

When in doubt, please ask :kev, :jorgev, :wbamberg, or :amyt on irc.mozilla.org

Retrieved from "https://wiki.allizom.org/index.php?title=Add-ons/Terminology&oldid=1176703"