Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Get Started introductory page #284

Merged
merged 6 commits into from
Jul 28, 2024
Merged

Improve Get Started introductory page #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
66b15d5
Improve Get Started page, plus fix some typos and links
robbiejackson Jul 17, 2024
f419681
v5.0 needs module tutorial if linked from Get Started page
robbiejackson Jul 17, 2024
eb3f6de
... plus the docs that the module tutorial links to
robbiejackson Jul 17, 2024
1949640
copied 5.1 into 5.0 build and concepts
robbiejackson Jul 18, 2024
938d20b
change install directory name to get round docusaurus feature
robbiejackson Jul 18, 2024
09513e5
updated README to warn about docusaurus problem with subdirectory names
robbiejackson Jul 18, 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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ Don't use colons (:) in titles.

Don't use `<br>` to force a new line (eg in table text); use `<br/>` instead.

Don't use subdirectory names which match somewhat the parent directory name. For example, avoid `./install-update/install/`, as this can cause docusaurus to report broken links.

### Docusaurus Additions

You won't see the effect of these when you preview the Markdown text, but you will see them by previewing the Pull Request.
Expand Down
0 ...date/install/_assets/changelog-manage.jpg → ...installation/_assets/changelog-manage.jpg
View file
Open in desktop
File renamed without changes
0 ...date/install/_assets/changelog-update.jpg → ...installation/_assets/changelog-update.jpg
View file
Open in desktop
File renamed without changes
0 ...tall-update/install/_assets/changelog.jpg → ...update/installation/_assets/changelog.jpg
View file
Open in desktop
File renamed without changes
260 changes: 130 additions & 130 deletions ...ions/install-update/install/change-log.md → ...install-update/installation/change-log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,130 +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>
```
---
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>
```

20 changes: 10 additions & 10 deletions ...xtensions/install-update/install/index.md → ...ions/install-update/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +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
---
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