From 110b4f703472c76f007f6333326dea16a8243321 Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 8 Aug 2026 20:08:38 +0200 Subject: [PATCH 1/2] Rename the site documents ahead of converting them Git records a rename plus a rewrite in one commit as a delete and an add, which stops 'git log --follow'. Splitting the rename out keeps the history. Please merge or rebase rather than squash. --- .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 .../src/site/{xdoc/index.xml => markdown/index.md} | 0 src/site/{xdoc/index.xml => markdown/index.md} | 0 11 files changed, 0 insertions(+), 0 deletions(-) rename modello-plugins/modello-plugin-converters/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-dom4j/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-jackson/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-jdom/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-sax/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-snakeyaml/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-stax/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-velocity/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-xdoc/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename modello-plugins/modello-plugin-xpp3/src/site/{xdoc/index.xml => markdown/index.md} (100%) rename src/site/{xdoc/index.xml => markdown/index.md} (100%) diff --git a/modello-plugins/modello-plugin-converters/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-converters/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-converters/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-converters/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-dom4j/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-dom4j/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-dom4j/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-dom4j/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-jackson/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-jackson/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-jackson/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-jackson/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-jdom/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-jdom/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-jdom/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-jdom/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-sax/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-sax/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-sax/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-sax/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-snakeyaml/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-snakeyaml/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-snakeyaml/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-snakeyaml/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-stax/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-stax/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-stax/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-stax/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-velocity/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-velocity/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-velocity/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-velocity/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-xdoc/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-xdoc/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-xdoc/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-xdoc/src/site/markdown/index.md diff --git a/modello-plugins/modello-plugin-xpp3/src/site/xdoc/index.xml b/modello-plugins/modello-plugin-xpp3/src/site/markdown/index.md similarity index 100% rename from modello-plugins/modello-plugin-xpp3/src/site/xdoc/index.xml rename to modello-plugins/modello-plugin-xpp3/src/site/markdown/index.md diff --git a/src/site/xdoc/index.xml b/src/site/markdown/index.md similarity index 100% rename from src/site/xdoc/index.xml rename to src/site/markdown/index.md From f9498cd572051ccafa981d9ced417ca9bce59607 Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 8 Aug 2026 20:12:00 +0200 Subject: [PATCH 2/2] Convert two site documents from xdoc to Markdown Converts the Modello overview and the modello-plugin-velocity page. The other nine xdoc pages are deliberately left as they are. They depend on inline HTML that Markdown cannot express - constructs like my.model.package.io.sax.ModelName, and
inside list items. Converting them means embedding the same HTML in a Markdown file, which is more fragile than the xdoc it replaces, so there is nothing to gain. Two converter defects needed repairing by hand: The overview page has a clickable image map over modello-deps.png, and doxia-converter silently dropped the entire element with all 20 hotspots, keeping only a bare . The original HTML block is restored verbatim. The velocity page's table came out with each row split across lines and blank lines between them, so it did not render as a table at all, and braces inside code spans were backslash-escaped. Verified by building the site before and after and diffing the normalised pages, head included. Both are identical. Part of codehaus-plexus/.github#58 --- .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 .../src/site/markdown/index.md | 56 ++++-------- .../{markdown/index.md => xdoc/index.xml} | 0 .../{markdown/index.md => xdoc/index.xml} | 0 src/site/markdown/index.md | 87 ++++++++----------- 11 files changed, 53 insertions(+), 90 deletions(-) rename modello-plugins/modello-plugin-converters/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-dom4j/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-jackson/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-jdom/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-sax/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-snakeyaml/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-stax/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-xdoc/src/site/{markdown/index.md => xdoc/index.xml} (100%) rename modello-plugins/modello-plugin-xpp3/src/site/{markdown/index.md => xdoc/index.xml} (100%) diff --git a/modello-plugins/modello-plugin-converters/src/site/markdown/index.md b/modello-plugins/modello-plugin-converters/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-converters/src/site/markdown/index.md rename to modello-plugins/modello-plugin-converters/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-dom4j/src/site/markdown/index.md b/modello-plugins/modello-plugin-dom4j/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-dom4j/src/site/markdown/index.md rename to modello-plugins/modello-plugin-dom4j/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-jackson/src/site/markdown/index.md b/modello-plugins/modello-plugin-jackson/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-jackson/src/site/markdown/index.md rename to modello-plugins/modello-plugin-jackson/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-jdom/src/site/markdown/index.md b/modello-plugins/modello-plugin-jdom/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-jdom/src/site/markdown/index.md rename to modello-plugins/modello-plugin-jdom/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-sax/src/site/markdown/index.md b/modello-plugins/modello-plugin-sax/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-sax/src/site/markdown/index.md rename to modello-plugins/modello-plugin-sax/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-snakeyaml/src/site/markdown/index.md b/modello-plugins/modello-plugin-snakeyaml/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-snakeyaml/src/site/markdown/index.md rename to modello-plugins/modello-plugin-snakeyaml/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-stax/src/site/markdown/index.md b/modello-plugins/modello-plugin-stax/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-stax/src/site/markdown/index.md rename to modello-plugins/modello-plugin-stax/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-velocity/src/site/markdown/index.md b/modello-plugins/modello-plugin-velocity/src/site/markdown/index.md index df3885287..4fd97f453 100644 --- a/modello-plugins/modello-plugin-velocity/src/site/markdown/index.md +++ b/modello-plugins/modello-plugin-velocity/src/site/markdown/index.md @@ -1,46 +1,24 @@ - +--- +title: Modello Velocity Plugin +author: Guillaume Nodet +--- - +# Modello Velocity Plugin - - Modello Velocity Plugin - Guillaume Nodet - +Modello Velocity Plugin generates files from the Modello model using [Velocity templates](https://velocity.apache.org/engine/2.3/vtl-reference.html). - +# Velocity Processing -
+The plugin is configured with a list of `template` files to evaluate, rfelative to `velocityBasedir` (which defaults to Maven's `${project.basedir}`). -

Modello Velocity Plugin generates files from the Modello model using Velocity templates.

+During template evaluation, `#MODELLO-VELOCITY#SAVE-OUTPUT-TO {relative path to file}` pseudo macro is available to send the rendered content to a file. -
+The Velocity context contains some variables related to the Modello model context that you can use: -
- -

The plugin is configured with a list of template files to evaluate, rfelative to velocityBasedir (which defaults to Maven's ${project.basedir}).

-

During template evaluation, #MODELLO-VELOCITY#SAVE-OUTPUT-TO {relative path to file} pseudo macro is available to send the rendered content to a file.

-

The Velocity context contains some variables related to the Modello model context that you can use: - - - - - - - - - - - - - - - - - -
VariableTypeDescription
parameters configured in the pluginStringThe parameters values configured in the plugin as {key}={value}.
versionStringThe version of the model being used.
modelModelThe Modello model.
HelperHelperA helper tool with classical functions useful to generate content from a Modello model API.
templateStringthe template that is being evaluated.
-

-
- - - - +| Variable | Type | Description | +|---|---|---| +| parameters configured in the plugin | `String` | The parameters values configured in the plugin as `{key}={value}`. | +| `version` | `String` | The version of the model being used. | +| `model` | [`Model`](../../modello-core/apidocs/org/codehaus/modello/model/package-summary.html) | The Modello model. | +| `Helper` | [`Helper`](apidocs/org/codehaus/modello/plugin/velocity/Helper.html) | A helper tool with classical functions useful to generate content from a Modello model API. | +| `template` | `String` | the template that is being evaluated. | diff --git a/modello-plugins/modello-plugin-xdoc/src/site/markdown/index.md b/modello-plugins/modello-plugin-xdoc/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-xdoc/src/site/markdown/index.md rename to modello-plugins/modello-plugin-xdoc/src/site/xdoc/index.xml diff --git a/modello-plugins/modello-plugin-xpp3/src/site/markdown/index.md b/modello-plugins/modello-plugin-xpp3/src/site/xdoc/index.xml similarity index 100% rename from modello-plugins/modello-plugin-xpp3/src/site/markdown/index.md rename to modello-plugins/modello-plugin-xpp3/src/site/xdoc/index.xml diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index b55e3db1d..9c9688c65 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -1,51 +1,36 @@ - - - - - - Modello - Hervé Boutemy - - - - -
- -

Modello is a framework for code generation from a simple model. - Modello generates code from a simple model format: based on a plugin architecture, various types of code and - descriptors can be generated from the single model, including Java POJOs, XML/JSON/YAML marshallers/unmarshallers, XSD, JSON Schema - and documentation. - Starting with 2.1.0, content can even be generated from Velocity templates for maximum flexibility. -

- -

- - - - - - - - - - - - - - - - - - - - - - - -

- -
- - - - +--- +title: Modello +author: Hervé Boutemy +--- + +# Modello + +Modello is a framework for code generation from a simple model. +Modello generates code from a [simple model format](modello.html): based on a plugin architecture, various types of code and +descriptors can be generated from the single model, including Java POJOs, XML/JSON/YAML marshallers/unmarshallers, XSD, JSON Schema +and documentation. +Starting with 2.1.0, content can even be [generated from Velocity templates](modello-plugins/modello-plugin-velocity/) for maximum flexibility. + + + + + + + + + + + + + + + + + + + + + + + +