This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch new-site-model
in repository https://gitbox.apache.org/repos/asf/maven-fluido-skin.git
commit da710d3a5d75494e7d17e724e34b022d12116a69
Author: Michael Osipov <micha...@apache.org>
AuthorDate: Tue Nov 5 09:52:55 2024 +0100
[MSKINS-256] Use new site model in documentation
---
src/site/apt/index.apt.vm | 105 +++++++++++++++++++++++++++-------------------
src/site/site.xml | 6 +--
2 files changed, 66 insertions(+), 45 deletions(-)
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index ca2b836..a026767 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -46,7 +46,8 @@ Welcome to ${project.name}!
{{{/doxia/doxia-sitetools/doxia-site-model/site.html#class_skin}the
<<<site.xml>>> site descriptor}}:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<skin>
<groupId>${project.groupId}</groupId>
@@ -54,7 +55,7 @@ Welcome to ${project.name}!
<version>${project.version}</version>
</skin>
[...]
-</project>
+</site>
+-----+
@@ -68,7 +69,8 @@ Welcome to ${project.name}!
Users have just play with flags in the <<<custom.fluidoSkin>>> element in
<<<site.xml>>>:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -77,7 +79,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
That allows users having 4 skins in only 1!
@@ -100,7 +102,8 @@ Welcome to ${project.name}!
the <<<custom.fluidoSkin.topBarIcon>>> element in <<<site.xml>>>:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -114,7 +117,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Topbar Container Style}
@@ -122,7 +125,8 @@ Welcome to ${project.name}!
You can configure the style attribute value of the div container for your
topbar
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -131,7 +135,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Navbar Style}
@@ -140,7 +144,8 @@ Welcome to ${project.name}!
Use navbar-inverse to have the black one.
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -149,7 +154,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Configuring column class}
@@ -159,7 +164,8 @@ Welcome to ${project.name}!
You can change that using:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -168,7 +174,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Matomo (e.g. Apache Analytics)}
@@ -177,7 +183,8 @@ Welcome to ${project.name}!
How to configure it for Apache Analytics, the <<options>> element will
contain some configuration (here some privacy setup):
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<matomo>
@@ -191,7 +198,7 @@ Welcome to ${project.name}!
</matomo>
</custom>
[...]
-</project>
+</site>
+-----+
** {Google Analytics}
@@ -199,7 +206,8 @@ Welcome to ${project.name}!
Users can optionally enable <<Google Analytics>> for the generated site:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -209,13 +217,14 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
By default, <<<forceSSL>>> and <<<anonymizeIp>>> are enabled. You can disable
both, but this might be illegal in several countries or regions (e.g., in the
EU due to GDPR):
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -227,7 +236,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Google Search}
@@ -237,17 +246,19 @@ Welcome to ${project.name}!
* the <<<project.url>>> property in <<<pom.xml>>>, unless the
<<<custom.fluidoSkin.googleSearch.sitesearch>>> property is set in the
<<<site.xml>>>:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<url>http://maven.apache.org/skins/${project.artifactId}</url>
[...]
-</project>
+</site>
+-----+
* the <<<custom.fluidoSkin.googleSearch>>> element in <<<site.xml>>>:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -257,7 +268,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
[]
@@ -279,7 +290,8 @@ Welcome to ${project.name}!
optionally enable line numbers rendering (disabled by default):
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -287,7 +299,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Copyright class}
@@ -295,7 +307,8 @@ Welcome to ${project.name}!
Since version <<1.3.1>>, you can configure a copyright class:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -303,7 +316,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {head/footer placeholders}
@@ -323,7 +336,8 @@ Welcome to ${project.name}!
* <<<custom.fluidoSkin.gitHub.ribbonColor>>>: <<optional>>, the ribbon color,
<<<red>>>/<<<green>>>/<<<black>>>/<<<darkblue>>>/<<<orange>>>/<<<gray>>> are
accepted only (<<<red>>> by default).
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -335,7 +349,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Project profile}
@@ -355,7 +369,8 @@ Welcome to ${project.name}!
are not using a production ready software:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -363,7 +378,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Twitter follow button}
@@ -378,7 +393,8 @@ Welcome to ${project.name}!
* <<<custom.fluidoSkin.twitter.showFollowers>>>: <<optional>>, flag to mark
the followers ribbon has to be shown (<<<false>>> by default).
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -390,7 +406,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
By default, it is rendered in the sidebar, if the topbar only is available it
will be rendered there.
@@ -415,7 +431,8 @@ Welcome to ${project.name}!
* <<<box_count>>>: default if sidebar is enabled
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -427,7 +444,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
By default, it is rendered in the sidebar, if the topbar only is available it
will be rendered there.
@@ -443,7 +460,8 @@ Welcome to ${project.name}!
You can optionally enable anchor ID generation with
{{{https://www.bryanbraun.com/anchorjs/}AnchorJS}}:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -451,7 +469,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
Note that the generated IDs are not compatible with IDs generated by the
underlying Doxia framework.
@@ -459,7 +477,8 @@ Welcome to ${project.name}!
Additionally you can provide a CSS selector for the <<<add()>>> function and
options:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -473,7 +492,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Skip generation date}
@@ -482,7 +501,8 @@ Welcome to ${project.name}!
to enable it:
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -490,7 +510,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
** {Breadcrumb Divider}
@@ -498,7 +518,8 @@ Welcome to ${project.name}!
Since version <<1.3.1>>, you can configure the breadcrumb divider (default
is a slash):
+-----+
-<project name="xxx">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
[...]
<custom>
<fluidoSkin>
@@ -506,7 +527,7 @@ Welcome to ${project.name}!
</fluidoSkin>
</custom>
[...]
-</project>
+</site>
+-----+
Acknowledgment
diff --git a/src/site/site.xml b/src/site/site.xml
index b97c211..38f35f8 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,8 +19,8 @@ specific language governing permissions and limitations
under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.8.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0
http://maven.apache.org/xsd/decoration-1.8.0.xsd";>
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
<edit>${project.scm.url}</edit>
@@ -64,4 +64,4 @@ under the License.
</body>
-</project>
+</site>
