Schema: allow @component in more places

Open
#2,706 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
xml
Domain
documentation

Research direction

The issue asks for the @component attribute to be allowed on docinfo/macros, book/subtitle, and idx. The payload does not name the schema file, so find where these elements are declared in the PreTeXt schema and check how @component is already allowed elsewhere. Done means each listed element accepts the attribute and a validation check passes; the three use cases are context for the change, not separate tasks.

Written by the indexing model from the issue text.

Description

Here are some places where @component is sometimes useful.

  • docinfo/macros/@component
    Use case: sometimes a macro needs a different "workaround" definition for a specific output target.

  • book/subtitle/@component
    Use case: full version versus abridged version, with no subtitle on the full version.

  • idx/@component
    Use case: sometimes the index path/hierarchy for an entry is different when versions include/exclude material that contains related idx entries.

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 Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.