lierdakil/pandoc-crossref

Context Support

Open

#33 opened on Sep 20, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Haskell (1,057 stars) (78 forks)batch import
enhancementhelp wanted

Description

How difficult would it be to add Context support to this? The referencing syntax is fairly simple at its most basic:

"The command \in provides the number of a chapter, section, figure, table, etc. The command \at produces a pagenumber and \about produces a complete title."

You can refer simply by using \in[fig:thefigure], which will create a reference link to the number where only the number is a clickable link. If you want the link to include more than just the number you can do \in {figure} [fig:thefigure], which would create a clickable link of "Figure 1".

Contributor guide

Tech stack
None
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
This issue requests adding context support (\in, \at, \about) to pandoc crossref. To implement, one would need to understand the current referencing syntax in the filter, modify the Pandoc AST handling to parse context commands, and generate appropriate cross reference links. The existing codebase in the lierdakil/pandoc crossref repository should be studied, particularly the writer and reader modules. The issue provides example syntax but no specific implementation details. A good starting point is to look at how simple cross references are currently implemented and extend that to support context based references.