Actions

Difference between revisions of "Extensions name"

From Joomla! Documentation

m (Forks)
(Marked this version for translation)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<noinclude><languages /></noinclude>
 
{{RightTOC}}
 
{{RightTOC}}
 +
<translate><!--T:1-->
 +
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!</translate>
  
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 JED.
+
<translate><!--T:2-->
 +
This article contains a few recommendations for naming extensions derived from best practices in the Joomla community.</translate>
  
Extension names will impact in the extension structure and URLs after installed, so plan ahead!
+
<translate>
 +
== Choosing a name: recommendations== <!--T:3-->
 +
</translate>
 +
<translate>
 +
=== Using a name similar to another extension? === <!--T:4-->
 +
</translate>
 +
<translate><!--T:5-->
 +
*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</translate>
 +
<translate><!--T:6-->
 +
*Security reports for an extension with similar names could confuse users</translate>
 +
<translate><!--T:7-->
 +
*Simply adding a company name might not be sufficient enough change to make users aware of the differences</translate>
 +
<translate><!--T:8-->
 +
*Try to avoid brand disputes with other developers.</translate>
  
== Choosing a name: recommendations==
+
<translate>
=== Using a name similar to another extension? ===
+
=== How to create a good extension name? === <!--T:9-->
* Users could be confused and send bad reports or reviews to your extension but that was intended to the other
+
</translate>
* Security  reports for an extension with similar names could confuse users
+
<translate><!--T:10-->
* Just adding your company name couldn't be sufficient to make users aware of the differences
+
Be creative and think on a brand: think about marketing for your extension, not for someone else brand!</translate>
* You should stay away from brand disputes with other developers
+
<translate><!--T:11-->
 +
*Create an original brand name</translate>
 +
<translate><!--T:12-->
 +
*Choose a name that's easy to pronounce</translate>
 +
<translate><!--T:13-->
 +
*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.</translate>
 +
<translate><!--T:14-->
 +
*Avoid overly descriptive names</translate>
 +
<translate><!--T:15-->
 +
*Make it easy to search for your extension based on functionality, not by name.</translate>
  
=== How to create a good extension name? ===
+
<translate>
Be creative and think on a brand: think about marketing for your extension, not for others brand!
+
== Extension names at JED == <!--T:16-->
* Try to make up a new word for your brand name
+
</translate>
* Choose  a name thats easy and cool to pronounce
+
<translate><!--T:17-->
* Needs to be short as your XML and PHP files will be named after extension name. URLs on Joomla! sites will suffer too!
+
JED its a directory and each submission gets its own ID (the number at the end of the URL on the edit page).</translate>
* Avoid descriptive names as they are longer and more difficult to promote
+
<translate><!--T:18-->
* To make it easy to search use your description text at JED, not the name!
+
* This ID its the single identifier for each entry at JED.</translate>
 +
<translate><!--T:19-->
 +
* Each entry will get an ''alias'', also called ''Name'', to be easy to remember.</translate>
  
 +
<translate>
 +
=== First Come, First Served === <!--T:20-->
 +
</translate>
 +
<translate><!--T:21-->
 +
The JED listing name is approved by JED Editors on a first come, first served basis.</translate>
 +
<translate><!--T:22-->
 +
*Your extension name needs to be different from any extension already submitted to the JED (company names not included)</translate>
 +
<translate><!--T:23-->
 +
*The extension name must be stated at the XML file tag NAME</translate>
 +
<translate><!--T:24-->
 +
*You should use the same name in your site and download page.</translate>
  
== Extension names at JED ==
+
<translate>
JED its a directory and each submission gets its own ID (the number at the end of the URL on the edit page).
+
=== Extension names conflict === <!--T:25-->
* This ID its the single identifier for each entry at JED.
+
</translate>
* Each entry will get an ''alias'', also called ''Name'', to be easy to remember.
+
<translate><!--T:26-->
 +
An extension name will be considered in conflict when its too similar to other extension, at the discretion of JED Editors.</translate>
 +
<translate><!--T:27-->
 +
*When extension names are found to be in conflict, the JED will consider the first listing submitted, even if it's unpublished</translate>
 +
<translate><!--T:28-->
 +
*More recent listings are required to change their extension name</translate>
 +
<translate><!--T:29-->
 +
*Conflicts are considred on a case-by-case basis</translate>
  
=== Different extensions, different names ===
+
<translate>
The JED entry name its approved by JED Editors in a ''first-submitted, first-served'' system.
+
== How is the name created at JED? == <!--T:30-->
* Your extension name needs to be different from any extension already submitted to JED (company names not included)
+
</translate>
* The extension name must be stated at the XML file tag NAME
+
<translate><!--T:31-->
* You should use the same name in your site when referring to the extension, especially in the download page
+
The alias (name) is created by a JED editor, using the following pieces of information:</translate>
 +
<translate><!--T:32-->
 +
*Proposal of developer in the field called "name" (the proposal should be the same to XML file tag "NAME" and MENU")</translate>
 +
<translate><!--T:33-->
 +
*Some words are not allowed</translate>
 +
<translate><!--T:34-->
 +
*Some words may be added by JED editors, acting as tags.</translate>
  
=== Extension names conflict ===
+
<translate>
An extension name will be considered in conflict when its too similar to other extension.
+
===Alias Disclaimer=== <!--T:35-->
 +
</translate>
 +
<translate><!--T:36-->
 +
Alias (names) can be edited by JED editors at any time if it's considered necessary for the maintainance of the directory.</translate>
 +
<translate><!--T:37-->
 +
*The alias names used at the JED do not represent an endorsement of trademarks used by the product by Joomla.org or OSM</translate>
 +
<translate><!--T:38-->
 +
*The JED will not be involved in trademark disputes as they need to be addressed by the users.</translate>
  
This is a JED Editors call, but you are able to create a report for that.
+
<translate>
* When extension names are found in conflict, JED will consider the oldest extension submitted, even if not currently published.
+
=== Name registered === <!--T:39-->
* The more recent ones will be required to change their names.
+
</translate>
* This will be done case by case with each extension developer.
+
<translate><!--T:40-->
 
+
Where will JED look for extension names?</translate>
 
+
<translate><!--T:41-->
== How is the name created at JED? ==
+
* In the XML tags and code file names. Some special tags need to be the same (spaces not included).</translate>
The alias (name) its created by a JED editor, using:
+
<translate>
* Proposal of developer in the field called "name".
+
==== XML tags example ==== <!--T:42-->
** The proposal must be the same to install name in the xml manifest tag "NAME".
+
</translate>
* Some words are not allowed. ie Refrain from using 'plugin' or 'module' in names.
+
<translate><!--T:43-->
* Some words can be added by JED editors, acting as tags.
+
as in:</translate>
 
+
=== Name registered ===
+
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).
+
==== XML tags ====
+
as in:
+
 
  * <name>jedilightsaber</name>
 
  * <name>jedilightsaber</name>
 
  * <menu>Jedi Lightsaber</menu>
 
  * <menu>Jedi Lightsaber</menu>
==== File names ====
+
<translate>
as in:
+
==== File names example ==== <!--T:44-->
 +
</translate>
 +
<translate><!--T:45-->
 +
as in:</translate>
 
  * mod_jedilightsaber.xml
 
  * mod_jedilightsaber.xml
 
  * mod_jedilightsaber.php
 
  * mod_jedilightsaber.php
  
==== Light and Pro versions ====
+
<translate>
The word "Light"and/or "Pro" can be added to differentiate two extensions from the same developer but with different features and distribution plans (as in non-commercial Lite version and commercial Pro version ) The word "Free" is considered promotional text and cannot be used.
+
==== Light and Pro versions ==== <!--T:46-->
 +
</translate>
 +
<translate><!--T:47-->
 +
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.</translate>
  
Where to add the LIGHT/PRO tag?
+
<translate><!--T:48-->
* Components: in the XML name tag and file names or just to the menu tag name and JED Alias name.
+
When adding the "Light" and "Pro" tags:</translate>
* Modules and plugins: in the XML name tag and file names or just at JED Alias name.
+
<translate><!--T:49-->
 +
* Components: in the XML name tag and file names or just to the menu tag name and JED alias name.</translate>
 +
<translate><!--T:50-->
 +
* Modules and plugins: in the XML name tag and file names or just at JED alias name.</translate>
  
== Joomla as a word ==
+
<translate>
=== Word "Joomla" and the extensions name ===
+
== Joomla! as a word == <!--T:51-->
We at the Joomla Extensions Directory have a direct interest in maintaining the integrity of the Joomla brand.
+
</translate>
 +
<translate>
 +
=== Word "Joomla!" and the extensions name === <!--T:52-->
 +
</translate>
 +
<translate><!--T:53-->
 +
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.</translate>
 +
<translate><!--T:54-->
 +
*An extension name can't start with the word "Joomla"</translate>
 +
<translate><!--T:55-->
 +
*Extensions that use "Joomla" or a derivative of Joomla! in the extension name need to be licensed by OSM</translate>
 +
<translate><!--T:56-->
 +
*Extensions that use "Joomla" or a derivative of Joomla in the domain name need to be licensed by OSM</translate>
 +
<translate><!--T:57-->
 +
*It's a best practice to completely avoid the full word Joomla.</translate>
 +
<translate><!--T:58-->
 +
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 [[S:MyLanguage/JED Entries Trademark Checklist|Trademark Checklist]] for more help.</translate>
  
As such, we cannot allow violations of the Joomla trademark, logo, brand, etc., to be placed in or linked from the Joomla Extensions Directory.
+
<translate>
* An extension name can't start with the word "Joomla".
+
=== Derivative of Joomla string === <!--T:59-->
* Extensions that use "Joomla" or a derivative of Joomla in the extension name need to be licensed by OSM.
+
</translate>
* Extensions that use "Joomla" or a derivative of Joomla in the domain name need to be licensed by OSM.
+
<translate><!--T:60-->
Please note that extensions should not be named ''Joomla! XXX''. Rather they should be named ''XXX for Joomla!'' or some other similar variation that will not cause confusion with Joomla!.
+
What are the strings considered related with Joomla string?</translate>
* Its a good practice to completely avoid the full word Joomla.
+
<translate><!--T:61-->
 +
* please read: [[S:MyLanguage/JED Entries Trademark Checklist|Trademark Checklist]]</translate>
  
=== Derivative of Joomla string ===
+
<translate>
What are the  strings considered related with Joomla string?
+
=== Joomla! Licensed === <!--T:62-->
* please read: [[JED_Entries_Trademark_Checklist]]
+
</translate>
 +
<translate><!--T:63-->
 +
How can your extensions be licensed?</translate>
 +
<translate><!--T:64-->
 +
* please read: [[S:MyLanguage/JED Entries Trademark Checklist|Trademark Checklist]]</translate>
  
=== Joomla! Licensed ===
+
<translate>
How can your extensions be licensed?
+
== Special cases == <!--T:65-->
* please read: [[JED_Entries_Trademark_Checklist]]
+
</translate>
 +
<translate>
 +
=== Extension Specific Extensions === <!--T:66-->
 +
</translate>
 +
<translate><!--T:67-->
 +
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.</translate>
  
 +
<translate>
 +
=== Rebranding === <!--T:68-->
 +
</translate>
 +
<translate><!--T:69-->
 +
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:</translate>
 +
<translate><!--T:70-->
 +
# Update your XML file tags NAME and MENU</translate>
 +
<translate><!--T:71-->
 +
# Rename your files to reflect the new extension name</translate>
 +
<translate><!--T:72-->
 +
# Repack and re-attach the file to your JED entry</translate>
 +
<translate><!--T:73-->
 +
# Revise the mentions to the extension at your website</translate>
 +
<translate><!--T:74-->
 +
'''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.</translate>
  
== Special cases ==
+
<translate>
=== Extension Specific Extensions ===
+
=== Forks === <!--T:75-->
Extension Specific Extensions are considered extensions that require another extension to be installed in order to run.
+
</translate>
* Specific extensions to an individual extension will have "for MAIN-EXTENSION-NAME" at the end of its name, and included as part of the XML name.
+
Example: "Category filter for K2" or "Product search for Virtuemart"
+
 
+
=== Rebranding ===
+
If you need to re-brand an old extension and avoid conflicts in installed sites 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 actual JED entry
+
# Revise the mentions to the extension at your website
+
Note: If #1 or #2 are not possible on compatibility 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.
 
Forked extensions have special rules to be listed at JED.
* The extension name also needs to be changed and cannot use the old one so it is very clear that this is a separate project.
+
<translate><!--T:76-->
 
+
Please read: [http://extensions.joomla.org/tos TOS - Extensions and Forks]
Please read: TOS - Extensions and Forks http://extensions.joomla.org/tos
+
Also read: [[S:MyLanguage/Forked_Extensions|Forked Extensions]]</translate>
Also read: Forked Extensions http://docs.joomla.org/Forked_Extensions
+
 
+
=== Tools ===
+
The name must be included at the main or EXE file name.
+
* A TXT file must be included with the tool name, copyright, license and URL to download
+
 
+
=== 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 donts ==
+
===The Do's ===
+
* XML file tag NAME needs to be the same as the extension entry name
+
* Components Admin menu (the tag MENU in the XML) needs to be the same as the Extension name
+
  
===The Don'ts ===
+
<translate>
* Offensive words, political or religious statements.
+
=== Scripts or libraries === <!--T:77-->
* Extension types as they are not considered part of the extension name.
+
</translate>
** This will be used only for the same developer extensions if required (module and plugin versions)
+
<translate><!--T:78-->
* Version number (there is a field for that)
+
The name must be included at the main file.</translate>
* Price tags, commercial promotions or URL domains
+
<translate><!--T:79-->
* Company name or author name (there is a field for that)
+
*In the headers script you need to include comments with the script name, copyright and license</translate>
 +
<translate><!--T:80-->
 +
*A TXT file must be included with the name, copyright, license and URL to download</translate>
  
 +
<translate>
 +
== JED entry name: Do's and Don'ts == <!--T:81-->
 +
</translate>
 +
<translate>
 +
===The Do's === <!--T:82-->
 +
</translate>
 +
<translate><!--T:83-->
 +
*Name the XML file tag NAME the same as the extension name</translate>
 +
<translate><!--T:84-->
 +
*Name the Component's admin menu (the tag MENU in the XML) the same as the extension name</translate>
  
== Alias Disclaimer ==
+
<translate>
Alias (names) can be edited by Jed editors at any time if its considered necessary for the maintainance of the directory.
+
===The Don'ts=== <!--T:85-->
*The alias names used at JED does not represent an endorsement of trademarks used by the product by Joomla.org or OSM
+
</translate>
*JED will not be involved in trademarks disputes as they need to be addressed by the users.
+
<translate><!--T:86-->
 +
*Use offensive words, political or religious statements</translate>
 +
<translate><!--T:87-->
 +
*Use extension types as part of the extension name (only used for the mobude and plugin versions of the same extension from the same developer)</translate>
 +
<translate><!--T:88-->
 +
*Use the version number in the name (there is a field for that)</translate>
 +
<translate><!--T:89-->
 +
*Use price tags, commercial promotions or URL domains in the name</translate>
 +
<translate><!--T:90-->
 +
*Use the author or company name in the extension name (there is a field for that)</translate>
  
 +
<translate>
 +
==More information== <!--T:91-->
 +
</translate>
 +
<translate><!--T:92-->
 +
*See: [http://extensions.joomla.org/support/knowledgebase/item/extension-names Extension Names on the JED website]</translate>
  
<noinclude>[[Category:JED]][[Category:FAQ]][[Category:Template Development]]
+
<noinclude>
 +
<translate>
 +
<!--T:93-->
 +
[[Category:JED]]
 +
[[Category:FAQ]]
 +
[[Category:Template Development]]
 
[[Category:Module Development]]
 
[[Category:Module Development]]
 
[[Category:Plugin Development]]
 
[[Category:Plugin Development]]
[[Category:Component Development]]</noinclude>
+
[[Category:Component Development]]
 +
</translate>
 +
</noinclude>

Latest revision as of 08:03, 20 August 2015

Other languages:
English

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 its a directory and each submission gets its own ID (the number at the end of the URL on the edit page).

  • This ID its 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 considred 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 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.

Name registered

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).

XML tags example

as in:

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

File names example

as in:

* 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 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 Checklist for more help.

Derivative of Joomla string

What are the strings considered related with Joomla string?

Joomla! Licensed

How can your extensions be licensed?

Special cases

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.

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. Please read: TOS - Extensions and Forks Also read: 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

JED entry name: Do's and Don'ts

The Do's

  • 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

The Don'ts

  • Use offensive words, political or religious statements
  • Use extension types as part of the extension name (only used for the mobude 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)

More information