leanprover / leanprover/verso

Generalize Part HTML rendering

Open
#561 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Lean
Stars
384
Forks
124
Avg merge
22h 28m
Merged PRs (30d)
10

Description

Currently, Verso parts are rendered to HTML inside a bare <section> tag. In writing https://github.com/leanprover/reference-manual/pull/599, it would have been useful, as a verso document author, to be able to attach a class="no-vale" attribute to that tag.

It might also be useful for other reasons to generally influence the attributes of this tag, or maybe even to inject other content before or after it. This issue proposes deciding on what extensibility is appropriate, and adding it to part HTML rendering, and/or other output formats as appropriate.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with src/verso/Verso/Doc/Html.lean around line 189, where parts are rendered inside a section tag. Read the surrounding HTML rendering code and determine which extensibility options are appropriate, including section attributes or content injection. Done means the chosen scope is specified and implemented for part HTML rendering, with any applicable other output formats addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.