Changeset 34221 for main

Timestamp:

2020-06-30T00:19:32+12:00 (4 years ago)

Author:

ak19

Message:

Undid the change of converting tabstops to their entities in docprint.pm (which has gone back to removing them now) and moved this conversion into TextPlugin.pm after all. In case this has an unforeseen effect, wanted to break as little as possible. Also, only want pre tags to preserve tabs and other html can be cleaned of this. TextPlugin definitely adds pre tags when converting txt to html, so it makes sense to always preserve tabstops there, whereas it doesn't make sense to assume the same need in all cases where html is produced as they may not contain pre tags.

Location:

main/trunk/greenstone2/perllib

Files:

• docprint.pm (modified) (1 diff)
• plugins/TextPlugin.pm (modified) (1 diff)

main/trunk/greenstone2/perllib/docprint.pm

@@ -103 +103 @@
     # (XML::Parser will barf on anything it doesn't consider to be
     # valid UTF-8 text, including things like \c@, \cC etc.)
-    # Will treat tab chars, \x09, as a special case right after this
-    $all_text =~ s/[\x00-\x08\x0B\x0C\x0E-\x1F]//g;
+    # and the tab character too (x09)
     
-    # $all_text gets written out into an xml context and represents the html version of a doc,
-    # allowing the use of html entities for the tab character (	)
-    # Tabs (ASCII \x09) may be meaningful spacing in such cases whether the html emanated from a
-    # text file, original html or other doc. Particularly when tabs are nested in <pre> tags.
-    # Instead of removing tabs, replacing tabs with their entity reference will allow <pre> tags
-    # to continue preserving any tabs in the final html display.
-    # Hopefully with this, XML::Parser will not choke on tabs, and we get tab stop spaces preserved
-    # in the html output.
-    # This may be the best location to do this replacement and not in TextPlugin, because an html
-    # source doc may contain <pre> elements with tab stops, so then HTMLPlugin would have to do the
-    # replacement too.
-    $all_text =~ s/\x09/&#09;/g;
-    
+    $all_text =~ s/[\x00-\x09\x0B\x0C\x0E-\x1F]//g;
+   
     return $all_text;
 }

main/trunk/greenstone2/perllib/plugins/TextPlugin.pm

@@ -138 +138 @@
     $$textref =~ s/</&lt;/g;
     $$textref =~ s/>/&gt;/g;
+
+ 
+    # $all_text gets written out into an xml context and represents the html version of a doc,
+    # allowing the use of html entities for the tab character (&#09;)
+    # But docprint.pm, which writes the doc_obj into doc.xml, removes tabs for XMLParser reasons
+    # Tabs (ASCII \x09) may be meaningful spacing in text files to preserve whitespace formatting
+    # as we're trying to do by nesting tabs in <pre> tags.
+    # So before docprint.pm removes tabs stops, replacing them here with their entity reference
+    # to allow <pre> tags to continue preserving any tabs in the final html display.
+    $$textref =~ s/\x09/&#09;/g;
+    
     
     # insert preformat tags and add text to document object