From Joomla! Documentation
- 1 Choosing a name: recommendations
- 2 Extension names at JED
- 3 How is the name created at JED?
- 4 Joomla! as a word
- 5 Special cases
- 6 JED entry name: Do's and Don'ts
- 7 More information
To name your extension its an art and part of a marketing strategy. But you also need to stay away of name conflicts with extensions already listed at the JED. 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: recommendations
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.
How to create a good extension name?
Be creative and think on a brand: think about marketing for your extension, not for someone else brand!
- 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 at JED
JED is a directory and each submission gets its own ID (the number at the end of the URL on the edit page).
- This ID is the single identifier for each entry at JED.
- 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 names conflict
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 considered on a case-by-case basis
How is the name created at JED?
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 (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.
Where will JED look for extension names?
- In the XML tags and code file names. Some special tags need to be the same (spaces not included).
* <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:
- Components: in the XML name tag and file names or just to the menu tag name and JED alias name.
- Modules and plugins: in the XML name tag and file names or just at JED alias name.
Joomla! as a word
Word "Joomla!" and the extensions name
The JED has a direct interest in maintaining the integrity of the Joomla! brand. The JED team will not allow violations of 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 Checklist for more help.
Derivative of Joomla string
What are the strings considered related with Joomla string?
- please read: Trademark Checklist
How can your extensions be licensed?
- please read: Trademark Checklist
Extension Specific Extensions
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.
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:
- Update your XML file tags NAME and MENU
- Rename your files to reflect the new extension name
- Repack and re-attach the file to your JED entry
- 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.
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
JED entry name: Do's and Don'ts
- 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
- 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)
- 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)