summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hereapplies/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/hereapplies/README.md')
-rw-r--r--macros/latex/contrib/hereapplies/README.md37
1 files changed, 16 insertions, 21 deletions
diff --git a/macros/latex/contrib/hereapplies/README.md b/macros/latex/contrib/hereapplies/README.md
index 380a1fbdf1..6767f52376 100644
--- a/macros/latex/contrib/hereapplies/README.md
+++ b/macros/latex/contrib/hereapplies/README.md
@@ -81,7 +81,7 @@ labeled \texttt{myref}.
\end{document}
```
-will generate [this document][1].
+will generate the [`hereapplies-example.pdf`][1] document attached.
A minimal tutorial
@@ -93,8 +93,8 @@ The `\hereapplies` command notifies the document that one or more identifiers
apply 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 chosen. This argument may contain only what is
-legal for `\pageref`.
+otherwise an opaque name will be chosen for it. This argument may contain only
+what is legal for `\pageref`.
The `identifiers` argument must be a comma-separated list of identifiers
(leading and trailing spaces around each member will be ignored). Each of these
@@ -104,8 +104,7 @@ not create conflicts with possible macros or labels of the same names.
After storing some internal values, `\hereapplies` will expand exactly to
``` tex
-\phantomsection
-\label{...}
+\phantomsection\label{...}
```
Its “starred” version (`\hereapplies*`) will not invoke the `\phantomsection`
@@ -133,19 +132,18 @@ Internationalization
Currently the localization of **Here Applies** is not automatic. It is possible
however to control the strings generated by overwriting the four macros
-`\hapage`, `\hapages`, `\hadelimiter` and `\halastdelimiter`.
-
-For example, writing at the beginning of a document
+`\hapage`, `\hapages`, `\hadelimiter` and `\halastdelimiter`. For example,
+writing at the beginning of a document
``` tex
% German translation of **Here Applies**
-% English: `p.\ `
+% English: "p.\ "
\gdef\hapage{S.\ }
-% English: `pp.\ `
+% English: "pp.\ "
\gdef\hapages{S.\ }
-% English: `\ and\ `
+% English: "\ and\ "
\gdef\halastdelimiter{\ und\ }
-% English: `,\ ` (exactly like in German -- leave it)
+% English: ",\ " (exactly like in German -- leave it)
%\gdef\hadelimiter{,\ }
```
@@ -156,12 +154,9 @@ Get involved
------------
If you wish to get involved, please do not hesitate to send [merge requests][2]
-or participate in the discussion.
-
-The package is also [available on CTAN][3] under
-[`macros/latex/contrib/hereapplies`][4].
-
-For any issue, please [drop a message][5].
+or participate in the discussion. The package is also [available on
+**CTAN**][3] under [`macros/latex/contrib/hereapplies/`][4]. For any issue,
+please [drop a message][5].
Free software
@@ -169,13 +164,13 @@ Free software
**Here Applies** is free software. You can redistribute it and/or modify it
under the terms of the **AGPL** license version 3 or any later version. See
-[COPYING][6] for details.
+[`COPYING`][6] for details.
[1]: hereapplies-example.pdf
[2]: https://github.com/madmurphy/hereapplies.sty/pulls
[3]: https://www.ctan.org/pkg/hereapplies
- [4]: https://www.ctan.org/tex-archive/macros/latex/contrib/hereapplies
- [5]: https://github.com/madmurphy/libgnunetworker/issues
+ [4]: https://www.ctan.org/tex-archive/macros/latex/contrib/hereapplies/
+ [5]: https://github.com/madmurphy/hereapplies.sty/issues
[6]: COPYING