Add-ons/Terminology: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
m (→‎Usage Guidelines: small edits)
m (more examples)
Line 3: Line 3:


===Background===
===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.  
When we first decided to move Firefox extensions to a new API, we needed a name for it that 1) was searchable 2) was distinguishable from legacy technology and 3) signals its cross-browser compatibility. “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.
Now that we’re close to completing the transition and supporting just one API, we need to gradually drop the term “WebExtensions” when describing extensions built using the WebExtensions API.


===Glossary===
===Glossary===
*'''Add-on:''' an umbrella term that describes different types of code that extend Firefox. Mostly used on [https://addons.mozilla.org AMO]. Includes extensions, themes, plug-ins, dictionaries, etc.  
*'''Add-ons:''' an umbrella term that describes different types of code that modify Firefox. Mostly used on [https://addons.mozilla.org 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.
*'''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 [https://browserext.github.io/ Browser Extensions standard]. ([https://www.smashingmagazine.com/2017/04/browser-extension-edge-chrome-firefox-opera-brave-vivaldi/ This article] illustrates it nicely).
*'''Browser extensions:''' cross-browser extensions implemented using the [https://browserext.github.io/ Browser Extensions standard]. ([https://www.smashingmagazine.com/2017/04/browser-extension-edge-chrome-firefox-opera-brave-vivaldi/ 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.
*'''WebExtensions:''' a deprecated term that describes Firefox extensions 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 context of describing the underlying technology (see below).
*'''Legacy extensions:''' a Firefox extension built using legacy APIs or the Add-on SDK.
*'''Legacy extensions:''' Firefox extensions built using legacy APIs or the Add-on SDK.


===Usage Guidelines===
===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.
*'''Avoid using "add-ons" and "extensions" interchangeably''' - The terms “add-ons” and “extensions” should be used in accordance with their definition and the context in which they appear.
*'''"WebExtensions" refers to the technology, and not add-ons built with the technology''' - For example, “Cool new extensions” rather than “Cool new WebExtensions”
**'''Add-ons''' is a Firefox-specific term. There are different kinds of add-ons that you can use to customize Firefox, including extensions and themes. Use "add-ons" when talking about the customization of Firefox in general.
*'''"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:
**'''Extensions''' add new features and functionality to browsers. Use "extensions" when talking about the type of add-on that adds new features and functionality to Firefox, or when talking about the customization of browsers in general.  
**To distinguish from a legacy add-on: "Your WebExtension add-on displays a 'compatible with Firefox 57+' banner."  
*'''"WebExtensions" refers to the technology, and not extensions 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 extensions built with the technology. For example:
**To distinguish from a legacy extension: "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."
**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.
*'''"API" or "APIs"?''' - The system, or the technology underlying Firefox extension development, is the WebExtensions API. Comprising it are WebExtensions APIs that expose certain parts of Firefox to 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
*'''"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


Revision as of 20:53, 28 July 2017

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 Firefox extensions to a new API, we needed a name for it that 1) was searchable 2) was distinguishable from legacy technology and 3) signals its cross-browser compatibility. “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, we need to gradually drop the term “WebExtensions” when describing extensions built using the WebExtensions API.

Glossary

  • Add-ons: an umbrella term that describes different types of code that modify 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 Firefox extensions 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 context of describing the underlying technology (see below).
  • Legacy extensions: Firefox extensions built using legacy APIs or the Add-on SDK.

Usage Guidelines

  • Avoid using "add-ons" and "extensions" interchangeably - The terms “add-ons” and “extensions” should be used in accordance with their definition and the context in which they appear.
    • Add-ons is a Firefox-specific term. There are different kinds of add-ons that you can use to customize Firefox, including extensions and themes. Use "add-ons" when talking about the customization of Firefox in general.
    • Extensions add new features and functionality to browsers. Use "extensions" when talking about the type of add-on that adds new features and functionality to Firefox, or when talking about the customization of browsers in general.
  • "WebExtensions" refers to the technology, and not extensions 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 extensions built with the technology. For example:
    • To distinguish from a legacy extension: "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 Firefox extension development, is the WebExtensions API. Comprising it are WebExtensions APIs that expose certain parts of Firefox to 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=1176804"