Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lthooks: new \ShowHook command #1250

Closed
wants to merge 175 commits into from

Conversation

jlaurens
Copy link
Contributor

@jlaurens jlaurens commented Jan 23, 2024

READ ME FIRST: Please understand that in most cases we will not be able to merge a pull request because there are a lot of internal activities needed when updating the LaTeX2e sources. If you have a code suggestion please discuss it with the team first.

This PR is on top of PR #1249 and PR #1248, only the 3rd commit is original.

Changes in lthooks.dtx:

  • The actual \@@_log:nN has been pushed for rollback with the 2023-06-01 tag.
  • A new \@@_log:nN is provided.

Changes in lthooks-show.lvt

  • new tests with rule compatibility (output focuses on warning and errors)

Changes in lthooks-show.lgt

  • this is exactly where the difference between old and new output is enlighten, diff helps a lot

Forthcoming work:

  • in tests that are not frozen, replace \ShowHook with a more appropriate\DebugPrintHook, actually in progress and quite complete
  • update the *.lgt (actually many tests fail because of the new \ShowHook output)

This will make this PR complete

Pull requests in this repository are intended for LaTeX Team members only.

Internal housekeeping

Status of pull request

  • Feedback wanted
  • Under development

Checklist of required changes before merge will be approved

  • Test file(s) added
  • Version and date string updated in changed source files
  • Relevant \changes entries in source included
  • Relevant changes.txt updated
  • Rollback provided (if necessary)?
  • ltnewsX.tex (and/or latexchanges.tex) updated

@jlaurens jlaurens force-pushed the lthooks-new-showhook-3 branch 7 times, most recently from 1a8d52a to cfcb30c Compare January 26, 2024 10:12
@jlaurens jlaurens marked this pull request as draft January 26, 2024 11:55
@jlaurens
Copy link
Contributor Author

I still have problems with checks, locally everything runs fine but on the remote, there are errors

@u-fischer
Copy link
Member

I still have problems with checks, locally everything runs fine but on the remote, there are errors

some of the required/firstaid tests fail for me locally too due to the changes of the PR. E.g. with this diff.

***** ..\..\BUILD\TEST-CONFIG-TU\firstaid-bidi.luatex.tlg
    2:  Don't change this file in any respect.
    3:  -> The generic hook 'file/biditools.sty/after':
    4:  > The hook is not declared.
    5:  > The hook is empty.
    6:  <recently read> }
***** ..\..\BUILD\TEST-CONFIG-TU\FIRSTAID-BIDI.LUATEX.LOG
    2:  Don't change this file in any respect.
    3:  ==> Hook: 'file/biditools.sty/after'
    4:  >   builtin generic.
    5:  <recently read> }
*****

@jlaurens jlaurens force-pushed the lthooks-new-showhook-3 branch 2 times, most recently from a4f21a4 to 187b4be Compare January 27, 2024 07:27
@jlaurens
Copy link
Contributor Author

Yes, that part was easy to fix. My problems are with

*** ../../build/test-config-toc/toc-ex-book-hyperref-1.tpf	Sat Jan 27 15:47:58 2024
--- ../../build/test-config-toc/toc-ex-book-hyperref-1.pdftex.pdf	Sat Jan 27 15:48:02 2024
***************
*** 1773,1845 ****
  << /Marked true  >>
  endobj
  319 0 obj
! << /S /GoTo /D (chapter.1) /SD 115 0 R >>
  endobj

@u-fischer
Copy link
Member

toc-ex-book-hyperref-1

I don't see this error in your last github check (and locally it works too). But minipage-005-footnote errors because of the changed hook messages.

@jlaurens
Copy link
Contributor Author

After stronger and cleaner processing (I am still learning), here are rebased commits

  • 1st commit to define before/after \ShowHook output
  • 2nd commit to define \ShowHook. Checks passed locally at the top level.
  • 3rd commit to define \DebugPrintHook because \ShowHook does not fit for testing. Checks passed locally at the top level. Doc builds at the top level

Please notice that base/testfiles-search/tlb-CJK-001.tlg is changed more than expected: there is an added \@forced@seriesfalse on line 6. It might be expected though.

@jlaurens
Copy link
Contributor Author

The top level checks do not pass for me locally, more precisely the config-toc in the required/latex-lab fails. Maybe this is expected.

@jlaurens jlaurens marked this pull request as ready for review January 28, 2024 17:21
@jlaurens jlaurens marked this pull request as draft February 2, 2024 07:23
@josephwright
Copy link
Member

Could you rebase onto develop here - I think things look like they are close to ready for review?

josephwright and others added 26 commits June 6, 2024 13:51
This includes the changes
- Renaming object to template types
- Dropping restricted templates
- Providing template copying
Will need a matching change in the stub xtemplate.

No checks just yet: for a second commit.
Makes the order in ltnews and has a logic to it.
Also tidies up some code/interface confusion.
At present unused in TL, not needed since we do not
include collections.
* exclude tabular* from math grabbing issue latex3/tagging-project#25

* use cmd hook for array in table code, latex3/tagging-project#28

* step version, update changes.txt

* switch to e-type

* update pdfmanagement

* update pdfmanagement

* correct date

* math docu improvements

* load amsmath earlier

* guard tag variables, issue latex3/tagging-project#15

* docu + spaces

* replace para check by tagpdf command

* update tagpdf to 0.98n

* correct typo in testfile

* Correct typo in testfile

* Correct expl3 loading

* update tests to new tagpdf (removed l3ref-tmp)

* allow also tabular to call table code, issue latex3#1174

* correct tests

* remove processor from \(..\), latex3/tagging-project#29

* add math disable/enable command

* usage of \m@th file

* document table key

* move variables from pdfresources

* add more docu about grabbing and fakemath

* spaces

* add fakemath boolean

* typo

* begin with sockets

* clean up split code

* docu

* update test (MC-push)

* add pdfmanagement version 0.96c

* add tagpdf 0.98p

* handle para counter, issue latex3/tagging-project#34

* missing tlg

* update tests (mc uses push/pop)

* missing \end{variable}

* correct test and message for item outside list, latex3/tagging-project#35

* update changes.txt

* update tests

* use para-wrapper

* update tagpdf to 0.98q

* continue with sockets

* move text content to socket

* grumpf

* add Span in toc for nested links, latex3/tagging-issue#26, WIP [ci-skip]

* revert adding span in toc for now

* more sockets

* more move to sockets

* more documentation

* correct guards

* more docu

* rename plugs

* start with display math sockets

* display math sockets

* remove duplicated intertext definition

* correct sign of intertext

* register alignat and alignat*

* correct intertext also in mathtools

* correct docu

* take latex-lab-table.dtx from uf-review-05

* latex-lab-table: move   \@@_show_curr_cell_data: into socket ;
array: put sockets into array ;
array: updated \insert@column to use sockets

* first stab at tabularx (WIP)

* getting there (tabularx)

* fix docu

* switch to Alt instead of Actualtext as the default

* display sockets

* fix so that the code runs when tagging is not used

* leftover \end{macrocode}

* update testfile (special from unused tagmcend is now hidden)

* remove kernel@math@begin

* update test (tagging code hidden in socket)

* use grabbing with \[ always

* clean up code

* add verst version of lttag.dtx

* simplify tabularx

* provide \ProvideDocElement

* change lttag -> lttagging;
us separate \insert@pcolumn with its own sockets

* WIP (broken)

* WIP

* WIP (working again)

* WIP

* medium rewrite/restructure (WIP)

* would have been too easy

* and a doc issue

* and one more

* move multicolumn changed into array;
change begindocument hook chunk to "kernel"

* better also add the socket declaration in the right file

* starting with L3 layer in array (WIP)

* added missing \MaintainedBy defs

* l3doc needs amsmath :-(

* updated \@array in array

* move \ar@ialign into array

* tracing/debugging now optional

* move \@addamp

* move \@Arraycr

* move \endarry ; add \ar@crcr

* move cell data handling to lttaging;
start with longtable (WIP)

* stray macrocode

* use   \tbl_update_multicolumn_cell_data:n

* more work on longtable (WIP)

* update \endlongtable and \LT@t@bularcr (WIP)

* hopefully fixed logic for \endhead and friends;
also fixed \hline issue (guess \cline needs also attention but not tonight)

* trying to get around l3bitset issue

* using newer kernel with l3bitset included

* l3bibset vanished

* sigh

* and a docu fix

* cleanup docu (WIP)

* docu changes (fail table-14-pbox)

* doc updates for "array"

* really update pdfmanagement

* some typos

* renamed a couple of sockets; but more docu

* add preliminary support for fakemath in tabular

* more updates and documentation

* enable math tagging in tabular if table code is loaded

* add alt text on subformulas to satisfy validator

* getting ready for first draft

* update tests

* implemented most of Ulrike's suggestions

* update test

* more suggestions

* cleanup after merge

* tagging support for maketitle in standard classes

* correct variable

* set metadata from title

* switch hook

* add testfiles

* setup test workflow

* sh for updates

* Update tests

* move \@tabular patch into math code

* add pdfauthor

* remove fakemath commands, probably unneeded

* add math/end socket for luamml flags

* add pdfsubtitle key

* some docu/comments in title module

* start to move mml-code, WIP

* keys for AF, WIP

* mumble

* embed mathml-xml-files if they exist

* add mathml support

* repair tagging if subparts are suppressed

* improve texsource stream

* add missing spaces, see issue latex3/tagging-project#57

* add variables for tag names in tables

* happy new year

* correct date, tabletag variable

* update test files to new tag variables.

* correct destination issue latex3/tagging-project#55

* guard code so that it works also without tagging

* update changes.txt

* handle \mathchoice in \text

* update test

* add mathml statistic

* extend table-disable to support also p-columns

* add support for attribute-class in para-main

* write mathml template, WIP

* Update tagpdf to 0.98s

* correct guard

* make \@title and \@author robust

* add support for authors in amsart.cls

* document html format (WIP)

* switch to html reader

* write html template

* correct html template

* correct docu

* correct docu

* add environment to hash

* update testfile2

* more restrictive catcode changes

* option to activate /Alt with mathml-AF

* disable math grabbing in begindocument

* update tagpdf

* missing testfile update

* more testfiles updates

* update testfiles in tools

* update tagpdf and testfiles

* first draft marginpar tagging

* correct docu errors

* correct case with optional argument

* add testfiles

* Update tagpdf to 0.98v

* one more testfiles

* more luatex testfiles.

* fix caption outside float handling

* use three runs

* update test.

* add missing space, latex3/tagging-project#50

* update tagpdfsetup keys in table

* rename tagpdfsetup keys

* update testfile template->dummy

* add changes entry

* update version float

* add marginpar to phase-III

* rename keys, rename layout value to raster

* force display title if UA-standard is used

* update key names, WIP

* Correct source mime type.

* add keys for AF-files

* remove socket redefinition

* use $ in texsource template (for ngpdf/mathjax)

* update math tests after change from begin{math} to $

* change from raster to presentation (as in ARIA)

* docu improvement

* add some ltnews text

* left align description labels

* update dates, correct some missing references

* update changes.txt

* address Davids comments

---------

Co-authored-by: Ulrike Fischer <[email protected]>
Co-authored-by: Frank Mittelbach <[email protected]>
* mainly updating missing closing parentheses but also a few typos noticed along the way.
First set of files up to ltmarks.

* remaining dtx in base

* typo fixes by kb

* few more typo corrections by Chris

* missed one fixed
…ex3#1276)

They are all shipped with l3kernel 2024-02-13. See commits

- latex3/latex3@34338536 (\DocInclude never worked (because in 2e the argument
  was space delimited) ..., 2020-08-21)
- latex3/latex3@8d816cf5 (and another missing space ..., 2020-08-21)
- latex3/latex3@2e1ff83c (Check missing `\endgroup` at the end of `\DocInclude`,
  2024-02-12)
- `lthooks-show-2020-10-01.lvt` is frozen at the 2020-10-01 release,
  no arguments in hooks
- `update-lthooks-tests.sh` includes the above test
- `lthooks-show.sty` is a library of test helpers. They will be used by
  forthcoming tests, as well as completed.
- tests for arguments
- show test file frozen for the 2023-06-01 release
- show test file for the latest release, will be used to change `\ShowHook` in a forthcoming PR
- Update update-lthooks-tests.sh

No date change, no code change
- Output of the `\ShowHook` command is more efficient
- New dedicated "lthooks-show.lvt"
- "*.lgt" are modified accordingly
- Problem: the `\ShowHook` command is no longer suitable for testing
- new function for testing
- new dedicated `lthooks-debug.tlv`
- many `*.tlv` and `*.tlg` updated
- some `update_*_tests.sh` updated
@jlaurens
Copy link
Contributor Author

jlaurens commented Jun 6, 2024

Too complicated to rebase
I will open another pull request

@jlaurens jlaurens closed this Jun 6, 2024
@jlaurens jlaurens deleted the lthooks-new-showhook-3 branch June 7, 2024 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants