This is an automated email from the ASF dual-hosted git repository. kwin pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-fluido-skin.git
commit fb30560d53569b185b1500a07038cb297e464ffd Author: Konrad Windszus <k...@apache.org> AuthorDate: Mon Dec 2 15:21:35 2024 +0100 [MSKINS-260] Convert to markdown with doxia-converter from revision https://github.com/apache/maven-doxia-converter/commit/6bdce4c8c8e94852b9d4ecb99b85e8a163fbe948 and https://github.com/apache/maven-doxia/commit/ac99291a53152e5f8863c29417c914170de2caa9 Some manual polishing applied afterwards, particularly to reconstruct velocity macros/expressions --- src/site/markdown/ITs.md | 93 ------- src/site/markdown/download.md.vm | 170 +++++------- src/site/markdown/index.md.vm | 559 ++++++++++++++++++--------------------- src/site/markdown/poweredby.md | 106 ++++---- src/site/markdown/sample.md | 258 +++++++----------- 5 files changed, 462 insertions(+), 724 deletions(-) diff --git a/src/site/markdown/ITs.md b/src/site/markdown/ITs.md deleted file mode 100644 index 1caafd0..0000000 --- a/src/site/markdown/ITs.md +++ /dev/null @@ -1,93 +0,0 @@ - ------ - Maven Fluido Skin ITs - ------ - Hervé Boutemy - ------ - 2018-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Fuido Skin ITs - - Here is a list of skin ITs to test misc. configuration conditions: - - * {{{./mskins-14/index.html}Search}} - - * {{{./mskins-177-apache-analytics/index.html}Apache Analytics}} - - * {{{./mskins-14_sitesearch/index.html}Search (sitesearch)}} - - * {{{./mskins-22/index.html}GitHub}} - - * {{{./mskins-22_default/index.html}GitHub (default)}} - - * {{{./mskins-22_topbar/index.html}GitHub (topbar)}} - - * {{{./mskins-24/index.html}Twitter}} - - * {{{./mskins-24_topbar/index.html}Twitter (topbar)}} - - * {{{./mskins-33/index.html}Like}} - - * {{{./mskins-161-sidebar-fb-like-share}Like with share}} - - * {{{./mskins-161-sidebar-fb-recommend-share}Like - Recommend with share}} - - * {{{./mskins-33_topbar/index.html}Like (topbar)}} - - * {{{./mskins-161-topbar-fb-like-share}Like with share (topbar)}} - - * {{{./mskins-161-topbar-fb-recommend-share}Like - Recommend with share (topbar)}} - - * {{{./mskins-10/index.html}MSKINS-10}} - - * {{{./mskins-13/index.html}MSKINS-13}} - - * {{{./mskins-15/index.html}MSKINS-15}} - - * {{{./mskins-16/index.html}MSKINS-16}} - - * {{{./mskins-17/index.html}MSKINS-17}} - - * {{{./mskins-21/index.html}MSKINS-21}} - - * {{{./mskins-23/index.html}MSKINS-23}} - - * {{{./mskins-28/index.html}MSKINS-28}} - - * {{{./mskins-41/index.html}MSKINS-41}} - - * {{{./mskins-72/index.html}MSKINS-72}} - - * {{{./mskins-76/index.html}MSKINS-76}} - - * {{{./mskins-76_topbar/index.html}MSKINS-76 (topbar)}} - - * {{{./mskins-85/index.html}MSKINS-85}} - - * {{{./mskins-143_default/index.html}MSKINS-143 (using defaults)}} - - * {{{./mskins-143_false/index.html}MSKINS-143 (using explicit false)}} - - * {{{./mskins-143_true/index.html}MSKINS-143 (using explicit true)}} - - [] diff --git a/src/site/markdown/download.md.vm b/src/site/markdown/download.md.vm index 4166b77..24be585 100644 --- a/src/site/markdown/download.md.vm +++ b/src/site/markdown/download.md.vm @@ -1,5 +1,6 @@ -<?xml version="1.0"?> - +--- +title: Download ${project.name} Source +--- <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file @@ -19,108 +20,65 @@ specific language governing permissions and limitations under the License. --> -<document> - <properties> - <title>Download ${project.name} Source</title> - </properties> - <body> - <section name="Download ${project.name} ${project.version} Source"> - - <p>${project.name} ${project.version} is distributed in source format. Use a source archive if you intend to build - ${project.name} yourself. Otherwise, simply use the ready-made binary artifacts from central repository.</p> - - <p>You will be prompted for a mirror - if the file is not found on yours, please be patient, as it may take 24 - hours to reach all mirrors.<p/> - - <p>In order to guard against corrupted downloads/installations, it is highly recommended to - <a href="http://www.apache.org/dev/release-signing#verifying-signature">verify the signature</a> - of the release bundles against the public <a href="https://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven - developers.</p> - - <p>${project.name} is distributed under the <a href="http://www.apache.org/licenses/">Apache License, version 2.0</a>.</p> - - <p></p>We <b>strongly</b> encourage our users to configure a Maven repository mirror closer to their location, please read <a href="./guides/mini/guide-mirror-settings.html">How to Use Mirrors for Repositories</a>.</p> - - <a name="mirror"/> - <subsection name="Mirror"> - - <p> - [if-any logo] - <a href="[link]"> - <img align="right" src="[logo]" border="0" - alt="logo"/> - </a> - [end] - The currently selected mirror is - <b>[preferred]</b>. - If you encounter a problem with this mirror, - please select another mirror. - If all mirrors are failing, there are - <i>backup</i> - mirrors - (at the end of the mirrors list) that should be available. - </p> - - <form action="[location]" method="get" id="SelectMirror"> - Other mirrors: - <select name="Preferred"> - [if-any http] - [for http] - <option value="[http]">[http]</option> - [end] - [end] - [if-any ftp] - [for ftp] - <option value="[ftp]">[ftp]</option> - [end] - [end] - [if-any backup] - [for backup] - <option value="[backup]">[backup] (backup)</option> - [end] - [end] - </select> - <input type="submit" value="Change"/> - </form> - - <p> - You may also consult the - <a href="http://www.apache.org/mirrors/">complete list of - mirrors.</a> - </p> - - </subsection> - - <subsection name="${project.name} ${project.version}"> - - <p>This is the current stable version of ${project.name}.</p> - - <table> - <thead> - <tr> - <th></th> - <th>Link</th> - <th>Checksum</th> - <th>Signature</th> - </tr> - </thead> - <tbody> - <tr> - <td>${project.name} ${project.version} (Source zip)</td> - <td><a href="[preferred]maven/skins/${project.artifactId}-${project.version}-source-release.zip">maven/skins/${project.artifactId}-${project.version}-source-release.zip</a></td> - <td><a href="https://www.apache.org/dist/maven/skins/${project.artifactId}-${project.version}-source-release.zip.sha512">maven/skins/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td> - <td><a href="https://www.apache.org/dist/maven/skins/${project.artifactId}-${project.version}-source-release.zip.asc">maven/skins/${project.artifactId}-${project.version}-source-release.zip.asc</a></td> - </tr> - </tbody> - </table> - </subsection> - - <subsection name="Previous Versions"> - - <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/skins/">archive site</a>.</p> - - </subsection> - </section> - </body> -</document> +# Download ${project.name} ${project.version} Source + +${project.name} ${project.version} is distributed in source format\. Use a source archive if you intend to build +${project.name} yourself\. Otherwise, simply use the ready\-made binary artifacts from central repository\. + +You will be prompted for a mirror \- if the file is not found on yours, please be patient, as it may take 24 +hours to reach all mirrors\. + +In order to guard against corrupted downloads/installations, it is highly recommended to +[verify the signature](http://www.apache.org/dev/release-signing#verifying-signature) +of the release bundles against the public [KEYS](https://www.apache.org/dist/maven/KEYS) used by the Apache Maven +developers\. + +${project.name} is distributed under the [Apache License, version 2\.0](http://www.apache.org/licenses/)\. + +We **strongly** encourage our users to configure a Maven repository mirror closer to their location, please read [How to Use Mirrors for Repositories](./guides/mini/guide-mirror-settings.html)\. + +<a id="mirror"></a> + +${esc.h}${esc.h} Mirror + +\[if-any logo\] + [](\[link\]) +\[end\] +The currently selected mirror is **[preferred]**. If you encounter a problem with this mirror, please select another mirror\. If all mirrors are failing, there are _backup_ mirrors \(at the end of the mirrors list\) that should be available\. + +<form action="[location]" method="get" id="SelectMirror"> + Other mirrors: + <select name="Preferred"> + [if-any http] + [for http] + <option value="[http]">[http]</option> + [end] + [end] + [if-any ftp] + [for ftp] + <option value="[ftp]">[ftp]</option> + [end] + [end] + [if-any backup] + [for backup] + <option value="[backup]">[backup] (backup)</option> + [end] + [end] + </select> + <input type="submit" value="Change"/> +</form> + +You may also consult the [complete list of mirrors\.](http://www.apache.org/mirrors/) + + +${esc.h}${esc.h} ${project.name} ${project.version} + +This is the current stable version of ${project.name}\. + +| |Link|Checksum|Signature| +|---|---|---|---| +${project.name} ${project.version} \(Source zip\)|[maven/skins/${project.artifactId}\-${project.version}\-source\-release\.zip](\[preferred\]maven/skins/${project.artifactId}-${project.version}-source-release.zip)|[maven/skins/${project.artifactId}\-${project.version}\-source\-release\.zip\.sha512](https://www.apache.org/dist/maven/skins/${project.artifactId}-${project.version}-source-release.zip.sha512)|[maven/skins/${project.artifactId}\-${project.version}\-source\-release\.zip\.asc](h [...] + +${esc.h}${esc.h} Previous Versions +Older non\-recommended releases can be found on our [archive site](http://archive.apache.org/dist/maven/skins/)\. \ No newline at end of file diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm index a026767..7139c27 100644 --- a/src/site/markdown/index.md.vm +++ b/src/site/markdown/index.md.vm @@ -1,51 +1,41 @@ - ------ - Introduction - ------ - Hervé Boutemy - Simone "Simo" Tripodi - ------ - 2012-06-28 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Welcome to ${project.name}! - - The Apache Maven Fluido Skin is an Apache Maven site skin built on top of - {{{http://bootstrapdocs.com/v${project.properties.get('bootstrap.version')}/docs/}Twitter's Bootstrap ${project.properties.get('bootstrap.version')}}}. - - A {{{./sample.html}sample page}} is provided to see the skin in action, and two complete sites to show skin - configurations: one for {{{./sidebar/}sidebar layout (default)}} and the other for {{{./topbar/}topbar layout}}. - - Notice: since version 1.5 of this skin, Velocity 1.7 (used by Maven Site Plugin version 3.5) is required. - But in previous versions of the skin, it was Velocity 1.5, which has some incompatibilities. - If you need to mix versions, please see {{{/plugins/maven-site-plugin/migrate.html}the migration guide}} to override - Velocity version used by Maven Site Plugin as per your specific skin and site plugin requirements. - -* Usage - - To use this skin in your project, use the skin element of - {{{/doxia/doxia-sitetools/doxia-site-model/site.html#class_skin}the <<<site.xml>>> site descriptor}}: - -+-----+ +--- +title: Introduction +author: + - Hervé Boutemy + - Simone "Simo" Tripodi +date: 2012-06-28 +--- + +<!-- Licensed to the Apache Software Foundation (ASF) under one--> +<!-- or more contributor license agreements. See the NOTICE file--> +<!-- distributed with this work for additional information--> +<!-- regarding copyright ownership. The ASF licenses this file--> +<!-- to you under the Apache License, Version 2.0 (the--> +<!-- "License"); you may not use this file except in compliance--> +<!-- with the License. You may obtain a copy of the License at--> +<!----> +<!-- http://www.apache.org/licenses/LICENSE-2.0--> +<!----> +<!-- Unless required by applicable law or agreed to in writing,--> +<!-- software distributed under the License is distributed on an--> +<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY--> +<!-- KIND, either express or implied. See the License for the--> +<!-- specific language governing permissions and limitations--> +<!-- under the License.--> + +# Welcome to ${project.name}! + +The Apache Maven Fluido Skin is an Apache Maven site skin built on top of [Twitter's Bootstrap ${project.properties.get('bootstrap.version')}](http://bootstrapdocs.com/v${project.properties.get('bootstrap.version')}/docs)\. + +A [sample page](./sample.html) is provided to see the skin in action, and two complete sites to show skin configurations: one for [sidebar layout \(default\)](./sidebar/) and the other for [topbar layout](./topbar/)\. + +Notice: since version 1\.5 of this skin, Velocity 1\.7 \(used by Maven Site Plugin version 3\.5\) is required\. But in previous versions of the skin, it was Velocity 1\.5, which has some incompatibilities\. If you need to mix versions, please see [the migration guide](/plugins/maven-site-plugin/migrate.html) to override Velocity version used by Maven Site Plugin as per your specific skin and site plugin requirements\. + +${esc.h}${esc.h} Usage + +To use this skin in your project, use the skin element of [the `site.xml` site descriptor](/doxia/doxia-sitetools/doxia-site-model/site.html#class_skin): + +```xml <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"> [...] @@ -56,19 +46,16 @@ Welcome to ${project.name}! </skin> [...] </site> -+-----+ +``` +The following aspects may be configured: - The following aspects may be configured: +<!-- MACRO{toc|section=1|fromDepth=3} --> +${esc.h}${esc.h}${esc.h} <a id="Topbar_and.2For_Sidebar"></a>Topbar and/or Sidebar -%{toc|section=1|fromDepth=3} +The skin supports different layouts, enabling/disabling the left sidebar menu and the topbar menu\. Users have just play with flags in the `custom.fluidoSkin` element in `site.xml`: -** {Topbar and/or Sidebar} - - The skin supports different layouts, enabling/disabling the left sidebar menu and the topbar menu. - Users have just play with flags in the <<<custom.fluidoSkin>>> element in <<<site.xml>>>: - -+-----+ +```xml <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"> [...] @@ -80,28 +67,22 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ - - That allows users having 4 skins in only 1! - - [[1]] sidebar only; +``` - [[2]] topbar only; +That allows users having 4 skins in only 1\! - [[3]] both side/top bars; +1. sidebar only; +1. topbar only; +1. both side/top bars; +1. none at all\. - [[4]] none at all. +Default skin setting is the option **1**\. - [] +${esc.h}${esc.h}${esc.h} <a id="Topbar_Icon"></a>Topbar Icon - Default skin setting is the option <<1>>. +When users decide to enable the topbar, they can plug a small icon/logo there \(typically 108\*20 px\) just configuring the `custom.fluidoSkin.topBarIcon` element in `site.xml`: -** {Topbar Icon} - - When users decide to enable the topbar, they can plug a small icon/logo there (typically 108*20 px) just configuring - the <<<custom.fluidoSkin.topBarIcon>>> element in <<<site.xml>>>: - -+-----+ +```xml <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"> [...] @@ -118,13 +99,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Topbar Container Style} +${esc.h}${esc.h}${esc.h} <a id="Topbar_Container_Style"></a>Topbar Container Style - You can configure the style attribute value of the div container for your topbar +You can configure the style attribute value of the div container for your topbar -+-----+ +```xml <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"> [...] @@ -136,14 +117,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Navbar Style} +${esc.h}${esc.h}${esc.h} <a id="Navbar_Style"></a>Navbar Style - You can configure style of your top bar nav (since bootstrap 2.1.0 is not anymore black by default). - Use navbar-inverse to have the black one. +You can configure style of your top bar nav \(since bootstrap 2\.1\.0 is not anymore black by default\)\. Use navbar\-inverse to have the black one\. -+-----+ +```xml <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"> [...] @@ -155,15 +135,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Configuring column class} +${esc.h}${esc.h}${esc.h} <a id="Configuring_column_class"></a>Configuring column class - When using sidebar, the navigation column uses by default <<<span2>>> class and body column uses - <<<span10>>>. To prevent weird/ugly result, the sum must be 12. - You can change that using: +When using sidebar, the navigation column uses by default `span2` class and body column uses `span10`\. To prevent weird/ugly result, the sum must be 12\. You can change that using: -+-----+ +```xml <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"> [...] @@ -175,14 +153,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Matomo (e.g. Apache Analytics)} +${esc.h}${esc.h}${esc.h} <a id="Matomo_.28e.g._Apache_Analytics.29"></a>Matomo \(e\.g\. Apache Analytics\) - Users can optionally enable <<Matomo>>. - How to configure it for Apache Analytics, the <<options>> element will contain some configuration (here some privacy setup): +Users can optionally enable **Matomo**\. How to configure it for Apache Analytics, the **options** element will contain some configuration \(here some privacy setup\): -+-----+ +```xml <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"> [...] @@ -199,13 +176,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Google Analytics} +${esc.h}${esc.h}${esc.h} <a id="Google_Analytics"></a>Google Analytics - Users can optionally enable <<Google Analytics>> for the generated site: +Users can optionally enable **Google Analytics** for the generated site: -+-----+ +```xml <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"> [...] @@ -218,11 +195,11 @@ Welcome to ${project.name}! </custom> [...] </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): +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\): -+-----+ +```xml <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"> [...] @@ -237,59 +214,52 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Google Search} +${esc.h}${esc.h}${esc.h} <a id="Google_Search"></a>Google Search - Users can optionally enable the <<Google Search>> for the generated site, requirements are: +Users can optionally enable the **Google Search** for the generated site, requirements are: - * the <<<project.url>>> property in <<<pom.xml>>>, unless the <<<custom.fluidoSkin.googleSearch.sitesearch>>> property is set in the <<<site.xml>>>: +- the `project.url` property in `pom.xml`, unless the `custom.fluidoSkin.googleSearch.sitesearch` property is set in the `site.xml`: -+-----+ -<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> - [...] -</site> -+-----+ + ```xml + <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> + [...] + </site> + ``` - * the <<<custom.fluidoSkin.googleSearch>>> element in <<<site.xml>>>: +- the `custom.fluidoSkin.googleSearch` element in `site.xml`: -+-----+ -<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> - <googleSearch> - <sitesearch/> - </googleSearch> - </fluidoSkin> - </custom> - [...] -</site> -+-----+ - - [] - - By default, the search form: + ```xml + <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> + <googleSearch> + <sitesearch/> + </googleSearch> + </fluidoSkin> + </custom> + [...] + </site> + ``` - * is <not> enabled; adding <<<custom.fluidoSkin.googleSearch>>> is enough to enable the searchbox. +By default, the search form: - * is rendered in the sidebar, if the topbar only is available it will be rendered there. +- is _not_ enabled; adding `custom.fluidoSkin.googleSearch` is enough to enable the searchbox\. +- is rendered in the sidebar, if the topbar only is available it will be rendered there\. - [] +External links are either rendered in the sidebar or the topbar\. When both sidebar and topbar are enabled, they are rendered as dropdown in the topbar only\. - External links are either rendered in the sidebar or the topbar. When both sidebar and topbar are enabled, - they are rendered as dropdown in the topbar only. +${esc.h}${esc.h}${esc.h} <a id="Source_code_line_numbers"></a>Source code line numbers -** {Source code line numbers} +Source code sections are enhanced by [Google Code Prettify](https://github.com/google/code-prettify), users can optionally enable line numbers rendering \(disabled by default\): - Source code sections are enhanced by {{{https://github.com/google/code-prettify}Google Code Prettify}}, users can - optionally enable line numbers rendering (disabled by default): - -+-----+ +```xml <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"> [...] @@ -300,13 +270,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Copyright class} +${esc.h}${esc.h}${esc.h} <a id="Copyright_class"></a>Copyright class - Since version <<1.3.1>>, you can configure a copyright class: +Since version **1\.3\.1**, you can configure a copyright class: -+-----+ +```xml <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"> [...] @@ -317,149 +287,130 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ - -** {head/footer placeholders} - - This skin will pass your custom head/footer to <<<${esc.d}render.eval()>>> and replace all variables - known to the Velocity context. - -** {GitHub Ribbons} - - Since version <<1.11.1>>, fluido-skin supports {{{https://github.com/simonwhitaker/github-fork-ribbon-css}GitHub ribbons}} to simplify - the <Fork me on GitHub> banner integration. Users must define: - - * <<<custom.fluidoSkin.gitHub.projectId>>>: <<required>>, the project id on GitHub and will be used to build the project page URL; - - * <<<custom.fluidoSkin.gitHub.ribbonOrientation>>>: <<optional>>, the ribbon position, <<<left-top>>>> (<<<left>>>)/<<<right-top>>> (<<<right>>>)/<<<left-bottom>>>/<<<right-bottom>>> are accepted only (<<<left-top>>> by default); - - * <<<custom.fluidoSkin.gitHub.ribbonColor>>>: <<optional>>, the ribbon color, <<<red>>>/<<<green>>>/<<<black>>>/<<<darkblue>>>/<<<orange>>>/<<<gray>>> are accepted only (<<<red>>> by default). - -+-----+ -<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> - <gitHub> - <projectId>apache/maven-skins</projectId> - <ribbonOrientation>right</ribbonOrientation> - <ribbonColor>black</ribbonColor> - </gitHub> - </fluidoSkin> - </custom> - [...] -</site> -+-----+ - -** {Project profile} - - As shown in {{{http://www.mojohaus.org/plugins.html}MojoHaus Maven plugins list}}, plugins life-cycle are characterized by - different status/stages: - - * Production - - * Pre-release - - * Sandbox - - * Graveyard (retired projects) - - Users can configure different backgrounds depending on the project status (except the production) to warrant users they - are not using a production ready software: - -+-----+ -<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> - <profile>(pre-release|sandbox|retired)</profile> - </fluidoSkin> - </custom> - [...] -</site> -+-----+ - -** {Twitter follow button} - - Since version <<1.1>>, fluido-skin supports the Twitter {{{https://dev.twitter.com/web/follow-button}follow button}} - to simplify its integration. Users must define: - - * <<<custom.fluidoSkin.twitter.user>>>: <<required>>, it is the Twitter id to suggest to follow; - - * <<<custom.fluidoSkin.twitter.showUser>>>: <<optional>>, flag to mark the user has to be shown (<<<false>>> by default); - - * <<<custom.fluidoSkin.twitter.showFollowers>>>: <<optional>>, flag to mark the followers ribbon has to be shown (<<<false>>> by default). - -+-----+ -<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> - <twitter> - <user>simonetripodi</user> - <showUser>true</showUser> - <showFollowers>true</showFollowers> - </twitter> - </fluidoSkin> - </custom> - [...] -</site> -+-----+ - - By default, it is rendered in the sidebar, if the topbar only is available it will be rendered there. - -** {Facebook like button} - - Since version <<1.2>>, fluido-skin supports the Facebook {{{https://developers.facebook.com/docs/plugins/like-button}like}} - integration. Users can define similar option to Facebook SDK: - - * <<<custom.fluidoSkin.facebookLike.recommend>>>: <<optional>>, if set to <<<true>>> <<Recommend>> button will be rendered instead of <<Like>> - - * <<<custom.fluidoSkin.facebookLike.shareButton>>>: <<optional>>, if set to <<<true>>> <<Share Button>> will be included. - - * <<<custom.fluidoSkin.facebookLike.layout>>>: <<optional>> facebook layout, Can be one of: - - * <<<standard>>> - - * <<<button_count>>>: default if sidebar is not enabled - - * <<<button>>> - - * <<<box_count>>>: default if sidebar is enabled - -+-----+ -<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> - <facebookLike> - <recommend>true/false</recommend> - <shareButton>true/false</shareButton> - <layout>box_count</layout> - </facebookLike> - </fluidoSkin> - </custom> - [...] -</site> -+-----+ - - By default, it is rendered in the sidebar, if the topbar only is available it will be rendered there. - - <<Note>> in order the Facebook like button appears, <<<$\{project.url\}>>> property <<must>> be set in the <<<pom.xml>>>! - -** {Flattr button} - - As of version <<2.0.0-M9>>, support for Flattr buttons in fluido-skin has been removed. - -** {AnchorJS} - - You can optionally enable anchor ID generation with {{{https://www.bryanbraun.com/anchorjs/}AnchorJS}}: - -+-----+ +``` + +${esc.h}${esc.h}${esc.h} <a id="head.2Ffooter_placeholders"></a>head/footer placeholders + +This skin will pass your custom head/footer to `$<a id="esc.d"></a>esc.drender.eval()` and replace all variables known to the Velocity context\. + +${esc.h}${esc.h}${esc.h} <a id="GitHub_Ribbons"></a>GitHub Ribbons + +Since version **1\.11\.1**, fluido\-skin supports [GitHub ribbons](https://github.com/simonwhitaker/github-fork-ribbon-css) to simplify the _Fork me on GitHub_ banner integration\. Users must define: + +- `custom.fluidoSkin.gitHub.projectId`: **required**, the project id on GitHub and will be used to build the project page URL; +- `custom.fluidoSkin.gitHub.ribbonOrientation`: **optional**, the ribbon position, `left-top`> \(`left`\)/`right-top` \(`right`\)/`left-bottom`/`right-bottom` are accepted only \(`left-top` by default\); +- `custom.fluidoSkin.gitHub.ribbonColor`: **optional**, the ribbon color, `red`/`green`/`black`/`darkblue`/`orange`/`gray` are accepted only \(`red` by default\)\. + + ```xml + <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> + <gitHub> + <projectId>apache/maven-skins</projectId> + <ribbonOrientation>right</ribbonOrientation> + <ribbonColor>black</ribbonColor> + </gitHub> + </fluidoSkin> + </custom> + [...] + </site> + ``` + +${esc.h}${esc.h}${esc.h} <a id="Project_profile"></a>Project profile + +As shown in [MojoHaus Maven plugins list](http://www.mojohaus.org/plugins.html), plugins life\-cycle are characterized by different status/stages: + +- Production +- Pre\-release +- Sandbox +- Graveyard \(retired projects\) + + Users can configure different backgrounds depending on the project status \(except the production\) to warrant users they are not using a production ready software: + + ```xml + <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> + <profile>(pre-release|sandbox|retired)</profile> + </fluidoSkin> + </custom> + [...] + </site> + ``` + +${esc.h}${esc.h}${esc.h} <a id="Twitter_follow_button"></a>Twitter follow button + +Since version **1\.1**, fluido\-skin supports the Twitter [follow button](https://dev.twitter.com/web/follow-button) to simplify its integration\. Users must define: + +- `custom.fluidoSkin.twitter.user`: **required**, it is the Twitter id to suggest to follow; +- `custom.fluidoSkin.twitter.showUser`: **optional**, flag to mark the user has to be shown \(`false` by default\); +- `custom.fluidoSkin.twitter.showFollowers`: **optional**, flag to mark the followers ribbon has to be shown \(`false` by default\)\. + + ```xml + <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> + <twitter> + <user>simonetripodi</user> + <showUser>true</showUser> + <showFollowers>true</showFollowers> + </twitter> + </fluidoSkin> + </custom> + [...] + </site> + ``` + + By default, it is rendered in the sidebar, if the topbar only is available it will be rendered there\. + +${esc.h}${esc.h}${esc.h} <a id="Facebook_like_button"></a>Facebook like button + +Since version **1\.2**, fluido\-skin supports the Facebook [like](https://developers.facebook.com/docs/plugins/like-button) integration\. Users can define similar option to Facebook SDK: + +- `custom.fluidoSkin.facebookLike.recommend`: **optional**, if set to `true` **Recommend** button will be rendered instead of **Like** +- `custom.fluidoSkin.facebookLike.shareButton`: **optional**, if set to `true` **Share Button** will be included\. +- `custom.fluidoSkin.facebookLike.layout`: **optional** facebook layout, Can be one of: + - `standard` + - `button_count`: default if sidebar is not enabled + - `button` + - `box_count`: default if sidebar is enabled + + ```xml + <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> + <facebookLike> + <recommend>true/false</recommend> + <shareButton>true/false</shareButton> + <layout>box_count</layout> + </facebookLike> + </fluidoSkin> + </custom> + [...] + </site> + ``` + + By default, it is rendered in the sidebar, if the topbar only is available it will be rendered there\. + + **Note** in order the Facebook like button appears, `${project.url}` property **must** be set in the `pom.xml`\! + +${esc.h}${esc.h}${esc.h} <a id="Flattr_button"></a>Flattr button + +As of version **2\.0\.0\-M9**, support for Flattr buttons in fluido\-skin has been removed\. + +${esc.h}${esc.h}${esc.h} <a id="AnchorJS"></a>AnchorJS + +You can optionally enable anchor ID generation with [AnchorJS](https://www.bryanbraun.com/anchorjs/): + +```xml <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"> [...] @@ -470,13 +421,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` - Note that the generated IDs are not compatible with IDs generated by the underlying Doxia framework. +Note that the generated IDs are not compatible with IDs generated by the underlying Doxia framework\. - Additionally you can provide a CSS selector for the <<<add()>>> function and options: +Additionally you can provide a CSS selector for the `add()` function and options: -+-----+ +```xml <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"> [...] @@ -493,14 +444,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Skip generation date} +${esc.h}${esc.h}${esc.h} <a id="Skip_generation_date"></a>Skip generation date - Since version <<1.3.1>>, you can skip generation date from the line "Generated by Apache Maven Doxia at \<date\>" - to enable it: +Since version **1\.3\.1**, you can skip generation date from the line "Generated by Apache Maven Doxia at <date>" to enable it: -+-----+ +```xml <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"> [...] @@ -511,13 +461,13 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -** {Breadcrumb Divider} +${esc.h}${esc.h}${esc.h} <a id="Breadcrumb_Divider"></a>Breadcrumb Divider - Since version <<1.3.1>>, you can configure the breadcrumb divider (default is a slash): +Since version **1\.3\.1**, you can configure the breadcrumb divider \(default is a slash\): -+-----+ +```xml <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"> [...] @@ -528,10 +478,9 @@ Welcome to ${project.name}! </custom> [...] </site> -+-----+ +``` -Acknowledgment +# Acknowledgment - ${project.name} contains/redistributes {{{http://glyphicons.com}Glyphicons Halflings}} as part of Bootstrap by Twitter, - released under {{{http://creativecommons.org/licenses/by/3.0/deed.en}Creative Commons Attribution 3.0 Unported (CC BY 3.0)}}. +${project.name} contains/redistributes [Glyphicons Halflings](http://glyphicons.com) as part of Bootstrap by Twitter, released under [Creative Commons Attribution 3\.0 Unported \(CC BY 3\.0\)](http://creativecommons.org/licenses/by/3.0/deed.en)\. diff --git a/src/site/markdown/poweredby.md b/src/site/markdown/poweredby.md index 5c6b56c..b507408 100644 --- a/src/site/markdown/poweredby.md +++ b/src/site/markdown/poweredby.md @@ -1,60 +1,46 @@ - ------ - Powered By - ------ -Simone "Simo" Tripodi - ------ - 2012-07-10 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Powered By - - Here is a non-exhaustive list of known projects which documentation sites have been generated using - the Maven Fluido Skin (in sparse order): - -* Apache Projects - -*-----*------*------* -{{{http://oltu.apache.org/}Apache Oltu}} | {{{http://any23.apache.org/}Apache Any23}} | {{{http://struts.apache.org/}Apache Struts}} -*-----*------*------* -{{{http://syncope.apache.org/}Apache Syncope}} | {{{http://archiva.apache.org/}Apache Archiva}} | {{{http://maven.apache.org/plugins/maven-surefire-plugin/}Apache Maven Surefire Plugin}} -*-----*------*------* -{{{http://chukwa.apache.org/}Apache Chukwa}} | {{{http://ambari.apache.org/}Apache Ambari}} | {{{http://logging.apache.org/log4j/2.x/}Apache Log4j 2}} -*-----*------*------* -{{{http://tomcat.apache.org/maven-plugin-trunk/}Apache Tomcat Maven Plugin}} | {{{http://hama.apache.org/}Apache Hama}} -*-----*------*------* -{{{http://people.apache.org/~olamy/resume/}Olivier Lamy}}'s ASF pages | {{{http://people.apache.org/~tommaso/}Tommaso Teofili}}'s ASF pages | {{{http://people.apache.org/~simonetripodi/}Simone Tripodi}}'s ASF pages -*-----*------*------* - -* Non-ASF projects - -*-----*------*------* -{{{http://www.mojohaus.org/}MojoHaus}} | {{{https://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html}Maven Alfresco Lifecycle}} | {{{http://www.silverpeas.org/}silverpeas.org}} -*-----*------*------* -{{{http://www.mybatis.org/mybatis-3/}MyBatis SQL Mapper}} | {{{http://redline-rpm.org/}Redline RPM}} | {{{http://www.99soft.org/}The 99 Software Foundation}} -*-----*------*------* -{{{http://code.grobmeier.de/jjson/}JJSON}} | {{{http://sparkle-g.googlecode.com/svn/site/3.3.1/index.html}Sparkle-G}} | {{{http://simpligility.github.io/android-maven-plugin/}Android Maven Plugin}} -*-----*------*------* -Terradue Spatial OpenSearch {{{http://terradue.github.com/jcatalogue-client/}catalogue client}} | {{{http://gwtbootstrap.github.com/gwt-bootstrap/}GWT Bootstrap}} | {{{http://tap4j.org/}Test Anything Protocol for Java}} -*-----*------*------* -{{{http://awhitford.github.com/lombok.maven/}Maven Plugin}} for Project Lombok | {{{http://www.alia4j.org/alia4j/}Advanced-dispatch Language Implementation Architecture for Java}} | {{{http://dozer.sourceforge.net/}Dozer}} -*-----*------*------* +--- +title: Powered By +author: + - Simone "Simo" Tripodi +date: 2012-07-10 +--- + +<!-- Licensed to the Apache Software Foundation (ASF) under one--> +<!-- or more contributor license agreements. See the NOTICE file--> +<!-- distributed with this work for additional information--> +<!-- regarding copyright ownership. The ASF licenses this file--> +<!-- to you under the Apache License, Version 2.0 (the--> +<!-- "License"); you may not use this file except in compliance--> +<!-- with the License. You may obtain a copy of the License at--> +<!----> +<!-- http://www.apache.org/licenses/LICENSE-2.0--> +<!----> +<!-- Unless required by applicable law or agreed to in writing,--> +<!-- software distributed under the License is distributed on an--> +<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY--> +<!-- KIND, either express or implied. See the License for the--> +<!-- specific language governing permissions and limitations--> +<!-- under the License.--> + +# Powered By + +Here is a non\-exhaustive list of known projects which documentation sites have been generated using the Maven Fluido Skin \(in sparse order\): + +## Apache Projects + +| | | | +|:---:|:---:|:---:| +|[Apache Oltu](http://oltu.apache.org/)|[Apache Any23](http://any23.apache.org/)|[Apache Struts](http://struts.apache.org/)| +|[Apache Syncope](http://syncope.apache.org/)|[Apache Archiva](http://archiva.apache.org/)|[Apache Maven Surefire Plugin](http://maven.apache.org/plugins/maven-surefire-plugin/)| +|[Apache Chukwa](http://chukwa.apache.org/)|[Apache Ambari](http://ambari.apache.org/)|[Apache Log4j 2](http://logging.apache.org/log4j/2.x/)| +|[Apache Tomcat Maven Plugin](http://tomcat.apache.org/maven-plugin-trunk/)|[Apache Hama](http://hama.apache.org/)|| +|[Olivier Lamy](http://people.apache.org/~olamy/resume/)'s ASF pages|[Tommaso Teofili](http://people.apache.org/~tommaso/)'s ASF pages|[Simone Tripodi](http://people.apache.org/~simonetripodi/)'s ASF pages| +## Non\-ASF projects + +| | | | +|:---:|:---:|:---:| +|[MojoHaus](http://www.mojohaus.org/)|[Maven Alfresco Lifecycle](https://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html)|[silverpeas\.org](http://www.silverpeas.org/)| +|[MyBatis SQL Mapper](http://www.mybatis.org/mybatis-3/)|[Redline RPM](http://redline-rpm.org/)|[The 99 Software Foundation](http://www.99soft.org/)| +|[JJSON](http://code.grobmeier.de/jjson/)|[Sparkle\-G](http://sparkle-g.googlecode.com/svn/site/3.3.1/index.html)|[Android Maven Plugin](http://simpligility.github.io/android-maven-plugin/)| +|Terradue Spatial OpenSearch [catalogue client](http://terradue.github.com/jcatalogue-client/)|[GWT Bootstrap](http://gwtbootstrap.github.com/gwt-bootstrap/)|[Test Anything Protocol for Java](http://tap4j.org/)| +|[Maven Plugin](http://awhitford.github.com/lombok.maven/) for Project Lombok|[Advanced\-dispatch Language Implementation Architecture for Java](http://www.alia4j.org/alia4j/)|[Dozer](http://dozer.sourceforge.net/)| diff --git a/src/site/markdown/sample.md b/src/site/markdown/sample.md index e72501e..c4c8fce 100644 --- a/src/site/markdown/sample.md +++ b/src/site/markdown/sample.md @@ -1,193 +1,131 @@ - ------ - Sample Content - ------ - Hervé Boutemy - ------ - 2011-11-07 - ------ +--- +title: Sample Content +author: + - Hervé Boutemy +date: 2011-11-07 +--- -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. +<!-- Licensed to the Apache Software Foundation (ASF) under one--> +<!-- or more contributor license agreements. See the NOTICE file--> +<!-- distributed with this work for additional information--> +<!-- regarding copyright ownership. The ASF licenses this file--> +<!-- to you under the Apache License, Version 2.0 (the--> +<!-- "License"); you may not use this file except in compliance--> +<!-- with the License. You may obtain a copy of the License at--> +<!----> +<!-- http://www.apache.org/licenses/LICENSE-2.0--> +<!----> +<!-- Unless required by applicable law or agreed to in writing,--> +<!-- software distributed under the License is distributed on an--> +<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY--> +<!-- KIND, either express or implied. See the License for the--> +<!-- specific language governing permissions and limitations--> +<!-- under the License.--> -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html +# Sample content -Sample content +Regular font\. _Italic_ font\. **Bold** font\. `Monospaced` font\. - Regular font. <Italic> font. <<Bold>> font. <<<Monospaced>>> font. +<a id="Anchor"></a>Anchor\. Links: [to Anchor](#Anchor), [to http:](http://www.pixware.fr), [to https:](https://www.pixware.fr), [to file:](file:///tmp), [to ftp:](ftp://ftp.apache.org), [to e\-mail](mailto:d...@maven.apach.org), [to \.asc](http://unknown.asc), [to \.jpg](http://unknown.jpg), [to \.jpeg](http://unknown.jpeg), [to \.gif](http://unknown.gif), [to \.png](http://unknown.png), [to \.tar\.gz](http://unknown.tar.gz), [to \.zip](http://unknown.zip), [to \.md5](http://unknown.md5) [...] - {Anchor}. Links: {{{Anchor}to Anchor}}, - {{{http://www.pixware.fr}to http:}}, - {{{https://www.pixware.fr}to https:}}, - {{{file:///tmp}to file:}}, - {{{ftp://ftp.apache.org}to ftp:}}, - {{{mailto:dev at maven dot apache dot org}to e-mail}}, - {{{http://unknown.asc}to .asc}}, - {{{http://unknown.jpg}to .jpg}}, - {{{http://unknown.jpeg}to .jpeg}}, - {{{http://unknown.gif}to .gif}}, - {{{http://unknown.png}to .png}}, - {{{http://unknown.tar.gz}to .tar.gz}}, - {{{http://unknown.zip}to .zip}}, - {{{http://unknown.md5}to .md5}}, - {{{http://unknown.sha1}to .sha1}}. +Basic icons = Success, Warning, Error, Info: - Basic icons = Success, Warning, Error, Info: + -[images/icon_success_sml.gif] Success +Changes plugin legend = Add, Fix, Help, Remove, Update: -[images/icon_warning_sml.gif] Warning + -[images/icon_error_sml.gif] Error +RSS icon \(shared across multiple plugins\): -[images/icon_info_sml.gif] Info + +# Section title - Changes plugin legend = Add, Fix, Help, Remove, Update: +## Sub\-section title -[images/add.gif] Add +### Sub\-sub\-section title -[images/fix.gif] Fix +#### Sub\-sub\-sub\-section title -[images/icon_help_sml.gif] Help +##### Sub\-sub\-sub\-sub\-section title -[images/remove.gif] Remove +List: -[images/update.gif] Update +- List item 1\. +- List item 2\. - RSS icon (shared across multiple plugins): + Paragraph contained in list item 2\. -[images/rss.png] rss + - Sub\-list item 1\. + - Sub\-list item 2\. +- List item 3\. Force end of list: -Section title +Numbered list with multiple schemes: \[\[1\]\], \[\[a\]\], \[\[A\]\], \[\[i\]\], \[\[I\]\] -* Sub-section title +1. Numbered item 1\. + 1. Numbered item A\. + 1. Numbered item B\. +1. Numbered item 2\. + 1. Numbered item a\. + 1. Numbered item b\. +1. Numbered item 3\. + 1. Numbered item i\. + 1. Numbered item i\. +1. Numbered item 4\. + 1. Numbered item I\. + 1. Numbered item I\. -** Sub-sub-section title +<dl> +<dt>Defined term 1</dt> +<dd>of definition list.</dd> +<dt>Defined term 2</dt> +<dd>of definition list. -*** Sub-sub-sub-section title - -**** Sub-sub-sub-sub-section title - - List: - - * List item 1. - - * List item 2. - - Paragraph contained in list item 2. - - * Sub-list item 1. - - * Sub-list item 2. - - * List item 3. - Force end of list: - - [] - - Numbered list with multiple schemes: [[1]], [[a]], [[A]], [[i]], [[I]] - - [[1]] Numbered item 1. - - [[A]] Numbered item A. - - [[B]] Numbered item B. - - [[2]] Numbered item 2. - - [[a]] Numbered item a. - - [[b]] Numbered item b. +```unknown +Verbatim text + in a box +``` - [[3]] Numbered item 3. +``` +Verbatim text + without box +``` - [[i]] Numbered item i. + - [[i]] Numbered item i. +|header |header |header | +|:---:|:---|---:| +|Centered cell 1,1|Left\-aligned cell 1,2|Right\-aligned cell 1,3| +|cell 2,1|cell 2,2|cell 2,3| +|cell 3,1|cell 3,2|cell 3,3| +|cell 4,1|cell 4,2|cell 4,3| +|cell 5,1|cell 5,2|cell 5,3| +</dd> +</dl> - [[4]] Numbered item 4. +No grid, no caption: - [[I]] Numbered item I. +| | | +|:---:|:---:| +|cell|cell| +|cell|cell| +|cell|cell| +|cell|cell| +|cell|cell| - [[I]] Numbered item I. +|header|header| +|:---:|:---:| +|cell|cell| +|cell|cell| +|cell|cell| +|cell|cell| - [] +Horizontal line: - [Defined term 1] of definition list. +*** - [Defined term 2] of definition list. +Force line +break\. -+-------------------------------+ -Verbatim text - in a box -+-------------------------------+ +Non breaking space\. ---------------------------------- -Verbatim text - without box ---------------------------------- - -[figure] Figure caption - -*----------*--------------+----------------: -| Centered | Left-aligned | Right-aligned | -| cell 1,1 | cell 1,2 | cell 1,3 | -*----------*--------------+----------------: -| cell 2,1 | cell 2,2 | cell 2,3 | -*----------*--------------+----------------: -| cell 3,1 | cell 3,2 | cell 3,3 | -*----------*--------------+----------------: -| cell 4,1 | cell 4,2 | cell 4,3 | -*----------*--------------+----------------: -| cell 5,1 | cell 5,2 | cell 5,3 | -*----------*--------------+----------------: -Table caption - - No grid, no caption: - -*-----*------* - cell | cell -*-----*------* - cell | cell -*-----*------* - cell | cell -*-----*------* - cell | cell -*-----*------* - cell | cell -*-----*------* - -*---------*---------* -|| header || header | -*---------*---------* -| cell | cell | -*---------*---------* -| cell | cell | -*---------*---------* -| cell | cell | -*---------*---------* -| cell | cell | -*---------*---------* - - Horizontal line: - -======================================================================= - - Force line\ - break. - - Non\ breaking\ space.