This is an automated email from the ASF dual-hosted git repository. kwin pushed a commit to branch feature/rework-references in repository https://gitbox.apache.org/repos/asf/maven-doxia-site.git
commit ddeede90f21a70e1e677e46204bcc707f83db4e3 Author: Konrad Windszus <[email protected]> AuthorDate: Tue Mar 10 12:15:16 2026 +0100 Move deprecated formats to according section Clean up references for markup languages This closes #58 --- content/markdown/modules/index.md | 73 ++++++------------------------------ content/markdown/references/index.md | 58 ++++++++++++---------------- 2 files changed, 35 insertions(+), 96 deletions(-) diff --git a/content/markdown/modules/index.md b/content/markdown/modules/index.md index 67feb61..e9851d3 100644 --- a/content/markdown/modules/index.md +++ b/content/markdown/modules/index.md @@ -27,97 +27,46 @@ date: 2009-06-15 Doxia has several built\-in modules that support some standard markup languages, see the [References](../references/index.html) page for an overview\. The following is just a collection of reference links for the individual formats\. <!-- MACRO{toc|section=1|fromDepth=2|toDepth=2} --> + ## <a id="APT"></a>APT -APT \(Almost Plain Text\) is a simple text format\. +APT \(Almost Plain Text\) is a legacy simple text format. **References**: - [Apt Reference](../references/apt-format.html) -## <a id="Confluence"></a>Confluence - -[Confluence](http://confluence.atlassian.com) is an Enterprise wiki from [Atlassian](http://www.atlassian.com)\. It uses [Textile](http://textism.com/tools/textile/) inside as an APT language\. - -**References**: - -- [Confluence Notation Guide Overview](http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview) -- [Confluence Element Reference](http://confluence.atlassian.com/renderer/notationhelp.action?section=all) -<!-- Textile in Java {{{https://sourceforge.net/projects/jtextile/}JTextile}}.--> -<!-- http://hobix.com/textile/--> -## <a id="Simplified_DocBook"></a>Simplified DocBook - -[DocBook](http://docbook.org/) is a markup language for technical documentation\. [Simplified DocBook](http://www.docbook.org/schemas/simplified) is a simpler subset\. - -**References**: -- [Simplified DocBook Introduction](https://www.docbook.org/schemas/simplified) -- [Simplified DocBook Element Reference](http://www.docbook.org/xml/simple/sdocbook/elements.html) ## <a id="FML"></a>FML -FML \(FAQ Markup Language\) is a FAQ markup language\. +FML \(FAQ Markup Language\) is a legacy FAQ markup language based on XHTML 1.0. **References**: - [FML Reference](../references/fml-format.html) -## <a id="iText"></a>iText - -[iText](http://www.lowagie.com/iText/) is a free Java/PDF library\. - -**References**: -- [iText tutorial](http://itextdocs.lowagie.com/tutorial/) -<!-- * {{{http://www.lowagie.com/iText/tutorial/ch07.html}(out-dated) chapter on XML support}}--> -## <a id="FO"></a>FO - -XSL formatting objects \(XSL\-FO\) - -**References**: - -- [XSL\-FO Recommendation \(05 December 2006\)](https://www.w3.org/TR/xsl11/) -- [XSL FO reference](https://zvon.org/xxl/xslfoReference/Output/index.html) -- [Apache FOP](https://xmlgraphics.apache.org/fop/) -## <a id="LaTeX"></a>LaTeX - -[LaTeX](https://www.latex-project.org/) is a popular document markup language\. - -**References**: - -- [LaTeX2e for authors](https://www.latex-project.org/guides/usrguide.pdf) -- [Latex reference sheet](http://www.stdout.org/~winston/latex/latexsheet.pdf) ## <a id="Markdown"></a>Markdown -[Markdown](http://en.wikipedia.org/wiki/Markdown) is a widespread Markup language\. +[Markdown](http://en.wikipedia.org/wiki/Markdown) is a widespread Markup language. **References**: - [Official Markdown project at Daring Fireball](https://daringfireball.net/projects/markdown/) -## <a id="RTF"></a>RTF - -[RTF](http://www.microsoft.com/downloads/details.aspx?FamilyId=DD422B8D-FF06-4207-B476-6B5396A18A2B&displaylang=en) is a proprietary document file format\. +- [CommonMark specification](https://commonmark.org/) +- [GitHub Flavored Markdown Spec](https://github.github.com/gfm/) -**References**: - -- [Microsoft Office Word 2007 Rich Text Format \(RTF\) Specification](http://www.microsoft.com/downloads/info.aspx?na=46&p=1&SrcDisplayLang=en&SrcCategoryId=&SrcFamilyId=dd422b8d-ff06-4207-b476-6b5396a18a2b&u=http%3a%2f%2fdownload.microsoft.com%2fdownload%2f2%2ff%2f5%2f2f599e18-07ee-4ec5-a1e7-f4e6a9423592%2fWord2007RTFSpec9.doc&oRef=http%3a%2f%2fmsdn2.microsoft.com%2fen-us%2foffice%2faa905482.aspx) -- [RTF Cookbook](http://search.cpan.org/~sburke/RTF-Writer/lib/RTF/Cookbook.pod) -## <a id="TWiki"></a>TWiki - -[TWiki](https://twiki.org/) is a structured wiki\. - -**References**: - -- [ TWiki Text Formatting](https://twiki.org/cgi-bin/view/TWiki04x01/TextFormattingRules) ## <a id="XDoc"></a>XDoc -XDoc is a generic format for document into a styled HTML document\. +XDoc is a legacy format for document into a styled HTML document based on XHTML 1.0. **References**: - [XDoc Reference](../references/xdoc-format.html) + ## <a id="XHTML"></a>XHTML -[XHTML](https://www.w3.org/MarkUp/) is a markup language with the same expressions as HTML, but also conforms to XML syntax\. +[XHTML](https://html.spec.whatwg.org/multipage/xhtml.html) is a markup language with the same expressions as HTML, but also conforms to XML syntax. **References**: -- [HTML and XHTML Quick Reference Charts: Head and Body Markup](http://www.iangraham.org/books/xhtml1/extras/html-7nov2000.pdf) -- [XHTML 1\.0 Specification](https://www.w3.org/TR/xhtml1/) +- [XHTML 5/Living Standard](https://html.spec.whatwg.org/multipage/xhtml.html) +- [Outdated XHTML 1\.0 Specification](https://www.w3.org/TR/xhtml1/) diff --git a/content/markdown/references/index.md b/content/markdown/references/index.md index 66bd955..bce9aae 100644 --- a/content/markdown/references/index.md +++ b/content/markdown/references/index.md @@ -39,50 +39,40 @@ The source directory is the directory under which Maven expects source documents |[Apt](./apt-format.html)|Almost Plain Text|||`apt`|`apt`|[`doxia-module-apt`](../doxia/doxia-modules/doxia-module-apt/)|`apt`| |[AsciiDoc](https://asciidoctor.org/)|[Asciidoctor Converter Doxia Module](https://docs.asciidoctor.org/maven-tools/latest/site-integration/converter-module-setup-and-configuration/)|||`asciidoc`|`adoc`, `asciidoc`|[`asciidoctor-converter-doxia-module`](https://github.com/asciidoctor/asciidoctor-maven-plugin#maven-site-integration)|`asciidoc`| |[AsciiDoc](https://asciidoctor.org/)|[Asciidoctor Parser Doxia Module](https://docs.asciidoctor.org/maven-tools/latest/site-integration/parser-module-setup-and-configuration/)|||`asciidoc`|`adoc`, `asciidoc`|[`asciidoctor-parser-doxia-module`](https://github.com/asciidoctor/asciidoctor-maven-plugin#maven-site-integration)|`asciidoc`| -|[Confluence](../modules/index.html#Confluence)|Confluence Enterprise Wiki||<sup>*</sup>|`confluence`|`confluence`|[`doxia-module-confluence`](../doxia/doxia-modules/doxia-module-confluence/)|`confluence`| -|[Simplified DocBook](../modules/index.html#Simplified_DocBook)|Simplified DocBook XML Standard|||`docbook`|`xml`|[`doxia-module-docbook-simple`](../doxia/doxia-modules/doxia-module-docbook-simple/)|`docbook`| |[FML](./fml-format.html)|FAQ Markup Language|||`fml`|`fml`|[`doxia-module-fml`](../doxia/doxia-modules/doxia-module-fml/)|`fml`| -|[Markdown](../modules/index.html#Markdown)<sup>**</sup>|Markdown markup language||<sup>****</sup>|`markdown`|`md`, `markdown`<sup>***</sup>|[`doxia-module-markdown`](../doxia/doxia-modules/doxia-module-markdown/)|`markdown`| -|[TWiki](../modules/index.html#TWiki)<sup>*</sup>|TWiki Structured Wiki|||`twiki`|`twiki`|[`doxia-module-twiki`](../doxia/doxia-modules/doxia-module-twiki/)|`twiki`| +|[Markdown](../modules/index.html#Markdown)|Markdown markup language|||`markdown`|`md`, `markdown`|[`doxia-module-markdown`](../doxia/doxia-modules/doxia-module-markdown/)|`markdown`| |[Xdoc](./xdoc-format.html)|XML Documentation Format|||`xdoc`|`xml`|[`doxia-module-xdoc`](../doxia/doxia-modules/doxia-module-xdoc/)|`xdoc`| |[XHTML](../modules/index.html#XHTML)|Extensible Hypertext Markup Language|||`xhtml`|`xhtml`|[`doxia-module-xhtml`](../doxia/doxia-modules/doxia-module-xhtml/)|`xhtml`| Note some modules are not included per default with the site plugin. Have a look at the available modules here: [https://repo.maven.apache.org/maven2/org/apache/maven/doxia/](https://repo.maven.apache.org/maven2/org/apache/maven/doxia/). -If you need to add module for the maven site plugin simply add it as a dependency of the plugin +If you need to add module for the `maven-site-plugin` simply add it as a dependency of the plugin: ```unknown - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-site-plugin</artifactId> - <version>3.2</version> - <dependencies> - <dependency> - <groupId>org.apache.maven.doxia</groupId> - <artifactId>doxia-module-markdown</artifactId> - <version>1.3</version> - </dependency> - </dependencies> - </plugin> - +<plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.2</version> + <dependencies> + <dependency> + <groupId>org.apache.maven.doxia</groupId> + <artifactId>doxia-module-markdown</artifactId> + <version>1.3</version> + </dependency> + </dependencies> +</plugin> ``` -<sup>*</sup> Since Doxia 1\.1 +# Doxia Formats \(deprecated\) -<sup>**</sup> Since Doxia 1\.3 +The following table gives an overview of the deprecated formats (which used to be supported mostly as Sink in former versions of Doxia): -<sup>***</sup> Since Doxia 1\.7 - -<sup>****</sup> Since Doxia 1\.12\.0 - -# Doxia Page Output Format \(deprecated\) - -The following table gives an overview of the output-only page-oriented deprecated \(in Doxia 1\.11\) formats: - -|Format|Short description|Doxia Module| +|Format|Short description|Doxia Module|Deprecated Since |---|---|---| -|[iText](../modules/index.html#iText)|iText PDF Library|[`doxia-module-itext`](../doxia/doxia-modules/doxia-module-itext/)| -|[FO](../modules/index.html#FO)<sup>*</sup>|XSL formatting objects \(XSL-FO\)|[`doxia-module-fo`](../doxia/doxia-modules/doxia-module-fo/)| -|[LaTeX](../modules/index.html#LaTeX)|LaTeX typesetting system|[`doxia-module-latex`](../doxia/doxia-modules/doxia-module-latex/)| -|[RTF](../modules/index.html#RTF)|Microsoft Rich Text Format|[`doxia-module-rtf`](../doxia/doxia-modules/doxia-module-rtf/)| - +|iText|iText PDF Library|[`doxia-module-itext`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-itext/)|1.11 +|FO|XSL formatting objects \(XSL-FO\)|[`doxia-module-fo`](../doxia-archives/doxia-1.11.1doxia-modules/doxia-module-fo/)|1.11 +|LaTeX|LaTeX typesetting system|[`doxia-module-latex`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-latex/)|1.11 +|RTF|Microsoft Rich Text Format|[`doxia-module-rtf`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-rtf/)|1.11 +|Confluence|Confluence Enterprise Wiki|[`doxia-module-confluence`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-confluence/)|2.0 +|Simplified DocBook|Simplified DocBook XML Standard|[`doxia-module-docbook-simple`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-docbook-simple/)|2.0 +|TWiki|TWiki Structured Wiki|[`doxia-module-twiki`](../doxia-archives/doxia-1.11.1/doxia-modules/doxia-module-twiki/)|2.0
