From ff8d8136370e14bc1ce11dfa45a6df76cd1c14e1 Mon Sep 17 00:00:00 2001 From: Bastien Dumont Date: Mon, 20 Feb 2023 21:35:57 +0100 Subject: [PATCH] Updated the template for Pandoc and slightly improved the manual --- CHANGELOG.md | 2 +- doc/Makefile | 9 ++++++--- doc/TEMPLATE_crossrefenum.context | 4 ++++ doc/crossrefenum.md | 6 +++++- release-to-CTAN.sh | 1 + 5 files changed, 17 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 472cd67..70ca264 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,5 +8,5 @@ ### 2023/02/20: Version 1.0.2 -Fixed minor problems in version numbers and a typo in the doc. +Fixed some minor issues in version numbers and in the manual. diff --git a/doc/Makefile b/doc/Makefile index 9d124db..31e2bc6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,6 +1,9 @@ -crossrefenum.pdf: crossrefenum.md ../CHANGELOG.md \ - TEMPLATE_crossrefenum.context fixes.lua - pandoc -o crossrefenum.pdf --pdf-engine=context \ +crossrefenum.pdf: crossrefenum-doc.tex + context $< && mv crossrefenum-doc.pdf $@ + +crossrefenum-doc.tex: crossrefenum.md ../CHANGELOG.md \ + TEMPLATE_crossrefenum.context fixes.lua + pandoc -s -o $@ -t context \ --template=TEMPLATE_crossrefenum.context \ -L fixes.lua \ crossrefenum.md ../CHANGELOG.md diff --git a/doc/TEMPLATE_crossrefenum.context b/doc/TEMPLATE_crossrefenum.context index 31d673e..27b15a0 100644 --- a/doc/TEMPLATE_crossrefenum.context +++ b/doc/TEMPLATE_crossrefenum.context @@ -88,6 +88,10 @@ intent=ISO coated v2 300\letterpercent\space (ECI)] \setuplist[subsection][margin=3em, width=3em] \setuplist[subsubsection][margin=6em, width=4em] +$if(highlighting-commands)$ +$highlighting-commands$ +$endif$ + \starttext \starttitlepagemakeup diff --git a/doc/crossrefenum.md b/doc/crossrefenum.md index 8150084..13e5494 100644 --- a/doc/crossrefenum.md +++ b/doc/crossrefenum.md @@ -230,7 +230,9 @@ if this feature were not already included in _crossrefenum_. \crfnm@newListFrom[\crfnm@doubleRefTypes][\crfnm@pageline] -> \crfnm@doubleRefTypes \crfnm@newListFrom[\crfnm@supportedTypes][\crfnm@line] -> \crfnm@supportedTypes \crfnm@newListFrom[\crfnm@supportedTypes][\crfnm@pageline] -> \crfnm@supportedTypes +``` +```{.tex} %% For the double types, set the primary and the secondary type. %% The primary type corresponds to the widest typographic unit %% (“page” for “pagenote”, “section” for “sectionpage”...). @@ -253,7 +255,9 @@ if this feature were not already included in _crossrefenum_. %% Required \def\crfnmLine{l.~} \def\crfnmLines{ll.~} +``` +```{.tex} %% If it differs from the defaults. \def\crfnmCollapsable{yes} \def\crfnmLineBeforeLastInSecond{, } @@ -263,7 +267,7 @@ if this feature were not already included in _crossrefenum_. \def\crfnmLinePrintPrefixInSecond{no} ``` -Adding support to yet unsupported formats is far less trivial, +Adding support for additional formats is far less trivial, not least because most of them do not provide a straightforward way to get reference numbers via purely expandable macros, which is required for _crossrefenum_ to perform its calculations. diff --git a/release-to-CTAN.sh b/release-to-CTAN.sh index ac1eae8..2ba040f 100755 --- a/release-to-CTAN.sh +++ b/release-to-CTAN.sh @@ -20,6 +20,7 @@ check_files cd doc make crossrefenum.pdf +if [[ $? != 0 ]] ; then cd - ; exit 1 ; fi cd - if [[ -a crossrefenum.zip ]] ; then rm crossrefenum.zip ; fi