跳至主要内容
版本：5.1

更改日志

扩展开发者可以利用 Joomla 读取更改日志文件并提供更改日志的可视化表示的功能。如果在更改日志中找不到给定的版本，则不会显示更改日志按钮。

发行版中的更改以这种方式呈现

Changelog display

显示更改日志​

更改日志可以在 Joomla 管理员后端的 2 个位置显示。

  1. 管理扩展

Manage Extensions display

您可以点击版本号以显示更改日志。

要启用此功能，您必须在扩展安装清单文件中指定 Joomla 应该在哪里查找以找到更改日志详细信息，例如

<changelogurl>https://example.com/updates/changelog.xml</changelogurl>

请注意：changelogurl 标记中的 URL 在其前后不能有任何空格或换行符。

  1. 更新扩展

Update Extensions display

要启用此功能，您必须在扩展更新服务器文件中指定 Joomla 应该在哪里查找以找到更改日志详细信息，例如

<changelogurl>https://example.com/updates/changelog.xml</changelogurl>
Joomla 问题

此功能目前无法使用；请参阅Joomla 问题 43505。

更改日志文件​

下面是一个更改日志文件的示例

<changelogs>
    <changelog>
        <element>com_lists</element>
        <type>component</type>
        <version>4.0.0</version>
        <security>
            <item>Item A</item>
            <item>Item b</item>
        </security>
        <fix>
            <item>Item A</item>
            <item>Item b</item>
        </fix>
        <language>
            <item>Item A</item>
            <item>Item b</item>
        </language>
        <addition>
            <item>Item A</item>
            <item>Item b</item>
        </addition>
        <change>
            <item>Item A</item>
            <item>Item b</item>
        </change>
        <remove>
            <item>Item A</item>
            <item>Item b</item>
        </remove>
        <note>
            <item>Item A</item>
            <item>Item b</item>
        </note>
    </changelog>
    <changelog>
        <element>com_lists</element>
        <type>component</type>
        <version>0.0.2</version>
        <security>
            <item>Big issue</item>
        </security>
    </changelog>
</changelogs>

您可以在 <changelogs> 元素中指定多个 <changelog> 元素，每个扩展版本一个。

每个 <changelog> 元素必须具有以下 3 个节点

  • 元素
  • 类型
  • 版本

此信息用于识别给定扩展的正确更改日志，例如

<element>com_lists</element>
<type>component</type>
<version>4.0.0</version>

更改日志包含一个或多个更改类型。支持以下更改类型

  • security：已修复的任何安全问题
  • fix：已修复的任何错误
  • language：这是语言更改
  • addition：添加的任何新功能
  • change：任何更改
  • remove：已删除的任何功能
  • note：告知用户的任何额外信息

每个节点可以根据需要重复多次。

文本格式可以是纯文本或 HTML，但如果是 HTML，则必须将其包含在 CDATA 标记中，如下所示

<security>
    <item><![CDATA[<h2>You MUST replace this file</h2>]]></item>
</security>