Switched from "ins" and "del" span classes to "ins" and "del" XHTML elements.

theory · theory · commit 29f74041daae · 2005-09-06T16:39:32.000Z
diff --git a/Changes b/Changes
@@ -1,6 +1,12 @@
 Revision history for Perl extension Text::Diff::HTML.
 
 0.04
+      - Swiched from <span class="ins"> and <span class="del"> to <ins>
+        and <del> elements. Why didn't I notice those before? Sorry for yet
+        another change in the XHTML, but this is more semantic, and I there-
+        fore don't expect to change it again. Suggested by Lucas Carlson.
+      - Rejiggered sample CSS in "eg/diff.css" for new XHTML elements and
+        shorter background color specs.
 
 0.03  2005-09-05T18:40:29
       - Improved CSS examples in "eg/diff.css" by using more specific
diff --git a/README b/README
@@ -21,8 +21,7 @@ Description
     by "diff()" are wrapped in a "<div>" element, as is each hunk of the
     diff. Within each hunk, all content is properly HTML encoded using
     HTML::Entities, and the various sections of the diff are marked up with
-    "<span>" elements. Each "<div>" and "<span>" element has a class,
-    defined as follows:
+    the appropriate XHTML elements. The elements used are as follows:
 
     * "<div class="file">"
         This element contains the entire contents of the diff "file"
@@ -57,22 +56,22 @@ Description
                 are contents that have *not* changed between the files being
                 "diff"ed.
 
-            * "<span class="ins">"
-                An insertion line, starting with "+".
+            * "<ins>"
+                Inserted content, each line starting with "+".
 
-            * "<span class="del">"
-                A deletion line, starting with "-".
+            * "<del>"
+                Deleted content, each line starting with "-".
 
             * "<span class="hunkfooter">"
                 The footer section of a hunk; contains no contents.
 
         * "<span class="filefooter">"
             The footer section of a file; contains no contents.
 
-    You may do whatever you like with these classes; I highly recommend that
-    you style them using CSS. You'll find an example CSS file in the eg
-    directory in the Text-Diff-HTML distribution. You will also likely want
-    to wrap the output of your diff a "<pre>" element.
+    You may do whatever you like with these elements and classes; I highly
+    recommend that you style them using CSS. You'll find an example CSS file
+    in the eg directory in the Text-Diff-HTML distribution. You will also
+    likely want to wrap the output of your diff a "<pre>" element.
 
 See Also
     Text::Diff
diff --git a/eg/diff.css b/eg/diff.css
@@ -1,6 +1,5 @@
 .file span { display: block; }
-.file .fileheader, .file .hunkheader {color: #888888; }
-.file .hunk .ctx { background: #eeeeee; }
-.file .hunk .ins { background: #ddffdd; }
-.file .hunk .del { background: #ffdddd; }
-
+.file .fileheader, .file .hunkheader {color: #888; }
+.file .hunk .ctx { background: #eee;}
+.file .hunk ins { background: #dfd; text-decoration: none; display: block; }
+.file .hunk del { background: #fdd; text-decoration: none; display: block; }
diff --git a/lib/Text/Diff/HTML.pm b/lib/Text/Diff/HTML.pm
@@ -57,9 +57,9 @@ use constant SEQ_A_IDX => 0;
 use constant SEQ_B_IDX => 1;
 
 my %code_map = (
-    '+' => 'ins',
-    '-' => 'del',
-    ' ' => 'ctx',
+    '+' => [ 'ins'              => 'ins' ],
+    '-' => [ 'del'              => 'del' ],
+    ' ' => [ 'span class="ctx"' => 'span' ]
 );
 
 sub hunk {
@@ -70,25 +70,25 @@ sub hunk {
 
     # Start the span element for the first opcode.
     my $last = $ops->[0][ OPCODE ];
-    my $hunk = qq{<span class="$code_map{ $last }">};
+    my $hunk = qq{<$code_map{ $last }->[0]>};
 
     # Output each line of the hunk.
     while (my $op = shift @$ops) {
         my $opcode = $op->[OPCODE];
-        my $class  = $code_map{ $opcode } or next;
+        my $elem   = $code_map{ $opcode } or next;
 
         # Close the last span and start a new one for a new opcode.
         if ($opcode ne $last) {
+            $hunk .= "</$code_map{ $last }->[1]><$elem->[0]>";
             $last  = $opcode;
-            $hunk .= qq{</span><span class="$class">};
         }
 
         # Output the appropriate line.
         my $idx = $opcode ne '+' ? SEQ_A_IDX : SEQ_B_IDX;
         $hunk  .= encode_entities("$opcode $seqs->[$idx][$op->[$idx]]");
     }
 
-    return $hunk . '</span>';
+    return $hunk . "</$code_map{ $last }->[1]>";
 }
 
 1;
@@ -133,8 +133,8 @@ In the XHTML formatted by this module, the contents of the diff returned by
 C<diff()> are wrapped in a C<< <div> >> element, as is each hunk of the diff.
 Within each hunk, all content is properly HTML encoded using
 L<HTML::Entities|HTML::Entities>, and the various sections of the diff are
-marked up with C<< <span> >> elements. Each C<< <div> >> and C<< <span> >>
-element has a class, defined as follows:
+marked up with the appropriate XHTML elements. The elements used are as
+follows:
 
 =over
 
@@ -174,13 +174,13 @@ This element immediately follows the opening "hunk" C<< <div> >> element.
 Context around the important part of a C<diff> hunk. These are contents that
 have I<not> changed between the files being C<diff>ed.
 
-=item * C<< <span class="ins"> >>
+=item * C<< <ins> >>
 
-An insertion line, starting with C<+>.
+Inserted content, each line starting with C<+>.
 
-=item * C<< <span class="del"> >>
+=item * C<< <del> >>
 
-A deletion line, starting with C<->.
+Deleted content, each line starting with C<->.
 
 =item * C<< <span class="hunkfooter"> >>
 
@@ -196,10 +196,10 @@ The footer section of a file; contains no contents.
 
 =back
 
-You may do whatever you like with these classes; I highly recommend that you
-style them using CSS. You'll find an example CSS file in the F<eg> directory
-in the Text-Diff-HTML distribution. You will also likely want to wrap the
-output of your diff a C<< <pre> >> element.
+You may do whatever you like with these elements and classes; I highly
+recommend that you style them using CSS. You'll find an example CSS file in
+the F<eg> directory in the Text-Diff-HTML distribution. You will also likely
+want to wrap the output of your diff a C<< <pre> >> element.
 
 =head1 See Also
 
diff --git a/t/base.t b/t/base.t
@@ -63,7 +63,7 @@ my @ops = (
 is $html_diff->hunk(\@file_one, \@file_two, \@ops),
     qq{<span class="ctx">  This is the first file. We this line will be changed.\n}
     . qq{  This one will stay &lt;em&gt;the same.&lt;/em&gt;\n}
-    . qq{</span><span class="del">- And so will this one.\n}
-    . qq{</span><span class="ins">+ But only the second file will have this line.\n}
-    . qq{</span>},
+    . qq{</span><del>- And so will this one.\n}
+    . qq{</del><ins>+ But only the second file will have this line.\n}
+    . qq{</ins>},
     'hunk() should give us what we expect.';
