Joomla! Documentation™

Joomla! 

4.x

>Tutorial

Dal momento che Joomla 4.0, gli sviluppatori di estensioni possono sfruttare la capacità di Joomla di leggere un file di log del changelog e fornire una rappresentazione visiva del log delle modifiche. Se una data versione non è stata trovata nel log delle modifiche, il pulsante del log delle modifiche non verrà mostrato.

I cambiamenti in una versione saranno presentati in questo modo:

Changelog modal

Il changelog è usato in due posti diversi.

Visualizza Aggiornamento

Il programma di installazione mostrerà il registro delle modifiche della versione che può essere installata se disponibile.

Changelog button on the Update View

Facendo clic sul pulsante Changelog qui verrà mostrato il log delle modifiche della nuova versione disponibile.

Manage View

Il gestore estensioni mostrerà il log delle modifiche dell'estensione attualmente installata, se disponibile.

Version number is a link to the changelog modal

Facendo clic sul numero di versione qui verrà mostrato il registro delle modifiche della versione installata corrente.

Aggiungi il tag changelogurl al file manifest

Il primo passaggio consiste nell'aggiornare il file manifest che dice a Joomla dove trovare i dettagli del changelog. Aggiungi il seguente nodo al file XML manifest:

<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. See code examples.

Update server manifest

Vedi questo esempio per un file update server manifest che informa Joomla di un aggiornamento di un componente chiamato "com_lists". Così si vedrà il pulsante Changelog nella vista di aggiornamento.

<?xml version="1.0" encoding="utf-8"?>
<updates>
 <update>
  <name>Student List</name>
  <description>List of students</description>
  <element>com_lists</element>
  <type>component</type>
  <version>4.0.0</version>

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

  <tags>
   <tag>stable</tag>
  </tags>
  <maintainer>Example Miller</maintainer>
  <maintainerurl>https://example.com/</maintainerurl>
  <section>Updates</section>
  <targetplatform name="joomla" version="4.?" />
  <client>1</client>
  <folder></folder>
 </update>
</updates>

Extension manifest

Aggiungere inoltre il tag changelogurl al file XML extension manifest. Così la versione dell'estensione sarà collegata ai changelogs nella manage view.

<?xml version="1.0" encoding="utf-8"?>
<extension type="component" method="upgrade">
	<name>COM_LISTS</name>

... Other stuff ...

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

	<updateservers>
        <server type="extension" name="My Extension's Updates">https://example.com/lists-updates.xml</server>
	</updateservers>
</extension>

Crea il file del registro delle modifiche

Il file changelog deve avere i seguenti 3 nodi:

• element
• type
• version

Questa informazione viene utilizzata per identificare il registro delle modifiche corretto per una determinata estensione.

Un nodo versione all'interno di qualsiasi changelog è sempre obbligatorio. Altrimenti vedrai un messaggio di errore come SyntaxError: JSON.parse: unexpected character at line 1 column 1 of the JSON data.

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

Inoltre il registro delle modifiche è pieno di uno o più tipi di modifica. Sono supportati i seguenti tipi di modifica:

• security: Eventuali problemi di sicurezza che sono stati risolti
• fix: Tutti i bug che sono stati corretti
• language: Questo è per i cambiamenti linguistici
• addition: Qualsiasi nuova funzionalità aggiunta
• change: Eventuali cambiamenti
• remove: Qualsiasi funzione rimossa
• note: Eventuali informazioni aggiuntive per informare l'utente

Ogni nodo può essere ripetuto tutte le volte che è necessario.

Il formato del testo può essere testo semplice o HTML, ma in caso di HTML, deve essere incluso nei tag CDATA come mostrato nell'esempio.

<changelogs>
    <changelog>
        <element>com_lists</element>
        <type>component</type>
        <version>4.0.0</version>
        <security>
            <item>Item A</item>
            <item><![CDATA[<h2>You MUST replace this file</h2>]]></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>

Questo file contiene 2 changelogs:

• Versione 0.0.2 (per testare la vista di gestione)
• Versione 4.0.0 (per testare la vista di aggiornamento)

Un log delle modifiche può avere tutte le versioni necessarie.