Merge branch 'main' into lostenderman/update-commonmark

.github/workflows/main.yml

@@ -12,14 +12,27 @@ on:
   pull_request_target:
   workflow_dispatch:
   schedule:
-    - cron: '30 4 * * *'
+    - cron: '30 4 * * MON'
 env:
   DEBIAN_FRONTEND: noninteractive
   DOCKER_DEV_IMAGE: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.draft == true }}
 jobs:
+  spacecheck:
+    name: Style check (Tabs and trailing spaces)
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request_target' || github.event.pull_request.draft == false
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          repository: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name || github.repository }}
+          ref: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
+      - name: Check for tabs and trailing spaces
+        run: grep -n -P '\t|\s+$' markdown.dtx
   shellcheck:
     name: Style check (Bash)
     runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request_target' || github.event.pull_request.draft == false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -33,6 +46,7 @@ jobs:
   luacheck:
     name: Style check (Lua)
     runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request_target' || github.event.pull_request.draft == false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -51,6 +65,7 @@ jobs:
   markdownlint:
     name: Style check (Markdown)
     runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request_target' || github.event.pull_request.draft == false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -74,6 +89,7 @@ jobs:
     runs-on: ubuntu-latest
     container:
       image: python:3.10
+    if: github.event_name != 'pull_request_target' || github.event.pull_request.draft == false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -94,6 +110,7 @@ jobs:
     runs-on: ubuntu-latest
     container:
       image: python:3.10
+    if: github.event_name != 'pull_request_target' || github.event.pull_request.draft == false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -111,6 +128,7 @@ jobs:
   build-docker-image:
     name: Build Docker image
     needs:
+      - spacecheck
       - shellcheck
       - luacheck
       - markdownlint
@@ -120,17 +138,18 @@ jobs:
       matrix:
         texlive:
           - TL2022-historic
+          - TL2023-historic
           - latest
-          - pretest
     outputs:
       TL2022-historic: ${{ steps.temporary-tags.outputs.TL2022-historic }}
+      TL2023-historic: ${{ steps.temporary-tags.outputs.TL2023-historic }}
       latest: ${{ steps.temporary-tags.outputs.latest }}
-      pretest: ${{ steps.temporary-tags.outputs.pretest }}
     runs-on: ubuntu-latest
     permissions:
       packages: write
     env:
       DOCKER_TEXLIVE_TAG: ${{ matrix.texlive }}
+    if: (success() || github.event.pull_request.draft == true) && !cancelled()
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -163,8 +182,8 @@ jobs:
       matrix:
         texlive:
           - TL2022-historic
+          - TL2023-historic
           - latest
-          - pretest
     runs-on: self-hosted
     container:
       image: ghcr.io/witiko/markdown:${{ needs.build-docker-image.outputs[matrix.texlive] }}
@@ -198,8 +217,8 @@ jobs:
       matrix:
         texlive:
           - TL2022-historic
+          - TL2023-historic
           - latest
-          - pretest
     runs-on: ubuntu-latest
     if: github.event_name != 'pull_request_target' && github.ref == 'refs/heads/main'
     env:
@@ -226,8 +245,8 @@ jobs:
       matrix:
         texlive:
           - TL2022-historic
+          - TL2023-historic
           - latest
-          - pretest
     runs-on: ubuntu-latest
     permissions:
       contents: write

CHANGES.md

@@ -1,6 +1,36 @@
 # Changes
 
-## 3.5.0
+## 3.4.3
+
+Fixes:
+
+- Remove trailing paragraph/interblock separators in right-open slice
+  intervals. (#408, #419)
+- Do not misinterpret bracketed e-mails as citations. (#424, #426,
+  sponsored by @istqborg)
+
+Documentation:
+
+- Add slides from the defense of projects MUNI/33/1654/2022 and
+  MUNI/33/1658/2022 to `README.md`. (49f01ccf)
+- Remove `<mroot>` from MathML in the user manual. (#420, #422,
+  contributed by @quark67)
+
+Contributed Software:
+
+- Make the documentation of contributions more detailed. (3f928162)
+
+Docker:
+
+- Add support for TeX Live 2024.
+  (#411, bafbb164, #413, 04957eee, 16000aa4, #425, 9549a5d8, 8f8e1315,
+   844beafc, cf592003)
+
+Continuous Integration:
+
+- Style-check tabs and trailing spaces in `markdown.dtx`. (3aa09c07)
+- Skip style checks in draft PRs to improve development velocity.
+  (c6ea570e)
 
 ## 3.4.2 (2024-03-09)
 
@@ -119,7 +149,7 @@ Fixes:
 - Remove the `options.cacheDir` directory if it is empty after conversion.
   (5cfcea6)
 - Allow tables inside lists. (#368, #371, contributed by @lostenderman,
-  sponsored by ISTQB)
+  sponsored by @istqborg)
 - Check that shell access is unrestricted before attempting shell escape.
   (#365, witiko/lt3luabridge#22, latex3/latex3#1339, #372)
 
@@ -152,16 +182,16 @@ Development:
 Fixes:
 
 - Make the `import` LaTeX option correctly handle recursive imports.
-  (68c7a2f5, danopolan/istqb_latex#87)
+  (68c7a2f5, istqborg/istqb_shared_documents#87)
 - Support attributes on multi-line setext headings.
   (#315, #355, #356, contributed by @lostenderman)
 - Correctly process the combination of Lua options `fancyLists` and
   `startNumber`. (59fb97e8)
 - Properly parse emphasis at line endings in headings.
   (#358, #360, contributed by @lostenderman)
 - Fix fancy lists that use roman numerals as markers.
-  (danopolan/istqb_latex#87, #359, #364,
-   contributed by @lostenderman, sponsored by ISTQB)
+  (istqborg/istqb_shared_documents#87, #359, #364,
+   contributed by @lostenderman, sponsored by @istqborg)
 
 Documentation:
 
@@ -232,7 +262,7 @@ Documentation:
 Fixes:
 
 - Correctly parse paragraphs with trailing spaces.
-  (danopolan/istqb_latex#77, #345, #347)
+  (istqborg/istqb_shared_documents#77, #345, #347)
 
 ## 3.0.0 (2023-08-25)
 

Dockerfile

@@ -23,6 +23,7 @@ ARG DEPENDENCIES="\
     poppler-utils \
     python3-pygments \
     python3-venv \
+    retry \
     ruby \
     unzip \
     wget \
@@ -66,19 +67,19 @@ set -o errexit
 set -o nounset
 set -o xtrace
 
+# Install dependencies
+apt-get -qy update
+apt-get -qy install --no-install-recommends ${DEPENDENCIES}
+
 # Update packages in non-historic TeX Live versions
 if echo ${TEXLIVE_TAG} | grep -q latest
 then
-  tlmgr update --self --all
+  retry -t 30 -d 60 tlmgr update --self --all
 elif echo ${TEXLIVE_TAG} | grep -q pretest
 then
-  tlmgr update --self --all --repository ftp://ftp.cstug.cz/pub/tex/local/tlpretest/
+  retry -t 30 -d 60 tlmgr update --self --all --repository ftp://ftp.cstug.cz/pub/tex/local/tlpretest/
 fi
 
-# Install dependencies
-apt-get -qy update
-apt-get -qy install --no-install-recommends ${DEPENDENCIES}
-
 # Generate the ConTeXt file database
 mtxrun --generate
 
@@ -150,13 +151,25 @@ set -o errexit
 set -o nounset
 set -o xtrace
 
+# Install dependencies, but this time we clean up after ourselves
+apt-get -qy update
+apt-get -qy install --no-install-recommends ${DEPENDENCIES}
+if [ ${DEV_IMAGE} = true ]
+then
+  apt-get -qy install --no-install-recommends ${DEV_DEPENDENCIES}
+fi
+apt-get -qy autoclean
+apt-get -qy clean
+apt-get -qy autoremove --purge
+rm -rfv ${AUXILIARY_FILES}
+
 # Update packages in non-historic TeX Live versions
 if echo ${TEXLIVE_TAG} | grep -q latest
 then
-  tlmgr update --self --all
+  retry -t 30 -d 60 tlmgr update --self --all
 elif echo ${TEXLIVE_TAG} | grep -q pretest
 then
-  tlmgr update --self --all --repository ftp://ftp.cstug.cz/pub/tex/local/tlpretest/
+  retry -t 30 -d 60 tlmgr update --self --all --repository ftp://ftp.cstug.cz/pub/tex/local/tlpretest/
 fi
 
 # Uninstall the distribution Markdown package
@@ -186,18 +199,6 @@ set -o xtrace
 # Make the markdown-cli script executable
 chmod +x ${BINARY_DIR}/markdown-cli
 
-# Install dependencies, but this time we clean up after ourselves
-apt-get -qy update
-apt-get -qy install --no-install-recommends ${DEPENDENCIES}
-if [ ${DEV_IMAGE} = true ]
-then
-  apt-get -qy install --no-install-recommends ${DEV_DEPENDENCIES}
-fi
-apt-get -qy autoclean
-apt-get -qy clean
-apt-get -qy autoremove --purge
-rm -rfv ${AUXILIARY_FILES}
-
 # Generate the ConTeXt file database
 mtxrun --generate
 

README.md

@@ -204,9 +204,10 @@ For further information, consult one of the following:
 6. Talks:
     - [Five Years of Markdown in LaTeX: What, Why, How, and Whereto][pv212-fall2020] (in Czech),
     - [Markdown 2.10.0: LaTeX Themes & Snippets, Two Flavors of Comments, and LuaMetaTeX][tb131-video] ([slides][tb131-slides]),
-    - [A Self-Publisher's Take on Markdown and TeX][tb134-01-video] ([slides][tb134-01-slides]), and
-    - [A Gentle Introduction to Markdown for Writers][tb134-02-video] ([slides][tb134-02-slides], [example][tb134-02-example]), and
-    - [Markdown 3: What's New, What's Next?][tb137-video] ([slides][tb137-slides]).
+    - [A Self-Publisher's Take on Markdown and TeX][tb134-01-video] ([slides][tb134-01-slides]),
+    - [A Gentle Introduction to Markdown for Writers][tb134-02-video] ([slides][tb134-02-slides], [example][tb134-02-example]),
+    - [Markdown 3: What's New, What's Next?][tb137-video] ([slides][tb137-slides]), and
+    - An Implementation of the CommonMark Standard and new Syntax Extensions to the Markdown Package for TeX ([slides][gencur-defense-slides]).
 7. Theses:
     - [Generic TeX Writer for the Pandoc Document Converter][thesis-umhg5]
     - [An implementation of the CommonMark standard into the Markdown package for TeX][thesis-r7z7l]
@@ -248,6 +249,8 @@ For further information, consult one of the following:
 
  [pv212-fall2020]: https://is.muni.cz/elearning/io/?qurl=%2Fel%2Ffi%2Fpodzim2020%2FPV212%2Findex.qwarp;prejit=5595952
 
+ [gencur-defense-slides]: https://docs.google.com/presentation/d/e/2PACX-1vRbgJZ-UJlj5WMOjgWnq0BeNWKdA9ZhFqCKajhCjXtv3OarSKmojl5-X8tDp1ivnKtujuyEDmD2z_Z0/pub "An Implementation of the CommonMark Standard and new Syntax Extensions to the Markdown Package for TeX"
+
  [install]:  https://mirrors.ctan.org/macros/generic/markdown/markdown.html#installation "Markdown Package User Manual"
  [liantze]:  http://liantze.penguinattack.org/                                           "Rants from the Lab"
  [overleaf]: https://www.overleaf.com/                                                   "Overleaf: Real-time Collaborative Writing and Publishing Tools with Integrated PDF Preview"
@@ -271,16 +274,17 @@ Acknowledgements
 | [<img width="150" src="https://www.fi.muni.cz/images/fi-logo.png">][fimu] | I gratefully acknowledge the funding from the [Faculty of Informatics][fimu] at the [Masaryk University][mu] in Brno, Czech Republic, for the development of the Markdown package in projects [MUNI/33/12/2015][], [MUNI/33/1784/2020][], [MUNI/33/0776/2021][], [MUNI/33/1654/2022][], and [MUNI/33/1658/2022][]. |
 | [<img width="150" src="https://cdn.overleaf.com/img/ol-brand/overleaf_og_logo.png">][overleaf] | Extensive user documentation for the Markdown package was kindly written by [Lian Tze Lim][liantze] and published by [Overleaf][]. |
 | [<img width="150" src="https://pbs.twimg.com/profile_images/1004769879319334912/6Bh1UthD.jpg">][omedym] | Support for content slicing (Lua options [`shiftHeadings`][option-shift-headings] and [`slice`][option-slice]) and pipe tables (Lua options [`pipeTables`][option-pipe-tables] and [`tableCaptions`][option-table-captions]) was graciously sponsored by [David Vins][dvins] and [Omedym][]. |
-| [<img width="150" src="https://www.istqb.org/static/istqb-logo-1b043e800a580724ad223567f9ea57c0.png">][istqb] | Fixes for issues [#359][issue-359] and [#368][issue-368] were graciously sponsored by the [International Software Testing Qualifications Board (ISTQB)][istqb]. |
+| [<img width="150" src="https://www.istqb.org/static/istqb-logo-1b043e800a580724ad223567f9ea57c0.png">][istqb] | Fixes for issues [#359][issue-359], [#368][issue-368], and [#424][issue-424] were graciously sponsored by the [International Software Testing Qualifications Board (ISTQB)][istqb]. |
 
  [dvins]:  https://github.com/dvins             "David Vins"
  [fimu]:   https://www.fi.muni.cz/index.html.en "Faculty of Informatics, Masaryk University"
- [ISTQB]:  https://www.istqb.org/               "International Software Testing Qualifications Board"
+ [ISTQB]:  https://github.com/istqborg          "ISTQB.ORG: Official ISTQB® GitHub account"
  [mu]:     https://www.muni.cz/en               "Masaryk University"
  [Omedym]: https://www.omedym.com/              "Omedym"
 
  [issue-359]: https://github.com/witiko/markdown/issues/359 "First item of a fancy list forms a separate list"
  [issue-368]: https://github.com/witiko/markdown/issues/368 "Tables nested in list items have empty lines"
+ [issue-424]: https://github.com/witiko/markdown/issues/424 "E-mail addresses are incorrectly interpreted as bracketed citations"
 
  [option-pipe-tables]:    https://mirrors.ctan.org/macros/generic/markdown/markdown.html#pipe-tables          "Markdown Package User Manual"
  [option-shift-headings]: https://mirrors.ctan.org/macros/generic/markdown/markdown.html#option-shiftheadings "Markdown Package User Manual"

contributions/README.md

@@ -1,11 +1,11 @@
 This directory contains Git submodules with external repositories that have
 been contributed to the Markdown package:
 
-- [37c3-beamer][] from [TeXhackse][]: Unofficial beamer theme for [37c3][]
+- [37c3-beamer][] from [TeXhackse][]: Unofficial beamer theme for [37c3][] that uses the Markdown package for document mark-up in addition to LaTeX
 - [book-templates][] from [xvrabcov][]: Open-source Markdown LaTeX themes for typesetting books and marketing colaterals
 - [doctoral-thesis][] from [witiko][]: A doctoral thesis written using the Markdown package
-- [fithesis][] from [witiko][], [xvrabcov][], and [others][fithesis-ctan]: A document class for typesetting theses at the Masaryk University
-- [istbq_product_base][] from [istqborg][]: Document templates for the International Software Testing Qualifications Board (ISTBQ) syllabi
+- [fithesis][] from [witiko][], [xvrabcov][], and [others][fithesis-ctan]: A document class for typesetting theses at the Masaryk University that includes examples of using the Markdown package in the example documents
+- [istbq_product_base][] from [istqborg][]: Document templates for the International Software Testing Qualifications Board (ISTBQ) that use the Markdown package for document mark-up in addition to LaTeX
 - [MarkX][] from [lostenderman][]: A tool for converting XML examples from CommonMark to test files used in the Markdown package
   - For more information, see also [the bachelor's thesis][thesis-r7z7l] of [lostenderman][].
 - [pandoc-to-markdown][] from [drehak][]: A proof-of-concept that shows how Pandoc can be integrated with the Markdown package
@@ -27,7 +27,7 @@ been contributed to the Markdown package:
 Here are some other repositories that have been contributed to the Markdown
 package but cannot be directly included as Git submodules:
 
-- [LaTeX Markdown Templates][l4070] from [TeXhackse][]: Document templates for German schools using the Markdown package
+- [LaTeX Markdown Templates][l4070] from [TeXhackse][]: Document templates for German schools that use the Markdown package for document mark-up in addition to LaTeX
 
  [l4070]: https://gitlab.com/l4070