start:overrides

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision
Révision précédente
start:overrides [2026/03/26 16:06] – [Tracking patches and customscriptings needs in plugin design] adminstart:overrides [2026/03/26 16:08] (Version actuelle) – [Tracking patches and customscriptings needs in plugin design] admin
Ligne 79: Ligne 79:
 ====Tracking patches and customscriptings needs in plugin design==== ====Tracking patches and customscriptings needs in plugin design====
  
-In our plugins, a common structure to self-document and provide out-of-the-band info about moodle alteration we need to get the plugin run correctly is given as '__' prefixed directories in the plugin.+In our plugins, a common structure to self-document and provide out-of-the-band info about moodle alteration we need to get the plugin run correctly is given as '<nowiki>__</nowiki>' prefixed directories in the plugin.
  
-   * **__patch:** contains core files with patches serving this plugin. +   * **<nowiki>__</nowiki>patch:** contains core files with patches serving this plugin. 
-   * **__customscripts:** contains files to add to the moodle local 'customscript' folder, as defined in ''config.php'' with the key ''$CFG->customscripts''+   * **<nowiki>__</nowiki>customscripts:** contains files to add to the moodle local 'customscript' folder, as defined in ''config.php'' with the key ''$CFG->customscripts''
-   * **__reference:** contains core files who serve as core source reference for the patchs, and are snapshot when the plugin is reviewed and packaged. Your installed core files may be somewhat different, if your minor version is not the exact one we use in our development faciity. +   * **<nowiki>__</nowiki>reference:** contains core files who serve as core source reference for the patchs, and are snapshot when the plugin is reviewed and packaged. Your installed core files may be somewhat different, if your minor version is not the exact one we use in our development faciity. 
  
 ===What happens if several plugins need patching/customscripting the same files=== ===What happens if several plugins need patching/customscripting the same files===
Ligne 93: Ligne 93:
 So it may be possible that assembling several unrelated plugins might need to overload the same core files. So it may be possible that assembling several unrelated plugins might need to overload the same core files.
  
-In case of patchs, all patchs are bounded strictly in ''// PATCH+'' and ''// PATCH-'' comments, so they are easy to locate in the code. In the future, we will have to make some effort in generalizing the @see tag so each patch refers to the plugin that required it.+In case of patchs, all patchs are bounded strictly in ''<nowiki>//</nowiki> PATCH+'' and ''<nowiki>//</nowiki> PATCH-'' comments, so they are easy to locate in the code. In the future, we will have to make some effort in generalizing the @see tag so each patch refers to the plugin that required it.
  
-In case of customscripts, the case of collision is also possible. In most case we try to use ''// CHANGE +'' and ''// CHANGE-'' comments to locate them.+In case of customscripts, the case of collision is also possible. In most case we try to use ''<nowiki>//</nowiki> CHANGE +'' and ''<nowiki>//</nowiki> CHANGE-'' comments to locate them.
  
 [[:start|Back to general index]] [[:start|Back to general index]]
start/overrides.1774541200.txt.gz · Dernière modification : de admin

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki