Fix documentation formatting, add menu items for new examples

Author: slawekjaranowski

src/site/apt/examples/example-exec-for-java-programs.apt.vm

@@ -50,7 +50,7 @@ mvn exec:exec -Dexec.executable="java" [...] -Dexec.args="%classpath"
 
  To execute Java programs, the Exec Maven Plugin helps by allowing the <<<\<classpath\>>>> special argument:
 
--------------------
++-------------------+
         <configuration>
           <executable>java</executable>
           <arguments>
@@ -79,11 +79,11 @@ mvn exec:exec -Dexec.executable="java" [...] -Dexec.args="%classpath"
             ...
           </arguments>
         </configuration>
--------------------
++-------------------+
 
 In case of the modules as supported since Java9 the configuration looks like
 
--------------------
++-------------------+
         <configuration>
           <executable>java</executable>
           <arguments>
@@ -96,4 +96,4 @@ In case of the modules as supported since Java9 the configuration looks like
             ...
           </arguments>
         </configuration>
--------------------
++-------------------+

src/site/apt/examples/example-exec-or-java-change-classpath-scope.apt.vm

@@ -29,13 +29,13 @@ Changing the classpath scope when running Java programs
   to change the scope of the plugin execution. This can be achieved using the <<<classpathScope>>> configuration element,
   e.g. for a <<<test>>> scope:
 
--------------------
++-------------------+
         <configuration>
           ...
           <classpathScope>test</classpathScope>
           ...
         </configuration>
--------------------
++-------------------+
 
   or, on the command line,
 

src/site/apt/examples/example-exec-using-executabledependency.apt.vm

@@ -39,7 +39,7 @@ Using Executable Binary Dependencies Instead of Local Executables
 
 ** pom.xml
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -71,4 +71,4 @@ Using Executable Binary Dependencies Instead of Local Executables
   </build>
   ...
 </project>
--------------------
++-------------------+

src/site/apt/examples/example-exec-using-plugin-dependencies.apt.vm

@@ -54,7 +54,7 @@ Using Plugin Dependencies Instead of Project Dependencies
 
 * Example POM Configuration using Plugin Dependencies
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -104,4 +104,4 @@ Using Plugin Dependencies Instead of Project Dependencies
   </build>
    ...
 </project>
--------------------
++-------------------+

src/site/apt/examples/example-exec-using-toolchains.apt.vm

@@ -40,7 +40,7 @@ Using Toolchains Instead of Explicit Paths
 
 ** pom.xml
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -80,11 +80,11 @@ Using Toolchains Instead of Explicit Paths
   </build>
   ...
 </project>
--------------------
++-------------------+
 
 ** toolchains.xml
 
--------------------
++-------------------+
 <?xml version="1.0" encoding="UTF8"?>
 <toolchains>
   <toolchain>
@@ -102,7 +102,7 @@ Using Toolchains Instead of Explicit Paths
   </toolchain>
   ...
 </toolchains>
--------------------
++-------------------+
 
 * The "jdk" Toolchain
 
@@ -111,7 +111,7 @@ Using Toolchains Instead of Explicit Paths
 
 ** pom.xml
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -145,11 +145,11 @@ Using Toolchains Instead of Explicit Paths
   </build>
   ...
 </project>
--------------------
++-------------------+
 
 ** toolchains.xml
 
--------------------
++-------------------+
 <?xml version="1.0" encoding="UTF8"?>
 <toolchains>
   <toolchain>
@@ -166,7 +166,7 @@ Using Toolchains Instead of Explicit Paths
   </toolchain>
   ...
 </toolchains>
--------------------
++-------------------+
 
 * Custom Toolchains
 
@@ -176,7 +176,7 @@ Using Toolchains Instead of Explicit Paths
 
 ** pom.xml
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -217,11 +217,11 @@ Using Toolchains Instead of Explicit Paths
   </build>
   ...
 </project>
--------------------
++-------------------+
 
 ** toolchains.xml
 
--------------------
++-------------------+
 <?xml version="1.0" encoding="UTF8"?>
 <toolchains>
   <toolchain>
@@ -235,4 +235,4 @@ Using Toolchains Instead of Explicit Paths
   </toolchain>
   ...
 </toolchains>
--------------------
++-------------------+

src/site/apt/examples/example-java-project-properties.apt.vm

@@ -23,14 +23,15 @@
  ~~ NOTE: For help with the syntax of this file, see:
  ~~ http://maven.apache.org/doxia/references/apt-format.html
 
+Forward maven properties to exec:java goal
 
-You can ensure the maven properties are available to your main forcing `<projectProperties />` property type.
+  You can ensure the maven properties are available to your main forcing <<<\<projectProperties /\>>>> property type.
 
-  Tip: you can still override potentially conflicting properties if you set them *after*.
+  Tip: you can still override potentially conflicting properties if you set them <<after>>.
 
 * pom.xml
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -67,5 +68,4 @@ You can ensure the maven properties are available to your main forcing `<project
   </build>
    ...
 </project>
--------------------
-
++-------------------+

src/site/apt/examples/example-java-runnable.vm renamed to src/site/apt/examples/example-java-runnable.apt.vm

@@ -1,12 +1,12 @@
  ------
- Use Runnable with exec:java goal
+ Execute a Runnable instead of a main
  ------
  Romain Manni-Bucau
  ------
- 2022-11-14
+ 2024-01-27
  ------
 
- ~~ Copyright 2022 The Codehaus
+ ~~ Copyright 2024 The Codehaus
  ~~
  ~~ Licensed under the Apache License, Version 2.0 (the "License");
  ~~ you may not use this file except in compliance with the License.
@@ -23,12 +23,13 @@
  ~~ NOTE: For help with the syntax of this file, see:
  ~~ http://maven.apache.org/doxia/references/apt-format.html
 
+Execute a Runnable instead of a main
 
-You can use since version `3.1.2` a `Runnable` instead of providing a main class to `exec:java`:
+  You can use since version <<<3.2.0>>> a <<<Runnable>>> instead of providing a main class to <<<exec:java>>>:
 
 * pom.xml
 
--------------------
++-------------------+
 <project>
   ...
   <build>
@@ -54,25 +55,33 @@ You can use since version `3.1.2` a `Runnable` instead of providing a main class
   </build>
    ...
 </project>
--------------------
++-------------------+
 
 The Runnable can be a plain class but can also get constructor injections:
 
-* `systemProperties`: `Properties`, session system properties 
-* `systemPropertiesUpdater`: `BiConsumer&lt;String, String&gt;`, session system properties update callback (pass the key/value to update, null value means removal of the key) 
-* `userProperties`: `Properties`, session user properties 
-* `userPropertiesUpdater`: `BiConsumer&lt;String, String&gt;`, session user properties update callback (pass the key/value to update, null value means removal of the key) 
-* `projectProperties`: `Properties`, project properties 
-* `projectPropertiesUpdater`: `BiConsumer&lt;String, String&gt;`, project properties update callback (pass the key/value to update, null value means removal of the key) 
-* `highestVersionResolver`: `Function&lt;String, String&gt;`, passing a `groupId:artifactId` you get the latest resolved version from the project repositories.
+  * <<<systemProperties>>>: <<<Properties>>>, session system properties
 
-Lastly you can inject a custom maven component naming the Runnable constructor parameter with its type and replacing dots by underscores.
-If you need to provide a hint you can suffix previous type name by `__hint_$yourhint` (assuming it stays a valid java name).
-This kind of parameter injection must be typed `Object`.
+  * <<<systemPropertiesUpdate>>>: <<<BiConsumer\<String, String\>>>>, session system properties update callback (pass the key/value to update, null value means removal of the key)
+
+  * <<<userProperties>>>: <<<Properties>>>, session user properties
+
+  * <<<userPropertiesUpdater>>>: <<<BiConsumer\<String, String\>>>>, session user properties update callback (pass the key/value to update, null value means removal of the key)
+
+  * <<<projectProperties>>>: <<<Properties>>>, project properties
+
+  * <<<projectPropertiesUpdater>>>: <<<BiConsumer\<String, String\>>>>, project properties update callback (pass the key/value to update, null value means removal of the key)
+
+  * <<<highestVersionResolver>>>: <<<Function\<String, String\>>>>, passing a <<<groupId:artifactId>>> you get the latest resolved version from the project repositories.
+
+  []
+
+    Lastly you can inject a custom maven component naming the Runnable constructor parameter with its type and replacing dots by underscores.
+    If you need to provide a hint you can suffix previous type name by <<<__hint_$yourhint>>> (assuming it stays a valid java name).
+    This kind of parameter injection must be typed `Object`.
 
 Example:
 
--------------------
++-------------------+
 public class HelloRunnable implements Runnable {
     private final Function<String, String> versionResolver;
     private final Properties properties;
@@ -92,4 +101,4 @@ public class HelloRunnable implements Runnable {
         updater.accept("hello.runnable.output", v + ": " + (versionResolver != null));
     }
 }
--------------------
++-------------------+

src/site/site.xml

@@ -24,6 +24,10 @@
             href="examples/example-exec-using-toolchains.html"/>
       <item name="Using executable binary dependencies instead of local executables"
             href="examples/example-exec-using-executabledependency.html"/>
+      <item name="Forward maven system properties to the main"
+            href="examples/example-java-project-properties.html"/>
+      <item name="Execute a Runnable instead of a main"
+            href="examples/example-java-runnable.html"/>
     </menu>
   </body>
 </project>