Joomla! Documentation - User contributions [en]

J4.x:Improved Override Management

2018-08-23T14:23:17Z

Anu1601cs:

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
<translate> Improved Override Management Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
<translate>
== Introduction == 
</translate>
<translate> This project adds an update checking feature to Joomla so that if a template overrides core file is changed or updated, it notifies the user that one of the core files of their template overrides is changed with the update, to avoid security issues or functionality issue and they can adjust their override before anyone can notice.</translate>

'''<translate> Project repository link:</translate>''' https://github.com/joomla-projects/gsoc18_override_management

<translate>
== Getting a head-start with Improved Override Management == 
</translate>
<translate>
=== Notes === 
</translate>
<translate> If you are new to Joomla development, and don't know much about Template Manager and Overrides, please read:</translate>
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|<translate> How to use the Template Manager</translate>]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|<translate> Layout Overrides in Joomla</translate>]]

<translate> Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.</translate>
* <translate> Supported Overrides</translate>
* <translate> Diff View</translate>
* <translate> Override - Quick Icon Notification Plugin</translate>
* <translate> Installer - Override Plugin</translate>
* <translate> Updated - Override History</translate>

<translate>
== Types of overrides supported by this feature == 
</translate>
<translate>
It does not support Alternative Layout in which filename get renamed to something else and js, css overrides.
This feature supports these override files listed in Create Override tab. Example:</translate>
[[File:Selection 035-<translate> en</translate>.png|center|800px]]

<translate>
== Diff view between core and override files == 
</translate>
<translate> This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.</translate>

<translate> Buttons like this:</translate>
[[File:Selection 027-<translate> en</translate>.png|center|Buttons]]
<translate>
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location of the core file and diff view in the template manager.</translate>
[[File:Selection 028-<translate> en</translate>.png|center|800px]]
<translate>

You can not edit the core file.</translate>

<translate>
=== How diff view is working === 
</translate>
<translate> When you click on any override file to edit it, it calls a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of the override file in the template. Example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of the file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of the core file if it exists.</translate>
<translate>

For showing the diff between the core and override files we used [https://github.com/kpdecker/jsdiff jsdiff] library.</translate>

<translate>
== Override - Quick Icon Notification Plugin == 
</translate>
<translate> A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. When overrides are updated then the quick icon shows something like in the example below:</translate>
[[File:Selection 020-<translate> en</translate>.png|center|Quick Icon|800px]]
<translate> When you click on it, it will redirect you to Templates which contain the list of your templates with their description. You'll see a new column header '''Overrides''' showing the number of override updated which belongs to the template. If nothing has been updated in the template override it will show a Up to date badge.</translate>
[[File:Selection 022-<translate> en</translate>.png|center|Templates|800px]]

<translate>
=== How quick icon is working === 
</translate>
<translate> It makes an AJAX call to the <tt>TemplateController.php</tt> which returns the information and displays a notification when such overrides are updated.</translate>

<translate> '''Warning'''</translate>

<translate> Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.</translate>
[[File:Selection 024-<translate> en</translate>.png|center|Enable|800px]]
<translate> If you click on the quick icon you will be redirected to the <tt>installer/override</tt> plugin settings where you can edit the settings of the plugin.</translate>
<translate>
== Installer - Override Plugin == 
</translate>
<translate> This plugin is the main part of this feature. It allows to find the correct updated overrides during the extension install or update and Joomla update.</translate>

[[File:Selection 025-<translate> en</translate>.png|center|Installer Override|800px]]

<translate>
=== How installer override plugin is working === 
</translate>
<translate> This plugin works on 6 events:
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate
</translate>
<translate> Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.</translate>

<translate>

== Updated - Override History == 
</translate>
<translate>
You can access this from the Updated Files tab in a template.
This is a list view that shows the list of updated overrides which do belongs to that template.</translate>
[[File:Selection 029-<translate> en</translate>.png|center|800px]]

<translate> There are many options available to manage list. Where you can check the status of override file history whether is checked or not, created date, date of change and update action like: whether it belongs to (Joomla Update, Extension Update or Extension Install).</translate>

<translate> '''Note'''</translate>

<translate> These information are only history so if you checked the updated override changes then, you can delete the history, as not needed anymore.
</translate>

<translate>
'''Watch video tutorial, how to use this feature.'''
<div class="video-container">
{{#widget:YouTube|id=l0_jFjswObI}}
</div></translate>

<noinclude>
[[Category:Google Summer of Code 2018{{#translation:}}]]
[[Category:Development{{#translation:}}]]
[[Category:Joomla!_4.x{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>

J4.x:Improved Override Management

2018-07-29T14:49:35Z

Anu1601cs: /* Introduction */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
Improved Override Management Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
This project adds an update checking feature to Joomla that if the template overrides core file is changed or updated, it notifies the user that one of the core files of their template overrides is changed with the update, to avoid security issues or functionality issue and they can adjust their override before anyone can notice.

'''Project repository link :''' https://github.com/joomla-projects/gsoc18_override_management

== Getting a head-start with Improved Override Management ==
=== Notes ===
If you are new to Joomla! development, and don't know much about Template Manager and Overrides, please read
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|How to use the Template Manager]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|Layout Overrides in Joomla]]

Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.
* Supported Overrides
* Diff View
* Override - Quick Icon Notification Plugin
* Installer - Override Plugin
* Updated - Override History

== Types of overrides supported by this feature ==
It does not support Alternative Layout in which filename get renamed to something else and js, css overrides.
This feature supports these override files listed in Create Override tab. Example :
[[File:Selection 035.png|center|800px]]

== Diff view between core and override files ==
This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.

Buttons like this :
[[File:Selection 027.png|center|Buttons]]
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location of the core file and diff view in the template manager.
[[File:Selection 028.png|center|800px]]

You can not edit the core file.

=== How diff view is working ===
When you click on any override file to edit it, it calls a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of the override file in the template. Example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of the file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of the core file if it exists.

For showing the diff between the core and override files we used [https://github.com/kpdecker/jsdiff jsdiff] library.

== Override - Quick Icon Notification Plugin ==
A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. When overrides are updated then the quick icon shows something like in the example below:
[[File:Selection 020.png|center|Quick Icon|800px]]
When you click on it, it will redirect you to Templates which contain the list of your templates with their description. You'll see a new column header '''Overrides''' showing the number of override updated which belongs to the template. If nothing has been updated in the template override it will show a Up to date badge.
[[File:Selection 022.png|center|Templates|800px]]

=== How quick icon is working ===
It makes an AJAX call to the <tt>TemplateController.php</tt> which returns the information and displays a notification when such overrides are updated.

'''Warning'''

Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.
[[File:Selection 024.png|center|Enable|800px]]
If you click on the quick icon you will be redirected to the <tt>installer/override</tt> plugin settings where you can edit the settings of the plugin.

== Installer - Override Plugin ==
This plugin is the main part of this feature. It allows to find the correct updated overrides during the extension install or update and Joomla update.

[[File:Selection 025.png|center|Installer Override|800px]]

=== How installer override plugin is working ===
This plugin works on 6 events :
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate

Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.

== Updated - Override History ==
You can access this from the Updated Files tab in a template.
This is a list view that shows the list of updated overrides which do belongs to that template.
[[File:Selection 029.png|center|800px]]

There are many options available to manage list. Where you can check the status of override file history whether is checked or not, created date, date of change and update action like: whether it belongs to (Joomla Update, Extension Update or Extension Install).

'''Note'''

These information are only history so if you checked the updated override changes then, you can delete the history, as not needed anymore.

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:Improved Override Management

2018-07-29T14:46:43Z

Anu1601cs: /* Types of overrides supported by this feature */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
Improved Override Management Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
This project adds an update checking feature to Joomla that if the template overrides core file is changed or updated, it notifies the user that one of the core files of their template overrides is changed with the update, to avoid security issues or functionality issue and they can adjust their override before anyone can notice.

== Getting a head-start with Improved Override Management ==
=== Notes ===
If you are new to Joomla! development, and don't know much about Template Manager and Overrides, please read
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|How to use the Template Manager]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|Layout Overrides in Joomla]]

Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.
* Supported Overrides
* Diff View
* Override - Quick Icon Notification Plugin
* Installer - Override Plugin
* Updated - Override History

== Types of overrides supported by this feature ==
It does not support Alternative Layout in which filename get renamed to something else and js, css overrides.
This feature supports these override files listed in Create Override tab. Example :
[[File:Selection 035.png|center|800px]]

== Diff view between core and override files ==
This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.

Buttons like this :
[[File:Selection 027.png|center|Buttons]]
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location of the core file and diff view in the template manager.
[[File:Selection 028.png|center|800px]]

You can not edit the core file.

=== How diff view is working ===
When you click on any override file to edit it, it calls a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of the override file in the template. Example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of the file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of the core file if it exists.

For showing the diff between the core and override files we used [https://github.com/kpdecker/jsdiff jsdiff] library.

== Override - Quick Icon Notification Plugin ==
A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. When overrides are updated then the quick icon shows something like in the example below:
[[File:Selection 020.png|center|Quick Icon|800px]]
When you click on it, it will redirect you to Templates which contain the list of your templates with their description. You'll see a new column header '''Overrides''' showing the number of override updated which belongs to the template. If nothing has been updated in the template override it will show a Up to date badge.
[[File:Selection 022.png|center|Templates|800px]]

=== How quick icon is working ===
It makes an AJAX call to the <tt>TemplateController.php</tt> which returns the information and displays a notification when such overrides are updated.

'''Warning'''

Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.
[[File:Selection 024.png|center|Enable|800px]]
If you click on the quick icon you will be redirected to the <tt>installer/override</tt> plugin settings where you can edit the settings of the plugin.

== Installer - Override Plugin ==
This plugin is the main part of this feature. It allows to find the correct updated overrides during the extension install or update and Joomla update.

[[File:Selection 025.png|center|Installer Override|800px]]

=== How installer override plugin is working ===
This plugin works on 6 events :
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate

Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.

== Updated - Override History ==
You can access this from the Updated Files tab in a template.
This is a list view that shows the list of updated overrides which do belongs to that template.
[[File:Selection 029.png|center|800px]]

There are many options available to manage list. Where you can check the status of override file history whether is checked or not, created date, date of change and update action like: whether it belongs to (Joomla Update, Extension Update or Extension Install).

'''Note'''

These information are only history so if you checked the updated override changes then, you can delete the history, as not needed anymore.

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Selection 035-en.png

2018-07-29T14:40:19Z

Anu1601cs:

Supported

J4.x:Improved Override Management

2018-07-29T14:12:29Z

Anu1601cs: /* Diff view between core and override files */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
Improved Override Management Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
This project adds an update checking feature to Joomla that if the template overrides core file is changed or updated, it notifies the user that one of the core files of their template overrides is changed with the update, to avoid security issues or functionality issue and they can adjust their override before anyone can notice.

== Getting a head-start with Improved Override Management ==
=== Notes ===
If you are new to Joomla! development, and don't know much about Template Manager and Overrides, please read
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|How to use the Template Manager]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|Layout Overrides in Joomla]]

Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.
* Supported Overrides
* Diff View
* Override - Quick Icon Notification Plugin
* Installer - Override Plugin
* Updated - Override History

== Types of overrides supported by this feature ==
It does not support Alternative Layout in which filename get renamed to something else.
This feature supports these override files listed in Create Override tab. Example :
<tt>TODO://</tt>

== Diff view between core and override files ==
This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.

Buttons like this :
[[File:Selection 027.png|center|Buttons]]
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location of the core file and diff view in the template manager.
[[File:Selection 028.png|center|800px]]

You can not edit the core file.

=== How diff view is working ===
When you click on any override file to edit it, it calls a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of the override file in the template. Example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of the file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of the core file if it exists.

For showing the diff between the core and override files we used [https://github.com/kpdecker/jsdiff jsdiff] library.

== Override - Quick Icon Notification Plugin ==
A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. When overrides are updated then the quick icon shows something like in the example below:
[[File:Selection 020.png|center|Quick Icon|800px]]
When you click on it, it will redirect you to Templates which contain the list of your templates with their description. You'll see a new column header '''Overrides''' showing the number of override updated which belongs to the template. If nothing has been updated in the template override it will show a Up to date badge.
[[File:Selection 022.png|center|Templates|800px]]

=== How quick icon is working ===
It makes an AJAX call to the <tt>TemplateController.php</tt> which returns the information and displays a notification when such overrides are updated.

'''Warning'''

Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.
[[File:Selection 024.png|center|Enable|800px]]
If you click on the quick icon you will be redirected to the <tt>installer/override</tt> plugin settings where you can edit the settings of the plugin.

== Installer - Override Plugin ==
This plugin is the main part of this feature. It allows to find the correct updated overrides during the extension install or update and Joomla update.

[[File:Selection 025.png|center|Installer Override|800px]]

=== How installer override plugin is working ===
This plugin works on 6 events :
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate

Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.

== Updated - Override History ==
You can access this from the Updated Files tab in a template.
This is a list view that shows the list of updated overrides which do belongs to that template.
[[File:Selection 029.png|center|800px]]

There are many options available to manage list. Where you can check the status of override file history whether is checked or not, created date, date of change and update action like: whether it belongs to (Joomla Update, Extension Update or Extension Install).

'''Note'''

These information are only history so if you checked the updated override changes then, you can delete the history, as not needed anymore.

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:Improved Override Management

2018-07-29T14:00:41Z

Anu1601cs: /* How diff view is working */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
Improved Override Management Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
This project adds an update checking feature to Joomla that if the template overrides core file is changed or updated, it notifies the user that one of the core files of their template overrides is changed with the update, to avoid security issues or functionality issue and they can adjust their override before anyone can notice.

== Getting a head-start with Improved Override Management ==
=== Notes ===
If you are new to Joomla! development, and don't know much about Template Manager and Overrides, please read
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|How to use the Template Manager]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|Layout Overrides in Joomla]]

Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.
* Supported Overrides
* Diff View
* Override - Quick Icon Notification Plugin
* Installer - Override Plugin
* Updated - Override History

== Types of overrides supported by this feature ==
It does not support Alternative Layout in which filename get renamed to something else.
This feature supports these override files listed in Create Override tab. Example :
<tt>TODO://</tt>

== Diff view between core and override files ==
This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.

Buttons like this :
[[File:Selection 027.png|center|Buttons]]
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location of core file and diff view in the template manager.
[[File:Selection 028.png|center|800px]]

You can not edit the core file.

=== How diff view is working ===
When you click on any override file to edit it, it calls a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of the override file in the template. Example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of the file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of the core file if it exists.

For showing the diff between the core and override files we used [https://github.com/kpdecker/jsdiff jsdiff] library.

== Override - Quick Icon Notification Plugin ==
A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. When overrides are updated then the quick icon shows something like in the example below:
[[File:Selection 020.png|center|Quick Icon|800px]]
When you click on it, it will redirect you to Templates which contain the list of your templates with their description. You'll see a new column header '''Overrides''' showing the number of override updated which belongs to the template. If nothing has been updated in the template override it will show a Up to date badge.
[[File:Selection 022.png|center|Templates|800px]]

=== How quick icon is working ===
It makes an AJAX call to the <tt>TemplateController.php</tt> which returns the information and displays a notification when such overrides are updated.

'''Warning'''

Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.
[[File:Selection 024.png|center|Enable|800px]]
If you click on the quick icon you will be redirected to the <tt>installer/override</tt> plugin settings where you can edit the settings of the plugin.

== Installer - Override Plugin ==
This plugin is the main part of this feature. It allows to find the correct updated overrides during the extension install or update and Joomla update.

[[File:Selection 025.png|center|Installer Override|800px]]

=== How installer override plugin is working ===
This plugin works on 6 events :
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate

Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.

== Updated - Override History ==
You can access this from the Updated Files tab in a template.
This is a list view that shows the list of updated overrides which do belongs to that template.
[[File:Selection 029.png|center|800px]]

There are many options available to manage list. Where you can check the status of override file history whether is checked or not, created date, date of change and update action like: whether it belongs to (Joomla Update, Extension Update or Extension Install).

'''Note'''

These information are only history so if you checked the updated override changes then, you can delete the history, as not needed anymore.

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:Improved Override Management

2018-07-26T19:25:50Z

Anu1601cs: /* Getting a head-start with Improved Override Management */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
Improved Override Management Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
This project adds an update checking feature to Joomla that if the template overrides core file is changed or updated, it notifies the user that one of core file of his template overrides is changed with the update, to avoid security issues or functionality issue and he can adjust his override before anyone can notice.
== Getting a head-start with Improved Override Management ==
=== Notes ===
If you are new to Joomla! development, and don't know much about Template Manager and Overrides, please read
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|How to use the Template Manager]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|Layout Overrides in Joomla]]

Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.
* Supported Overrides
* Diff View
* Override - Quick Icon Notification Plugin
* Installer - Override Plugin
* Updated - Override History

=== Types of overrides support this feature ===
It does not support Alternative Layout in which filename get renamed to something else.
This features to support these overrides files listed in Create Override tab. Example :
<tt>TODO://</tt>
=== Diff view between core and override file ===
This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.

Buttons like this :
[[File:Selection 027.png|center|Buttons]]
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location fo core file and diff view in the template manager.
[[File:Selection 028.png|left]]

You can not edit the core file.
==== How diff view is working ====
When you click on any override file to edit it call a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of override file in template, example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of core file if exist.

For showing the diff between the core and override file we used [https://github.com/kpdecker/jsdiff jsdiff] library.

=== Override - Quick Icon Notification Plugin ===
A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. Take an example when overrides are updated then quick icon shows something like this.
[[File:Selection 020.png|center|Quick Icon]]
And when you click on this it will redirect you to this templates. Which contains the list of templates you have with all its description. And, now you will see one more information that is '''Override''' which show a badge like: Number of override updated which belongs to the template. If nothing has updated in the template override it will show up to date badge.
[[File:Selection 022.png|center|Templates]]
==== How quick icon is working ====
It makes AJAX call to the TemplateController.php which returns the information and displays a notification when such overrides are updated.

'''Warning'''

Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.
[[File:Selection 024.png|center|Enable]]
And, when you click on the quick icon you will get redirect to <tt>installer/override</tt> plugin settings where you can change settings of the plugin.
=== Installer - Override Plugin ===
This plugin is the main part of this feature which find the correct updated overrides during the extension install or update and Joomla update.

[[File:Selection 025.png|Installer Override]]

==== How installer override plugin is working ====
This plugin works on 6 events :
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate

Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.

=== Updated - Override History ===
You can access this on Updated Files tab in a template manager.
This is a list view shows the list of updated overrides which do belongs to that template.
[[File:Selection 029.png|center]]

There are many options available to manage list. Where you can check the status of override file history whether is checked or not checked, created date, date of change and update action like: whether it belongs to (Joomla Update, Extension Update or Extension Install).

'''Note'''

These informations are only history so if you checked the updated override changes then, you can delete the history. Because, it's no more need.

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Selection 029-en.png

2018-07-26T19:14:36Z

Anu1601cs:

List

J4.x:Improved Override Management

2018-07-26T18:38:55Z

Anu1601cs: /* Getting a head-start with Improved Override Management */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
Improved Override Management Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
This project adds an update checking feature to Joomla that if the template overrides core file is changed or updated, it notifies the user that one of core file of his template overrides is changed with the update, to avoid security issues or functionality issue and he can adjust his override before anyone can notice.
== Getting a head-start with Improved Override Management ==
=== Notes ===
If you are new to Joomla! development, and don't know much about Template Manager and Overrides, please read
#[[S:MyLanguage/J3.x:How_to_use_the_Template_Manager|How to use the Template Manager]]
#[[S:MyLanguage/Layout_Overrides_in_Joomla|Layout Overrides in Joomla]]

Now, if you got familiar with how to use Template Manager and types of Overrides in Joomla. Then, let's go through this project features.
* Supported Overrides
* Diff View
* Override - Quick Icon Notification Plugin
* Installer - Override Plugin
* Updated - Override History

=== Types of overrides support this feature ===
It does not support Alternative Layout in which filename get renamed to something else.
This features to support these overrides files listed in Create Override tab. Example :
<tt>TODO://</tt>
=== Diff view between core and override file ===
This feature shows the difference between the core file and the override file. When you open any override file to edit you can see two buttons or switchers in the top right corner of the page if core file of that file is exited.

Buttons like this :
[[File:Selection 027.png|center|Buttons]]
Here, you can control the hide and show view of diff view and core file view.
In the next image, you will see the location fo core file and diff view in the template manager.
[[File:Selection 028.png|left]]

You can not edit the core file.
==== How it is working ====
When you click on any override file to edit it call a function method <tt>getCoreFile</tt> which receives the two parameters <tt>path</tt> of override file in template, example : <tt>/html/layouts/joomla/form/field/user.php</tt> and the client path of file whether it belongs to <tt>Site</tt> or <tt>Administrator</tt>. Then, based on these information it returns the path of core file if exist.

For showing the diff between the core and override file we used [https://github.com/kpdecker/jsdiff jsdiff] library.

=== Override - Quick Icon Notification Plugin ===
A quick icon notification plugin which shows the notification in cpanel and it shows the total updated overrides from all templates. Take an example when overrides are updated then quick icon shows something like this.
[[File:Selection 020.png|center|Quick Icon]]
And when you click on this it will redirect you to this templates. Which contains the list of templates you have with all its description. And, now you will see one more information that is '''Override''' which show a badge like: Number of override updated which belongs to the template. If nothing has updated in the template override it will show up to date badge.
[[File:Selection 022.png|center|Templates]]
==== How quick icon is working ====
It makes AJAX call to the TemplateController.php which returns the information and displays a notification when such overrides are updated.

'''Warning'''

Quick icon notification plugin only works or able to fetch data if <tt>installer/override</tt> plugin is enabled. If <tt>installer/override</tt> is disabled then you will see this error message in quick icon.
[[File:Selection 024.png|center|Enable]]
And, when you click on quick icon you will get redirect to <tt>installer/override</tt> plugin settings where you can change settings of plugin.
=== Installer - Override Plugin ===
This plugin is a main part of this features which find the correct updated overrides during the extension install or update and joomla update.

[[File:Selection 025.png|Installer Override]]

This plugin works on 6 events :
*onExtensionBeforeUpdate
*onExtensionAfterUpdate
*onInstallerBeforeInstaller
*onInstallerAfterInstaller
*onJoomlaBeforeUpdate
*onJoomlaAfterUpdate

Which collect all overrides core file <tt>md5_file()</tt> hash before update and after update then compairs both values. Then, find the correct changed or updated file. And, store information in <tt>#__templates_overrides</tt> table.

=== Updated - Override History ===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Selection 025-en.png

2018-07-26T18:34:24Z

Anu1601cs:

Installer Override

File:Selection 024-en.png

2018-07-26T17:52:11Z

Anu1601cs:

Enable

File:Selection 022-en.png

2018-07-26T17:20:18Z

Anu1601cs:

Templates

File:Selection 020-en.png

2018-07-26T17:15:48Z

Anu1601cs:

Quick icon

J4.x:Improved Override Management

2018-07-26T17:10:36Z

Anu1601cs: /* Getting a head-start with Improved Override Management */

File:Selection 028-en.png

2018-07-26T16:37:53Z

Anu1601cs:

DIff view

File:Selection 027-en.png

2018-07-26T16:29:25Z

Anu1601cs:

Button

File:Selection 026.png

2018-07-22T15:36:33Z

Anu1601cs:

Supported

J4.x:Improved Override Management

2018-07-22T15:11:57Z

Anu1601cs: /* Getting a head-start with Improved Override Management */

J4.x:Improved Override Management

2018-07-22T14:45:07Z

Anu1601cs: /* Getting a head-start with Improved Override Management */

J4.x:Improved Override Management

2018-07-22T10:38:12Z

Anu1601cs: /* Introduction */

J4.x:Improved Override Management

2018-07-22T10:01:36Z

Anu1601cs: /* Introduction */