Joomla! Extensions Directory™

Download
Launch

JED Documentation

Extension Names

Naming your extension is very important. Extension names impact the extension structure and URLs that are displayed after the extension is installed, so plan ahead! This article contains a few recommendations for naming extensions derived from best practices in the Joomla community.

Choosing a Name

Using a Name Similar to Another Extension

  • Users could mix up the two extensions and report your extension or write a bad review for your extension even though it was intended for another
  • Security reports for an extension with similar names could confuse users
  • Simply adding a company name might not be sufficient enough change to make users aware of the differences
  • Try to avoid brand disputes with other developers

Creating a Good Extension Name

Be creative and think about branding and marketing your extension.

  • Create an original brand name
  • Choose a name that's easy to pronounce
  • The name should be short as your XML and PHP files are named after the extension name. URLs on Joomla sites are also impacted by extension names.
  • Avoid overly descriptive names
  • Make it easy to search for your extension based on functionality, not by name

Extension Names in the JED

Each listing in the JED gets it's own unique ID (the number at the end of the URL on the edit page).

  • This ID is used as the main identifier for listings
  • Each entry will get an alias, also called "Name", to be easy to remember

First Come, First Served

The JED listing name is approved by JED Editors on a first come, first served basis.

  • Your extension name needs to be different from any extension already submitted to the JED (company names not included)
  • The extension name must be stated at the XML file tag NAME
  • You should use the same name in your site and download page

Extension Name Conflicts

An extension name will be considered in conflict when its too similar to other extension, at the discretion of JED Editors.

  • When extension names are found to be in conflict, the JED will consider the first listing submitted, even if it's unpublished
  • More recent listings are required to change their extension name
  • Conflicts are considred on a case-by-case basis

Extension Name Aliases

The alias (name) is created by a JED editor, using the following pieces of information:

  • Proposal of developer in the field called "name" (the proposal should be the same to XML file tag "NAME" and MENU")
  • Some words are not allowed
  • Some words may be added by JED editors, acting as tags.

Alias Disclaimer

Alias (names) can be edited by JED editors at any time if it's considered necessary for the maintainance of the directory.

  • The alias names used at the JED do not represent an endorsement of trademarks used by the product by Joomla.org or OSM
  • The JED will not be involved in trademark disputes as they need to be addressed by the users.

Registered Names

The JED looks for extension names in the XML tags and code file names. Some special tags need to be the same (spaces not included).

XML example:

* <name>jedilightsaber</name>
* <menu>Jedi Lightsaber</menu>

File names example:

* mod_jedilightsaber.xml
* mod_jedilightsaber.php

Light and Pro Versions

The words "Light" and "Pro" can be added to differentiate two extensions from the same developer, but the extensions must have different features and distribution plans (like a free Lite version and paid Pro version). The word "Free" is considered promotional text and cannot be used.

When adding the "Light" and "Pro" tags:

  • For Components: in the XML name tag and file names or just to the menu tag name and JED alias name.
  • For Modules and Plugins: in the XML name tag and file names or just at JED alias name.

Using the Word "Joomla"

The JED has a direct interest in maintaining the integrity of the Joomla brand. The JED team will not allow violations fo the Joomla trademark, logo, brand, etc. to be placed in or linked from the JED.

  • An extension name can't start with the word "Joomla"
  • Extensions that use "Joomla" or a derivative of Joomla in the extension name need to be licensed by OSM
  • Extensions that use "Joomla" or a derivative of Joomla in the domain name need to be licensed by OSM
  • It's a best practice to completely avoid the full word Joomla.

Please note that extensions should not be named "Joomla! x". Instead, they should be named "x for Joomla!" or something similar that will not be confused with Joomla. Review the Trademark Checkist for more help.

Special Cases

Extension Specific Plugins

Extension Specific Plugins are extensions that require another extension to be installed in order to run. These plugins must have "for MAIN-EXTENSION-NAME" at the end of the extension name, even if it's not in the XML file.

Rebranding

If you need to re-brand an old extension, but you want to avoid conflicts with sites where the older extension is already installed, please talk with JED Team first. After choosing the new name:

  1. Update your XML file tags NAME and MENU
  2. Rename your files to reflect the new extension name
  3. Repack and re-attach the file to your JED entry
  4. Revise the mentions to the extension at your website

Note: If #1 or #2 are not possible in respects to compatibility issues with installed sites, please include the new name in the description tag or in a comments line at your XML file.

Forks

Forked extensions have special rules to be listed at JED. Read more about Forked Extensions.

Scripts or Libraries

The name must be included at the main file.

  • In the headers script you need to include comments with the script name, copyright and license
  • A TXT file must be included with the name, copyright, license and URL to download

Extension Names Dos and Don'ts

Do:

  • Name the XML file tag NAME the same as the extension name
  • Name the Component's admin menu (the tag MENU in the XML) the same as the extension name

Don't:

  • Use offensive words, political or religious statements
  • Use extension types as part of the extension name (only used for the module and plugin versions of the same extension from the same developer). Keywords such as module, plugin or template are considered reserved words and can't be used in the extension names.
  • Use the version number in the name (there is a field for that)
  • Use price tags, commercial promotions or URL domains in the name
  • Use the author or company name in the extension name (there is a field for that)

 

Install name and Entry Name

Please, remember to define the install name in the manifest file the same than the entry name.

Plugins install name

In the particular case of plugins, Joomla! has a general convention of adding the plugin group in the extension name.

The name of your plugin must comply with the JED naming conventions - plugins in the form “{Type} - {Extension Name}”.

For instance: Authentication - Joomla