Expand AddonModule documentation

Author: APickledWalrus

src/content/docs/api/localization/language-files.md

@@ -24,4 +24,4 @@ Language entries are defined in a tree-like structure:
 error messages:
     unknown error: An unknown error has occurred.
 ```
-This entry would then be available under the key `error messages.unknown error`.
+This entry would be available under the key `error messages.unknown error`.

src/content/docs/api/skript/addons.md

@@ -51,7 +51,8 @@ public class MyAddon {
 ```
 
 ## Addon modules
-SkriptAddon instances can also be used to load [AddonModules](https://github.com/SkriptLang/Skript/blob/master/src/main/java/org/skriptlang/skript/addon/AddonModule.java), which allow you to modularize (organize) the features you are registering. This makes it much easier to control which features of your addon are enabled and which are not.
+SkriptAddon instances can also be used to load [AddonModules](https://github.com/SkriptLang/Skript/blob/master/src/main/java/org/skriptlang/skript/addon/AddonModule.java), which allow you to modularize (organize) the features you are registering.
+This makes it much easier to control which features of your addon are enabled and which are not.
 
 ### Creating an addon module
 Addon modules are defined by implementing the AddonModule interface on a class.
@@ -70,18 +71,41 @@ This method is intended to be implemented by modules that register components th
 The `load(SkriptAddon)` method is the second and final stage of module initialization.
 This method is intended to be implemented by modules that register components that are generally only used within the module itself, such as [syntax](../../syntax).
 
+#### name
+The `name` method, which is required to be implemented, should just return a name that describes the module's purpose.
+For example, if you were creating a module covering math syntax, you could call it `math`.
+The module name can really be anything, though, as it does not affect functionality.
+It is primarily used for documentation and logging purposes.
+
 #### Example module
 The following is a simple example of a module that prints a message when it loads:
 ```java
+// MyModule.java
 import org.skriptlang.skript.addon.AddonModule;
 public class MyModule implements AddonModule {
 	@Override
+	public void init(SkriptAddon addon) {
+		System.out.println("MyModule has just been initialized by " + addon.name());
+	}
+	
+	@Override
     public void load(SkriptAddon addon) {
 		System.out.println("MyModule has just been loaded by " + addon.name());
     }
+	
+	@Override
+    public String name() {
+		return "MyModule";
+    }
 }
 ```
 
+When `MyModule` is loaded, `init` is run before `load`, so the output will look something like:
+```bash title="My Skript Process"
+MyModule has just been initialized by ...
+MyModule has just been loaded by ...
+```
+
 ### Loading an addon module
 Defined on SkriptAddon is a utility method, `loadModules(AddonModule...)` that loads method.
 That is, it first calls `canLoad` on each provided module, compiling a collection of those that are permitted to load.
@@ -101,13 +125,86 @@ public class MyAddon {
 	}
 }
 ```
+### Hierarchical addon modules
+We also provide an implementation of AddonModule, [HierarchicalAddonModule](https://github.com/SkriptLang/Skript/blob/master/src/main/java/org/skriptlang/skript/addon/HierarchicalAddonModule.java), which allows defining a module with children (submodules).
+This implementation overrides the standard module methods to manage loading the hierarchy.
+Instead, implementors can override methods such as `canLoadSelf`, `initSelf` and `loadSelf` which function the same as their regular versions.
+
+The key method of this implementation is `children`, which can be overridden.
+The method should return an iterable of the instances of the children modules.
+
+#### Example hierarchical modules
+Here is an example of defining a module with a child module:
+```java
+// MyParentModule.java
+import org.skriptlang.skript.addon.HierarchicalAddonModule;
+public class MyParentModule implements HierarchicalAddonModule {
+	// No special constructor needed since this module will not have a parent (it is the root)
+
+	@Override
+	public Iterable<AddonModule> children() {
+		// We initialize a new instance of MyChildModule with this module as the parent
+		return List.of(new MyChildModule(this));
+	}
+
+	@Override
+	public void initSelf(SkriptAddon addon) {
+		System.out.println("MyParentModule has just been initialized by " + addon.name());
+	}
+
+	@Override
+    public void loadSelf(SkriptAddon addon) {
+		System.out.println("MyParentModule has just been loaded by " + addon.name());
+    }
+
+	@Override
+    public String name() {
+		return "MyParentModule";
+    }
+}
+```
+```java
+// MyChildModule.java
+import org.skriptlang.skript.addon.HierarchicalAddonModule;
+public class MyChildModule implements HierarchicalAddonModule {
+	// We define a constructor for setting this module's parent
+	public MyChildModule(AddonModule parentModule) {
+		super(parentModule);
+	}
+
+	// MyChildModule has no children, so no need to override 'children'
+
+	@Override
+	public void initSelf(SkriptAddon addon) {
+		System.out.println("MyChildModule has just been initialized by " + addon.name());
+	}
+
+	@Override
+    public void loadSelf(SkriptAddon addon) {
+		System.out.println("MyChildModule has just been loaded by " + addon.name());
+    }
+
+	@Override
+    public String name() {
+		return "MyChildModule";
+    }
+}
+```
+
+When `MyParentModule` is loaded, its `...Self` methods will always run before the equivalent for its children, meaning the output will look something like:
+```bash title="My Skript Process"
+MyParentModule has just been initialized by ...
+MyChildModule has just been initialized by ...
+MyParentModule has just been loaded by ...
+MyChildModule has just been loaded by ...
+```
 
 ## Using registries
 SkriptAddon instances provide access to Skript's registries through multiple methods defined on the interface.
 
 :::note
 This section does not cover any of the registries defined and used by the API.
-For more information about what registries are available, please review the [registries](../../registries) section.
+For more information about what registries are available, see the [registries](../../registries) section.
 :::
 
 ### Obtaining registries

src/content/docs/api/syntax/writing-syntax.md

@@ -1,5 +1,8 @@
 ---
 title: Writing Syntax
+tableOfContents:
+  minHeadingLevel: 1
+  maxHeadingLevel: 4
 sidebar:
     order: 5
 ---