Différences

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

--- start:overrides [2026/02/09 20:07] – [Core patchs] admin
+++ start:overrides [2026/03/26 16:08] (Version actuelle) – [Tracking patches and customscriptings needs in plugin design] admin
@@ Ligne 25: / Ligne 25: @@
 Now we can address the notion of "Trouble". "Trouble" is a subjective notion, and wil not affect all actors the same way. Maintainers will have "Trouble" in having to maintain complex things and make it available for users. Users will be troubled in not having friendly enough or unefficiant tools, stakeholders will be troubled to get informed and harassed that thing do NOT WORK well.
+Now let propose a structural definition of the Trouble:
+<html><center style="font-size:170%">$Tb = k * \frac{Imp}{\sum_{r=1}^n{dCUi * NUi}}$</center></html>
+Let's explain now...
+The trouble raises when the Technical Impact raises. We just add a k constant factor to adjust units and scales.
+Oppositely, the trouble decreases when the "gain in process" (dCU) per user in a certain role and the role population (NU, as number of users) increases. In other words, the more users can gain in their own process (gain of time, gain of mental load), the more affordable the Technical Impact will be for the organisation.
@@ Ligne 65: / Ligne 74: @@
 and THIS can be the tough part, specially if:
-   * Patchs are not documented
+   * Patchs are **not documented**
-   * Patchs are not properly tagged and identified in the code
+   * Patchs are **not properly tagged** and identified in the code
+   * 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]]