diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/ChangeLog.md | 19 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/README.md | 82 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.pdf | bin | 49807 -> 50857 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.tex | 25 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies-example.lyx | 78 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies.module | 10 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/hereapplies/package.json | 2 |
7 files changed, 169 insertions, 47 deletions
diff --git a/Master/texmf-dist/doc/latex/hereapplies/ChangeLog.md b/Master/texmf-dist/doc/latex/hereapplies/ChangeLog.md index 0835e321b9d..7f1fda1e25d 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/ChangeLog.md +++ b/Master/texmf-dist/doc/latex/hereapplies/ChangeLog.md @@ -2,6 +2,25 @@ Change Log ========== +## 0.4.0 (2022-08-16) + +Changes: + +* The `\whereapplies` macro and its starred counterpart now support page ranges + and a more robust indexing (a partial rewrite of the code and the addition of + the `refcount` dependency were necessary) +* The LyX module has been updated +* Documentation +* Examples + + +## 0.3.1 (2022-08-15) + +Changes: + +* Documentation + + ## 0.3.0 (2022-08-13) Changes: diff --git a/Master/texmf-dist/doc/latex/hereapplies/README.md b/Master/texmf-dist/doc/latex/hereapplies/README.md index 8ffda3cd99b..2ef03857e6f 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/README.md +++ b/Master/texmf-dist/doc/latex/hereapplies/README.md @@ -7,38 +7,43 @@ A LaTeX package for cross-linking concepts to their applications Overview -------- -**Here Applies** is a LaTeX package that implements an _informal glossary_. Its -core mechanism is identical to that of a conventional glossary – i.e. some -concepts are marked as “important” and indicized every time they appear in the -document – but it does not produce any nomenclature section, nor relies on the -conventions that normally take part in a glossary. - -In fact, normally, besides an indicization mechanism, a proper glossary should -be able to produce a dedicated section (usually at the end of the document) +**Here Applies** is a LaTeX package that implements an _informal glossary_ for +cross-linking concepts to their applications. Its core mechanism is identical +to that of a conventional glossary – i.e. some concepts are marked as +“important” and indicized every time they appear in the document – but it does +not produce any nomenclature section, nor relies on the conventions that +normally take part in a glossary. + +Besides an indicization mechanism, in fact, a proper glossary should normally +be able to produce a dedicated section – usually at the end of the document – where the terms are collected in alphabetical order, their definitions are -shown, and the lists of their occurrences are presented. By design, all these -things but the last one are missing in **Here Applies**. +shown, and the lists of their occurrences are presented. All these things but +the last one, by design, are missing in **Here Applies**. Instead, the package offers only two macros: `\hereapplies` and `\whereapplies` (plus their “starred” versions `\hereapplies*` and `\whereapplies*`). In both cases a “concept name” is passed as argument – and this can be any string invented in the moment, as long as it contains only letters. -Every time `\hereapplies` is invoked again on an identical string the document -knows that the same concept from previous invocations is occurring at that -point. And so every time the `\whereapplies` macro is invoked, all the -occurrences of that concept within the entire document will be printed in the -form of a linkable page number list (“pp. 1, 2, 3, 4, …”). +Every time `\hereapplies` is invoked again on an identical string, the document +is made aware that the same concept from previous invocations is occurring at +that point. And so, every time the `\whereapplies` macro is invoked on that +same string, all the occurrences of that concept within the entire document +will be printed in the form of a linkable page number list (e.g. “pp. 1, 5, +8–9, 14–20…”). As `\hereapplies` is designed to be invoked in the middle of a chapter or a -section and make it linkable, the `\phantomsection` macro is invoked by default -before a label is added to that place. To avoid calling `\phantomsection`, -the “starred” macro `\hereapplies*` is available. +section, and that location must be made linkable, the `\phantomsection` macro +is invoked by default before a label is added. To avoid calling +`\phantomsection`, the “starred” macro `\hereapplies*` is available. Finally, like `\whereapplies` resembles a pluralizable version of `\pageref`, its “starred” version `\whereapplies*` resembles a pluralizable version of `\pageref*`. +If you use LyX, the package ships a LyX module as well (please check the +`lyx-module` subdirectory). + Example usage ------------- @@ -53,29 +58,34 @@ The following LaTeX manuscript \begin{document} \title{Some title} + \author{Some author} \maketitle -This is concept one. To find this concept applied, please -see \whereapplies{conceptOne}. - -This is concept two. To find this concept applied, please -see \whereapplies{conceptTwo}. +This is concept one. To find this concept applied, please see +\whereapplies{conceptOne}. -\newpage +This is concept two. To find this concept applied, please see +\whereapplies{conceptTwo}.\newpage \hereapplies{conceptOne}This is page \thepage. As you can see, ``concept one'' applies here.\newpage -\hereapplies{conceptTwo}This is page \thepage. As you can see, -``concept two'' applies here.\newpage +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage \hereapplies{conceptOne}This is page \thepage. As you can see, ``concept one'' applies here.\newpage -\hereapplies{conceptTwo}This is page \thepage. As you can see, -``concept two'' applies here.\newpage +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage + +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage + +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage \hereapplies[myref]{conceptOne}This is page \thepage. As you can see, ``concept one'' applies here. This point in the document is @@ -90,27 +100,31 @@ will generate [this document][1]. A minimal tutorial ------------------ -### Macro `\hereapplies[label]{concept_name}` +### Macro `\hereapplies[Label]{ConceptName}` The `\hereapplies` macro notifies the document that a particular concept -applies to a particular point and creates a label for it. +applies to a particular point and adds a label to it. If the optional argument is passed the label created will be named accordingly, otherwise an opaque name will be assigned to it. This argument may contain only what is legal in both `\label` and `\pageref`. -The `concept_name` argument may contain only letters and the “at” sign (`@`). +The `ConceptName` argument may contain only Latin letters and the “at” sign +(`@`). This string remains confined within the internal scope of the package +and does not create conflicts with possible macros or labels of the same name. The “starred” version of this macro (`\hereapplies*`) does not invoke the `\phantomsection` directive. -### Macro `\whereapplies{concept_name}` +### Macro `\whereapplies{ConceptName}` The `\whereapplies` macro prints all the occurrences of a concept, in the form -“p. …” or “pp. …” +“p. …” or “pp. …” (with page range support). -The `concept_name` argument may contain only letters and the “at” sign (`@`). +The `ConceptName` argument may contain only Latin letters and the “at” sign +(`@`). This string remains confined within the internal scope of the package +and does not create conflicts with possible macros or labels of the same name. The “starred” version of this macro (`\whereapplies*`) will use `\pageref*` instead of `\pageref` for generating the page list. diff --git a/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.pdf b/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.pdf Binary files differindex 7e58c9011e3..a6406da256d 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.pdf +++ b/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.pdf diff --git a/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.tex b/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.tex index 18b2154e10d..ef76ef5ce09 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.tex +++ b/Master/texmf-dist/doc/latex/hereapplies/hereapplies-example.tex @@ -5,29 +5,34 @@ \begin{document} \title{Some title} + \author{Some author} \maketitle -This is concept one. To find this concept applied, please -see \whereapplies{conceptOne}. - -This is concept two. To find this concept applied, please -see \whereapplies{conceptTwo}. +This is concept one. To find this concept applied, please see +\whereapplies{conceptOne}. -\newpage +This is concept two. To find this concept applied, please see +\whereapplies{conceptTwo}.\newpage \hereapplies{conceptOne}This is page \thepage. As you can see, ``concept one'' applies here.\newpage -\hereapplies{conceptTwo}This is page \thepage. As you can see, -``concept two'' applies here.\newpage +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage \hereapplies{conceptOne}This is page \thepage. As you can see, ``concept one'' applies here.\newpage -\hereapplies{conceptTwo}This is page \thepage. As you can see, -``concept two'' applies here.\newpage +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage + +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage + +\hereapplies{conceptTwo}This is page \thepage. As you can see, ``concept +two'' applies here.\newpage \hereapplies[myref]{conceptOne}This is page \thepage. As you can see, ``concept one'' applies here. This point in the document is diff --git a/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies-example.lyx b/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies-example.lyx index 0b9e259dca8..8f77964e197 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies-example.lyx +++ b/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies-example.lyx @@ -297,6 +297,84 @@ concept two status open \begin_layout Plain Layout +conceptTwo +\end_layout + +\end_inset + +This is page +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + + +\backslash +thepage +\end_layout + +\end_inset + +. + As you can see, +\begin_inset Quotes eld +\end_inset + +concept two +\begin_inset Quotes erd +\end_inset + + applies here. +\begin_inset Newpage newpage +\end_inset + + +\end_layout + +\begin_layout Standard +\begin_inset Flex Here applies +status open + +\begin_layout Plain Layout +conceptTwo +\end_layout + +\end_inset + +This is page +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + + +\backslash +thepage +\end_layout + +\end_inset + +. + As you can see, +\begin_inset Quotes eld +\end_inset + +concept two +\begin_inset Quotes erd +\end_inset + + applies here. +\begin_inset Newpage newpage +\end_inset + + +\end_layout + +\begin_layout Standard +\begin_inset Flex Here applies +status open + +\begin_layout Plain Layout \begin_inset Argument 1 status open diff --git a/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies.module b/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies.module index 6d927540ca7..27438dde669 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies.module +++ b/Master/texmf-dist/doc/latex/hereapplies/lyx-module/hereapplies.module @@ -34,6 +34,9 @@ InsetLayout Flex:Here_applies BgColor lightgray Argument 1 Decoration Classic + Font + Color blue + EndFont LabelString "Label" MenuString "Instance label" Tooltip "A string that will become the label of the instance (which can be referenced with \ref, \pageref, etc.)" @@ -64,6 +67,9 @@ InsetLayout Flex:Here_applies* BgColor lightgray Argument 1 Decoration Classic + Font + Color blue + EndFont LabelString "Label" MenuString "Instance label" Tooltip "A string that will become the label of the instance (which can be referenced with \ref, \pageref, etc.)" @@ -81,7 +87,7 @@ InsetLayout Flex:Where_applies EndFont LabelFont Family Serif - Color green + Color purple Size Small EndFont LabelString "Applications of" @@ -104,7 +110,7 @@ InsetLayout Flex:Where_applies* EndFont LabelFont Family Serif - Color green + Color purple Size Small EndFont LabelString "Applications of*" diff --git a/Master/texmf-dist/doc/latex/hereapplies/package.json b/Master/texmf-dist/doc/latex/hereapplies/package.json index b74ebec02cd..74dd5ed4a97 100644 --- a/Master/texmf-dist/doc/latex/hereapplies/package.json +++ b/Master/texmf-dist/doc/latex/hereapplies/package.json @@ -1,6 +1,6 @@ { "name": "hereapplies.sty", - "version": "0.3.0", + "version": "0.4.0", "description": "A LaTeX package for cross-linking concepts to their applications", "homepage": "https://madmurphy.github.io/hereapplies.sty", "author": "madmurphy", |