Block consistency #2286

brucemiller · 2023-12-20T00:33:11Z

This PR improves the LaTeXML Schema for vertical blocks of material at various levels (block, logical (aka para), sectional) and improves the flexibility of processing. The revised insertBlock captures the material to be inserted in a special _CaptureBlock_ (temporary) element, and then determines an appropriate container element based on the content, context, and attributes to be added. Several other simplifications and cleanup were then enabled.

To make this work, a more consistent set of blocks were needed: we now have

block which contains Block.model and can appear in Block.class
logical-block which contains Para.model and can appear in Para.class
sectional-block which contains sectional material and can appear in sections.
Along with an inline- variant for each, which appears in Misc.class.
NOTE the breaking change that ltx:inline-para has been renamed ltx:inline-logical-block.

Additional changes include cleaning up \normal@par and \lx@newline to behave more generally, and to no-longer need \inner@par.
Moreover, the content model of ltx:td was changed to Inline.model to be more consistent with HTML; when needed inline- block can be used.

Fixes #1705
Fixes #2038
Fixes #2005
Fixes #2037

which are typically (vertical) blocks of block, para orsectional material (according to the level) for layout purposes. * block can contain Block.model allowed in Block.class * logical-block can contain Para.model allowed in Para.class * sectional-block can contain sectional material, allowed in sections Each has an inline- variant which is in Misc.class. NOTE: that inline-para has been renamed inline-logical-block! NOTE: that the content model of table cells (ltx:td) has been changed to Inline.model; if it needs to contain block level material, it needs to be contained in an appropriate inline-xxx element.

…porarily capturing block-like content at various levels to defer determining which level (block,logical,sectional) is needed

…with the new name allowing for automatic opening/closing of nodes

…ate proper inline-blocks

…ode avoiding unnecessary ltx:break; use these more consistently, obsoleting \inner@par, \lx@parboxnewline

…fications

dginev

Took a first introductory read through the PR - I really like the changes! The new naming scheme is very helpful to describe the variations on the block-like theme.

_CaptureBlock_ is really fascinating. I'm going to explore a bit how the tests change for my subfigure refactor branch.

dginev · 2023-12-20T02:27:49Z

lib/LaTeXML/Package/LaTeX.pool.ltxml

-    return; },
-  properties => { isBreak => 1 });
-
+Let('\lx@parboxnewline[]', '\lx@newline');    # Obsolete, but in case still used


probably the [] arg should go away for the Let?

dginev · 2023-12-20T02:52:58Z

t/alignment/halignatt.xml

@@ -4,8 +4,8 @@
 <document xmlns="http://dlmf.nist.gov/LaTeXML">
  <resource src="LaTeXML.css" type="text/css"/>
  <resource src="ltx-article.css" type="text/css"/>
-  <para xml:id="p1">
-    <tabular vattach="bottom">
+  <para vattach="bottom" xml:id="p1">


Hm... vattach on para, which is the top content element of a document? Seems a little fishy.

Well, the test is fishy starting with a vbox.

dginev · 2023-12-20T02:58:48Z

t/structure/figures.xml

@@ -116,7 +114,6 @@ and collectively as <ref labelref="LABEL:fig:D"/>.</p>
        <toccaption><tag close=" ">(b)</tag>This is another figure</toccaption>
        <caption><tag close=" "><text font="bold" fontsize="80%">(b)</text></tag><text font="italic" fontsize="80%">This is another figure</text></caption>
      </figure>
-      <break class="ltx_centering"/>


I am trying to remember if the trailing break was helpful for the flexbox layout to have a clear end... Would need to look at tests, but dropping it is probably fine. The intermediate breaks are the important ones.

In this PR, I've generally been trying to avoid introducing the breaks if I can, particularly in a block situation where things should be vertically stacked anyway.

…g:foreignObject in ltx:_CaptureBlock_

…ng inlne- blocks when needed)

…oreignObject

dginev · 2023-12-21T14:19:05Z

lib/LaTeXML/Core/Document.pm

@@ -1970,7 +1970,7 @@ sub renameNode {
    my $key   = $attr->getName;
    my $value = $node->getAttribute($key);
    $id = $value if $key eq 'xml:id';    # Save to register after removal of old node.
-    $new->setAttribute($key, $value); }
+    $new->setAttribute($key, $value) if $model->canHaveAttribute($newname, $key); }


should we emit an Info message if an attribute gets dropped here? I wonder if it may aid some future debugging session.

hmm, yeah maybe, but probably just a lot of noise?

dginev · 2023-12-21T14:28:38Z

lib/LaTeXML/resources/RelaxNG/LaTeXML-misc.rnc

@@ -111,7 +111,7 @@ grammar {
   common.attrs.aria.implicit.link = empty
   SVG.Core.extra.attrib &= parent svgForeign.attributes
  include "svg11.rnc"
-  { SVG.foreignObject.content = parent Flow.model
+  { SVG.foreignObject.content = parent Inline.model


Thinking out loud: Right, so the idea for switching to Inline.model is to leverage ltx:inline-block (or similar) auto-opening.

I think that would benefit from a schema comment - since the HTML+SVG spec and TeX would both permit pretty much any layout-oriented content in those nodes (e.g. a table, a citation, a math formula, but not a section or a bibliography). I think it would be helpful for the schema to document that, and mention the inline-block mechanism as the intended carrier for the effect.

I guess the alternative was to start as block-level and auto-open nodes that can hold Inline content?

Certain TeX does, which is the issue; HTML sorta does, but when you start getting p in peculiar places, it has undesirable effects that can be papered over with CSS, but it gets complex & error-prone. So it's basically the same rationale for changing td content model to Inline.

In this recent set of changes, I'm finding Flow model kinda annoying for that reason. It probably contributes to the confusion dealing with figure & graphic layout since you're never quite sure what you're getting.

dginev

No further comments, excited to merge and rebase my subfigure work over.

dginev · 2023-12-23T13:50:34Z

I just got a private email inquiring about some details of LaTeXML's schema and I realized I forgot to suggest a post-merge step:

@brucemiller Could you please regenerate the schema docs at the online manual? The current schema page mentions it was last generated December, 2022.

brucemiller added 13 commits December 18, 2023 19:37

Add XSLT for the new (or renamed) block elements

ab7aace

Add support for an internal ltx:_CaptureBlock_ element useful for tem…

d16c52f

…porarily capturing block-like content at various levels to defer determining which level (block,logical,sectional) is needed

Enhance document->renameNode with option to 're-insert' the contents …

bb63cbd

…with the new name allowing for automatic opening/closing of nodes

Replace ltx:inline-para with ltx:inline-logical-block

293c661

Replacement insertBlock based on _CaptureBlock

3f7ca71

\hbox creates inline-block if placed where #PCDATA is allowed

5a6c792

Have p{} column type pass the desired width to \hbox, so that can cre…

3286cfa

…ate proper inline-blocks

Simplify but generalize \normal@par, \lx@newline to recognize block m…

53f9662

…ode avoiding unnecessary ltx:break; use these more consistently, obsoleting \inner@par, \lx@parboxnewline

Fixup CSS styling for various blocks, inline, etc

168e1b6

Enhance tabular test-case for interation between @ and p column speci…

09dbc03

…fications

Enhance framed test-case to show framing of more awkward combinations

6281316

Updated test-cases for changes to block processing

5f7f064

brucemiller requested a review from dginev December 20, 2023 00:33

dginev reviewed Dec 20, 2023

View reviewed changes

brucemiller added 5 commits December 21, 2023 08:23

always allow (internal) attributes that start with _; allow svg:g, sv…

fe7d141

…g:foreignObject in ltx:_CaptureBlock_

Change svg:foreignObject content from Flow.model to Inline.model (usi…

7765da9

…ng inlne- blocks when needed)

In renameNode, only copy allowed attributes

2b0f239

Fix copy mistake

2890273

Careful about insertBlock into svg which may or may not need an svg:f…

545fdca

…oreignObject

dginev reviewed Dec 21, 2023

View reviewed changes

brucemiller changed the title ~~[WiP] Block consistency~~ Block consistency Dec 21, 2023

brucemiller mentioned this pull request Dec 21, 2023

Model and styling for figures found in minipages #1797

Open

dginev approved these changes Dec 21, 2023

View reviewed changes

brucemiller merged commit e3e4845 into master Dec 22, 2023
26 checks passed

brucemiller deleted the block-consistency branch December 22, 2023 00:13

dginev mentioned this pull request Jan 23, 2024

Missing <graphics> for PDF figures under certain conditions #1979

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block consistency #2286

Block consistency #2286

brucemiller commented Dec 20, 2023 •

edited

Loading

dginev left a comment •

edited

Loading

dginev Dec 20, 2023

brucemiller Dec 21, 2023

dginev Dec 20, 2023

brucemiller Dec 21, 2023

dginev Dec 20, 2023

brucemiller Dec 21, 2023

dginev Dec 21, 2023

brucemiller Dec 21, 2023

dginev Dec 21, 2023

brucemiller Dec 21, 2023

dginev left a comment

dginev commented Dec 23, 2023

Block consistency #2286

Block consistency #2286

Conversation

brucemiller commented Dec 20, 2023 • edited Loading

dginev left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dginev left a comment

Choose a reason for hiding this comment

dginev commented Dec 23, 2023

brucemiller commented Dec 20, 2023 •

edited

Loading

dginev left a comment •

edited

Loading