给您的扩展命名非常重要。扩展名称会影响扩展结构和扩展安装后显示的 URL,因此请提前规划!本文包含了一些来自 Joomla! 社区最佳实践的命名扩展建议。
选择名称
使用与另一个扩展相似的名称
- 用户可能会混淆这两个扩展,即使它是为另一个扩展而设计的,也可能报告您的扩展或为您的扩展写负面评论
- 具有相似名称的扩展的安全报告可能会使用户困惑
- 仅仅添加公司名称可能不足以让用户意识到差异
- 尽量避免与其他开发者发生品牌争议
创建一个良好的扩展名称
发挥创意,考虑您扩展的**品牌**和**营销**。
- 创建一个原创品牌名称
- 选择一个易于发音的名称
- 名称应该尽可能短,因为您的 XML 和 PHP 文件是以扩展名称命名的。Joomla! 站点上的 URL 也受扩展名称的影响。
- 避免过于描述性的名称
- 使您的扩展易于根据功能而不是名称进行搜索
JED 中的扩展名称
JED 中的每个条目都获得其唯一的 ID(编辑页面 URL 末尾的数字)。
- 此 ID 用作条目的主要标识符
- 每个条目都会得到一个别名,也称为“名称”,以便于记忆
先来后到
JED 列表名称是由 JED 编辑根据先来后到的原则批准的。
- 您的扩展名称需要与已提交给 JED 的任何扩展名称不同(公司名称除外)
- 扩展名称必须在 XML 文件标签 NAME 中声明
- 您应该在您的网站和下载页面上使用相同的名称
扩展名称冲突
如果一个扩展名称与其他扩展名称过于相似,则 JED 编辑将根据情况考虑其为冲突。
- 当发现扩展名称存在冲突时,JED 将考虑首先提交的列表,即使它尚未发布
- 需要更近期的列表来更改其扩展名称
- 冲突将根据具体情况考虑
扩展名称别名
别名(名称)是由 JED 编辑根据以下信息创建的
- 称为“名称”的该领域开发者的建议(建议应与 XML 文件标签“NAME”和“MENU”相同)
- 有些词不允许使用
- 有些词可能由 JED 编辑添加,作为标签。
别名免责声明
如果认为对目录的维护有必要,JED 编辑可以随时编辑别名(名称)。
- JED 中使用的别名名称不代表 Joomla.org 或 OSM 对产品使用的商标的认可
- JED 不会涉及商标争议,因为这些争议需要由用户解决。
注册名称
JED 在 XML 标签和代码文件名称中寻找扩展名称。一些特殊的标签需要相同(不包括空格)。
XML 示例
* <name>jedilightsaber</name> * <menu>Jedi Lightsaber</menu>
文件名称示例
* mod_jedilightsaber.xml * mod_jedilightsaber.php
轻量版和 Pro 版本
可以在区分同一开发者的两个扩展时添加“轻量”和“Pro”这两个词,但扩展必须具有不同的功能和分发计划(如免费的 Lite 版本和付费的 Pro 版本)。单词“免费”被视为促销文本,不能使用。
添加“轻量”和“Pro”标签时
- 对于组件:在 XML 名称标签和文件名称或仅菜单标签名称和 JED 别名名称中。
- 对于模块和插件:在 XML 名称标签和文件名称或仅 JED 别名名称中。
使用“Joomla”一词
JED 对维护 Joomla 品牌的完整性有直接兴趣。JED 团队不会允许将违反 Joomla 商标、标志、品牌等的行为放置在或从 JED 链接。
- 扩展名称不能以“Joomla”开头
- 在扩展名称中使用“Joomla”或 Joomla 衍生物的扩展需要由 OSM 许可
- 在域名中使用“Joomla”或 Joomla 衍生物的扩展需要由 OSM 许可
- 最好完全避免使用完整的单词 Joomla。
请注意,扩展名称不应命名为“Joomla! x”。相反,它们应命名为“x for Joomla!”或类似名称,这样就不会与 Joomla 混淆。 查看商标清单以获取更多信息。
特殊情况
特定于扩展的插件
特定于扩展的插件是需要在安装其他扩展后才能运行的扩展。这些插件必须在扩展名称的末尾有“for MAIN-EXTENSION-NAME”,即使它不在 XML 文件中。
重新品牌化
如果您需要重新品牌化旧的扩展,但又想避免与已安装旧扩展的网站发生冲突,请首先与 JED 团队联系。在选择了新名称后
- 更新您的 XML 文件标签 NAME 和 MENU
- 将您的文件重命名为反映新的扩展名称
- 重新打包并将文件重新附加到您的 JED 条目
- 修改您网站上对扩展的提及
注意:如果#1或#2由于与已安装网站兼容性问题而不可行,请在XML文件的描述标签或注释行中包含新名称。
分支
分支扩展在JED上有特殊规则。有关分支扩展的更多信息,请参阅分支扩展。
脚本或库
必须在主文件中包含名称。
- 在脚本头部中,您需要包含包含脚本名称、版权和许可证的注释
- 必须包含一个TXT文件,其中包含名称、版权、许可证和下载URL
扩展名称的规范与禁忌
做
- 将XML文件标签的NAME命名为与扩展名称相同
- 将组件的admin菜单(XML中的MENU标签)命名为与扩展名称相同
不要
- 使用攻击性词语、政治或宗教声明
- 将扩展类型作为扩展名称的一部分使用(仅用于来自同一开发者的同一扩展的模块和插件版本)。关键字如模块、插件或模板被视为保留词,不能用于扩展名称。
- 在名称中使用版本号(有一个字段用于此目的)
- 在名称中使用价格标签、商业促销或URL域名
- 在扩展名称中使用作者或公司名称(有一个字段用于此目的)
安装名称和条目名称
请记住,在清单文件中定义的安装名称与条目名称相同。
插件安装名称
在特定情况下,Joomla!对插件有一个通用约定,即在扩展名称中添加插件组。
您的插件名称必须符合JED命名约定 - 形式为“{Type} - {Extension Name}”的插件。
例如:认证 - Joomla