Aunkrig: /* Change Log */

2024-05-02T17:00:46Z

Change Log

← Older revision		Revision as of 18:00, 2 May 2024
Line 52:		Line 52:

	== Change Log ==		== Change Log ==

			; Version 1.0.3, 2018-10-29:
			:* Added vertical alignment (e.g. "<div align='justify'>").
			:* Made the tests robust against the platform-dependent line separators.
			:* Cleaned up the MAINDOC generation.

	; Version 1.0.2, 2016-11-25:		; Version 1.0.2, 2016-11-25:

Aunkrig: Created page with "A tool to convert HTML documents into plain text. For example this HTML code File:Main.main.jpg is rendered like this: File:usage.txt.jpg For a complete description of the supported HTML inline elements, see [http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_INLINE_ELEMENTS here]. For a complete description of the supported HTML block elements, see [http://html2txt.unkrig.de/javad..."

2024-05-01T18:55:34Z

Created page with "A tool to convert HTML documents into plain text. For example this HTML code File:Main.main.jpg is rendered like this: File:usage.txt.jpg For a complete description of the supported HTML inline elements, see [http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_INLINE_ELEMENTS here]. For a complete description of the supported HTML block elements, see [http://html2txt.unkrig.de/javad..."

New page

A tool to convert HTML documents into plain text.

For example this HTML code

[[File:Main.main.jpg]]

is rendered like this:

[[File:usage.txt.jpg]]

For a complete description of the supported HTML inline elements, see
[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_INLINE_ELEMENTS here].

For a complete description of the supported HTML block elements, see
[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_BLOCK_ELEMENTS here].

== Motivation ==

The goal was to generate the "usage" page that a command line tool usually prints when you invoke it with a "<tt>-help</tt>" or "<tt>--help</tt>" option, rather than maintain it manually (e.g. in the form of "<tt>println()</tt>" statements in the code).

The chosen solution is to put a big DOC comment before the "<tt>main()</tt>" method, generate an HTML page with JAVADOC, convert that into a plain text file, put it into the application's JAR file and copy its contents to STDOUT when the user want to see it.

The command line version of <tt>html2txt</tt> itself uses that technique, and you can see the results above.

== Download ==

You can download the latest version of the runnable JAR file [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=html2txt&v=LATEST&c=jar-with-dependencies here].

== Limitations ==

Since the tool uses the JRE's built-in XML parser, it supports "numeric character references" (like "&#252;" for "Ü"), but not "named HTML character entity references" (like "&Uuml;" for "Ü").

For the same reason, the HTML markup in the DOC comments must be "well-formed", i.e. all start tags must be matched by an end tag (like "<code><li>...</li></code>"), and void tags must end with a slash, like "<code> </code>".

== Usage ==

=== Command line tool ===

see [http://html2txt.unkrig.de/Main.main(String%5b%5d).html here].

=== ANT task ===

see [http://html2txt.unkrig.de/antdoc/index.html here].

=== Library ===

see [http://html2txt.unkrig.de/javadoc/index.html the JAVADOC].

=== Source Code ===

see [https://github.com/aunkrig/html2txt the source code repository].

== Change Log ==

; Version 1.0.2, 2016-11-25:
:* Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".

; Version 1.0.1, 2016-11-07:
:* Resurrected Java 6 compatibility.

== License ==

<code>html2txt</code> is published under the "[[New BSD License]]".

== Contact ==

If you have issues, don't hesitate to [https://sourceforge.net/p/html2txt/tickets/ submit a ticket].

To discuss in public, check the [https://sourceforge.net/p/html2txt/discussion/ forum] and/or subscribe to it (envelope icon).

Html2txt - Revision history

Aunkrig: /* Change Log */