You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by hb...@apache.org on 2023/01/08 18:20:56 UTC
svn commit: r1906467 [21/27] - in /maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/ apidocs/org/apache/maven/doxia/ apidocs/org/apache/maven/doxia/class-u...
Added: maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/usage.html
==============================================================================
--- maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/usage.html (added)
+++ maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/usage.html Sun Jan 8 18:20:54 2023
@@ -0,0 +1,248 @@
+<!DOCTYPE html>
+
+
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/apt/usage.apt.vm at 2023-01-08
+ | Rendered using Apache Maven Fluido Skin 1.11.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+ <meta name="author" content="Vincent Siveton" />
+ <meta name="date" content="2010-07-28" />
+ <title>Doxia Tools :: Converter – Usage</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script src="./js/apache-maven-fluido-1.11.1.min.js"></script>
+
+ <!-- Matomo -->
+ <script>
+ var _paq = window._paq = window._paq || [];
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+
+ (function() {
+ var u="https://analytics.apache.org/";
+ _paq.push(['setTrackerUrl', u+'/matomo.php']);
+ _paq.push(['setSiteId', '3']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+ </script>
+ <!-- End Matomo Code -->
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../../images/apache-maven-project.png" alt="Doxia Tools :: Converter" style="" /></a></div>
+ <div class="pull-right"><a href="../../" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia" style="" /></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
+ <li class=""><a href="../../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
+ <li class=""><a href="../../index.html" title="Doxia">Doxia</a><span class="divider">/</span></li>
+ <li class=""><a href="../index.html" title="Doxia Tools">Doxia Tools</a><span class="divider">/</span></li>
+ <li class=""><a href="index.html" title="Doxia Tools :: Converter">Doxia Tools :: Converter</a><span class="divider">/</span></li>
+ <li class="active ">Usage <a href="https://github.com/apache/maven-doxia-converter/tree/HEAD/src/site/apt/usage.apt.vm"><img src="./images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-01-08</li>
+ <li id="projectVersion" class="pull-right">Version: 1.3-SNAPSHOT</li>
+ </ul>
+ </div>
+ </header>
+ <div class="row-fluid">
+ <header id="leftColumn" class="span2">
+ <nav class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li class="active"><a><span class="none"></span>Usage</a></li>
+ <li><a href="http://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li>
+ <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+ <li class="nav-header">Maven Projects</li>
+ <li><a href="../../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li>
+ <li><a href="../../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li>
+ <li><a href="../../index.html" title="Doxia"><span class="none"></span>Doxia</a></li>
+ <li><a href="../../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li>
+ <li><a href="../../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li>
+ <li><a href="../../../ref/current" title="Maven"><span class="none"></span>Maven</a></li>
+ <li><a href="../../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li>
+ <li><a href="../../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li>
+ <li><a href="../../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li>
+ <li><a href="../../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li>
+ <li><a href="../../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li>
+ <li><a href="../../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li>
+ <li><a href="../../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li>
+ <li><a href="../../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li>
+ <li><a href="../../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li>
+ <li><a href="../../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li>
+ <li class="nav-header">ASF</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li>
+ <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li>
+ <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li>
+ </ul>
+ </nav>
+ <div class="well sidebar-nav">
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </header>
+ <main id="bodyColumn" class="span10" >
+<section>
+<h2><a name="Usage"></a>Usage</h2>
+<p>The following examples describe the basic usage of the Doxia Converter.</p>
+<ul>
+<li><a href="#Command_Line_Help">Command Line Help</a></li>
+<li><a href="#Command_Line_Execution">Command Line Execution</a></li>
+<li><a href="#Java_Usage">Java Usage</a></li>
+<li><a href="#Ant_Usage">Ant Usage</a></li></ul><section>
+<h3><a name="Command_Line_Help"></a>Command Line Help</h3>
+<div class="source"><pre class="prettyprint linenums"># java -jar target/doxia-converter-1.3-SNAPSHOT-jar-with-dependencies.jar -h
+
+usage: doxia-converter [options] -in <arg> [-from <arg>] [-inEncoding <arg>] -out
+ <arg> -to <arg> [-outEncoding <arg>]
+
+Options:
+-e,--errors Produce execution error messages.
+-f,--format Format the output (actually only xml based outputs) to be human readable.
+-from <arg> From format. If not specified, try to autodetect it.
+-h,--help Display help information.
+-in,--input <arg> Input file or directory.
+-inEncoding <arg> Input file encoding. If not specified, try to autodetect it.
+-out,--output <arg> Output file or directory.
+-outEncoding <arg> Output file encoding. If not specified, use the input encoding (or autodetected).
+-to <arg> To format.
+-v,--version Display version information.
+-X,--debug Produce execution debug output.
+
+Supported Formats:
+from: apt, confluence, docbook, fml, twiki, xdoc, xhtml, xhtml5 or autodetect
+to: apt, confluence, docbook, fo, itext, latex, rtf, twiki, xdoc, xhtml, xhtml5
+
+Supported Encoding:
+UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, Shift_JIS, ISO-2022-JP, ISO-2022-CN, ISO-2022-KR, GB18030, EUC-JP, EUC-KR, Big5,
+ISO-8859-1, ISO-8859-2, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8-I, ISO-8859-8, windows-1251, windows-1256, KOI8-R,
+ISO-8859-9, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr</pre></div>
+<p><b>Note</b>: The input parameters (i.e. encoding and format) can be autodetected.</p></section><section>
+<h3><a name="Command_Line_Execution"></a>Command Line Execution</h3>
+<div class="source"><pre class="prettyprint linenums"># java -jar target/doxia-converter-1.3-SNAPSHOT-jar-with-dependencies.jar \
+ -in /path/to/xhtml.file \
+ -from xhtml \
+ -out /path/to/outputdir \
+ -to apt</pre></div>
+<p><b>Note</b>: The <code>from</code> parameter can be empty. In that case, Doxia converter tries to autodetect the <code>from</code> input from the <code>in</code> file parameter.</p></section><section>
+<h3><a name="Java_Usage"></a>Java Usage</h3>
+<div class="source"><pre class="prettyprint linenums">String in = "...";
+String from = "...";
+String out = "...";
+String to = "...";
+
+Converter converter = new DefaultConverter();
+try
+{
+ InputFileWrapper input = InputFileWrapper.valueOf( in, from, "ISO-8859-1", converter.getInputFormats() );
+ OutputFileWrapper output = OutputFileWrapper.valueOf( out, to, "UTF-8", converter.getOutputFormats() );
+
+ converter.convert( input, output );
+}
+catch ( UnsupportedFormatException e )
+{
+ e.printStackTrace();
+}
+catch ( ConverterException e )
+{
+ e.printStackTrace();
+}</pre></div></section><section>
+<h3><a name="Ant_Usage"></a>Ant Usage</h3>
+<div class="source"><pre class="prettyprint linenums"> <target name="doxia-convert">
+ <java
+ jar="./lib/doxia-converter-1.3-SNAPSHOT-jar-with-dependencies.jar"
+ dir="."
+ fork="true"
+ failonerror="true"
+ >
+
+ <arg value="-in"/>
+ <arg value="${tdi.apt}"/>
+
+ <arg value="-out"/>
+ <arg value="./doc/${tdi.apt}.${doxia.out.extension}"/>
+
+ <arg value="-to"/>
+ <arg value="${doxia.out.format}"/>
+
+
+ <arg value="-from"/>
+ <arg value="apt"/>
+
+ <arg value="-f"/>
+ </java>
+ </target>
+
+ <target name="doc.xhtml">
+ <antcall target="doxia-convert">
+ <param name = "doxia.out.format" value = "xhtml"/>
+ <param name = "doxia.out.extension" value = "html"/>
+ </antcall>
+ </target>
+ <target name="doc.docbook">
+ <antcall target="doxia-convert">
+ <param name = "doxia.out.format" value = "docbook"/>
+ <param name = "doxia.out.extension" value = "xml"/>
+ </antcall>
+ </target>
+ <target name="doc.rtf">
+ <antcall target="doxia-convert">
+ <param name = "doxia.out.format" value = "rtf"/>
+ <param name = "doxia.out.extension" value = "rtf"/>
+ </antcall>
+ </target>
+ <target name="doc.latex">
+ <antcall target="doxia-convert">
+ <param name = "doxia.out.format" value = "latex"/>
+ <param name = "doxia.out.extension" value = "tex"/>
+ </antcall>
+ </target>
+
+ <target name="doc">
+ <antcall target="doc.xhtml" />
+ <antcall target="doc.docbook" />
+ <antcall target="doc.rtf" />
+ <antcall target="doc.latex" />
+ </target></pre></div></section></section>
+ </main>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>© 2005–2023
+<a href="https://www.apache.org/">The Apache Software Foundation</a>
+</p>
+ </div>
+ </div>
+ </footer>
+<script>
+ if(anchors) {
+ anchors.add();
+ }
+</script>
+ </body>
+</html>
\ No newline at end of file
Added: maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/xref-test/allclasses-frame.html
==============================================================================
--- maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/xref-test/allclasses-frame.html (added)
+++ maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/xref-test/allclasses-frame.html Sun Jan 8 18:20:54 2023
@@ -0,0 +1,18 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <!-- generated by Apache Maven JXR (jdk8) -->
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>All Classes</title>
+ <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
+ </head>
+ <body>
+ <h1 class="bar">All Classes</h1>
+ <div class="indexContainer">
+ <ul>
+ <li><a href="org/apache/maven/doxia/ConverterTest.html#ConverterTest" target="classFrame">ConverterTest</a></li>
+ </ul>
+ </div>
+ </body>
+</html>
\ No newline at end of file
Added: maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/xref-test/index.html
==============================================================================
--- maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/xref-test/index.html (added)
+++ maven/doxia/website/components/doxia-tools-archives/doxia-converter-LATEST/xref-test/index.html Sun Jan 8 18:20:54 2023
@@ -0,0 +1,75 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<html xml:lang="en" lang="en">
+ <!-- this is a JXR report set (jdk8) -->
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>Doxia Tools :: Converter 1.3-SNAPSHOT Reference</title>
+ <script type="text/javascript">
+ tmpTargetPage = "" + window.location.search;
+ if (tmpTargetPage != "" && tmpTargetPage != "undefined")
+ tmpTargetPage = tmpTargetPage.substring(1);
+ if (tmpTargetPage.indexOf(":") != -1 || (tmpTargetPage != "" && !validURL(tmpTargetPage)))
+ tmpTargetPage = "undefined";
+ targetPage = tmpTargetPage;
+ function validURL(url) {
+ try {
+ url = decodeURIComponent(url);
+ }
+ catch (error) {
+ return false;
+ }
+ var pos = url.indexOf(".html");
+ if (pos == -1 || pos != url.length - 5)
+ return false;
+ var allowNumber = false;
+ var allowSep = false;
+ var seenDot = false;
+ for (var i = 0; i < url.length - 5; i++) {
+ var ch = url.charAt(i);
+ if ('a' <= ch && ch <= 'z' ||
+ 'A' <= ch && ch <= 'Z' ||
+ ch == '$' ||
+ ch == '_' ||
+ ch.charCodeAt(0) > 127) {
+ allowNumber = true;
+ allowSep = true;
+ } else if ('0' <= ch && ch <= '9'
+ || ch == '-') {
+ if (!allowNumber)
+ return false;
+ } else if (ch == '/' || ch == '.') {
+ if (!allowSep)
+ return false;
+ allowNumber = false;
+ allowSep = false;
+ if (ch == '.')
+ seenDot = true;
+ if (ch == '/' && seenDot)
+ return false;
+ } else {
+ return false;
+ }
+ }
+ return true;
+ }
+ function loadFrames() {
+ if (targetPage != "" && targetPage != "undefined")
+ top.classFrame.location = top.targetPage;
+ }
+ </script>
+ </head>
+ <frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()">
+ <frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()">
+ <frame src="overview-frame.html" name="packageListFrame" title="All Packages"/>
+ <frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"/>
+ </frameset>
+ <frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"/>
+ <noframes>
+ <h1>Frame Alert</h1>
+ <p>
+ You don't have frames. Go <a href="overview-summary.html">here</a>
+ </p>
+ </noframes>
+ </frameset>
+</html>
\ No newline at end of file