W3C home > Mailing lists > Public > html-tidy@w3.org > October to December 2001

RE: [PATCH] workaround of entities processing for non-english lan guages

From: Reitzel, Charlie <CReitzel@arrakisplanet.com>
Date: Fri, 23 Nov 2001 14:15:08 -0500
Message-ID: <B5C79DDBC655D311B6BD0008C7E64D76013C1996@exchange.arrakisplanet.com>
To: "'Alexey Zelkin'" <phantom@FreeBSD.org>, html-tidy@w3.org
Hi Alexey,

Thanks very much for the patch.  The usual answer to the entity problem is
that Tidy is doing the right thing because these entities are not supported
on some widely used browsers (NS 4.x).  But this is not the first time this
issue has come up, so I'm fairly certain others will find your patch useful.
Still, I'd like to get a better understanding of the proposed change.

Can you send the config file you use this option with?  My understanding,
perhaps wrong, is that entities are converted to ASCII only with the -clean
option.  Question: would the -preserve option ever be needed without the
-clean option?

take it easy,
Charlie


-----Original Message-----
From: Alexey Zelkin [mailto:phantom@FreeBSD.org]
Sent: Wednesday, November 21, 2001 2:50 PM
To: html-tidy@w3.org
Subject: [PATCH] workaround of entities processing for non-english
languages


hi,

I am person involved into The FreeBSD Documentation Project. This project
utilizes tidy very much and we ran into problems with processing of html
documents for translation teams. When tidy processes files which
contains entities like &copy; it converts it to its ASCII representation.

I have wrote a patch which is allowing us to leave such entities untouched.
It would be nice to have it integrated into main distribution of tidy.

This patch has been tested against Russian, Chezch and Japanese languages
and appears to do expected things.

diff -u work/tidy4aug00/config.c tidy4aug00.patched/config.c
--- work/tidy4aug00/config.c	Fri Aug  4 19:21:05 2000
+++ tidy4aug00.patched/config.c	Thu Nov 15 21:55:25 2001
@@ -94,6 +94,7 @@
 Bool TidyMark = yes;        /* add meta element indicating tidied doc */
 Bool Emacs = no;            /* if true format error output for GNU Emacs */
 Bool LiteralAttribs = no;   /* if true attributes may use newlines */
+Bool PreserveEntities = no; /* if true don't convert entities to chars */
 
 typedef struct _lex PLex;
 
@@ -186,6 +187,7 @@
     {"doctype",         {(int *)&doctype_str},      ParseDocType},
     {"fix-backslash",   {(int *)&FixBackslash},     ParseBool},
     {"gnu-emacs",       {(int *)&Emacs},            ParseBool},
+    {"preserve-entities", {(int *)&PreserveEntities}, ParseBool},
 
   /* this must be the final entry */
     {0,          0,             0}
@@ -533,6 +535,12 @@
     {
         QuoteAmpersand = yes;
         HideEndTags = no;
+    }
+
+ /* Avoid &amp;copy; in preserve-entities case */
+    if (PreserveEntities)
+    {
+       QuoteAmpersand = no;
     }
 }
 
diff -u work/tidy4aug00/html.h tidy4aug00.patched/html.h
--- work/tidy4aug00/html.h	Fri Aug  4 19:21:05 2000
+++ tidy4aug00.patched/html.h	Thu Nov 15 21:55:26 2001
@@ -758,6 +758,7 @@
 extern Bool Word2000;
 extern Bool Emacs;  /* sasdjb 01May00 GNU Emacs error output format */
 extern Bool LiteralAttribs;
+extern Bool PreserveEntities;
 
 /* Parser methods for tags */
 
diff -u work/tidy4aug00/lexer.c tidy4aug00.patched/lexer.c
--- work/tidy4aug00/lexer.c	Fri Aug  4 19:21:05 2000
+++ tidy4aug00.patched/lexer.c	Thu Nov 15 21:55:26 2001
@@ -1517,8 +1517,10 @@
 
                     continue;
                 }
-                else if (c == '&' && mode != IgnoreMarkup)
-                    ParseEntity(lexer, mode);
+                else if (c == '&' && mode != IgnoreMarkup
+				&& !PreserveEntities) {
+               		ParseEntity(lexer, mode);
+		}
 
                 /* this is needed to avoid trimming trailing whitespace */
                 if (mode == IgnoreWhitespace)
@@ -2624,7 +2626,7 @@
                 seen_gt = yes;
         }
 
-        if (c == '&')
+        if (c == '&')	/* XXX: possibly need support for PreserveEntities
*/
         {
             AddCharToLexer(lexer, c);
             ParseEntity(lexer, null);
diff -u work/tidy4aug00/localize.c tidy4aug00.patched/localize.c
--- work/tidy4aug00/localize.c	Fri Aug  4 19:21:05 2000
+++ tidy4aug00.patched/localize.c	Thu Nov 15 21:55:26 2001
@@ -736,6 +736,7 @@
     tidy_out(out, "  -xml            use this when input is wellformed
xml\n");
     tidy_out(out, "  -asxml          to convert html to wellformed xml\n");
     tidy_out(out, "  -slides         to burst into slides on h2
elements\n");
+    tidy_out(out, "  -preserve       to preserve entities as is in source
file\n");
     tidy_out(out, "\n");
 
     tidy_out(out, "Character encodings\n");
diff -u work/tidy4aug00/man_page.txt tidy4aug00.patched/man_page.txt
--- work/tidy4aug00/man_page.txt	Fri Aug  4 19:21:05 2000
+++ tidy4aug00.patched/man_page.txt	Thu Nov 15 21:55:26 2001
@@ -12,6 +12,7 @@
 .IR column ]
 .RB [ -upper ]
 .RB [ -clean ]
+.RB [ -preserve ]
 .RB [ -raw
 |
 .B -ascii
@@ -106,6 +107,9 @@
 .TP
 .B -slides
 Burst into slides on <H2> elements.
+.TP
+.B -preserve
+Preserve source file entities as is.
 .TP
 .BR -help ", " -h
 List command-line options.
diff -u work/tidy4aug00/tidy.c tidy4aug00.patched/tidy.c
--- work/tidy4aug00/tidy.c	Fri Aug  4 19:21:05 2000
+++ tidy4aug00.patched/tidy.c	Thu Nov 15 21:55:26 2001
@@ -785,6 +785,8 @@
                 Quiet = yes;
             else if (strcmp(arg, "slides") == 0)
                 BurstSlides = yes;
+            else if (strcmp(arg, "preserve") == 0)
+                PreserveEntities = yes;
             else if (strcmp(arg, "help") == 0 ||
                      argv[1][1] == '?'|| argv[1][1] == 'h')
             {
Received on Friday, 23 November 2001 14:14:31 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 3 April 2012 06:13:47 GMT