Support links in USE manual (#36)#138
Open
cansin wants to merge 1 commit into
Open
Conversation
…l#36) manual/main.md was converted from LaTeX with pandoc and kept pandoc-only syntax that GitHub does not render: figure anchors {#fig:X} and []{label="..."}, cross-references {reference-type="ref" reference="..."}, heading ids {#label}, and image sizing {width="..."}. These appeared as literal text and the figure/section links did not work. This converts main.md to the same GitHub-native style already used by the overview figure and the bibliography: - figures become <a name="fig:X"></a> followed by an italic "*Figure N: caption*" line (number kept from the references); - cross-references become plain [N](#anchor) links; - section headings get a preceding <a name="label"></a> anchor; - inline toolbar icons become <img src="..." width="...">. All 104 internal references now resolve to an anchor and no pandoc artifacts remain. https://claude.ai/code/session_01A85dAvTAvi2oWkGZH6REEq
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #36.
manual/main.mdwas converted from LaTeX with pandoc and kept pandoc-only syntaxthat GitHub does not render, so links to figures (and sections) did not work and
the markup appeared as literal text — visible e.g. in the "Graphical User
Interface" section.
This converts the whole file to the GitHub-native reference style already used by
the overview figure (
<a name="fig-workflow">…) and the bibliography(
<a name="bib-…">…).What changed (manual/main.md)
![cap[]{label="fig:X"}](path){#fig:X}<a name="fig:X"></a>+*Figure N: cap*[N](#fig:X){reference-type="ref" reference="fig:X"}[N](#fig:X)### Title {#label}<a name="label"></a>+### Title{width="3%"}<img src="path" width="3%">Figure numbers are preserved from the existing references.
Verification
A link-checker confirms all 104 intra-document references resolve to an anchor and
no pandoc artifacts remain (
{#…},[]{label=…},{reference-type=…},{width=…}). Onlymain.mdwas affected;developer.md,plugins.mdandtestsuites.mdwere already clean.