Witiko / markdown

:notebook_with_decorative_cover: A package for converting and rendering markdown documents in TeX
http://ctan.org/pkg/markdown
LaTeX Project Public License v1.3c
326 stars 31 forks source link

Review compatibility of LaTeX dependencies with PDF tagging #466

Open Witiko opened 1 month ago

Witiko commented 1 month ago

During their TUG talk, @u-fischer mentioned a list of LaTeX packages (and classes) that are (in)compatible with the PDF tagging project. We should review the list, compare it with the LaTeX dependencies of the Markdown package (see technical documentation, Section 1.1.3), and see if we can remove or replace any packages that are not listed as "compatible".

In the example markdown documents for the PDF tagging workshops at TUG 2023 and 2024, there is the following code:

\usepackage[tightLists=false,
            fencedCode %%don't load paralist ...
            ]{markdown}

This indicates that the paralist package is a part of the problem.

Witiko commented 1 month ago

In the list, the markdown package is listed as "unknown" and "needs tests". I wonder if we can do anything about that?!

u-fischer commented 1 month ago

I can change that to "partially-compatible" with a comment and add the workshop file as a first test file. But as there are lots of options it really needs more tests and examples. (And you can write "in her TUG talk ...", it is not a secret that I'm a woman.)

Witiko commented 1 month ago

But as there are lots of options it really needs more tests and examples.

Most options enable syntax extensions. These produce renderer commands that are handed over to various LaTeX packages unless the commands are redefined by users to do something else. All dependencies are listed in Section 1.1 of the technical documentation. The default renderer commands are defined in Section 3.3.4 of the same document. Most incompatibilities should be visible at a glance and due to our use of an outdated LaTeX package. We do little low-level TeX stuff or patching on our own.

I am happy to write tests and examples. As I understand it, this was one of the topics of this year's LaTeX developers' workshop. Sadly, I could not attend it but I am happy to go through the materials on my own.

And you can write "in her TUG talk ...", it is not a secret that I'm a woman.

I am sorry. I have been using the singular they for possessives in my technical writing for the past ~15 years, long before it was the politically correct thing to do. I realize that it may feel somewhat impersonal as technical writing often does.