Différences

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

--- start:overrides [2026/02/09 20:27] – [A bit of theory] admin
+++ start:overrides [2026/03/26 16:08] (Version actuelle) – [Tracking patches and customscriptings needs in plugin design] admin
@@ Ligne 78: / Ligne 78: @@
    * There is **no tool** to help the process
 ====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 '<nowiki>__</nowiki>' prefixed directories in the plugin.
+   * **<nowiki>__</nowiki>patch:** contains core files with patches serving this plugin.
+   * **<nowiki>__</nowiki>customscripts:** contains files to add to the moodle local 'customscript' folder, as defined in ''config.php'' with the key ''$CFG->customscripts''.
+   * **<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===
+This is a more tricky situation that can happen, as we aim to keep the modularity concept of Moodle as clean as possible, which means, many plugin do not have to car another plugin exist, moreover if there is no functional relation between them.
+As a consequence, a general packing rule has been to only pack whate was relative to the current plugin (or pluginset in case of real unbreakabke bundles).
+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 ''<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 ''<nowiki>//</nowiki> CHANGE +'' and ''<nowiki>//</nowiki> CHANGE-'' comments to locate them.
 [[:start|Back to general index]]