"Fossies" - the Fresh Open Source Software Archive

Member "htmlrecode-1.3.1/README.html" (21 Jul 2009, 8732 Bytes) of package /linux/www/old/htmlrecode-1.3.1.tar.gz:

Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the htmlrecode-1.3.1.tar.gz project site itself.

HTML file Character set converter

0. Contents

This is the documentation of htmlrecode-1.3.1.
   1. Purpose
   2. Usage
   3. TODO
   4. Installation
   5. Example
   6. Feedback
   7. Requirements
      7.1. Compilation problems
   8. Changelog
   9. Copying
   10. Downloading

1. Purpose

Recodes the HTML file using a new character set, while losing no characters at all. You can recode shift_jis to euc-jp, utf8 to latin1, iso-8859-15 to GB18030, iso-2022-jp to koi8-r etc if you wish, and none of the characters on the page will become unreadable (unless you specify -l switch, which disables making &#nnnn; escapes).

Standard-correct HTML is a good thing. One of the goals in the development of this program is that it never makes the HTML more broken than it previously was. It should even make it better than it was. So if you see that the program does the opposite, please tell me.

2. Usage

htmlrecode 1.2.0 - Copyright (C) 1992,2003 Bisqwit (http://iki.fi/bisqwit/)

Usage: htmlrecode [<option> [<...>]]

Reads stdin, writes stdout.

    -I, --inset setname   Assumed input character set (default: iso-8859-1)
    -O, --outset setname  Wanted output character set (default: iso-8859-1)
    -V, --version         Displays version information.
    -e, --usehex          Use hexadecimal escapes.
    -g, --signature       Prefix the file with an unicode signature.
    -h, --help            This help.
    -l, --lossy           Disable lossless conversion.
    -q, --quiet           Be less verbose.
    -s, --strict          Turn off support for slightly broken HTML.
    -v, --verbose         Be less quiet.
    -x, --xmlmode         XML mode: all tag param values quoted.

Pipe in the html file and pipe the output to result file.


I'll soon add an interface for modifying the text content of a HTML file.
This should make making filters like Pootpoot or Pikachifier easier. It is already theoretically supported, but I haven't invented an interface for it yet.

4. Installation

$ make
$ su
# make install
If you do not want to install libargh (included in the archive), do not use "make install" and edit Makefile and enable the STATIC linking instead of DYNAMIC.

5. Example

This page template is locally stored in iso-8859-1, but is automatically converted to utf-8 to make the final version.

Here are some latin letters: åäöñé
Here are some CJK (chinese/japanese/korean ideograms): 日本
Here are some html escapes: >"äöê

Source code of the above:

Here are some latin letters: åäöñé<br>
Here are some CJK (chinese/japanese/korean ideograms): &#26085;&#26412;<br>
Here are some html escapes: &gt;&quot;&auml;&ouml;&ecirc;<br>
What your browser is getting, is not &#26085; etc but the actual utf-8 characters.

6. Feedback

If you have problems using this program or ideas how to develop it, email me your questions or ideas.
Please do not omit the details.
My email address (sigh) is: bisqwit at iki dot fi

7. Requirements

htmlrecode has been written in C++, utilizing the standard template library.
GNU make is required.
I have g++ version 3.3, and htmlrecode compiles without warnings. For now.

7.1. Compilation problems

htmlrecode uses widestrings, which is a feature different g++ versions are very inconsistent about. htmlrecode.hh has some settings you can try to choose between. Try this:


 //#define wstring ucs4string
 typedef wchar_t ucs4;
 //typedef unsigned int ucs4;
 //typedef basic_string<ucs4> wstring;
 //#define wstring ucs4string
 //typedef wchar_t ucs4;
 typedef unsigned int ucs4;
 typedef basic_string<ucs4> wstring;

This might help compiling on g++-2.95.

8. Changelog

Since 1.3.0:
  - Compilation fixes on more up-to-date compilers. (Thanks Santiago M. Mola)

Since 1.2.0:
  - Abrubtly terminated multibyte sequences no longer
    cause htmlrecode to enter an infinite loop

Since 1.1.5:
  - Tags are now recognized in all mixed case
  - Tag values can be in '', not only in ""
  - -:_. are recognized to be part of tag value if no "" is there
  - Nonspace are also recognized as above :(   (unless -s option was used)
  - SCRIPT and STYLE contents are "raw" until the next </, unless -s was used
  - SCRIPT/STYLE contents are properly rehidden if necessary
  - " and ' quotes (and no quotes) are used wisely
  - Warnings from some bad HTML
  - Indentations inside tags are now kept mostly intact
  - XHTML support
  - Unicode signature character support
  - Major structural rewrites
  - New "configure" script
 - Big thanks to Winfried Szukalski for
   his thorough testing efforts and comments.

Since 1.1.4:
  - workaround for g++ versions, now compiles with g++-3

Since 1.1.3:
  - optimizations
  - error resistence

Since 1.1.2:
  - hex support
  - g++ string workarounds

Since 1.1.1:
  - improved documentation
  - fixed < (was outputted as &gt;, should be &lt;)

9. Copying

htmlrecode has been written by Joel Yliluoma, a.k.a. Bisqwit,
and is distributed under the terms of the General Public License (GPL).

10. Downloading

The official home page of htmlrecode is at http://iki.fi/bisqwit/source/htmlrecode.html.
Check there for new versions.

Generated from progdesc.php (last updated: Tue, 21 Jul 2009 15:55:58 +0300)
with docmaker.php (last updated: Tue, 21 Jul 2009 15:55:58 +0300)
at Tue, 21 Jul 2009 15:55:58 +0300