bdumont
/
crossrefenum
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial commit

This commit is contained in:
Bastien Dumont 2022-11-13 19:32:36 +01:00
commit c4bbc57605
21 changed files with 5518 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md Normal file
View File

@ -0,0 +1,3 @@
## Changes
### 2022/11/11: Version 1.0

674
LICENSE.txt Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

82
README.md Normal file
View File

@ -0,0 +1,82 @@
# crossrefenum 2022/11/11 v1.0
Smart typesetting of enumerated cross-references for various TeX formats.
Copyright (C) 2022
by Bastien Dumont <bastien.dumont@posteo.net>
CTAN: `macros/generic/crossrefenum`
## Summary
_crossrefenum_ lets TeX manage the formatting
of bunches of cross-references for you. It features:
* Automatic collapsing of references;
* Support for references by various criteria,
including page and note number, line number in ConTeXt
and edpage and edline when used in conjunction with _reledmac_;
* Handling of references combining two criteria
(e.g. by page and note number);
* Extension mechanisms to add support to other types of references
without modifying the internal macros.
Note that sorting is not supported.
I assume that users know in what order
the labels they refer to appear in their document.
It is written in Plain TeX as much as possible
in order to make it compatible with a wide array of formats.
For the moment, it works out of the box with ConTeXt and LaTeX.
## List of files
* `CHANGELOG.md`:
* `LICENSE.txt`: _GNU Public License v. 3_
* `README.md`:
* `doc/`:
* `crossrefenum.md`: _Markdown source of the user guide to be typeset with Pandoc._
* `crossrefenum.pdf`: _User guide typeset with ConTeXt._
* `fixes.lua`: _Lua filter to be used with Pandoc for some typographic improvements._
* `LICENSE_FLD_1-3.md`: _GNU Free Documentation License_
* `Makefile`: _Provides the target `crossrefenum.pdf` with the required instructions for Pandoc_
* `TEMPLATE_crossrefenum.context`: _Template to be used with Pandoc._
* `test/`:
* `config-crossrefenum.tex`: _Configuration macros for *crossrefenum* `specific`: to the test file._
* `config-formats.tex`: _Preambles to be used in the test file for all supported formats._
* `data-common.tex`: _Text input to be used with all formats._
* `data-lines.tex`: _Text input to test line numbering._
* `data-reledmac.tex`: _Text input for *reledmac*._
* `format-specific-defs.tex`: _Definition of the macros used in the test and data files that depend on format-specific macros._
* `main-test_context.pdf`: _Test file generated with ConTeXt._
* `main-test_latex.pdf`: _Test file generated with LaTeX._
* `main-test.tex`: _Main test file._
* `Makefile`: _Provides targets to generate the test file (`test` for LaTeX, `test-context`) and to `check` its correctness._
* `validated_output`: _Used by `make check`._
* `tex/`
* `crossrefenum.sty`: _Wrapper for LaTeX._
* `crossrefenum.tex`: _Macro file._
* `t-crossrefenum.tex`: _Wrapper for ConTeXt._
## Manual installation
In your local texmf tree, create `tex/generic/crossrefenum`
and put in it `crossrefenum.tex` and, if required,
`crossrefenum.sty` and/or `t-crossrefenum.tex`.
## License
Copyright 2022 by Bastien Dumont (bastien.dumont@posteo.net)
crossrefenum.tex is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
crossrefenum.tex is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with crossrefenum.tex. If not, see <https://www.gnu.org/licenses/>.

434
doc/LICENSE_FDL_1-3.md Normal file
View File

@ -0,0 +1,434 @@
## GNU Free Documentation License {#gnu-free-documentation-license-1}
Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
\<<https://fsf.org/>\>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
### 0. PREAMBLE {#section0}
The purpose of this License is to make a manual, textbook, or other
functional and useful document \"free\" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it, with
or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible for
modifications made by others.
This License is a kind of \"copyleft\", which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft license
designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free program
should come with manuals providing the same freedoms that the software
does. But this License is not limited to software manuals; it can be
used for any textual work, regardless of subject matter or whether it is
published as a printed book. We recommend this License principally for
works whose purpose is instruction or reference.
### 1. APPLICABILITY AND DEFINITIONS {#section1}
This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The \"Document\", below, refers
to any such manual or work. Any member of the public is a licensee, and
is addressed as \"you\". You accept the license if you copy, modify or
distribute the work in a way requiring permission under copyright law.
A \"Modified Version\" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
A \"Secondary Section\" is a named appendix or a front-matter section of
the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document\'s overall subject
(or to related matters) and contains nothing that could fall directly
within that overall subject. (Thus, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding them.
The \"Invariant Sections\" are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice that
says that the Document is released under this License. If a section does
not fit the above definition of Secondary then it is not allowed to be
designated as Invariant. The Document may contain zero Invariant
Sections. If the Document does not identify any Invariant Sections then
there are none.
The \"Cover Texts\" are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may be
at most 5 words, and a Back-Cover Text may be at most 25 words.
A \"Transparent\" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the general
public, that is suitable for revising the document straightforwardly
with generic text editors or (for images composed of pixels) generic
paint programs or (for drawings) some widely available drawing editor,
and that is suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent file format whose
markup, or absence of markup, has been arranged to thwart or discourage
subsequent modification by readers is not Transparent. An image format
is not Transparent if used for any substantial amount of text. A copy
that is not \"Transparent\" is called \"Opaque\".
Examples of suitable formats for Transparent copies include plain ASCII
without markup, Texinfo input format, LaTeX input format, SGML or XML
using a publicly available DTD, and standard-conforming simple HTML,
PostScript or PDF designed for human modification. Examples of
transparent image formats include PNG, XCF and JPG. Opaque formats
include proprietary formats that can be read and edited only by
proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the machine-generated
HTML, PostScript or PDF produced by some word processors for output
purposes only.
The \"Title Page\" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in formats
which do not have any title page as such, \"Title Page\" means the text
near the most prominent appearance of the work\'s title, preceding the
beginning of the body of the text.
The \"publisher\" means any person or entity that distributes copies of
the Document to the public.
A section \"Entitled XYZ\" means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as \"Acknowledgements\",
\"Dedications\", \"Endorsements\", or \"History\".) To \"Preserve the
Title\" of such a section when you modify the Document means that it
remains a section \"Entitled XYZ\" according to this definition.
The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this License,
but only as regards disclaiming warranties: any other implication that
these Warranty Disclaimers may have is void and has no effect on the
meaning of this License.
### 2. VERBATIM COPYING {#section2}
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies to
the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further copying
of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
### 3. COPYING IN QUANTITY {#section3}
If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document\'s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover Texts:
Front-Cover Texts on the front cover, and Back-Cover Texts on the back
cover. Both covers must also clearly and legibly identify you as the
publisher of these copies. The front cover must present the full title
with all words of the title equally prominent and visible. You may add
other material on the covers in addition. Copying with changes limited
to the covers, as long as they preserve the title of the Document and
satisfy these conditions, can be treated as verbatim copying in other
respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy a
computer-network location from which the general network-using public
has access to download using public-standard network protocols a
complete Transparent copy of the Document, free of added material. If
you use the latter option, you must take reasonably prudent steps, when
you begin distribution of Opaque copies in quantity, to ensure that this
Transparent copy will remain thus accessible at the stated location
until at least one year after the last time you distribute an Opaque
copy (directly or through your agents or retailers) of that edition to
the public.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
### 4. MODIFICATIONS {#section4}
You may copy and distribute a Modified Version of the Document under the
conditions of sections 2 and 3 above, provided that you release the
Modified Version under precisely this License, with the Modified Version
filling the role of the Document, thus licensing distribution and
modification of the Modified Version to whoever possesses a copy of it.
In addition, you must do these things in the Modified Version:
- A. Use in the Title Page (and on the covers, if any) a title
distinct from that of the Document, and from those of previous
versions (which should, if there were any, be listed in the History
section of the Document). You may use the same title as a previous
version if the original publisher of that version gives permission.
- B. List on the Title Page, as authors, one or more persons or
entities responsible for authorship of the modifications in the
Modified Version, together with at least five of the principal
authors of the Document (all of its principal authors, if it has
fewer than five), unless they release you from this requirement.
- C. State on the Title page the name of the publisher of the Modified
Version, as the publisher.
- D. Preserve all the copyright notices of the Document.
- E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
- F. Include, immediately after the copyright notices, a license
notice giving the public permission to use the Modified Version
under the terms of this License, in the form shown in the Addendum
below.
- G. Preserve in that license notice the full lists of Invariant
Sections and required Cover Texts given in the Document\'s license
notice.
- H. Include an unaltered copy of this License.
- I. Preserve the section Entitled \"History\", Preserve its Title,
and add to it an item stating at least the title, year, new authors,
and publisher of the Modified Version as given on the Title Page. If
there is no section Entitled \"History\" in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
- J. Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions it
was based on. These may be placed in the \"History\" section. You
may omit a network location for a work that was published at least
four years before the Document itself, or if the original publisher
of the version it refers to gives permission.
- K. For any section Entitled \"Acknowledgements\" or \"Dedications\",
Preserve the Title of the section, and preserve in the section all
the substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
- L. Preserve all the Invariant Sections of the Document, unaltered in
their text and in their titles. Section numbers or the equivalent
are not considered part of the section titles.
- M. Delete any section Entitled \"Endorsements\". Such a section may
not be included in the Modified Version.
- N. Do not retitle any existing section to be Entitled
\"Endorsements\" or to conflict in title with any Invariant Section.
- O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices
that qualify as Secondary Sections and contain no material copied from
the Document, you may at your option designate some or all of these
sections as invariant. To do this, add their titles to the list of
Invariant Sections in the Modified Version\'s license notice. These
titles must be distinct from any other section titles.
You may add a section Entitled \"Endorsements\", provided it contains
nothing but endorsements of your Modified Version by various
parties---for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of Front-Cover
Text and one of Back-Cover Text may be added by (or through arrangements
made by) any one entity. If the Document already includes a cover text
for the same cover, previously added by you or by arrangement made by
the same entity you are acting on behalf of, you may not add another;
but you may replace the old one, on explicit permission from the
previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
### 5. COMBINING DOCUMENTS {#section5}
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its license
notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by adding
at the end of it, in parentheses, the name of the original author or
publisher of that section if known, or else a unique number. Make the
same adjustment to the section titles in the list of Invariant Sections
in the license notice of the combined work.
In the combination, you must combine any sections Entitled \"History\"
in the various original documents, forming one section Entitled
\"History\"; likewise combine any sections Entitled
\"Acknowledgements\", and any sections Entitled \"Dedications\". You
must delete all sections Entitled \"Endorsements\".
### 6. COLLECTIONS OF DOCUMENTS {#section6}
You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
### 7. AGGREGATION WITH INDEPENDENT WORKS {#section7}
A compilation of the Document or its derivatives with other separate and
independent documents or works, in or on a volume of a storage or
distribution medium, is called an \"aggregate\" if the copyright
resulting from the compilation is not used to limit the legal rights of
the compilation\'s users beyond what the individual works permit. When
the Document is included in an aggregate, this License does not apply to
the other works in the aggregate which are not themselves derivative
works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies
of the Document, then if the Document is less than one half of the
entire aggregate, the Document\'s Cover Texts may be placed on covers
that bracket the Document within the aggregate, or the electronic
equivalent of covers if the Document is in electronic form. Otherwise
they must appear on printed covers that bracket the whole aggregate.
### 8. TRANSLATION {#section8}
Translation is considered a kind of modification, so you may distribute
translations of the Document under the terms of section 4. Replacing
Invariant Sections with translations requires special permission from
their copyright holders, but you may include translations of some or all
Invariant Sections in addition to the original versions of these
Invariant Sections. You may include a translation of this License, and
all the license notices in the Document, and any Warranty Disclaimers,
provided that you also include the original English version of this
License and the original versions of those notices and disclaimers. In
case of a disagreement between the translation and the original version
of this License or a notice or disclaimer, the original version will
prevail.
If a section in the Document is Entitled \"Acknowledgements\",
\"Dedications\", or \"History\", the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual title.
### 9. TERMINATION {#section9}
You may not copy, modify, sublicense, or distribute the Document except
as expressly provided under this License. Any attempt otherwise to copy,
modify, sublicense, or distribute it is void, and will automatically
terminate your rights under this License.
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally terminates
your license, and (b) permanently, if the copyright holder fails to
notify you of the violation by some reasonable means prior to 60 days
after the cessation.
Moreover, your license from a particular copyright holder is reinstated
permanently if the copyright holder notifies you of the violation by
some reasonable means, this is the first time you have received notice
of violation of this License (for any work) from that copyright holder,
and you cure the violation prior to 30 days after your receipt of the
notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
### 10. FUTURE REVISIONS OF THIS LICENSE {#section10}
The Free Software Foundation may publish new, revised versions of the
GNU Free Documentation License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns. See <https://www.gnu.org/licenses/>.
Each version of the License is given a distinguishing version number. If
the Document specifies that a particular numbered version of this
License \"or any later version\" applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document specifies
that a proxy can decide which future versions of this License can be
used, that proxy\'s public statement of acceptance of a version
permanently authorizes you to choose that version for the Document.
### 11. RELICENSING {#section11}
\"Massive Multiauthor Collaboration Site\" (or \"MMC Site\") means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A public
wiki that anybody can edit is an example of such a server. A \"Massive
Multiauthor Collaboration\" (or \"MMC\") contained in the site means any
set of copyrightable works thus published on the MMC site.
\"CC-BY-SA\" means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
\"Incorporate\" means to publish or republish a Document, in whole or in
part, as part of another Document.
An MMC is \"eligible for relicensing\" if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole or
in part into the MMC, (1) had no cover texts or invariant sections, and
(2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
## ADDENDUM: How to use this License for your documents {#addendum}
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and license
notices just after the title page:
Copyright (C) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the \"with ... Texts.\" line with this:
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit
their use in free software.

6
doc/Makefile Normal file
View File

@ -0,0 +1,6 @@
crossrefenum.pdf: crossrefenum.md ../CHANGELOG.md \
TEMPLATE_crossrefenum.context fixes.lua
pandoc -o crossrefenum.pdf --pdf-engine=context \
--template=TEMPLATE_crossrefenum.context \
-L fixes.lua \
crossrefenum.md ../CHANGELOG.md

135
doc/TEMPLATE_crossrefenum.context Normal file
View File

@ -0,0 +1,135 @@
\setuppapersize[S6]
\setuplayout[backspace=2cm, topspace=0.7cm, bottom=0.5cm, width=middle, height=fit]
\setupinteraction[state=start,
$if(title)$
title={$title$},
$endif$
n$if(subtitle)$
subtitle={$subtitle$},
$endif$
$if(author)$
author={$for(author)$$author$$sep$; $endfor$},
$endif$
$if(keywords)$
keyword={$for(keywords)$$keywords$$sep$; $endfor$},
$endif$
style=,
color=blue,
contrastcolor=,
click=yes]
\placebookmarks[chapter, section, subsection, subsubsection, subsubsubsection, subsubsubsubsection][chapter, section]
\setupbodyfontenvironment[default][em=italic]
\definefontfamily[mainface][rm][cochineal]
\definefontfamily[mainface][ss][linuxbiolinumo]
\definefontfamily[mainface][tt][nimbusmonops][features=none]
\setupbodyfont[mainface,12pt]
\setuptype[lines=no]
\setuphead[chapter] [style=\ssc\bf\setupinterlinespace,header=empty]
\setuphead[section] [style=\ssb\bf\setupinterlinespace]
\setuphead[subsection] [style=\ssa\bf\setupinterlinespace]
\setuphead[subsubsection] [style=\ss\bf]
\setuphead[subsubsubsection] [style=\ss]
\setuphead[subsubsubsubsection][style=\ss\it]
\setupheads[indentnext=no]
\setuppagenumbering[location=] % Pour que le numéro de page n'apparaisse pas en haut au milieu
\setupheader[text][leftstyle=\em]
\setupheadertexts[section][pagenumber]
\setupfootertexts$if(toc)$[{\inframed{\goto{Table of contents}[page(3)]}}]$endif$[{\inframed{\goto{Jump to previous page}[PreviousJump]}}]
\setupbackend[
format={pdf/a-1a:2005},
profile={default_cmyk.icc,default_rgb.icc,default_gray.icc},
intent=ISO coated v2 300\letterpercent\space (ECI)]
\setupbackend[export=yes]
\setupstructure[state=start,method=auto]
\definefontfeature[default][default][script=latn, protrusion=quality, expansion=quality, itlc=yes, textitalics=yes, onum=yes, pnum=yes]
\definefontfeature[smallcaps][script=latn, protrusion=quality, expansion=quality, smcp=yes, onum=yes, pnum=yes]
\setupalign[hz,hanging]
\setupitaliccorrection[global, always]
\defineitemgroup[enumerate]
\setupenumerate[each][fit][itemalign=left,distance=.5em,style={\feature[+][default:tnum]}]
\setupindenting[yes, small]
\setupwhitespace[small]
\setupnotation[footnote][alternative=left, numbercommand=, stopper={.}]
\setupitemize[autointro] % prevent orphan list intro
\definesymbol[emdash][—]
\definesymbol[endash][–]
\setupitemize[1][symbol=emdash, width=2.2em, indenting=-0.7em] % cochineal has no bullet
\setupitemize[2][symbol=endash, width=1.3em, indenting=-0.3em]
\setupdelimitedtext[blockquote][indenting=no]
\definebreakpoints[lbreakwithouthyphen]
\definebreakpoint[lbreakwithouthyphen][=][type=1]
\definebreakpoint[lbreakwithouthyphen][-][type=1]
\setbreakpoints[lbreakwithouthyphen]
\definemakeup[titlepage][doubleside=no,align=middle,headerstate=empty]
\definemakeup[licensepage][doubleside=no,top=\vfill,headerstate=empty]
\setupcombinedlist[content, listoftables, listoffigures][criterium=all,
list={chapter,section,subsection, subsubsection},
alternative=c]
\setuplist[chapter, section, subsection, subsubsection][color=no, numberstyle={\feature[-][f:oldstyle]}, pagestyle={\feature[-][f:oldstyle]}]
\setuplist[chapter][width=1em, style=\bf\ss]
\setuplist[section][margin=1em, width=2em]
\setuplist[subsection][margin=3em, width=3em]
\setuplist[subsubsection][margin=6em, width=4em]
\starttext
\starttitlepagemakeup
$if(title)$
{\tfd\setupinterlinespace $title$}
$if(subtitle)$
\blank[force,1cm]
{\tfa\setupinterlinespace $subtitle$}
$endif$
$if(author)$
\blank[force,1cm]
{\tfa\setupinterlinespace $for(author)$$author$$sep$\crlf $endfor$}
$endif$
$if(date)$
\blank[force,1cm]
{\tfa\setupinterlinespace $date$}
$endif$
\stoptitlepagemakeup
\pagebreak
$endif$
$if(license)$
\startlicensepagemakeup
\inframed[frame=off, width=0.66\textwidth, align=normal]{%
Copyright (C) 2022 Bastien Dumont.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license should have been distributed with this file.
If not, see \hyphenatedurl{https://www.gnu.org/licenses/fdl-1.3.html}.%
}
\stoplicensepagemakeup
\pagebreak
$endif$
$if(toc)$
\completecontent
$endif$
\pagebreak
$body$
\stoptext

738
doc/crossrefenum.md Normal file
View File

@ -0,0 +1,738 @@
---
title: "crossrefenum"
subtitle: "Smart typesetting of enumerated cross-references for various TeX formats"
author: Bastien Dumont
date: 2022/11/11
lang: en-US
toc: true
license: true
---
_crossrefenum_ lets TeX manage the formatting
of bunches of cross-references for you. It features:
* Automatic collapsing of references;
* Support for references by various criteria,
including page and note number, line number in ConTeXt
and edpage and edline when used in conjunction with _reledmac_;
* Handling of references combining two criteria
(e.g. by page and note number);
* Extension mechanisms to add support to other types of references
without modifying the internal macros.
Note that sorting is not supported.
I assume that users know in what order
the labels they refer to appear in their document.
It is written in Plain TeX as much as possible
in order to make it compatible with a wide array of formats.
For the moment, it works out of the box with ConTeXt and LaTeX.
The file `main-test.pdf` provides a showcase of the abilities of _crossrefenum_.
## Loading
To load _crossrefenum_, provided that
`crossrefenum.tex`, `crossrefenum.sty` and `t-crossrefenum.tex`
are installed in a directory where TeX will find them
(presumably under the `tex/generic/crossrefenum` directory of one of your _texmf_ trees),
you can do:
* `\input{crossrefenum}` (generic);
* `\usepackage{crossrefenum}` (LaTeX;
must be called after _nameref_ if you use _hyperref_);
* `\usemodule[crossrefenum]` (ConTeXt).
## Basic invocation
The macro `\crossrefenum` has the following syntax:
> \\crossrefenum\[_type_\]\[_print prefix?_\]{_enumeration_}
* _type_ is the type of reference. Built-in possible values are:
* For LaTeX and ConTeXt: `page`, `note`, `pagenote`;
* For ConTeXt only: `line`, `pageline`;
* For LaTeX with _reledmac_: `edpage`, `edline`, `edpageline`.
* _print prefix?_ indicates whether the prefix (like “p. ”) should be printed or not: true if set to `withprefix` or `yes`;
* _enumeration_ is a group containing one or more _single_ labels (e.g. `{mylabel}`) or _ranges_ (e.g. `{lbl-begin to lbl-end}`) included in groups. Ranges cannot be used with `note` and `pagenote` types.
_type_ and _print prefix?_ are optional. _type_ defaults to `page` and _print prefix_ to `withprefix`.
Here are some valid invocations:
* `\crossrefenum[note][withprefix]{{lblone}{lbltwo}{lblthree}}`
* `\crossrefenum[edline][noprefix]{{lblone}{lbltwo}{lblthree}}`
* `\crossrefenum[noprefix]{{lblone}{lbltwo}{lblthree}}` (_type_ defaults to `page`)
* `\crossrefenum[note]{{lblone}{lbltwo}{lblthree}}` (_print prefix?_ defaults to `withprefix`)
* `\crossrefenum{{lblone}{lbltwo}{lblthree}}` (_type_ defaults to `page` and _print prefix?_ defaults to `withprefix`)
* `\crossrefenum{{only-one}}` (even if the enumeration is limited to one item, it must be inside its own group)
## Customization
Customizing is done by redefining configuration macros.
We describe the general mechanism first.
Macros for double types are introduced at the end of this section.
### Prefixes, delimiters and separators
Every simple type has two macros corresponding to the singular and plural prefixes
printed before the value of the reference. By default, they are set to:
```{.tex}
\def\crfnmPage{p.~}
\def\crfnmPages{pp.~}
\def\crfnmNote{n.~}
\def\crfnmNotes{nn.~}
\let\crfnmEdpage\crfnmPage
\let\crfnmEdpages\crfnmPages
\def\crfnmEdline{l.~}
\def\crfnmEdlines{ll.~}
```
Between successive items in an enumeration, `\crossrefenum` calls `\crfnmDefaultEnumDelim` or `\crfnmDefaultBeforeLastInEnum`. By default, they are set to:
```{.tex}
\def\crfnmDefaultEnumDelim{, }
\def\crfnmDefaultBeforeLastInEnum{ and }
```
The beginning and the end of a range are separated by `\crfnmDefaultRangeSep`. By default:
```{.tex}
\def\crfnmDefaultRangeSep{–}
```
### Collapsable and non-collapsable types {#collapsable-types}
The macro `\crfnmDefaultCollapsable` defines if ranges are allowed.
The default configuration is:
```{.tex}
\def\crfnmDefaultCollapsable{yes}
\def\crfnmNoteCollapsable{no}
```
Thus, a reference to consecutive notes is formatted like _nn. 3, 4 and 5_, not like _nn. 3–5_.
Ranges are not accepted in the argument of `\crossrefenum` for non-collapsable types.
This extends to double types that include a non-collapsable type
(such as `pagenote` in the default configuration).
### Double types
Two subtypes in a double type (e.g. page and note number for `pagenote`)
are separated by `\crfnmDefaultSubtypesSep`. Default:
```{.tex}
\def\crfnmDefaultSubtypesSep{, }
```
When more than one reference is cited in an enumeration,
you may not want the first prefix to be repeated every time
(e.g. you could prefer “pp. 5, n. 2; 7, n. 4” over “p. 5, n. 2; p. 7, n. 4”).
In that case, set `\crfnmDefaultPrintFirstPrefix` to `once`.
Default is:
```{.tex}
\def\crfnmDefaultPrintFirstPrefix{always}
```
If you want to format the second part of the reference in a special way (e.g. in superscript),
use `\crfnmDefaultFormatInSecond`,
which takes one argument which corresponds to the reference number and all its affixes.
Default is:
```{.tex}
\def\crfnmDefaultFormatInSecond#1{#1}
```
If you don't want any prefix to be printed in the second term of a double reference,
set `\crfnmDefaultPrintPrefixInSecond` to `no` (default is yes).
For instance:
```{.tex}
\def\crfnmEdlineFormatInSecond#1{\textsuperscript{#1}}
\def\crfnmEdlinePrintPrefixInSecond{no}
\crossrefenum[edpageline]{{mylabel}}
```
`\noindentation`{=context} may return “p. 5^10^”, while `\crossrefenum[edline]{{mylabel}}` would return “l. 10”.
For the second part of such an enumeration (e.g. “l. 10” in “p. 5, l. 10”),
you can specify a specific delimiter
and a specific string to be printed before the last reference:
for instance, you may want to use the word “and”
before the last note number if the reference type is a simple one (`note`),
and a comma if it is comes in second in a double reference (e.g. in `pagenote`).
To achieve this, you should redefine `\crfnmDefaultEnumDelimInSecond`
and `\crfnmDefaultBeforeLastInEnumInSecond`.
By default, these macros fall back respectively
on `\crfnmDefaultEnumDelim` and `\crfnmDefaultBeforeLastInEnum`.
When citing a range, the two parts of the reference can
either be split (e.g. “p. 5, l. 3 – p. 7, l. 44”)
or grouped (“p. 5–7, l. 3–44”).
This is controlled via `\crfnmDefaultGroupSubtypes`, which can be set to `yes` or `no`.
This works only with [collapsable types](#collapsable-types).
Default is:
```{.tex}
\def\crfnmDefaultGroupSubtypes{no}
```
To know if a reference to “p. 6, l. 34” should be merged with “p. 7, l. 35”,
_crossrefenum_ needs to know if the lineation is
continuous (in this case, these lines are consecutive)
or per page (they are not, so they should not be merged).
You can set accordingly
`\crfnmDefaultNumberingContinuousAcrossDocument`[^line-numbering] to `yes` (default) or `no`.
Note that _crossrefenum_ cannot merge a reference
to the last line of a page and the first line of the following page
if the lineation is not continuous.
[^line-numbering]: In this case, you could set more specifically
`\crfnmLineNumberingContinuousAcrossDocument`
or `\crfnmEdlineNumberingContinuousAcrossDocument`:
see [the following subsection](#specialize-config-macros).
By default, the number of the first subtype in the name of the double type
(e.g. “page” in “pagenote”) is always displayed first.
If you want to change this, set `\crfnmDefaultOrder` to `inverted` (defaults to `normal`).
### Specific values for given types {#specialize-config-macros}
If you want to override some of these macros for a specific type,
simply replace `Default` in its name with the (capitalized) name of the type
(e.g. `\def\crfnmPageEnumDelim{; }`).
Setting one of these macros to `\relax` will cause `\crossrefenum`
to use the corresponding default macro instead.
If you want a specific macro to be set to nothing,
use an empty group (e.g. `\def\crfnmPageEnumDelim{}`).
## How to extend crossrefenum with other types and formats {#extending}
Adding support for new types consists in defining the related macros in your preamble.
Here is a commented example that would add support for references to lines in ConTeXt
if this feature were not already included in _crossrefenum_.
```{.tex}
% Register the types. Take care about capitalization!
%% Set the names of the types and their corresponding macros:
%% the control sequence should always be lowercase
%% and the name of the type capitalized.
\def\crfnm@line{Line}
\def\crfnm@pageline{Pageline}
%% Add them to the lists of known types.
\crfnm@newListFrom[\crfnm@simpleRefTypes][\crfnm@line] -> \crfnm@simpleRefTypes
\crfnm@newListFrom[\crfnm@doubleRefTypes][\crfnm@pageline] -> \crfnm@doubleRefTypes
\crfnm@newListFrom[\crfnm@supportedTypes][\crfnm@line] -> \crfnm@supportedTypes
\crfnm@newListFrom[\crfnm@supportedTypes][\crfnm@pageline] -> \crfnm@supportedTypes
%% 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”...).
\let\crfnm@PagelinePrimary\crfnm@page
\let\crfnm@PagelineSecondary\crfnm@line
% Define the macro used to typeset the reference number.
\def\crfnm@LineRef#1{\in[lr:b:#1]}
% Define the macro used by \crossrefenum internally
% to retrieve the raw reference number without typesetting it.
% If you want to support multiple formats,
% see how the macro \crfnm@case is used in crossrefenum.tex.
% Note: the Lua function get_raw_ref_number is defined
% in crossrefenum.tex for ConTeXt.
\def\crfnm@getLineNumber#1{\directlua{get_raw_ref_number('lr:b:#1', 'linenumber')}}
% Define all specific configuration options in the regular way.
%% Required
\def\crfnmLine{l. }
\def\crfnmLines{ll.}
%% If it differs from the defaults.
\def\crfnmCollapsable{yes}
\def\crfnmLineBeforeLastInSecond{, }
\def\crfnmPagelineSubtypesSep{}
\def\crfnmPagelinePrintFirstPrefix{once}
\def\crfnmLineFormatInSecond#1{\crfnmSuperscript{#1}}
\def\crfnmLinePrintPrefixInSecond{no}
```
Adding support to yet unsupported 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.
If you have wishes or hints about this, please contact me.
## Compatibility issues
With LaTeX, the _nameref_ package (required by _hyperref_)
must be loaded explicitely before _crossrefenum_.
However, if the links in the output of `\crossrefenum` (not the numbers)
point to a wrong location, you may wish to patch the macro
to disable _hyperref_ locally:
``` {.tex}
\makeatletter
\let\oldcrfnm@enum\crfnm@enum
\def\crfnm@enum[#1][#2]#3{\begin{NoHyper}\oldcrfnm@enum[#1][#2]{#3}\end{NoHyper}}
\makeatother
```
<!--
GNU Free Documentation License
Version 1.3, 3 November 2008
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other
functional and useful document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
This License is a kind of "copyleft", which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The "Document", below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as "you". You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of
the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
The "Invariant Sections" are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML, PostScript or PDF designed for human modification. Examples of
transparent image formats include PNG, XCF and JPG. Opaque formats
include proprietary formats that can be read and edited only by
proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the
machine-generated HTML, PostScript or PDF produced by some word
processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, "Title Page" means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
The "publisher" means any person or entity that distributes copies of
the Document to the public.
A section "Entitled XYZ" means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as "Acknowledgements",
"Dedications", "Endorsements", or "History".) To "Preserve the Title"
of such a section when you modify the Document means that it remains a
section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no
other conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to
give them a chance to provide you with an updated version of the
Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled "History" in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the "History" section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications",
Preserve the Title of the section, and preserve in the section all
the substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section
may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements"
or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various
parties--for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History"
in the various original documents, forming one section Entitled
"History"; likewise combine any sections Entitled "Acknowledgements",
and any sections Entitled "Dedications". You must delete all sections
Entitled "Endorsements".
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other
documents released under this License, and replace the individual
copies of this License in the various documents with a single copy
that is included in the collection, provided that you follow the rules
of this License for verbatim copying of each of the documents in all
other respects.
You may extract a single document from such a collection, and
distribute it individually under this License, provided you insert a
copy of this License into the extracted document, and follow this
License in all other respects regarding verbatim copying of that
document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an "aggregate" if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements",
"Dedications", or "History", the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the
GNU Free Documentation License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns. See
https://www.gnu.org/licenses/.
Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document
specifies that a proxy can decide which future versions of this
License can be used, that proxy's public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
11. RELICENSING
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A
public wiki that anybody can edit is an example of such a server. A
"Massive Multiauthor Collaboration" (or "MMC") contained in the site
means any set of copyrightable works thus published on the MMC site.
"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
"Incorporate" means to publish or republish a Document, in whole or in
part, as part of another Document.
An MMC is "eligible for relicensing" if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole or
in part into the MMC, (1) had no cover texts or invariant sections, and
(2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the "with...Texts." line with this:
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
-->

45
doc/fixes.lua Normal file
View File

@ -0,0 +1,45 @@
local ZERO_WD_SP = pandoc.RawInline('context', '\\hskip0pt ')
local function set_break_points(code)
local raw_code = code.text
local broken_code = {}
for a, b in string.gmatch(raw_code, '([^a-zA-Z\\]?)([A-Z\\]?[a-z.]*)') do
if a ~= '' then
table.insert(broken_code, ZERO_WD_SP)
table.insert(broken_code, pandoc.Code(a))
end
if b ~= '' then
table.insert(broken_code, ZERO_WD_SP)
table.insert(broken_code, pandoc.Code(b))
end
end
return broken_code
end
local function has_one_of(s, string_table)
for i = 1, #string_table do
if string.match(s, string_table[i]) then
return string_table[i]
end
end
return false
end
local function logos(str)
local s = str.text
-- 'TeX' must be included last because it is contained in the other names.
local match = has_one_of(s, { 'LaTeX', 'ConTeXt', 'TeX' })
if match then
local pre, logo, post = string.match(s, '^(.*)(' .. match .. ')(.*)$')
local to_return = {}
if pre then table.insert(to_return, pandoc.Str(pre)) end
table.insert(to_return, pandoc.RawInline('context', '\\' .. logo .. '{}'))
if post then table.insert(to_return, pandoc.Str(post)) end
return to_return
end
end
return {
{ Code = set_break_points },
{ Str = logos }
}

45
release-to-CTAN.sh Executable file
View File

@ -0,0 +1,45 @@
#!/bin/bash
EDIT_CMD="/usr/bin/emacs -Q -nw"
check_files(){
read -n 1 -p 'Do you want to check that you updated the changelog and the version strings? [y/n] ' rep
if [[ "$rep" == y ]] ; then
$EDIT_CMD CHANGELOG.md
$EDIT_CMD README.md
$EDIT_CMD doc/crossrefenum.md
$EDIT_CMD tex/crossrefenum.tex
$EDIT_CMD tex/t-crossrefenum.tex
elif [[ "$rep" != n ]] ; then
echo -e "\nPlease type y or n."
check_files
fi
}
check_files
mkdir crossrefenum
cd crossrefenum
for file in README.md CHANGELOG.md LICENSE.txt ; do
ln -s ../$file $file
done
mkdir doc test tex
cd doc
for file in crossrefenum.md crossrefenum.pdf fixes.lua LICENSE_FLD_1-3.md Makefile TEMPLATE_crossrefenum.context ; do
ln -s ../../doc/$file $file
done
cd ../test
for file in config-crossrefenum.tex config-formats.tex data-common.tex data-lines.tex data-reledmac.tex format-specific-defs.tex main-test_context.pdf main-test_latex.pdf main-test.tex Makefile validated_output ; do
ln -s ../../test/$file $file
done
cd ../tex
for file in crossrefenum.sty crossrefenum.tex t-crossrefenum.tex ; do
ln -s ../../tex/$file $file
done
cd ../..
7z a -l crossrefenum.zip crossrefenum
rm -r --interactive=never crossrefenum

38
test/Makefile Normal file
View File

@ -0,0 +1,38 @@
.PHONY: clean test log check
ALL=main-test.tex data-common.tex data-reledmac.tex config-formats.tex config-crossrefenum.tex format-specific-defs.tex
define MAKE_BOXES_LIST
sed -i 's/%\\tracingoutput/\\tracingoutput/' $<
-xelatex main-test.tex
sed -i 's/^\\tracingoutput/%\\tracingoutput/' $<
full_boxes_list="$$(grep -E '^\.+\\TU' main-test.log)"; \
i_test_result_end="$$(( $$(grep -Fn '....\TU/lmr/m/sc/10 Capitulus' <<< "$$full_boxes_list" | head -n 1 | cut -d ':' -f 1) - 1))"; \
sed -n 1,$${i_test_result_end}p <<< "$$full_boxes_list" > $@
endef
clean:
-rm main-test.{aux,log,1,2,fdb_latexmk,fls,xdv,tuc}
test: clean $(ALL)
latexmk -xelatex main-test.tex
log: $(ALL)
sed -i 's/%\\tracingcommands/\\tracingcommands/' $<
sed -i 's/%\\tracingmacros/\\tracingmacros/' $<
-xelatex main-test.tex
sed -i 's/^\\tracingcommands/%\\tracingcommands/' $<
sed -i 's/^\\tracingmacros/%\\tracingmacros/' $<
validated-output: $(ALL)
$(MAKE_BOXES_LIST)
check: test log test-output
diff test-output validated-output
@echo -e '\n==============\nCheck passed!\n==============\n'
test-output: $(ALL)
$(MAKE_BOXES_LIST)
test-context: $(ALL)
context $<

11
test/config-crossrefenum.tex Normal file
View File

@ -0,0 +1,11 @@
% Only configuration macros differing from the defaults
% are defined here.
\def\crfnmEdlineNumberingContinuousAcrossDocument{no}
\def\crfnmLineNumberingContinuousAcrossDocument{no}
\def\crfnmDefaultRangeSep{-}
\def\crfnmPagenoteRangeSep{ – }
\def\crfnmEdlineBeforeLastInSecond{, }
\def\crfnmEdpagelineSubtypesSep{}
\def\crfnmEdpagelinePrintFirstPrefix{once}
\def\crfnmEdlineFormatInSecond#1{\crfnmSuperscript{#1}}
\def\crfnmEdlinePrintPrefixInSecond{no}

29
test/config-formats.tex Normal file
View File

@ -0,0 +1,29 @@
\crfnm@case[\fmtname]
\crfnm@latex: {
\documentclass{article}
\usepackage[a5paper]{geometry}
\usepackage{setspace}
\doublespacing
\usepackage[perpage]{footmisc}
\usepackage[series=A,noend,noeledsec,noledgroup]{reledmac}
\lineation{page}
\usepackage{polyglossia}
\setmainlanguage{latin}
\setotherlanguage{english}
}
\crfnm@context: {
\setuppapersize[A5]
\setuplayout[backspace=65pt, width=middle,
topspace=73pt, header=0pt, headerdistance=0pt,
textheight=393, height=447pt]
\setuppagenumbering[location=footer]
\setupbodyfont[10pt]
\setupinterlinespace[13pt]
\definebodyfontenvironment[8pt][interlinespace=9pt]
\setupwhitespace[none]
\setupnotation[way=bypage]
\setupnote[footnote][before={\blank[3pt, weak]}, rule=off]
\setuplinenumbering[step=5, method=page]
\mainlanguage[latin]
}
\crfnm@endCases

17
test/data-common.tex Normal file
View File

@ -0,0 +1,17 @@
\crfnmheader{Capitulus primus}
1\crfnmlbl{matthaeus-1} liber generationis Iesu Christi filii David filii Abraham 2\crfnmlbl{matthaeus-2} Abraham genuit Isaac Isaac autem genuit Iacob Iacob autem genuit Iudam et fratres eius 3\crfnmlbl{matthaeus-3} Iudas autem genuit Phares et Zara de Thamar Phares autem genuit Esrom Esrom autem genuit Aram 4\crfnmlbl{matthaeus-4} Aram autem genuit Aminadab Aminadab\crfnmfootnote[note-Aminadab-undecim]{undecim diebus de Horeb per viam montis Seir usque Cadesbarne} autem genuit Naasson Naasson autem genuit Salmon 5\crfnmlbl{matthaeus-5} Salmon autem genuit Booz de Rachab Booz autem genuit Obed ex Ruth Obed autem genuit Iesse Iesse autem genuit David regem 6\crfnmlbl{matthaeus-6} David autem rex genuit Salomonem ex ea quae fuit Uriae 7\crfnmlbl{matthaeus-7} Salomon autem genuit Roboam Roboam autem genuit Abiam Abia autem genuit Asa 8\crfnmlbl{matthaeus-8} Asa autem genuit Iosaphat\crfnmfootnote[note-Iosaphat-ad]{ad cetera quae ei proxima sunt campestria} Iosaphat autem genuit Ioram Ioram autem genuit Oziam 9\crfnmlbl{matthaeus-9} Ozias autem genuit Ioatham Ioatham autem genuit Achaz Achaz autem genuit Ezechiam 10\crfnmlbl{matthaeus-10} Ezechias autem genuit Manassen Manasses autem genuit Amon Amon autem genuit Iosiam 11\crfnmlbl{matthaeus-11} Iosias autem genuit Iechoniam et fratres eius in transmigratione Babylonis 12\crfnmlbl{matthaeus-12} et post transmigrationem Babylonis\crfnmfootnote[note-Babylonis-Libani]{Libani usque ad flumen magnum Eufraten} Iechonias genuit Salathihel Salathihel autem genuit Zorobabel 13\crfnmlbl{matthaeus-13} Zorobabel autem genuit Abiud Abiud autem genuit Eliachim Eliachim autem genuit Azor 14\crfnmlbl{matthaeus-14} Azor autem\crfnmfootnote[note-autem-non]{non valeo solus vestra negotia sustinere et pondus ac iurgia} genuit Saddoc Saddoc autem genuit Achim Achim autem genuit Eliud 15\crfnmlbl{matthaeus-15} Eliud autem genuit Eleazar Eleazar autem genuit Matthan Matthan autem genuit Iacob 16\crfnmlbl{matthaeus-16} Iacob autem genuit Ioseph virum Mariae de qua natus est Iesus qui vocatur Christus 17\crfnmlbl{matthaeus-17} omnes ergo generationes ab Abraham usque ad David generationes quattuordecim et a David usque ad transmigrationem Babylonis generationes\crfnmfootnote[note-generationes-quis]{quis est in vobis de universo populo eius sit Deus illius cum ipso ascendat Hierusalem quae est in Iudaea et aedificet domum Domini Dei Israhel ipse est Deus qui est in Hierusalem} quattuordecim et a transmigratione Babylonis usque ad Christum generationes quattuordecim
18\crfnmlbl{matthaeus-18} Christi autem generatio\crfnmfootnote[note-generatio-Persarum]{Persarum per manum Mitridatis filii Gazabar et adnumeravit ea Sasabassar principi Iudae} sic erat cum esset desponsata mater eius Maria Ioseph antequam convenirent inventa est in utero habens de Spiritu Sancto 19\crfnmlbl{matthaeus-19} Ioseph autem vir eius cum esset iustus et nollet eam traducere voluit occulte dimittere eam 20\crfnmlbl{matthaeus-20} haec autem eo cogitante ecce angelus Domini in somnis\crfnmfootnote[note-somnis-hic]{hic est numerus eorum fialae aureae triginta fialae argenteae mille cultri viginti novem scyphi aurei triginta} apparuit ei dicens Ioseph fili David noli timere accipere Mariam coniugem tuam quod enim in ea natum est de Spiritu Sancto est 21\crfnmlbl{matthaeus-21} pariet autem filium et vocabis nomen eius Iesum ipse enim salvum faciet populum suum a peccatis eorum 22\crfnmlbl{matthaeus-22} hoc autem totum factum est ut adimpleretur id quod dictum est a Domino per prophetam dicentem 23\crfnmlbl{matthaeus-23} ecce virgo in utero habebit et pariet filium et vocabunt nomen eius Emmanuhel quod est interpretatum Nobiscum Deus 24\crfnmlbl{matthaeus-24} exsurgens autem Ioseph a somno fecit sicut praecepit ei angelus Domini et accepit coniugem suam 25\crfnmlbl{matthaeus-25} et non cognoscebat eam donec peperit filium suum primogenitum et vocavit nomen eius Iesum
\crfnmheader{Capitulus secundus}
1\crfnmlbl{matthaeus-021} cum\crfnmfootnote[note-cum-haec]{haec dicit Dominus super tribus sceleribus Damasci et super quattuor non convertam eum eo quod trituraverint in plaustris ferreis Galaad} ergo natus esset Iesus in Bethleem Iudaeae in diebus Herodis regis ecce magi ab oriente venerunt Hierosolymam 2\crfnmlbl{matthaeus-022} dicentes ubi est qui natus est rex Iudaeorum vidimus enim stellam eius in oriente et venimus adorare eum 3\crfnmlbl{matthaeus-023} audiens autem Herodes rex turbatus est et omnis Hierosolyma cum illo 4\crfnmlbl{matthaeus-024} et congregans\crfnmfootnote[note-congregans-conteram]{conteram vectem Damasci et disperdam habitatorem de campo Idoli et tenentem sceptrum de domo Voluptatis et transferetur populus Syriae Cyrenen dicit Dominus} omnes principes sacerdotum et scribas populi sciscitabatur ab eis ubi Christus nasceretur 5\crfnmlbl{matthaeus-025} at illi dixerunt ei in Bethleem Iudaeae sic enim scriptum est per prophetam 6\crfnmlbl{matthaeus-026} et tu Bethleem terra Iuda nequaquam minima es in principibus Iuda ex te enim exiet dux qui reget populum meum Israhel\crfnmfootnote[note-Israhel-mittam]{mittam ignem in murum Gazae et devorabit aedes eius 8 et disperdam habitatorem de Azoto et tenentem sceptrum de Ascalone et convertam manum meam super Accaron et peribunt reliqui Philisthinorum dicit Dominus Deus} 7\crfnmlbl{matthaeus-027} tunc Herodes clam vocatis magis diligenter didicit ab eis tempus stellae quae apparuit eis 8\crfnmlbl{matthaeus-028} et mittens illos in Bethleem dixit ite et interrogate diligenter de puero et cum inveneritis renuntiate mihi ut et ego veniens adorem eum
9\crfnmlbl{matthaeus-029} qui cum audissent regem\crfnmfootnote[note-regem-Theman]{Theman et devorabit aedes Bosrae} abierunt et ecce stella quam viderant in oriente antecedebat eos usque dum veniens staret supra ubi erat puer 10\crfnmlbl{matthaeus-0210} videntes autem stellam gavisi sunt gaudio magno valde 11\crfnmlbl{matthaeus-0211} et intrantes domum invenerunt puerum cum Maria matre eius et procidentes\crfnmfootnote[note-procidentes-stillabunt]{stillabunt montes dulcedinem et colles fluent lacte et per omnes rivos Iuda ibunt aquae et fons de domo Domini egredietur et inrigabit torrentem Spinarum} adoraverunt eum et apertis thesauris suis obtulerunt ei munera aurum tus et murram 12\crfnmlbl{matthaeus-0212} et responso accepto in somnis ne redirent\crfnmfootnote[note-redirent-populi]{populi populi in valle concisionis quia iuxta est dies Domini in valle concisionis} ad Herodem per aliam viam reversi sunt in regionem suam
13\crfnmlbl{matthaeus-0213} qui cum recessissent ecce angelus Domini apparuit in somnis Ioseph dicens surge et accipe puerum et matrem eius et fuge in Aegyptum et esto ibi usque dum dicam tibi futurum est enim ut Herodes quaerat\crfnmfootnote[note-quaerat-clamate]{clamate hoc in gentibus sanctificate bellum suscitate robustos accedant ascendant omnes viri bellatores} puerum ad perdendum eum 14\crfnmlbl{matthaeus-0214} qui consurgens accepit puerum et matrem eius nocte et recessit in Aegyptum 15\crfnmlbl{matthaeus-0215} et erat ibi usque ad obitum\crfnmfootnote[note-obitum-mittite]{mittite falces quoniam maturavit messis venite et descendite quia plenum est torcular exuberant torcularia quia multiplicata est malitia eorum} Herodis ut adimpleretur quod dictum est a Domino per prophetam dicentem ex Aegypto vocavi filium meum
16\crfnmlbl{matthaeus-0216} tunc Herodes videns quoniam inlusus esset a magis iratus est valde et mittens occidit omnes pueros qui erant in Bethleem et in omnibus finibus eius a bimatu et infra secundum tempus quod exquisierat a magis 17\crfnmlbl{matthaeus-0217} tunc adimpletum est quod dictum est per Hieremiam prophetam dicentem 18\crfnmlbl{matthaeus-0218} vox in Rama audita est ploratus et\crfnmfootnote[note-et-et]{et surrexerunt principes patrum de Iuda et Beniamin et sacerdotes et Levitae omnis cuius suscitavit Deus spiritum ut ascenderent ad aedificandum templum Domini quod erat in Hierusalem} ululatus multus Rachel plorans filios suos et noluit consolari quia non sunt
19\crfnmlbl{matthaeus-0219} defuncto autem\crfnmfootnote[note-autem-rex]{rex quoque Cyrus protulit vasa templi Domini quae tulerat Nabuchodonosor de Hierusalem et posuerat} Herode ecce apparuit angelus Domini in somnis Ioseph in Aegypto 20\crfnmlbl{matthaeus-0220} dicens surge et accipe puerum et matrem eius et vade in terram Israhel defuncti sunt enim qui quaerebant animam pueri 21\crfnmlbl{matthaeus-0221} qui surgens accepit puerum\crfnmfootnote[note-puerum-et]{et hic est numerus eorum fialae aureae triginta fialae argenteae mille cultri} et matrem eius et venit in terram Israhel 22\crfnmlbl{matthaeus-0222} audiens autem quod Archelaus regnaret in Iudaea pro Herode patre suo timuit illo ire et admonitus in somnis secessit in partes Galilaeae 23\crfnmlbl{matthaeus-0223} et veniens habitavit\crfnmfootnote[note-habitavit-quae]{quae tulerat Nabuchodonosor} in civitate quae vocatur Nazareth ut adimpleretur quod dictum\crfnmfootnote[note-dictum-mnia]{mnia vasa aurea et argentea quinque milia quadringenta universa tulit Sasabassar cum his qui ascendebant de transmigratione Babylonis in Hierusalem} est per prophetas quoniam Nazareus vocabitur

13
test/data-lines.tex Normal file
View File

@ -0,0 +1,13 @@
\crfnmheader{Lineae}
\ifcontext{
\let\oldcrfnmlbl\crfnmlbl
\def\crfnmlbl#1{\oldcrfnmlbl{#1}\someline[#1]}
}
\ifcontext{\startlinenumbering}
1\crfnmlbl{soph-1} Verbum Domini, quod factum est ad Sophoniam filium Chusi filii Godoliæ filii Amariæ filii Ezechiæ, in diebus Iosiæ filii Amon regis Iudæ. 2\crfnmlbl{soph-2} “Auferens auferam omnia a facie terræ, dicit Dominus, 3\crfnmlbl{soph-3} auferam hominem et pecus, auferam volatile cæli et pisces maris. Et ruinæ impiorum erunt; et disperdam homines a facie terræ, dicit Dominus. 4\crfnmlbl{soph-4} Et extendam manum meam super Iudam et super omnes habitantes Ierusalem; et disperdam de loco hoc reliquias Baal et nomina ædituorum cum sacerdotibus 5\crfnmlbl{soph-5} et eos, qui adorant super tecta militiam cæli et adorant et iurant in Domino et iurant in Melchom, 6\crfnmlbl{soph-6} et qui avertuntur de post tergum Domini, et qui non quærunt Dominum nec investigant eum”. 7\crfnmlbl{soph-7} Silete a facie Domini Dei, quia iuxta est dies Domini; quia præparavit Dominus hostiam, sanctificavit vocatos suos. 8\crfnmlbl{soph-8} “Et erit in die hostiæ Domini: visitabo super principes et super filios regis et super omnes, qui induti sunt veste peregrina; 9\crfnmlbl{soph-9} et visitabo super omnem, qui arroganter ingreditur super limen in die illa, qui complent domum domini sui iniquitate et dolo. 10\crfnmlbl{soph-10} Et erit in die illa, dicit Dominus, vox clamoris a porta Piscium, et ululatus ab urbe Nova, et contritio magna a collibus. 11\crfnmlbl{soph-11} Ululate, habitatores Pilæ, quia interiit omnis populus Chanaan, disperierunt omnes involuti argento. 12\crfnmlbl{soph-12} Et erit in tempore illo: scrutabor Ierusalem in lucernis et visitabo super viros defixos in fæcibus suis, qui dicunt in cordibus suis: “Non faciet bene Dominus et non faciet male”. 13\crfnmlbl{soph-13} Et erunt opes eorum in direptionem, et domus eorum in desertum; et ædificabunt domos et non habitabunt, et plantabunt vineas et non bibent vinum earum”. 14\crfnmlbl{soph-14} Iuxta est dies Domini magnus, iuxta et velox nimis; vox diei Domini amara, tribulabitur ibi fortis. 15\crfnmlbl{soph-15} Dies iræ dies illa, dies tribulationis et angustiæ, dies vastitatis et desolationis, dies tenebrarum et caliginis, dies nebulæ et turbinis, 16\crfnmlbl{soph-16} dies tubæ et clangoris super civitates munitas et super angulos excelsos. 17\crfnmlbl{soph-17} Et tribulabo homines, et ambulabunt ut cæci, quia Domino peccaverunt; et effundetur sanguis eorum sicut humus, et viscera eorum sicut stercora. 18\crfnmlbl{soph-18} Sed et argentum eorum et aurum eorum non poterit liberare eos in die iræ Domini; in igne zeli eius devorabitur omnis terra, quia consummationem cum festinatione faciet cunctis habitantibus terram.
1\crfnmlbl{soph-01} Convenite, congregamini, gens non amabilis, 2\crfnmlbl{soph-02} priusquam dispergamini quasi pulvis transeuntes, antequam veniat super vos ira furoris Domini, antequam veniat super vos dies furoris Domini. 3\crfnmlbl{soph-03} Quærite Dominum, omnes mansueti terræ, qui iudicium eius estis operati; quærite iustitiam, quærite mansuetudinem, si quomodo abscondamini in die furoris Domini. 4\crfnmlbl{soph-04} Quia Gaza deserta erit, et Ascalon desolata, Azotum in meridie eicient, et Accaron eradicabitur. 5\crfnmlbl{soph-05} Væ, qui habitatis funiculum maris, gens Cretensium! Verbum Domini super vos, Chanaan, terra Philisthinorum: “Disperdam te, ita ut non sit inhabitator”. 6\crfnmlbl{soph-06} Et erit funiculus maris requies pastorum et caulæ pecorum. 7\crfnmlbl{soph-07} Et erit funiculus maris reliquiis domus Iudæ: ibi pascentur, in domibus Ascalonis ad vesperam requiescent, quia visitabit eos Dominus Deus eorum et convertet sortem eorum. 8\crfnmlbl{soph-08} “Audivi opprobrium Moab et blasphemias filiorum Ammon, qui exprobraverunt populo meo et magnificati sunt super terminos eorum. 9\crfnmlbl{soph-09} Propterea vivo ego, dicit Dominus exercituum, Deus Israel, quia Moab ut Sodoma erit, et filii Ammon quasi Gomorra, possessio spinarum et acervi salis et desertum usque in æternum; reliquiæ populi mei diripient eos, et residui gentis meæ possidebunt illos”. 10\crfnmlbl{soph-010} Hoc eis eveniet pro superbia sua, quia blasphemaverunt et magnificati sunt super populum Domini exercituum. 11\crfnmlbl{soph-011} Horribilis Dominus super eos, quia attenuabit omnes deos terræ; et adorabunt eum, singuli de loco suo, omnes insulæ gentium. 12\crfnmlbl{soph-012} “Sed et vos, Æthiopes, interfecti gladio meo eritis”. 13\crfnmlbl{soph-013} Et extendet manum suam super aquilonem et perdet Assyriam; et ponet Nineven in solitudinem et in aridam, quasi desertum. 14\crfnmlbl{soph-014} Et accubabunt in medio eius greges, omne genus animalium. Et onocrotalus et ulula in capitellis eius morabuntur; vox cantat in fenestra, corvus in limine, quoniam tabulatum cedrinum sublatum est. 15\crfnmlbl{soph-015} Hæc est civitas exsultans, habitans in confidentia, quæ dicebat in corde suo: “Ego sum, et extra me non est alia amplius!”. Quomodo facta est in desertum, cubile bestiæ? Omnis, qui transit per eam, sibilabit et movebit manum suam.
\ifcontext{\stoplinenumbering}

23
test/data-reledmac.tex Normal file
View File

@ -0,0 +1,23 @@
\section{Capitulus tertius}
\beginnumbering
\pstart 1\crfnmedlbl{vulgate-1} fuit \edtext{vir}{\Afootnote{colo B}} unus de Ramathaimsophim de monte Ephraim et nomen eius Helcana filius Hieroam filii Heliu filii Thau filii Suph Ephratheus 2\crfnmedlbl{vulgate-2} et habuit duas uxores nomen uni Anna et nomen secundae Fenenna fueruntque Fenennae filii Annae autem non erant liberi 3\crfnmedlbl{vulgate-3} et ascendebat vir ille de civitate sua statutis diebus ut adoraret et sacrificaret Domino exercituum in Silo erant autem ibi duo filii Heli Ofni et Finees sacerdotes Domini 4\crfnmedlbl{vulgate-4} venit ergo dies et immolavit Helcana deditque Fenennae uxori suae et cunctis filiis eius et filiabus partes 5\crfnmedlbl{vulgate-5} Annae autem dedit partem unam tristis quia Annam diligebat Dominus autem concluserat vulvam eius 6\crfnmedlbl{vulgate-6} adfligebat quoque eam aemula eius et vehementer angebat in tantum ut exprobraret quod conclusisset Dominus vulvam eius 7\crfnmedlbl{vulgate-7} sicque faciebat per singulos annos cum redeunte tempore ascenderent templum Domini et sic provocabat eam porro illa flebat et non capiebat cibum 8\crfnmedlbl{vulgate-8} dixit \edtext{ergo}\Afootnote{\lemma{ergo} ego B} ei Helcana vir suus Anna cur fles et quare non comedis et quam ob rem adfligitur cor tuum numquid non ego melior sum tibi quam decem filii\pend
\pstart 9\crfnmedlbl{vulgate-9} surrexit autem Anna postquam comederat in Silo et biberat et Heli sacerdote sedente super sellam ante postes templi Domini 10\crfnmedlbl{vulgate-10} cum esset amaro animo oravit Dominum flens largiter 11\crfnmedlbl{vulgate-11} et votum vovit dicens Domine exercituum si respiciens videris adflictionem famulae tuae et recordatus mei fueris nec oblitus ancillae tuae dederisque servae tuae sexum virilem dabo eum Domino omnes dies vitae eius et novacula non ascendet super caput eius 12\crfnmedlbl{vulgate-12} factum est ergo cum illa multiplicaret preces coram Domino ut Heli observaret os eius 13\crfnmedlbl{vulgate-13} porro Anna loquebatur in corde suo tantumque labia illius movebantur et vox penitus non audiebatur aestimavit igitur eam Heli temulentam 14\crfnmedlbl{vulgate-14} dixitque ei usquequo ebria eris digere paulisper vinum quo mades 15\crfnmedlbl{vulgate-15} respondens Anna nequaquam inquit domine mi nam mulier infelix nimis ego sum vinumque et omne quod inebriare potest non bibi sed effudi animam meam in conspectu Domini 16\crfnmedlbl{vulgate-16} ne reputes ancillam tuam quasi unam de filiabus Belial quia ex multitudine doloris et maeroris mei locuta sum usque in praesens 17\crfnmedlbl{vulgate-17} tunc Heli ait ei vade in pace et Deus Israhel det tibi petitionem quam rogasti eum 18\crfnmedlbl{vulgate-18} et illa dixit utinam inveniat ancilla tua gratiam in oculis tuis et abiit mulier in viam suam et comedit vultusque eius non sunt amplius in diversa mutati\pend
\pstart 19\crfnmedlbl{vulgate-19} et surrexerunt mane et adoraverunt coram Domino reversique sunt et venerunt in domum suam Ramatha cognovit autem Helcana Annam uxorem suam et recordatus est eius Dominus 20\crfnmedlbl{vulgate-20} et factum est post circulum dierum concepit Anna et peperit filium vocavitque nomen eius Samuhel eo quod a Domino postulasset eum 21\crfnmedlbl{vulgate-21} ascendit autem vir Helcana et omnis domus eius ut immolaret Domino hostiam sollemnem et votum suum 22\crfnmedlbl{vulgate-22} et Anna non ascendit dixit enim viro suo non vadam donec ablactetur infans et ducam eum et appareat ante conspectum Domini et maneat ibi iugiter 23\crfnmedlbl{vulgate-23} et ait ei Helcana vir suus fac quod bonum tibi videtur et mane donec ablactes eum precorque ut impleat Dominus verbum suum mansit ergo mulier et lactavit filium suum donec amoveret eum a lacte 24\crfnmedlbl{vulgate-24} et adduxit eum secum postquam ablactaverat in vitulis tribus et tribus modiis farinae et amphora vini et adduxit eum ad domum Domini in Silo puer autem erat adhuc infantulus 25\crfnmedlbl{vulgate-25} et immolaverunt vitulum et obtulerunt puerum Heli 26\crfnmedlbl{vulgate-26} et ait obsecro mi domine vivit anima tua domine ego sum illa mulier quae steti coram te hic orans Dominum 27\crfnmedlbl{vulgate-27} pro puero isto oravi et dedit Dominus mihi petitionem meam quam postulavi eum 28\crfnmedlbl{vulgate-28} idcirco et ego commodavi eum Domino cunctis diebus quibus fuerit accommodatus Domino et adoraverunt ibi Dominum et oravit Anna et ait\pend
\endnumbering
\section{Capitulus quartus}
\beginnumbering
\pstart 1 exultavit cor meum in Domino exaltatum est cornu meum in Domino dilatatum est os meum super inimicos meos quia laetata sum in salutari tuo 2 non est sanctus ut est Dominus neque enim est alius extra te et non est fortis sicut Deus noster 3 nolite multiplicare loqui sublimia gloriantes recedant vetera de ore vestro quoniam Deus scientiarum Dominus est et ipsi praeparantur cogitationes 4 arcus fortium superatus est et infirmi accincti sunt robore 5 saturati prius pro pane se locaverunt et famelici saturati sunt donec sterilis peperit plurimos et quae multos habebat filios infirmata est 6 Dominus mortificat et vivificat deducit ad infernum et reducit 7 Dominus pauperem facit et ditat humiliat et sublevat 8 suscitat de pulvere egenum et de stercore elevat pauperem ut sedeat cum principibus et solium gloriae teneat Domini enim sunt cardines terrae et posuit super eos orbem 9 pedes sanctorum suorum servabit et impii in tenebris conticescent quia non in fortitudine roborabitur vir 10 Dominum formidabunt adversarii eius super ipsos in caelis tonabit Dominus iudicabit fines terrae et dabit imperium regi suo et sublimabit cornu christi sui\pend
\pstart 11\crfnmedlbl{vulgate-211} et abiit Helcana Ramatha in domum suam puer autem erat minister in conspectu Domini ante faciem Heli sacerdotis 12\crfnmedlbl{vulgate-212} porro filii Heli filii Belial nescientes Dominum 13\crfnmedlbl{vulgate-213} neque officium sacerdotum ad populum sed quicumque immolasset victimam veniebat puer sacerdotis dum coquerentur carnes et habebat fuscinulam tridentem in manu sua 14\crfnmedlbl{vulgate-214} et mittebat eam in lebetem vel in caldariam aut in ollam sive in caccabum et omne quod levabat fuscinula tollebat sacerdos sibi sic faciebant universo Israheli venientium in Silo 15\crfnmedlbl{vulgate-215} etiam antequam adolerent adipem veniebat puer sacerdotis et dicebat immolanti da mihi carnem ut coquam sacerdoti non enim accipiam a te carnem coctam sed crudam 16\crfnmedlbl{vulgate-216} dicebatque illi immolans incendatur primum iuxta morem hodie adeps et tolle tibi quantumcumque desiderat anima tua qui respondens aiebat ei nequaquam nunc enim dabis alioquin tollam vi 17\crfnmedlbl{vulgate-217} erat ergo peccatum puerorum grande nimis coram Domino quia detrahebant homines sacrificio Domini 18\crfnmedlbl{vulgate-218} Samuhel autem ministrabat ante faciem Domini puer accinctus ephod lineo 19\crfnmedlbl{vulgate-219} et tunicam parvam faciebat ei mater sua quam adferebat statutis diebus ascendens cum viro suo ut immolaret hostiam sollemnem 20\crfnmedlbl{vulgate-220} et benedixit Heli Helcanae et uxori eius dixitque reddat Dominus tibi semen de muliere hac pro fenore quod commodasti Domino et abierunt in locum suum 21\crfnmedlbl{vulgate-221} visitavit ergo Dominus Annam et concepit et peperit tres filios et duas filias et magnificatus est puer Samuhel apud Dominum 22\crfnmedlbl{vulgate-222} Heli autem erat senex valde et audivit omnia quae faciebant filii sui universo Israheli et quomodo dormiebant cum mulieribus quae observabant ad ostium tabernaculi 23\crfnmedlbl{vulgate-223} et dixit eis quare facitis res huiuscemodi quas ego audio res pessimas ab omni populo 24\crfnmedlbl{vulgate-224} nolite filii mi non enim est bona fama quam ego audio ut transgredi faciatis populum Domini 25\crfnmedlbl{vulgate-225} si peccaverit vir in virum placari ei potest Deus si autem in Domino peccaverit vir quis orabit pro eo et non audierunt vocem patris sui quia voluit Dominus occidere eos 26\crfnmedlbl{vulgate-226} puer autem Samuhel proficiebat atque crescebat et placebat tam Deo quam hominibus\pend
\pstart 27\crfnmedlbl{vulgate-227} venit autem vir Dei ad Heli et ait ad eum haec dicit Dominus numquid non aperte revelatus sum domui patris tui cum essent in Aegypto in domo Pharaonis 28\crfnmedlbl{vulgate-228} et elegi eum ex omnibus tribubus Israhel mihi in sacerdotem ut ascenderet altare meum et adoleret mihi incensum et portaret ephod coram me et dedi domui patris tui omnia de sacrificiis filiorum Israhel 29\crfnmedlbl{vulgate-229} quare calce abicitis victimam meam et munera mea quae praecepi ut offerrentur in templo et magis honorasti filios tuos quam me ut comederetis primitias omnis sacrificii Israhel populi mei 30\crfnmedlbl{vulgate-230} propterea ait Dominus Deus Israhel loquens locutus sum ut domus tua et domus patris tui ministraret in conspectu meo usque in sempiternum nunc autem dicit Dominus absit hoc a me sed quicumque glorificaverit me glorificabo eum qui autem contemnunt me erunt ignobiles 31\crfnmedlbl{vulgate-231} ecce dies veniunt et praecidam brachium tuum et brachium domus patris tui ut non sit senex in domo tua 32\crfnmedlbl{vulgate-232} et videbis aemulum tuum in templo in universis prosperis Israhel et non erit senex in domo tua omnibus diebus 33\crfnmedlbl{vulgate-233} verumtamen non auferam penitus virum ex te ab altari meo sed ut deficiant oculi tui et tabescat anima tua et pars magna domus tuae morietur cum ad virilem aetatem venerit 34\crfnmedlbl{vulgate-234} hoc autem erit tibi signum quod venturum est duobus filiis tuis Ofni et Finees in die uno morientur ambo 35\crfnmedlbl{vulgate-235} et suscitabo mihi sacerdotem fidelem qui iuxta cor meum et animam meam faciat et aedificabo ei domum fidelem et ambulabit coram christo meo cunctis diebus 36\crfnmedlbl{vulgate-236} futurum est autem ut quicumque remanserit in domo tua veniat ut oretur pro eo et offerat nummum argenteum et tortam panis dicatque dimitte me obsecro ad unam partem sacerdotalem ut comedam buccellam panis\pend
\endnumbering

22
test/format-specific-defs.tex Normal file
View File

@ -0,0 +1,22 @@
\crfnm@case[\fmtname]
\crfnm@context: {
\def\crfnmlblmark[##1]{{\bf [##1]}}
\def\crfnmlbl##1{\crfnmlblmark[##1]\pagereference[##1]}
\def\crfnmfootnote[##1]##2{\footnote[##1]{\crfnmlblmark[##1]##2}}
\def\crfnmresetpage{\setnumber[userpage][1]}
\def\smaller{\setupbodyfont[script]}
\let\crfnmsc\sc
}
\crfnm@latex: {
\def\crfnmlbl##1{{\bf [##1]}\label{##1}}
\def\crfnmfootnote[##1]##2{\footnote{\crfnmlbl{##1}##2}}
\def\crfnmresetpage{\setcounter{page}{1}}
\let\smaller\footnotesize
\let\crfnmsc\scshape
}
\crfnm@endCases
\def\crfnmedlbl#1{%
{\bf [[#1]]}%
\edlabel{#1}%
}

456
test/main-test.tex Normal file
View File

@ -0,0 +1,456 @@
\input ../tex/crossrefenum
\crfnmOriginalCatcodeAt=\catcode`\@
\catcode`\@=11
\input config-formats
\input format-specific-defs
\catcode`\@=\crfnmOriginalCatcodeAt
\input config-crossrefenum
%\tracingmacros=1
%\tracingcommands=2
%\tracingoutput=2
\showboxbreadth=100
\showboxdepth=50
\def\withvisiblespace{\tt}
\long\def\iflatex#1{%
\expandafter\ifx\csname usepackage\endcsname\relax\else #1\fi
}
\long\def\ifcontext#1{%
\expandafter\ifx\csname contextformat\endcsname\relax\else #1\fi
}
% TODO : verser dans crossrefenum.tex et commenter le code dans le README
\catcode`\@=11
\ifcontext{
\def\crfnm@line{Line}
\def\crfnm@pageline{Pageline}
\crfnm@newListFrom[\crfnm@simpleRefTypes][\crfnm@line] -> \crfnm@simpleRefTypes
\crfnm@newListFrom[\crfnm@doubleRefTypes][\crfnm@pageline] -> \crfnm@doubleRefTypes
\let\crfnm@PagelinePrimary\crfnm@page
\let\crfnm@PagelineSecondary\crfnm@line
\def\crfnm@LineRef#1{\in[lr:b:#1]}
\def\crfnm@getLineNumber#1{\directlua{get_raw_ref_number('lr:b:#1', 'linenumber')}}
\def\crfnmLine{l. }
\def\crfnmLines{ll.}
\def\crfnmLineBeforeLastInSecond{, }
\def\crfnmPagelineSubtypesSep{}
\def\crfnmPagelinePrintFirstPrefix{once}
\def\crfnmLineFormatInSecond#1{\crfnmSuperscript{#1}}
\def\crfnmLinePrintPrefixInSecond{no}
}
\catcode`\@=\crfnmOriginalCatcodeAt
\parindent=0pt
\long\def\crfnmtestenum#1#2#3#4#5{%
\def\crfnmtestdesc{#1}
\def\crfnmempty{}
\ifx\crfnmtestdesc\crfnmempty\else
\vbox{%
\lineskiplimit=10000pt\lineskip=1ex
\parskip=2ex
{\it #1}
\everypar={\leftskip=1em}
\raggedright Enumeration: \crfnmTypesetEnumArg#2{crfnmEnumArgEnd}
Reference type: {\tt #3}
Expected: {\withvisiblespace [#5]}
Result: \hbox to 1.3em{}{\withvisiblespace [\crossrefenum[#3][#4]{#2}]}
}%
\vskip2.5\bigskipamount
\fi
}
\def\crfnmEnumArgEnd{crfnmEnumArgEnd}
\def\crfnmTypesetEnumArg#1{%
\def\crfnmTheArg{#1}%
\ifx\crfnmTheArg\crfnmEnumArgEnd\else
\allowbreak{\tt\detokenize{{#1}}}\expandafter\crfnmTypesetEnumArg
\fi
}
\long\def\crfnmheader#1{{\crfnmsc #1}\nobreak\vglue\baselineskip}
\def\crfnmverbatim#1#2{{\tt\detokenize{#1}}#2}
\iflatex{
\begin{document}
\begin{english}
}
\ifcontext{
\starttext
\language[en]
}
\vfill
\crfnmheader{All references point to different pages}
\crfnmtestenum{Nothing}
{}
{page}
{withprefix}
{p. }
\crfnmtestenum{One single page}
{{matthaeus-14}}
{page}
{withprefix}
{p. 2}
\crfnmtestenum{One single page without prefix}
{{matthaeus-18}}
{page}
{noprefix}
{2}
\crfnmtestenum{Two single pages}
{{matthaeus-14}{matthaeus-025}}
{page}
{withprefix}
{pp. 2 and 4}
\crfnmtestenum{Two single pages without prefix}
{{matthaeus-19}{matthaeus-0210}}
{page}
{noprefix}
{2 and 4}
\crfnmtestenum{More than two single pages}
{{matthaeus-14}{matthaeus-026}{matthaeus-0223}}
{page}
{withprefix}
{pp. 2, 4 and 6}
\crfnmtestenum{One single page again}
{{matthaeus-027}}
{page}
{withprefix}
{p. 4}
\crfnmtestenum{One range}
{{matthaeus-14 to matthaeus-23}}
{page}
{withprefix}
{pp. 2-3}
\crfnmheader{Some references point to the same page}
\crfnmtestenum{One range that returns a single page}
{{matthaeus-027 to matthaeus-029}}
{page}
{withprefix}
{p. 4}
\crfnmtestenum{Two identical pages}
{{matthaeus-026}{matthaeus-028}}
{page}
{withprefix}
{p. 4}
\crfnmtestenum{A range followed by a reference on its end page}
{{matthaeus-2 to matthaeus-15}{matthaeus-16}}
{page}
{withprefix}
{pp. 1-2}
\crfnmtestenum{Two ranges with a common boundary}
{{matthaeus-5 to matthaeus-21}{matthaeus-25 to matthaeus-0214}}
{page}
{withprefix}
{pp. 1-5}
\crfnmtestenum{Two ranges with a common boundary, the second one having boths ends on a single page}
{{matthaeus-5 to matthaeus-21}{matthaeus-25 to matthaeus-022}}
{page}
{withprefix}
{pp. 1-3}
\crfnmtestenum{A range followed by a reference to its end page and a reference to another page}
{{matthaeus-2 to matthaeus-15}{matthaeus-16}{matthaeus-0216}}
{page}
{withprefix}
{pp. 1-2 and 5}
\crfnmtestenum{A range followed by two references to its end page}
{{matthaeus-2 to matthaeus-15}{matthaeus-16}{matthaeus-18}}
{page}
{withprefix}
{pp. 1-2}
\crfnmtestenum{A range preceded by a reference to its begin page}
{{matthaeus-1}{matthaeus-2 to matthaeus-15}}
{page}
{withprefix}
{pp. 1-2}
\crfnmheader{Some references point to successive pages}
\crfnmtestenum{Successive pages forming a range}
{{matthaeus-2}{matthaeus-15}{matthaeus-22}{matthaeus-025}}
{page}
{withprefix}
{pp. 1-4}
\crfnmtestenum{A range followed by a page that extends it}
{{matthaeus-2 to matthaeus-15}{matthaeus-22}}
{page}
{withprefix}
{pp. 1-3}
\crfnmtestenum{A range preceded by a page that extends it}
{{matthaeus-1}{matthaeus-14 to matthaeus-0210}}
{page}
{withprefix}
{pp. 1-4}
\crfnmtestenum{A range extended by another range}
{{matthaeus-2 to matthaeus-15}{matthaeus-22 to matthaeus-025}}
{page}
{withprefix}
{pp. 1-4}
\crfnmheader{References to notes}
\crfnmtestenum{One note}
{{note-Aminadab-undecim}}
{note}
{withprefix}
{n. 1}
\crfnmtestenum{Two notes}
{{note-autem-non}{note-generatio-Persarum}}
{note}
{withprefix}
{nn. 2 and 4}
\crfnmtestenum{Two consecutive notes}
{{note-autem-non}{note-generationes-quis}}
{note}
{withprefix}
{nn. 2 and 3}
\crfnmtestenum{Three consecutive notes}
{{note-congregans-conteram}{note-Israhel-mittam}{note-regem-Theman}}
{note}
{withprefix}
{nn. 1, 2 and 3}
\crfnmheader{References to notes with page number}
\crfnmtestenum{One note with page number}
{{note-Babylonis-Libani}}
{pagenote}
{withprefix}
{p. 2, n. 1}
\def\crfnmPagenoteOrder{inverted}
\crfnmtestenum{Same thing, but with \crfnmverbatim{\crfnmPagenoteOrder} set to {\tt inverted}}
{{note-quaerat-clamate}}
{pagenote}
{withprefix}
{n. 3, p. 5}
\def\crfnmPagenoteOrder{normal}
\crfnmtestenum{Four notes on different pages}
{{note-Aminadab-undecim}{note-generationes-quis}{note-regem-Theman}}
{pagenote}
{withprefix}
{p. 1, n. 1, p. 2, n. 3 and p. 4, n. 3}
\def\crfnmPagenotePrintFirstPrefix{once}
\crfnmtestenum{Same thing, but with \crfnmverbatim{\crfnmPagenotePrintFirstPrefix} set to {\tt once}}
{{note-Aminadab-undecim}{note-generationes-quis}{note-regem-Theman}}
{pagenote}
{withprefix}
{pp. 1, n. 1, 2, n. 3 and 4, n. 3}
\def\crfnmPagenotePrintFirstPrefix{always}
\crfnmtestenum{Several notes on the same page}
{{note-et-et}{note-puerum-et}{note-habitavit-quae}}
{pagenote}
{withprefix}
{p. 6, nn. 1, 3 and 4}
\crfnmtestenum{Same thing, but followed by an isolated reference on another page}
{{note-somnis-hic}{note-cum-haec}{note-quaerat-clamate}}
{pagenote}
{withprefix}
{p. 3, nn. 1 and 2 and p. 5, n. 3}
\def\crfnmPagenoteOrder{inverted}
\crfnmtestenum{Same thing, but with \crfnmverbatim{\crfnmPagenoteOrder} set to {\tt inverted}}
{{note-somnis-hic}{note-cum-haec}{note-quaerat-clamate}{note-obitum-mittite}}
{pagenote}
{withprefix}
{nn. 1 and 2, p. 3 and nn. 3 and 4, p. 5}
\def\crfnmPagenoteOrder{normal}
\iflatex{
\crfnmheader{Reledmac}
\crfnmtestenum{Simple reference to a line}
{{vulgate-12}}
{edline}
{withprefix}
{l. 8}
\crfnmtestenum{Simple reference to page and line}
{{vulgate-14}}
{edpageline}
{withprefix}
{p. 8\crfnmSuperscript{12}}
\crfnmtestenum{Several lines on different pages}
{{vulgate-15}{vulgate-24}{vulgate-215}}
{edpageline}
{withprefix}
{pp. 8\crfnmSuperscript{13}, 9\crfnmSuperscript{15} and 11\crfnmSuperscript{13}}
\crfnmtestenum{A range of lines on a single page}
{{vulgate-22 to vulgate-23}}
{edpageline}
{withprefix}
{p. 9\crfnmSuperscript{9-11}}
\crfnmtestenum{A range of lines on two different pages}
{{vulgate-24 to vulgate-212}}
{edpageline}
{withprefix}
{pp. 9\crfnmSuperscript{15}-11\crfnmSuperscript{6}}
\def\crfnmEdpagelineGroupSubtypes{yes}
\crfnmtestenum{A range of lines on two different pages
with \crfnmverbatim{\crfnmEdpagelineGroupSubtypes} set to {\tt yes}}
{{vulgate-11 to vulgate-215}}
{edpageline}
{withprefix}
{pp. 8-11\crfnmSuperscript{4-13}}
\def\crfnmEdpagelineGroupSubtypes{no}
\crfnmtestenum{Two ranges of lines on the same page that should be merged}
{{vulgate-211 to vulgate-212}{vulgate-213 to vulgate-217}}
{edpageline}
{withprefix}
{p. 11\crfnmSuperscript{4-19}}
\crfnmtestenum{Two ranges of lines on the same page that should not be merged}
{{vulgate-219 to vulgate-221}{vulgate-224 to vulgate-227}}
{edpageline}
{withprefix}
{p. 12\crfnmSuperscript{1-6, 12-19}}
\crfnmtestenum{Two ranges of lines spanning across pages that should be merged}
{{vulgate-214 to vulgate-223}{vulgate-224 to vulgate-233}}
{edpageline}
{withprefix}
{pp. 11\crfnmSuperscript{10}-13\crfnmSuperscript{15}}
\crfnmtestenum{Two ranges of lines on consecutive pages,
the beginning of the second being at the same line number as the end of the first + 1.
They should not be merged, since the document is lineated per page.}
{{vulgate-2 to vulgate-6}{vulgate-14 to vulgate-18}}
{edpageline}
{withprefix}
{pp. 7\crfnmSuperscript{3-11} and 8\crfnmSuperscript{12-20}}
\def\crfnmEdlineNumberingContinuousAcrossDocument{yes}
\crfnmtestenum{Same as the above, but with
\crfnmverbatim{\crfnmEdlineNumberingContinuousAcrossDocument} set to {\tt yes}.
We make {\em crossrefenum} believe that the first range ends at the end of a page
and the second begins at the first line of the following page.}
{{vulgate-2 to vulgate-6}{vulgate-14 to vulgate-18}}
{edpageline}
{withprefix}
{pp. 7\crfnmSuperscript{3}-8\crfnmSuperscript{20}}
\def\crfnmEdlineNumberingContinuousAcrossDocument{no}
\crfnmtestenum{A range of lines whose page boundaries are identical to those of the preceding and following references}
{{vulgate-3}{vulgate-7 to vulgate-20}{vulgate-25}}
{edpageline}
{withprefix}
{pp. 7\crfnmSuperscript{5}, 7\crfnmSuperscript{13}-9\crfnmSuperscript{5} and 9\crfnmSuperscript{17}}
}
\ifcontext{
\crfnmheader{References to lines}
{See the tests on reledmac in the file produced by LaTeX for a more extensive coverage.}\vskip\baselineskip
\crfnmtestenum{Simple reference to a line}
{{soph-2}}
{line}
{withprefix}
{l. 3}
\crfnmtestenum{Simple reference to page and line}
{{soph-5}}
{pageline}
{withprefix}
{p. 7\crfnmSuperscript{9}}
\crfnmtestenum{Several lines on different pages}
{{soph-7}{soph-13}{soph-012}}
{pageline}
{withprefix}
{pp. 7\crfnmSuperscript{12}, 8\crfnmSuperscript{5} and 10\crfnmSuperscript{3}}
\crfnmtestenum{A range of lines on a single page}
{{soph-04 to soph-06}}
{pageline}
{withprefix}
{p. 9\crfnmSuperscript{5-9}}
\crfnmtestenum{A range of lines on two different pages}
{{soph-14 to soph-014}}
{pageline}
{withprefix}
{pp. 8\crfnmSuperscript{8}-10\crfnmSuperscript{6}}
\crfnmtestenum{}
{}
{}
{}
{}
\crfnmtestenum{}
{}
{}
{}
{}
}
\iflatex{\end{english}}
\ifcontext{
\language[latin]
\setupinterlinespace[big]
}
\vfill\penalty-10000
\crfnmresetpage
\input data-common
\iflatex{\input data-reledmac}
\input data-lines
\ifcontext{\stoptext}
\iflatex{
\def\crfnmtheend{\end{document}}
\expandafter\crfnmtheend
}

1229
test/validated-output Normal file
View File

File diff suppressed because it is too large Load Diff

3
tex/crossrefenum.sty Normal file
View File

@ -0,0 +1,3 @@
\input crossrefenum.tex
\ProvidesPackage{crossrefenum}[\crfnmDate{} v\crfnmVersion{} Enumeration of cross-references]
\endinput

1497
tex/crossrefenum.tex Normal file
View File

File diff suppressed because it is too large Load Diff

18
tex/t-crossrefenum.tex Normal file
View File

@ -0,0 +1,18 @@
%D \module
%D [ file=t-crossrefenum,
%D version=1.0, % May differ from crossrefenum.tex
%D title=\CONTEXT\ module for crossrefenum,
%D subtitle=Smart typesetting of enumerated cross-references for various TeX formats,
%D author=Bastien Dumont,
%D date=2022/11/11,
%D url=%TODO,
%D copyright=Bastien Dumont,
%D license=GNU Public License v. 3.0 or higher]
\startmodule[crossrefenum]
\unprotect
\input ../crossrefenum.tex
\protect
\stopmodule