Html2txt: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
A tool to convert HTML documents into plain text. | 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 | For a complete description of the supported HTML inline elements, see | ||
| Line 18: | Line 14: | ||
For a complete description of the supported HTML block elements, see | For a complete description of the supported HTML block elements, see | ||
<span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_BLOCK_ELEMENTS here]</span>. | <span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_BLOCK_ELEMENTS here]</span>. | ||
== 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. | |||
[[File:Example.jpg]] | |||
== Download == | |||
You can download the latest and all older versions [http://html2txt.unkrig.de/download/ here]; the change log is available [http://html2txt.unkrig.de/CHANGELOG.txt here]. | |||
== Usage == | |||
Html2txt is written in Java; it is available as a command line tool and as an APACHE ANT task. | |||
== 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). | |||
Revision as of 21:53, 9 May 2015
A tool to convert HTML documents into plain text.
For example this HTML code
is rendered like this:
For a complete description of the supported HTML inline elements, see here.
For a complete description of the supported HTML block elements, see here.
Motivation
The goal was to generate the "usage" page that a command line tool usually prints when you invoke it with a "-help" or "--help" option, rather than maintain it manually (e.g. in the form of "println()" statements in the code).
The chosen solution is to put a big DOC comment before the "main()" 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 html2txt itself uses that technique, and you can see the results above.
Download
You can download the latest and all older versions here; the change log is available here.
Usage
Html2txt is written in Java; it is available as a command line tool and as an APACHE ANT task.
License
html2txt/code> is published under the "New BSD License".
Contact
If you have issues, don't hesitate to submit a ticket.
To discuss in public, check the forum and/or subscribe to it (envelope icon).