You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kw...@apache.org on 2024/01/19 19:35:29 UTC
(maven-doxia-converter) branch master updated: Update site to reflect supported parameters and name of JAR
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-doxia-converter.git
The following commit(s) were added to refs/heads/master by this push:
new 16a3137 Update site to reflect supported parameters and name of JAR
16a3137 is described below
commit 16a31378bc1ca6cbea166b70eb69f8a027f72e46
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri Jan 19 20:35:23 2024 +0100
Update site to reflect supported parameters and name of JAR
---
pom.xml | 2 +-
src/site/apt/index.apt | 4 +--
src/site/apt/usage.apt.vm | 64 ++++++++++++++++-------------------------------
3 files changed, 25 insertions(+), 45 deletions(-)
diff --git a/pom.xml b/pom.xml
index 480f5d1..0ede3e7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -55,7 +55,7 @@ under the License.
</distributionManagement>
<properties>
- <doxiaVersion>2.0.0-M9</doxiaVersion>
+ <doxiaVersion>2.0.0-M10-SNAPSHOT</doxiaVersion>
<javaVersion>8</javaVersion>
<project.build.outputTimestamp>2023-01-09T21:24:22Z</project.build.outputTimestamp>
</properties>
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index 9c0e43b..1de5291 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -33,9 +33,9 @@ Doxia Converter
Currently, the supported Doxia formats are:
- * input format: <<<apt>>>, <<<confluence>>>, <<<docbook>>>, <<<fml>>>, <<<markdown>>>, <<<twiki>>>, <<<xdoc>>>, <<<xhtml>>>, <<<xhtml5>>> or <<<autodetect>>>
+ * input format: <<<apt>>>, <<<fml>>>, <<<markdown>>>, <<<xdoc>>>, <<<xhtml>>> or <<<autodetect>>>
- * output format: <<<apt>>>, <<<confluence>>>, <<<docbook>>>, <<<fo>>>, <<<itext>>>, <<<latex>>>, <<<markdown>>>, <<<rtf>>>, <<<twiki>>>, <<<xdoc>>>, <<<xhtml>>>, <<<xhtml5>>>
+ * output format: <<<apt>>>, <<<markdown>>>, <<<xdoc>>> or <<<xhtml>>>
[]
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index 981e240..74e666c 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -35,30 +35,31 @@ Usage
* Command Line Help
-------
-# java -jar target/doxia-converter-${project.version}-jar-with-dependencies.jar -h
+# java -jar target/doxia-converter-${project.version}-shaded.jar -h
-usage: doxia-converter [options] -in <arg> [-from <arg>] [-inEncoding <arg>] -out
- <arg> -to <arg> [-outEncoding <arg>]
+usage: doxia-converter [-e] [-f] [-from <arg>] [-h] [-in <arg>] [-inEncoding <arg>] [-out <arg>] [-outEncoding <arg>] [-to
+ <arg>] [-v] [-X]
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.
+ -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 (only works if input is a single file)
+ -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, markdown, twiki, xdoc, xhtml, xhtml5 or autodetect
-to: apt, markdown, confluence, docbook, fo, itext, latex, markdown, rtf, twiki, xdoc, xhtml, xhtml5
+ from: apt, fml, xdoc, xhtml or auto
+ to: apt, xdoc, xhtml, markdown
+
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,
+ 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
-------
@@ -68,15 +69,15 @@ ISO-8859-9, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr
* Command Line Execution
-------
-# java -jar target/doxia-converter-${project.version}-jar-with-dependencies.jar \
+# java -jar target/doxia-converter-${project.version}-shaded.jar \
-in /path/to/xhtml.file \
-from xhtml \
-out /path/to/outputdir \
- -to apt
+ -to markdown
-------
<<Note>>: The <<<from>>> parameter can be empty. In that case, Doxia converter tries to autodetect the <<<from>>>
- input from the <<<in>>> file parameter.
+ input from the <<<in>>> file parameter, this only works when the input is a file (and not a directory).
* Java Usage
@@ -109,7 +110,7 @@ catch ( ConverterException e )
+-----+
<target name="doxia-convert">
<java
- jar="./lib/doxia-converter-${project.version}-jar-with-dependencies.jar"
+ jar="./lib/doxia-converter-${project.version}-shaded.jar"
dir="."
fork="true"
failonerror="true"
@@ -138,29 +139,8 @@ catch ( ConverterException e )
<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>
+-----+