Framed fix (#2161)

* Move framed,framecolor attributes to Backgroundable.attributes (from Positionable.attributes) where they make more sense * Make CSS ltx_framed provide support for framing, but not actual frame * use framed attribute, not class * Make \fbox,\framebox respect non-default \fboxsep; and not collapse framed nodes * framed attribute inhibits collapsing redundant nodes * Update test cases for framed tweaks
brucemiller · Jul 24, 2023 · 24b27a5 · 24b27a5
1 parent 2dde370
commit 24b27a5
Show file tree

Hide file tree

Showing 13 changed files with 282 additions and 276 deletions.
diff --git a/lib/LaTeXML/Core/Document.pm b/lib/LaTeXML/Core/Document.pm
@@ -748,7 +748,6 @@ sub openText {
   return if $font->getFamily eq 'nullfont';
   Debug("openText \"$text\" /" . Stringify($font) . " at " . Stringify($node))
     if $LaTeXML::DEBUG{document};
-
   # Get the desired font attributes, particularly the desired element
   # (usually ltx:text, but let Font override, eg for \emph)
   my $declared_font       = getNodeFont($self, $node);
@@ -1272,7 +1271,8 @@ our %non_mergeable_attributes = map { $_ => 1; }
   qw(about aboutlabelref aboutidref
   resource resourcelabelref resourceidref
   property rel rev tyupeof datatype content
-  data datamimetype dataencoding);
+  data datamimetype dataencoding
+  framed);
 
 # Avoid redundant nesting of font switching elements:
 # If we're closing a node that can take font switches and it contains

diff --git a/lib/LaTeXML/Package/LaTeX.pool.ltxml b/lib/LaTeXML/Package/LaTeX.pool.ltxml
@@ -4695,7 +4695,7 @@ DefMacro('\framebox', '\@ifnextchar(\pic@framebox\@framebox', robust => 1);
 DefConstructor('\@framebox[Dimension][]{}',
   "?#mathframe(<ltx:XMArg enclose='box'>#inner</ltx:XMArg>)"
     . "(<ltx:text ?#width(width='#width') ?#align(align='#align')"
-    . " framed='rectangle' framecolor='#framecolor'"
+    . " framed='rectangle' framecolor='#framecolor' cssstyle='#cssstyle'"
     . " _noautoclose='1'>#3</ltx:text>)",
   alias        => '\framebox', sizer => '#3',
   beforeDigest => sub {
@@ -4704,8 +4704,10 @@ DefConstructor('\@framebox[Dimension][]{}',
     $stomach->beginMode('text');
     AssignValue(FRAME_IN_MATH => $wasmath); },
   properties => sub {
+    my $sep= LookupRegister('\fboxsep')->toAttribute;
     (($_[2] ? (align => $makebox_alignment{ ToString($_[2]) }) : ()),
       framecolor => LookupValue('font')->getColor,
+     ($sep ne '3.0pt' ? (cssstyle   => 'padding:' . $sep):()),
       ($_[1] ? (width => $_[1]) : ())); },
   afterDigest => sub {
     my ($stomach, $whatsit) = @_;
@@ -4724,7 +4726,8 @@ DefConstructor('\@framebox[Dimension][]{}',
     my $model = $document->getModel;
     # and that child can have the framed attribute
     if ((scalar(@c) == 1)
-      && $document->canHaveAttribute($model->getNodeQName($c[0]), 'framed')) {
+      && $document->canHaveAttribute($model->getNodeQName($c[0]), 'framed')
+      && !$c[0]->hasAttribute('framed')) {
       # unwrap, copying the attributes
       $document->unwrapNodes($node);
       foreach my $k (qw(width align framed)) {

diff --git a/lib/LaTeXML/Package/ntheorem.sty.ltxml b/lib/LaTeXML/Package/ntheorem.sty.ltxml
@@ -176,7 +176,7 @@ Let('\renewtheorem', '\newtheorem');
 DefConstructorI('\lx@addframing', undef, sub {
     my ($doc, %props) = @_;
     my $node = $doc->getElement;
-    $doc->addClass($node, 'ltx_framed');
+    $doc->setAttribute($node, framed => 'rectangle');
     my $css = $node->getAttribute('cssstyle');
     my $pad = 'padding:' . $props{margin} . 'pt;';
     $doc->setAttribute($node, cssstyle => ($css ? $css . ';' . $pad : $pad)); },

diff --git a/lib/LaTeXML/Package/titlesec.sty.ltxml b/lib/LaTeXML/Package/titlesec.sty.ltxml
@@ -34,7 +34,7 @@ DefMacro('\lx@titleformat@star {}{}', sub {
       Tokens($format, T_SPACE, T_PARAM, T_OTHER('1'))); });
 our %titlesec_shape_class_map = (
   runin       => 'ltx_runin',
-  frame       => 'ltx_framed',
+  frame       => 'ltx_framed ltx_framed_rectangle',
   rightmargin => 'ltx_align_right',
   leftmargin  => 'ltx_align_left'
 );

diff --git a/lib/LaTeXML/resources/CSS/LaTeXML.css b/lib/LaTeXML/resources/CSS/LaTeXML.css
@@ -347,7 +347,6 @@ span.ltx_rowspan { position:absolute; top:0; bottom:0; }
 .ltx_td,
 .ltx_th      { display:table-cell; }
 
-.ltx_framed  { border:1px solid black;}
 .ltx_tabular .ltx_td,
 .ltx_tabular .ltx_th { padding:0.1em 0.5em; }
 /* regular lines */
@@ -366,6 +365,8 @@ span.ltx_rowspan { position:absolute; top:0; bottom:0; }
 .ltx_border_B  { border-bottom:1px solid gray; }
 .ltx_border_L  { border-left:1px solid gray; }
 /* Framing */
+.ltx_framed    { padding:3pt; }
+span.ltx_framed       { display:inline-block; text-indent:0; } /* avoid padding/margin collapse */
 .ltx_framed_rectangle { border-style:solid; border-width:1px; }
 .ltx_framed_top       { border-top-style:solid; border-top-width:1px; }
 .ltx_framed_left      { border-left-style:solid; border-left-width:1px; }

diff --git a/lib/LaTeXML/resources/RelaxNG/LaTeXML-common.rnc b/lib/LaTeXML/resources/RelaxNG/LaTeXML-common.rnc
@@ -183,7 +183,13 @@ Backgroundable.attributes =
   ## In postprocessing, these values are carried to the \attr{class} attribute,
   ## and can thus be effected by CSS; the background will presumably
   ## correspond to a bounding rectangle, but is determined by the CSS rendering engine.
-  attribute backgroundcolor { text }?
+  attribute backgroundcolor { text }?,
+
+  ## the kind of frame or outline for the box.
+  attribute framed { "rectangle" | "underline" | text }?,
+
+  ## the color of the frame or outlie for the box.
+  attribute framecolor { text }?
 
 ## Attributes shared by low-level, generic inline and block elements
 ## that can be sized or shifted.
@@ -212,13 +218,7 @@ Positionable.attributes =
   attribute vattach { "top" | "middle" | "bottom" | "baseline" }?,
 
   ## the horizontal floating placement parameter that determines where the object is displayed.
-  attribute float { ( "right" | "left" | text) }?,
-
-  ## the kind of frame or outline for the box.
-  attribute framed { "rectangle" | "underline" | text }?,
-
-  ## the color of the frame or outlie for the box.
-  attribute framecolor { text }?
+  attribute float { ( "right" | "left" | text) }?
 
 ## Attributes shared by (hopefully few) elements that can be transformed.
 ## Such elements should also have Positionable.attributes.

diff --git a/lib/LaTeXML/resources/RelaxNG/LaTeXML-common.rng b/lib/LaTeXML/resources/RelaxNG/LaTeXML-common.rng
@@ -241,6 +241,21 @@ and can thus be effected by CSS; the background will presumably
 correspond to a bounding rectangle, but is determined by the CSS rendering engine.</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="framed">
+        <a:documentation>the kind of frame or outline for the box.</a:documentation>
+        <choice>
+          <value>rectangle</value>
+          <value>underline</value>
+          <text/>
+        </choice>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="framecolor">
+        <a:documentation>the color of the frame or outlie for the box.</a:documentation>
+      </attribute>
+    </optional>
   </define>
   <define name="Positionable.attributes">
     <a:documentation>Attributes shared by low-level, generic inline and block elements
@@ -308,21 +323,6 @@ The default is baseline. </a:documentation>
         </choice>
       </attribute>
     </optional>
-    <optional>
-      <attribute name="framed">
-        <a:documentation>the kind of frame or outline for the box.</a:documentation>
-        <choice>
-          <value>rectangle</value>
-          <value>underline</value>
-          <text/>
-        </choice>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="framecolor">
-        <a:documentation>the color of the frame or outlie for the box.</a:documentation>
-      </attribute>
-    </optional>
   </define>
   <define name="Transformable.attributes">
     <a:documentation>Attributes shared by (hopefully few) elements that can be transformed.

diff --git a/lib/LaTeXML/resources/RelaxNG/LaTeXML-inline.rnc b/lib/LaTeXML/resources/RelaxNG/LaTeXML-inline.rnc
@@ -141,7 +141,8 @@ element rule { rule_attributes, rule_model }
 rule_attributes =
   Common.attributes,
   Positionable.attributes,
-  Colorable.attributes
+  Colorable.attributes,
+  Backgroundable.attributes
 
 ## Content model for \elementref{rule}.
 rule_model = empty

diff --git a/lib/LaTeXML/resources/RelaxNG/LaTeXML-inline.rng b/lib/LaTeXML/resources/RelaxNG/LaTeXML-inline.rng
@@ -180,6 +180,7 @@ mixed with arbitrary characters.</a:documentation>
     <ref name="Common.attributes"/>
     <ref name="Positionable.attributes"/>
     <ref name="Colorable.attributes"/>
+    <ref name="Backgroundable.attributes"/>
   </define>
   <define name="rule_model">
     <a:documentation>Content model for \elementref{rule}.</a:documentation>