Validation-plus: warn on WeBWorK together with LaTeX macros containing "@"

Open Beginner friendly
#3,075 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
xml
Domain
tooling

Research direction

Start with pretext-validation-plus.xsl, where the new warning template goes, and look at how existing checks in that file are structured. Read the docinfo/macros handling and the WeBWorK detection the issue describes, and check #1007 for the hazard before writing the guard. Done means a warning appears when WeBWorK exercises and an @ in the macros both exist, and stays silent otherwise.

Written by the indexing model from the issue text.

Description

Carried forward from #1009, which requested this as a Schematron rule; Schematron was retired in #2991, and pretext-validation-plus.xsl is now the home for context-dependent checks.

The check: warn when a project contains WeBWorK exercises and its LaTeX macros (docinfo/macros) contain @, which is mildly dangerous in the WeBWorK handling of macros — see #1007 for the original hazard.

Shape: a warning template in pretext-validation-plus.xsl, guarded on the presence of webwork in the document and @ in the macros content.

Claude Fable 5, acting as a coding assistant for Rob Beezer

Dominant language
XSLT
Stars
466
Forks
251
Avg merge
4m
Merged PRs (30d)
13

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PreTeXtBook/pretext

All issues in PreTeXtBook/pretext

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.