Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
b6eb613
step1
robbiejackson Apr 27, 2024
c36501e
step 2 tmpl file
robbiejackson Apr 29, 2024
62a8b14
step 3 helper file
robbiejackson Apr 29, 2024
6afbc71
Merge branch 'joomla:main' into module-tutorial
robbiejackson Apr 29, 2024
6fdf1ca
step 4 language support
robbiejackson Apr 30, 2024
b3f590a
fix language files
robbiejackson Apr 30, 2024
8781033
step 5 config
robbiejackson Apr 30, 2024
35fffbf
fix typos, plus try // as comments in ini file highlights
robbiejackson Apr 30, 2024
9386dfa
Merge branch 'joomla:main' into module-tutorial
robbiejackson May 1, 2024
b64b462
step 6 javascript plus removed Restricted Access
robbiejackson May 2, 2024
efa02e8
remove version in extension element in manifest file
robbiejackson May 3, 2024
77f7264
insert of script file as step 6
robbiejackson May 5, 2024
836e314
Step 6 script file inserted
robbiejackson May 15, 2024
a99b37c
Step 8 service provider done
robbiejackson May 16, 2024
8f5b125
Step 9 Ajax
robbiejackson May 17, 2024
2e64f32
Revised step 1
robbiejackson May 22, 2024
51f9746
fix build
robbiejackson May 22, 2024
3303cbd
backticks around xml tags
robbiejackson May 22, 2024
f640e55
revised step 2
robbiejackson May 23, 2024
9ca1acf
revised step 3
robbiejackson May 23, 2024
4afb008
revised step 4
robbiejackson May 23, 2024
7c46450
Revised step 5
robbiejackson May 24, 2024
cabc9b7
revised step 6
robbiejackson May 24, 2024
82709d2
revised step 7
robbiejackson May 24, 2024
e40c8b7
revised step 8
robbiejackson May 24, 2024
d830b84
revised step 9
robbiejackson May 25, 2024
e0c5926
revised step 10
robbiejackson May 27, 2024
19ffba1
revised step 10
robbiejackson May 27, 2024
eeaac97
some install documentation
robbiejackson Jun 2, 2024
73699a5
br tag changed
robbiejackson Jun 2, 2024
3c1f221
fix backtick
robbiejackson Jun 2, 2024
a15e9f6
fix broken links and format summary table
robbiejackson Jun 2, 2024
43fc304
changes associated with alternative languages approach
robbiejackson Jun 2, 2024
b4583b7
step 11 update server
robbiejackson Jun 2, 2024
666e48d
changelog added
robbiejackson Jun 21, 2024
f7b848d
package extension done
robbiejackson Jun 23, 2024
9bc710a
Merge branch 'joomla:main' into module-tutorial
robbiejackson Jun 24, 2024
2b6c152
Fixes typos and other small items after final check
robbiejackson Jun 27, 2024
97f2e5b
Merge branch 'joomla:main' into module-tutorial
robbiejackson Jun 27, 2024
f8b1b16
Changes duplicated to other versions
robbiejackson Jun 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 0 additions & 150 deletions docs/building-extensions/install-update/install.md

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
130 changes: 130 additions & 0 deletions docs/building-extensions/install-update/install/change-log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
---
sidebar_position: 3
title: Changelogs
---

Changelogs
==========

Extension developers can leverage the ability of Joomla to read a changelog file and give a visual representation of the changelog. If a given version is not found in the changelog, the changelog button will not be shown.

The changes in a release are presented in this manner:

![Changelog display](./_assets/changelog.jpg)

## Displaying the Changelog

Changelogs can be displayed in 2 places within the Joomla administrator back-end.

1. Manage Extensions

![Manage Extensions display](./_assets/changelog-manage.jpg)

You can click on the version number to display the changelog.

To enable this you must specify in the extension installation manifest file where Joomla should look to find the changelog details, for example:

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

Please note: The URL in the changelogurl tag must not have any spaces or line breaks before or after it.

2. Update Extensions

![Update Extensions display](./_assets/changelog-update.jpg)

To enable this you must specify in the extension[ update server](../update-server.md) file where Joomla should look to find the changelog details, for example:

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

:::note[Joomla Issue]
This feature does not currently work; see [Joomla issue 43505](https://issues.joomla.org/tracker/joomla-cms/43505).
:::

## The Changelog File

An example of a changelog file is below:

```xml
<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>
```

You may specify multiple `<changelog>` elements within the `<changelogs>` element, one for each version of the extension.

Each `<changelog>` element must have the following 3 nodes:
- element
- type
- version

This information is used to identify the correct changelog for a given extension, for example:

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

The changelog contains one or more change types. The following change types are supported:
- security: Any security issues that have been fixed
- fix: Any bugs that have been fixed
- language: This is for language changes
- addition: Any new features added
- change: Any changes
- remove: Any features removed
- note: Any extra information to inform the user

Each node can be repeated as many times as needed.

The format of the text can be plain text or HTML but in case of HTML, it must be enclosed in CDATA tags as in:

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

10 changes: 10 additions & 0 deletions docs/building-extensions/install-update/install/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 1
title: Installing Extensions
---

This section covers:
- how to install extensions - by means of a Manifest File
- the overall installation process, and how you can write a Script File to interact with it
- the ChangeLog File
- packages
Loading