branch: externals/denote-sequence
commit ac0e3095fae0af54e0e1453c08b0b46e4522d671
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
WORK-IN-PROGRESS Move denote-sequence.el into its own Git repository
---
.gitignore | 5 +
COPYING | 674 +++++++++++++++++++++++++++
README.org | 889 ++++++++++++++++++++++++++++++++++++
denote-sequence.el | 1011 +++++++++++++++++++++++++++++++++++++++++
tests/denote-sequence-test.el | 247 ++++++++++
5 files changed, 2826 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..874ad7b128
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+*.elc
+*-autoloads.el
+*-pkg.el
+denote-sequence.info
+denote-sequence.texi
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000000..d5a2539069
--- /dev/null
+++ b/COPYING
@@ -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) 2025 Protesilaos Stavrou
+
+ 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) 2025 Protesilaos Stavrou
+ 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>.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..b080afff2e
--- /dev/null
+++ b/README.org
@@ -0,0 +1,889 @@
+#+title: denote-sequence: Sequence notes or Folgezettel with Denote
+#+author: Protesilaos Stavrou
+#+email: i...@protesilaos.com
+#+language: en
+#+options: ':t toc:nil author:t email:t num:t
+#+startup: content
+#+macro: stable-version 0.0.0
+#+macro: release-date N/A
+#+macro: development-version 0.1.0-dev
+#+export_file_name: denote-sequence.texi
+#+texinfo_filename: denote-sequence.info
+#+texinfo_dir_category: Emacs misc features
+#+texinfo_dir_title: Denote: (denote)
+#+texinfo_dir_desc: Sequence notes or Folgezettel with Denote
+#+texinfo_header: @set MAINTAINERSITE @uref{https://protesilaos.com,maintainer
webpage}
+#+texinfo_header: @set MAINTAINER Protesilaos Stavrou
+#+texinfo_header: @set MAINTAINEREMAIL @email{i...@protesilaos.com}
+#+texinfo_header: @set MAINTAINERCONTACT
@uref{mailto:i...@protesilaos.com,contact the maintainer}
+
+#+texinfo: @insertcopying
+
+WORK-IN-PROGRESS. Not all links may work and I will update things as
+part of {{{development-version}}}.
+
+This manual, written by Protesilaos Stavrou, describes the customization
+options for the Emacs package called ~denote~ (or =denote.el=), and
+provides every other piece of information pertinent to it.
+
+The documentation furnished herein corresponds to stable version
+{{{stable-version}}}, released on {{{release-date}}}. Any reference to
+a newer feature which does not yet form part of the latest tagged
+commit, is explicitly marked as such.
+
+Current development target is {{{development-version}}}.
+
++ Package name (GNU ELPA): ~denote-sequence~
++ Official manual: <https://protesilaos.com/emacs/denote-sequence>
++ Git repository: <https://github.com/protesilaos/denote-sequence>
++ Backronym: Denote... Sequences Efficiently Queue Unsorted Entries
+ Notwithstanding Curation Efforts.
+
+If you are viewing the README.org version of this file, please note that
+the GNU ELPA machinery automatically generates an Info manual out of it.
+
+#+toc: headlines 8 insert TOC here, with eight headline levels
+
+* COPYING
+:PROPERTIES:
+:COPYING: t
+:CUSTOM_ID: h:copying
+:END:
+
+Copyright (C) 2022-2025 Free Software Foundation, Inc.
+
+#+begin_quote
+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, with the Front-Cover Texts being “A GNU Manual,” and
+with the Back-Cover Texts as in (a) below. A copy of the license is
+included in the section entitled “GNU Free Documentation License.”
+
+(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
+modify this GNU manual.”
+#+end_quote
+
+* Write sequence notes or "folgezettel"
+:PROPERTIES:
+:CUSTOM_ID: h:write-sequence-notes-or-folgezettel
+:ALT_TITLE: Sequence notes
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+This section is about the optional extension =denote-sequence.el=,
+which is part of the ~denote~ package. Its commands are autoloaded, so
+they are avaialble in the =M-x= interface at the outset and will load
+their file when they are invoked. Though users can explicitly load
+the file on demand with:
+
+#+begin_src emacs-lisp
+(require 'denote-sequence)
+#+end_src
+
+Denote defines an optional file name component called the =SIGNATURE=
+([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The file-naming scheme]]). This is
a free form field that users can
+fill in with whatever text they want, such as to have a video split up
+into =part1= and =part2=, or to set some kind of priority like =a= and
+=b=, or even to have a special tag that stands out from the rest of
+the keywords.
+
+A more specialised use-case of the =SIGNATURE= is to define a
+hierarchical relationship between notes, such that the thoughts they
+expound on form sequences. For example, an article about the Labrador
+Retriever dog breed is a continuation of a thought process that
+extends something about dog breeds in general which, in turn, is a
+topic that belongs to the wider theme of dogs. A sequence, then, is a
+representation of such relationships. A note with a =SIGNATURE= of
+~1=1~ (the ~=~ is the field separator of signatures, per the Denote
+file-naming scheme) is thus the first child of note =1= and the
+sibling of note ~1=2~. In this regard, something unrelated to dogs
+will be its own parent, such as =2=, and so on.
+
+All the relevant functions we provide take care to automatically use
+the right number for a given sequence
([[#h:6293ec17-05ef-4e41-9ae3-25df2ad86303][Create parent, child, or sibling
sequence notes]]).
+If, for example, we create a new child of parent ~1=1~, we make sure
+that it is the largest number among any existing children, so if
+~1=1=1~ already exists we use ~1=1=2~, and the like.
+
+The =denote-sequence.el= optional extension is not necessary for such
+a workflow. Users can always define whatever =SIGNATURE= they want
+manually. The purpose of this extension is to streamline this work.
+
+** Select a sequencing scheme for ~denote-sequence-scheme~
+:PROPERTIES:
+:CUSTOM_ID: h:select-a-sequencing-scheme-for-denote-sequence-scheme
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+#+vindex: denote-sequence-scheme
+The user option ~denote-sequence-scheme~ allows users to select either
+the =numeric= scheme, which is like ~1=1=2~ or the =alphanumeric=
+scheme, which is =1a2= for the same sequence
([[#h:373710df-a62e-4400-961c-87fac019b0a0][Convert from one sequencing scheme
to another]]):
+
+- Numeric sequencing scheme :: A numeric sequence consists only of
+ numbers. The level of depth is derived from the number of fields in
+ the sequence, separated by the equals sign. Thus, the sequence
+ ~1=1=2~ consists of three levels of depth. For deeper sequences, the
+ numeric scheme will get longer, which some users may consider
+ unwieldy. The upside, however, is that is easier to reason about
+ larger numbers, such as ~1=100=2=50~.
+
+- Alphanumeric sequencing scheme :: An alphanumeric sequence combines
+ numbers and letters. The level of depth is undestand by the
+ alteration from numbers to letters and vice versa. As such, the
+ sequence =1a2= has three levels of depth. This scheme is more
+ compact, which users may like but can be harder to reason about
+ large numbers, such as =1zzzv2zx= corresponding to the numeric
+ ~1=100=2=50~ (this is because the number 26 is z, 27 is za, 52 is
+ zz, and so on). In practice, large numbers may not be a problem,
+ though this is something to keep in mind.
+
+*** Convert from one sequencing scheme to another
+:PROPERTIES:
+:CUSTOM_ID: h:convert-from-one-sequencing-scheme-to-another
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+The decision on the desired ~denote-sequence-scheme~ wil affect new
+notes long-term ([[#h:8c682f08-f162-4ddd-be03-805e87737d55][Select a
sequencing scheme for ~denote-sequence-scheme~]]).
+It thus is important to think through your needs and proceed accordingly.
+
+#+findex: denote-sequence-convert
+Still, one cannot be sure which scheme they prefer until they
+experiment with it. It then is inconvenient to manually revert to the
+alternative scheme. To this end, we provide the command
+~denote-sequence-convert~. It convers one or more files from their
+current scheme to its counterpart.
+
+When called from inside a Denote file, it converts that file. When
+called from a Dired buffer, it operates on the marked files. If no
+files are marked, it works with the Dired file at point.
+
+Note that ~denote-sequence-convert~ DOES NOT REPARENT OR ANYHOW CHECK
+THE RESULTING SEQUENCES FOR DUPLICATES
([[#h:98eb8ee5-93c4-49ba-9092-65a3b61c69c6][Re-parent a file to extend a given
sequence]]).
+
+** Create parent, child, or sibling sequence notes
+:PROPERTIES:
+:CUSTOM_ID: h:create-parent-child-or-sibling-sequence-notes
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+[ In the interest of simplicity, here we provide examples using the
+ =numeric= value of ~denote-sequence-scheme~, though the =alphanumeric=
+ will work as well ([[#h:8c682f08-f162-4ddd-be03-805e87737d55][Select a
sequencing scheme for ~denote-sequence-scheme~]]). ]
+
+A new sequence note can be of the type =parent=, =child=, and
+=sibling=. For the convenience of the user, we provide commands to
+create such "sequence notes", link only between them (as opposed to
+a link to any other file with the Denote file-naming scheme
([[#h:fc913d54-26c8-4c41-be86-999839e8ad31][Linking notes]])), and
+re-parent them on demand.
+
+Concretely, we provide the following commands:
+
+#+findex: denote-sequence
+- ~denote-sequence~ :: The most general way to create a new sequence
+ note. It prompts for a type of sequence among =parent=, =child=, and
+ =sibling= and the rest of the work accordingly. If the new sequence
+ is not a parent, it thus prompts for an existing file to extend
+ from. The rest of the interaction is that of all the usual Denote
+ commands, such as to prompt for a title and keywords
([[#h:17896c8c-d97a-4faa-abf6-31df99746ca6][Points of entry]]).
+
+#+findex: denote-sequence-new-parent
+- ~denote-sequence-new-parent~ :: This is a convenience wrapper of
+ ~denote-sequence~ which directly creates a parent sequence.
+
+#+findex: denote-sequence-new-child
+- ~denote-sequence-new-child~ :: This is a convenience wrapper of
+ ~denote-sequence~ which directly creates a child of an existing
+ sequence, prompting for it using minibuffer completion.
+
+#+findex: denote-sequence-new-child-of-current
+- ~denote-sequence-new-child-of-current~ :: This will create a new
+ child of the current file's sequence. If the current file does not
+ have such a sequence, then the command behaves the same as the
+ aforementioned ~denote-sequence-new-child~.
+
+#+findex: denote-sequence-new-sibling
+- ~denote-sequence-new-sibling~ :: This is a convenience wrapper of
+ ~denote-sequence~ which directly creates a sibling of an existing
+ sequence, prompting for it using minibuffer completion.
+
+#+findex: denote-sequence-new-sibling-of-current
+- ~denote-sequence-new-sibling-of-current~ :: This will create a new
+ sibling of the current file's sequence. If the current file does not
+ have such a sequence, then the command behaves the same as the
+ aforementioned ~denote-sequence-new-sibling~.
+
+** Find a relative of the current sequence
+:PROPERTIES:
+:CUSTOM_ID: h:find-a-relative-of-the-current-sequence
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+#+findex: denote-sequence-find
+While reading a file with a sequence, you may want to find what its
+relatives are about. To this end, the command ~denote-sequence-find~
+prompts for a type among =parent=, =sibling=, =child=, and then asks
+to select a file among those matching the given type. It then visits
+the file.
+
+#+findex: denote-sequence-find-dired
+Instead of selecting a single file, the command ~denote-sequence-find-dired~
+puts all the matching files in a bespoke Dired buffer
([[#h:7811300e-5758-4b86-89bf-1d904bf1598a][Show all or some sequences in a
Dired buffer]]).
+
+** Link only to sequences
+:PROPERTIES:
+:CUSTOM_ID: h:link-only-to-sequences
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+#+findex: denote-sequence-link
+The command ~denote-sequence-link~ is a variant of the standard
+~denote-link~ command which limits the list of files only to those
+which contain a sequence ([[#h:fc913d54-26c8-4c41-be86-999839e8ad31][Linking
notes]]). Consider it a convenience to
+link to sequence notes more quickly. It is by no means necessary
+though, as the regular linking commands will work as expected with any
+Denote file, including those which contain a sequence as their file
+name =SIGNATURE= ([[#h:d5ca722d-e7fa-46fa-9a57-6363b1d4186f][Write sequence
notes or "folgezettel"]]).
+
+** Re-parent a file to extend a given sequence
+:PROPERTIES:
+:CUSTOM_ID: h:re-parent-a-file-to-extend-a-given-sequence
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+#+findex: denote-sequence-reparent
+The command ~denote-sequence-reparent~ can be used from inside a file
+or for the file-at-point in Dired to make that file a child of a given
+sequence. It does so by prompting for the target file using minibuffer
+completion. Files available at this prompt are only those which
+contain a sequence as their file name =SIGNATURE=
([[#h:d5ca722d-e7fa-46fa-9a57-6363b1d4186f][Write sequence notes or
"folgezettel"]]).
+
+** Show all or some sequences in a Dired buffer
+:PROPERTIES:
+:CUSTOM_ID: h:show-all-or-some-sequences-in-a-dired-buffer
+:END:
+:PROPERTIES:
+
+:END:
+
+[ The =denote-sequence.el= is part of {{{development-version}}}. ]
+
+[ In the interest of simplicity, here we provide examples using the
+ =numeric= value of ~denote-sequence-scheme~, though the =alphanumeric=
+ will work as well ([[#h:8c682f08-f162-4ddd-be03-805e87737d55][Select a
sequencing scheme for ~denote-sequence-scheme~]]). ]
+
+#+findex: denote-sequence-dired
+The command ~denote-sequence-dired~ produces a bespoke and fully
+fledged Dired buffers that contains all the sequences in their order
+(as opposed to a regular Dired which sorts files using the =ls=
+flags).
+
+With an optional =C-u= prefix argument, this command prompts for a
+prefix to only show sequences that include it (e.g. only show notes
+with ~1=1~, like ~1=1=1~ and ~1=1=2~ but not ~1=2~).
+
+With an optional double prefix argument of =C-u C-u=, this command
+will prompt for the prefix as well as the level of depth to limit the
+results to. Here "depth" means how deep to go in a sequence where, for
+example, ~1=1=2~ is three levels of depth. It is possible to use an
+empty string at the prefix prompt to not limit the results to any
+prefix.
+
+A more specialised alternative for only relatives of a given sequence
+is also available ([[#h:8ec774f4-4154-4599-b8cf-fa767e18d22d][Find a relative
of the current sequence]]).
+
+* Installation
+:PROPERTIES:
+:CUSTOM_ID: h:installation
+:END:
+#+cindex: Installation instructions
+
+** GNU ELPA package
+:PROPERTIES:
+:CUSTOM_ID: h:gnu-elpa-package
+:END:
+
+The package is available as =denote-sequence=. Simply do:
+
+: M-x package-refresh-contents
+: M-x package-install
+
+And search for it.
+
+GNU ELPA provides the latest stable release. Those who prefer to follow
+the development process in order to report bugs or suggest changes, can
+use the version of the package from the GNU-devel ELPA archive. Read:
+https://protesilaos.com/codelog/2022-05-13-emacs-elpa-devel/.
+
+** Manual installation
+:PROPERTIES:
+:CUSTOM_ID: h:manual-installation
+:END:
+:PROPERTIES:
+
+:END:
+
+Assuming your Emacs files are found in =~/.emacs.d/=, execute the
+following commands in a shell prompt:
+
+#+begin_src sh
+cd ~/.emacs.d
+
+# Create a directory for manually-installed packages
+mkdir manual-packages
+
+# Go to the new directory
+cd manual-packages
+
+# Clone this repo, naming it "denote-sequence"
+git clone https://github.com/protesilaos/denote-sequence denote-sequence
+#+end_src
+
+Finally, in your =init.el= (or equivalent) evaluate this:
+
+#+begin_src emacs-lisp
+;; Make Elisp files in that directory available to the user.
+(add-to-list 'load-path "~/.emacs.d/manual-packages/denote-sequence")
+#+end_src
+
+Everything is in place to set up the package.
+
+* Sample configuration
+:PROPERTIES:
+:CUSTOM_ID: h:sample-configuration
+:END:
+#+cindex: Package configuration
+
+NOT AVAILABLE YET as part of {{{development-version}}}.
+
+* Acknowledgements
+:PROPERTIES:
+:CUSTOM_ID: h:acknowledgements
+:END:
+#+cindex: Contributors
+
+Denote Sequence is meant to be a collective effort. Every bit of help matters.
+
++ Author/maintainer :: Protesilaos Stavrou.
+
++ Contributions to code or the manual :: Claudio Migliorelli, Kierin Bell.
+
++ Ideas and/or user feedback :: Mirko Hernandez.
+
+* GNU Free Documentation License
+:PROPERTIES:
+:APPENDIX: t
+:CUSTOM_ID: h:gnu-free-documentation-license
+:END:
+
+#+texinfo: @include doclicense.texi
+
+#+begin_export html
+<pre>
+
+ 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.
+</pre>
+#+end_export
+
+#+html: <!--
+
+* Indices
+:PROPERTIES:
+:CUSTOM_ID: h:indices
+:END:
+
+** Function index
+:PROPERTIES:
+:INDEX: fn
+:CUSTOM_ID: h:function-index
+:END:
+
+** Variable index
+:PROPERTIES:
+:INDEX: vr
+:CUSTOM_ID: h:variable-index
+:END:
+
+** Concept index
+:PROPERTIES:
+:INDEX: cp
+:CUSTOM_ID: h:concept-index
+:END:
+
+#+html: -->
diff --git a/denote-sequence.el b/denote-sequence.el
new file mode 100644
index 0000000000..3afab1093d
--- /dev/null
+++ b/denote-sequence.el
@@ -0,0 +1,1011 @@
+;;; denote-sequence.el --- Sequence notes or Folgezettel with Denote -*-
lexical-binding: t -*-
+
+;; Copyright (C) 2024-2025 Free Software Foundation, Inc.
+
+;; Author: Protesilaos Stavrou <i...@protesilaos.com>
+;; Maintainer: Protesilaos Stavrou <i...@protesilaos.com>
+;; URL: https://github.com/protesilaos/denote-sequence
+;; Version: 0.0.0
+;; Package-Requires: ((emacs "28.1") (denote "3.1.0"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; 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/>.
+
+;;; Commentary:
+
+;; Sequence notes extension for Denote. It uses the SIGNATURE file
+;; name component of Denote to establish a hierarchy between notes.
+;; As such, with the default numeric `denote-sequence-scheme', note
+;; 1=1=2 is the second child of the first child of note 1. While with
+;; the alphanumeric scheme, note 1a2 is the equivalent. The rest of
+;; the Denote file naming scheme continues to apply as described in
+;; the manual, as do all the other features of Denote.
+;;
+;; A new sequence note can be of the type `parent', `child', and
+;; `sibling'. For the convenience of the user, we provide commands to
+;; create such "sequence notes", link only between them (as opposed to
+;; a link to any other file with the Denote file-naminng scheme), and
+;; re-parent them on demand, as well as display them in a Dired buffer
+;; in accordance with their inherent order.
+;;
+;; All the relevant functions we provide take care to automatically
+;; use the right number for a given sequence, per the user option
+;; `denote-sequence-scheme'. If, for example, we create a new child
+;; for parent 1=1, we make sure that it is the new largest number
+;; among any existing children, so if 1=1=1 already exists we use
+;; 1=1=2, and so on.
+;;
+;; This optional extension is not necessary for such a workflow.
+;; Users can always define whatever SIGNATURE they want manually. The
+;; purpose of this extension is to streamline that work.
+
+;;; Code:
+
+;; TODO 2025-01-08: Test whether the built-in hierarchy.el can be used
+;; to present the sequences in a nice way. What do we need and how
+;; exactly do we use that library.
+(require 'denote)
+
+(defgroup denote-sequence ()
+ "Sequence notes or Folgezettel with Denote."
+ :group 'denote
+ :link '(info-link "(denote-sequence) top")
+ :link '(url-link :tag "Denote homepage"
"https://protesilaos.com/emacs/denote";)
+ :link '(url-link :tag "Denote Sequence homepage"
"https://protesilaos.com/emacs/denote-sequence";))
+
+(defcustom denote-sequence-scheme 'numeric
+ "Sequencing scheme to establish file hierarchies.
+The value is the symbol `numeric' or `alphanumeric'.
+
+Numeric sequences (the default) are the easier to understand but also
+are the longest. Each level of depth in the hierarchy is delimited by
+an equals sign: the 1=1=2 thus refers to the second child of the first
+child of parent 1. Each level of depth can be a number of any length,
+like 1=40=2=20.
+
+Alphanumeric sequences are more compact than numeric ones. Their depth
+is derived via the alternation from numbers to latin characters, such
+that 1a2 refers to the second child of the first child of parent 1.
+Because they alternate between numbers and letters, they do not use the
+equals sign. When a number cannot be represented by a single letter,
+two or more are used instead, such as the number 51 corresponding to
+zx (z is 26 and x is 25)."
+ :group 'denote-sequence
+ :type '(choice (const :tag "Numeric like 1=1=2" numeric)
+ (const :tag "Alphanumeric like 1a2" alphanumeric)))
+
+(defconst denote-sequence-numeric-regexp "=?[0-9]+"
+ "Pattern of a numeric sequence.")
+
+(defconst denote-sequence-alphanumeric-regexp "\\([0-9]+\\)\\([[:alpha:]]+\\)?"
+ "Pattern of an alphanumeric sequence.")
+
+(defconst denote-sequence-types '(parent child sibling)
+ "Types of sequence.")
+
+(defun denote-sequence-numeric-p (sequence)
+ "Return SEQUENCE if it is numeric per `denote-sequence-scheme'."
+ (when (and (string-match-p denote-sequence-numeric-regexp sequence)
+ (not (string-match-p "[[:alpha:]]" sequence))
+ (not (string-suffix-p "=" sequence)))
+ sequence))
+
+(defun denote-sequence-alphanumeric-p (sequence)
+ "Return SEQUENCE if it is alphanumeric per `denote-sequence-scheme'."
+ (when (and (string-match-p denote-sequence-alphanumeric-regexp sequence)
+ (string-match-p "\\`[0-9]+" sequence)
+ (not (string-match-p "=" sequence)))
+ sequence))
+
+(defun denote-sequence-p (sequence)
+ "Return SEQUENCE string is of a supported scheme.
+Also see `denote-sequence-numeric-p' and `denote-sequence-alphanumeric-p'."
+ (when (or (denote-sequence-numeric-p sequence)
+ (denote-sequence-alphanumeric-p sequence))
+ sequence))
+
+(defun denote-sequence-with-error-p (sequence)
+ "Return SEQUENCE string if it matches `denote-sequence-numeric-regexp'."
+ (or (denote-sequence-p sequence)
+ (error "The sequence `%s' does not pass `denote-sequence-p'" sequence)))
+
+(defun denote-sequence--numeric-partial-p (string)
+ "Return non-nil if STRING likely is part of a numeric sequence."
+ (and (string-match-p "[0-9]+" string)
+ (not (string-match-p "[[:alpha:][:punct:]]" string))))
+
+(defun denote-sequence--alphanumeric-partial-p (string)
+ "Return non-nil if STRING likely is part of an alphanumeric sequence."
+ (and (string-match-p "[[:alpha:]]+" string)
+ (not (string-match-p "[0-9[:punct:]]+" string))))
+
+(defun denote-sequence-and-scheme-p (sequence &optional partial)
+ "Return the sequencing scheme of SEQUENCE, per `denote-sequence-scheme'.
+Return a cons cell of the form (sequence . scheme), where the `car' is
+SEQUENCE and the `cdr' is its sequencing scheme as a symbol among those
+mentioned in `denote-sequence-scheme'.
+
+With optional PARTIAL as a non-nil value, assume SEQUENCE to be a string
+that only represents part of a sequence, which itself consists entirely
+of numbers or letters.
+
+Produce an error if the sequencing scheme cannot be established."
+ (cond
+ ((or (and partial (denote-sequence--alphanumeric-partial-p sequence))
+ (denote-sequence-alphanumeric-p sequence))
+ (cons sequence 'alphanumeric))
+ ((or (and partial (denote-sequence--numeric-partial-p sequence))
+ (denote-sequence-numeric-p sequence))
+ (cons sequence 'numeric))
+ (t (error "The sequence `%s' does not pass `denote-sequence-p'" sequence))))
+
+(defun denote-sequence--scheme-of-strings (strings)
+ "Return the sequencing scheme of STRINGS, per `denote-sequence-scheme'."
+ (if (seq-find (lambda (string) (string-match-p "[[:alpha:]]" string))
strings)
+ 'alphanumeric
+ 'numeric))
+
+(defun denote-sequence-file-p (file)
+ "Return the sequence if Denote signature of FILE is a sequence.
+A sequence is string that conforms with `denote-sequence-p'."
+ (when-let* ((signature (denote-retrieve-filename-signature file)))
+ (denote-sequence-p signature)))
+
+(defun denote-sequence-join (strings scheme)
+ "Join STRINGS to form a sequence according to SCHEME.
+SCHEME is a symbol among those mentioned in `denote-sequence-scheme'.
+Return resulting sequence if it conforms with `denote-sequence-p'."
+ (pcase scheme
+ ('numeric (mapconcat #'identity strings "="))
+ ('alphanumeric (apply #'concat strings))))
+
+(defun denote-sequence-split (sequence &optional partial)
+ "Split the SEQUENCE string into a list.
+SEQUENCE conforms with `denote-sequence-p'. If PARTIAL is non-nil, it
+has the same meaning as in `denote-sequence-and-scheme-p'."
+ (pcase-let* ((`(,sequence . ,scheme) (denote-sequence-and-scheme-p sequence
partial)))
+ (pcase scheme
+ ('numeric
+ (split-string sequence "=" t))
+ ('alphanumeric
+ (let ((strings nil)
+ (start 0))
+ (while (string-match denote-sequence-alphanumeric-regexp sequence
start)
+ (push (match-string 1 sequence) strings)
+ (when-let* ((two (match-string 2 sequence)))
+ (push two strings)
+ (setq start (match-end 2)))
+ (setq start (match-end 1)))
+ (if strings
+ (nreverse strings)
+ (split-string sequence "" :omit-nulls)))))))
+
+(defun denote-sequence--alpha-to-number (string)
+ "Convert STRING of alphabetic characters to its numeric equivalent."
+ (let* ((strings (denote-sequence-split string :partial))
+ (numbers (mapcar
+ (lambda (string)
+ (let ((num (- (string-to-char string) 96)))
+ (cond
+ ((and (> num 0) (<= num 26))
+ num)
+ (t
+ (let ((times (/ num 26)))
+ (if-let* ((mod (% num 26))
+ ((> mod 0))
+ (suffix (+ mod 96)))
+ (list (* times 26) suffix)
+ (list (* times 26))))))))
+ strings)))
+ (format "%s" (apply #'+ numbers))))
+
+(defun denote-sequence--number-to-alpha (string)
+ "Convert STRING of numbers to its alphabetic equivalent."
+ (let ((num (string-to-number string)))
+ (cond
+ ((= num 0)
+ (char-to-string (+ num 97)))
+ ((and (> num 0) (<= num 26))
+ (char-to-string (+ num 96)))
+ (t
+ (let ((times (/ num 26)))
+ (if-let* ((mod (% num 26))
+ ((> mod 0))
+ (prefix (make-string times ?z))
+ (suffix (char-to-string (+ mod 96))))
+ (concat prefix suffix)
+ (make-string times ?z)))))))
+
+(defun denote-sequence--alpha-to-number-complete (sequence)
+ "Like `denote-sequence--alpha-to-number' but for the complete SEQUENCE."
+ (if (denote-sequence-numeric-p sequence)
+ sequence
+ (let* ((parts (denote-sequence-split sequence))
+ (converted-parts (mapcar
+ (lambda (string)
+ (if (denote-sequence--numeric-partial-p string)
+ string
+ (denote-sequence--alpha-to-number string)))
+ parts)))
+ (denote-sequence-join converted-parts 'numeric))))
+
+(defun denote-sequence--number-to-alpha-complete (sequence)
+ "Like `denote-sequence--number-to-alpha' but for the complete SEQUENCE."
+ (if (denote-sequence-alphanumeric-p sequence)
+ sequence
+ (let* ((parts (denote-sequence-split sequence))
+ (odd-is-numeric 0)
+ (converted-parts (mapcar
+ (lambda (string)
+ (setq odd-is-numeric (+ odd-is-numeric 1))
+ (cond
+ ((= (% odd-is-numeric 2) 1)
+ string)
+ ((denote-sequence--alphanumeric-partial-p
string)
+ string)
+ (t
+ (denote-sequence--number-to-alpha string))))
+ parts)))
+ (denote-sequence-join converted-parts 'alphanumeric))))
+
+(defun denote-sequence-make-conversion (string &optional string-is-sequence)
+ "Convert STRING to its counterpart sequencing scheme.
+If STRING-IS-SEQUENCE then assume STRING to be a complete sequence, in
+which case convert the entirety of it. Also see `denote-sequence-scheme'."
+ (cond
+ ((and string-is-sequence (denote-sequence-alphanumeric-p string))
+ (denote-sequence--alpha-to-number-complete string))
+ ((and string-is-sequence (denote-sequence-numeric-p string))
+ (denote-sequence--number-to-alpha-complete string))
+ ((denote-sequence--alphanumeric-partial-p string)
+ (denote-sequence--alpha-to-number string))
+ ((denote-sequence--numeric-partial-p string)
+ (denote-sequence--number-to-alpha string))
+ (t
+ (if string-is-sequence
+ (error "String `%s' did not pass `denote-sequence-p'" string)
+ (error "The `%s' must not contain both numbers and letters" string)))))
+
+(defun denote-sequence-increment (string)
+ "Increment number represented by STRING and return it as a string.
+STRING is part of a sequence, not the entirety of it."
+ (cond
+ ((denote-sequence--numeric-partial-p string)
+ (number-to-string (+ (string-to-number string) 1)))
+ ((denote-sequence--alphanumeric-partial-p string)
+ (let* ((letters (split-string string "" :omit-nulls))
+ (length-1 (= (length letters) 1))
+ (first (car letters))
+ (reverse (nreverse (copy-sequence letters)))
+ (last (car reverse)))
+ (cond
+ ((and length-1 (string= "z" first))
+ "za")
+ (length-1
+ (char-to-string (+ (string-to-char first) 1)))
+ ((string= "z" last)
+ (apply #'concat (append letters (list "a"))))
+ (t
+ (let ((last last))
+ (apply #'concat
+ (append (butlast letters)
+ (list (char-to-string (+ (string-to-char last)
1))))))))))
+ (t
+ (error "The string `%s' must contain only numbers or letters" string))))
+
+(defun denote-sequence-depth (sequence)
+ "Get the depth of SEQUENCE.
+For example, 1=2=1 and 1b1 are three levels of depth."
+ (length (denote-sequence-split sequence)))
+
+(defun denote-sequence--children-implied-p (sequence)
+ "Return non-nil if SEQUENCE implies children.
+This does not actually check if there are children in the variable
+`denote-directory', but only that SEQUENCE is greater than 1."
+ (> (denote-sequence-depth sequence) 1))
+
+(defun denote-sequence--get-parent (sequence)
+ "Return implied parent of SEQUENCE, else nil.
+Produce an error if SEQUENCE does not conform with `denote-sequence-p'.
+The implied check here has the same meaning as described in
+`denote-sequence--children-implied-p'."
+ (pcase-let* ((`(,sequence . ,scheme) (denote-sequence-and-scheme-p
sequence)))
+ (when (and (denote-sequence-with-error-p sequence)
+ (denote-sequence--children-implied-p sequence))
+ (let ((strings (thread-last
+ (denote-sequence-split sequence)
+ (butlast))))
+ (denote-sequence-join strings scheme)))))
+
+(defun denote-sequence--get-files (&optional files)
+ "Return list of files or buffers in the variable `denote-directory'.
+With optional FILES only consider those, otherwise use
`denote-directory-files'."
+ (delete-dups (append (denote--buffer-file-names) (or files
(denote-directory-files)))))
+
+(defun denote-sequence-get-all-files (&optional files)
+ "Return all files in variable `denote-directory' with a sequence.
+A sequence is a Denote signature that conforms with `denote-sequence-p'.
+
+With optional FILES consider only those, otherwise use the return value
+of `denote-directory-files'."
+ (seq-filter #'denote-sequence-file-p (denote-sequence--get-files files)))
+
+(defun denote-sequence--sequence-prefix-p (prefix sequence)
+ "Return non-nil if SEQUENCE has prefix sequence PREFIX.
+
+SEQUENCE is a Denote signatures that conforms with `denote-sequence-p'.
+PREFIX is a list of strings containing the components of the prefix
+sequence, as is returned by `denote-sequence-split'.
+
+If PREFIX is nil, return non-nil as if the SEQUENCE has PREFIX."
+ (let ((value (denote-sequence-split sequence))
+ (depth (length prefix))
+ (matched 0))
+ (while (and value
+ (< matched depth)
+ (string-equal (pop value) (nth matched prefix)))
+ (setq matched (1+ matched)))
+ (= matched depth)))
+
+(defun denote-sequence-get-all-files-with-prefix (sequence &optional files)
+ "Return all files in variable `denote-directory' with prefix SEQUENCE.
+A sequence is a Denote signature that conforms with `denote-sequence-p'.
+
+With optional FILES, operate on them, else use the return value of
+`denote-directory-files'."
+ (when-let* (((not (string-empty-p sequence)))
+ (prefix (denote-sequence-split sequence)))
+ (seq-filter
+ (lambda (file)
+ (when-let* ((file-sequence (denote-sequence-file-p file)))
+ (denote-sequence--sequence-prefix-p prefix file-sequence)))
+ (denote-sequence-get-all-files files))))
+
+(defun denote-sequence-get-all-files-with-max-depth (depth &optional files)
+ "Return all files with sequence depth up to DEPTH (inclusive).
+With optional FILES, operate on them, else use the return value of
+`denote-sequence-get-all-files'."
+ (delq nil
+ (mapcar
+ (lambda (file)
+ (when-let* ((sequence (denote-retrieve-filename-signature file))
+ (components (denote-sequence-split sequence))
+ ((>= depth (length components))))
+ file))
+ (denote-sequence-get-all-files files))))
+
+(defun denote-sequence-get-all-sequences (&optional files)
+ "Return all sequences in `denote-directory-files'.
+With optional FILES return all sequences among them instead.
+
+A sequence is a Denote signature that conforms with `denote-sequence-p'."
+ (delq nil (mapcar #'denote-sequence-file-p (denote-sequence-get-all-files
files))))
+
+(defun denote-sequence-get-all-sequences-with-prefix (sequence &optional
sequences)
+ "Get all sequences which extend SEQUENCE.
+With optional SEQUENCES operate on those, else use the return value of
+`denote-sequence-get-all-sequences'.
+
+A sequence is a Denote signature that conforms with `denote-sequence-p'."
+ (when-let* (((not (string-empty-p sequence)))
+ (prefix (denote-sequence-split sequence)))
+ (seq-filter
+ (lambda (string)
+ (denote-sequence--sequence-prefix-p prefix string))
+ (or sequences (denote-sequence-get-all-sequences)))))
+
+(defun denote-sequence-get-all-sequences-with-max-depth (depth &optional
sequences)
+ "Get sequences up to DEPTH (inclusive).
+With optional SEQUENCES operate on those, else use the return value of
+`denote-sequence-get-all-sequences'."
+ (let* ((strings (or sequences (denote-sequence-get-all-sequences)))
+ (lists-all (mapcar #'denote-sequence-split strings))
+ (lists (seq-filter (lambda (element) (>= depth (length element)))
lists-all)))
+ (delete-dups
+ (mapcar
+ (lambda (strings)
+ (denote-sequence-join (seq-take strings depth)
(denote-sequence--scheme-of-strings strings)))
+ lists))))
+
+(defun denote-sequence--pad (sequence type)
+ "Create a new SEQUENCE with padded spaces for TYPE.
+TYPE is a symbol among `denote-sequence-types'. The special TYPE `all'
+means to pad the full length of the sequence."
+ (let* ((sequence-separator-p (denote-sequence--children-implied-p sequence))
+ (split (denote-sequence-split sequence))
+ (s (cond
+ ((eq type 'all) split)
+ (sequence-separator-p
+ (pcase type
+ ('parent (car split))
+ ('sibling split)
+ ('child (car (nreverse split)))
+ (_ (error "The type `%s' is not among `denote-sequence-types'"
type))))
+ (t sequence))))
+ (if (listp s)
+ (combine-and-quote-strings
+ (mapcar
+ (lambda (part)
+ (string-pad part 5 32 :pad-from-start))
+ s)
+ "=")
+ (string-pad s 32 32 :pad-from-start))))
+
+(defun denote-sequence--get-largest-by-order (sequences type)
+ "Sort SEQUENCES of TYPE to get largest in order, using
`denote-sequence--pad'."
+ (car
+ (reverse
+ (sort sequences
+ (lambda (s1 s2)
+ (string<
+ (denote-sequence--pad s1 type)
+ (denote-sequence--pad s2 type)))))))
+
+(defun denote-sequence--string-length-sans-delimiter (string)
+ "Return length of STRING without the equals sign."
+ (if (eq denote-sequence-scheme 'numeric)
+ (length (replace-regexp-in-string "=" "" string))
+ (length string)))
+
+(defun denote-sequence--get-largest-by-length (sequences)
+ "Compare length of SEQUENCES to determine the largest among them.
+If there are more than one sequences of equal length, return them."
+ (let* ((seqs-with-length (mapcar (lambda (sequence)
+ (cons
(denote-sequence--string-length-sans-delimiter sequence) sequence))
+ sequences))
+ (longest (apply #'max (mapcar #'car seqs-with-length)))
+ (largest-sequence (delq nil
+ (mapcar (lambda (element)
+ (unless (< (car element) longest)
+ (cdr element)))
+ seqs-with-length))))
+ (if (= (length largest-sequence) 1)
+ (car largest-sequence)
+ largest-sequence)))
+
+(defun denote-sequence--get-largest (sequences type)
+ "Return largest sequence in SEQUENCES given TYPE.
+TYPE is a symbol among `denote-sequence-types'."
+ (if (eq type 'child)
+ (let ((largest (denote-sequence--get-largest-by-length sequences)))
+ (if (listp largest)
+ (denote-sequence--get-largest-by-order largest type)
+ largest))
+ (denote-sequence--get-largest-by-order sequences type)))
+
+(defun denote-sequence--get-start (&optional sequence prepend-delimiter)
+ "Return the start of a new sequence.
+With optional SEQUENCE, do so based on the final level of depth therein.
+This is usefule only for the alphanumeric `denote-sequence-scheme'. If
+optional PREPEND-DELIMITER is non-nil, prepend the equals sign to the
+number if `denote-sequence-scheme' is numeric."
+ (pcase denote-sequence-scheme
+ ('numeric (if prepend-delimiter "=1" "1"))
+ ('alphanumeric (if (denote-sequence--alphanumeric-partial-p (substring
sequence -1))
+ "1"
+ "a"))))
+
+(defun denote-sequence--get-new-parent (&optional sequences)
+ "Return a new to increment largest among sequences.
+With optional SEQUENCES consider only those, otherwise operate on the
+return value of `denote-sequence-get-all-sequences'."
+ (if-let* ((all (or sequences (denote-sequence-get-all-sequences))))
+ (let* ((largest (denote-sequence--get-largest all 'parent))
+ (first-component (car (denote-sequence-split largest)))
+ (current-number (string-to-number first-component)))
+ (number-to-string (+ current-number 1)))
+ (denote-sequence--get-start)))
+
+(defun denote-sequence-filter-scheme (sequences &optional scheme)
+ "Return list of SEQUENCES that are `denote-sequence-scheme' or SCHEME."
+ (let ((predicate (pcase (or scheme denote-sequence-scheme)
+ ('alphanumeric #'denote-sequence-alphanumeric-p)
+ ('numeric #'denote-sequence-numeric-p))))
+ (seq-filter predicate sequences)))
+
+(defun denote-sequence--get-new-child (sequence &optional sequences)
+ "Return a new child of SEQUENCE.
+Optional SEQUENCES has the same meaning as that specified in the
+function `denote-sequence-get-all-sequences-with-prefix'."
+ (if-let* ((depth (+ (denote-sequence-depth sequence) 1))
+ (all-unfiltered (denote-sequence-get-all-sequences-with-prefix
sequence sequences))
+ (start-child (denote-sequence--get-start sequence
:prepend-delimiter)))
+ (if (= (length all-unfiltered) 1)
+ (format "%s%s" (car all-unfiltered) start-child)
+ (if-let* ((all-schemeless (cond
+
((denote-sequence-get-all-sequences-with-max-depth depth all-unfiltered))
+ (t all-unfiltered)))
+ (all (denote-sequence-filter-scheme all-schemeless))
+ (largest (denote-sequence--get-largest all 'child)))
+ (if (denote-sequence--children-implied-p largest)
+ (pcase-let* ((`(,largest . ,scheme)
(denote-sequence-and-scheme-p largest))
+ (components (denote-sequence-split largest))
+ (butlast (butlast components))
+ (last-component (car (nreverse components)))
+ (new-number (denote-sequence-increment
last-component)))
+ (denote-sequence-join
+ (if butlast
+ (append butlast (list new-number))
+ (list largest new-number))
+ scheme))
+ (format "%s%s" largest start-child))
+ (format "%s%s" sequence start-child)))
+ (error "Cannot find sequences given sequence `%s' using scheme `%s'"
sequence denote-sequence-scheme)))
+
+(defun denote-sequence--get-prefix-for-siblings (sequence)
+ "Get the prefix of SEQUENCE such that it is possible to find its siblings."
+ (pcase-let ((`(,sequence . ,scheme) (denote-sequence-and-scheme-p sequence)))
+ (when (denote-sequence--children-implied-p sequence)
+ (denote-sequence-join (butlast (denote-sequence-split sequence))
scheme))))
+
+(defun denote-sequence--get-new-sibling (sequence &optional sequences)
+ "Return a new sibling SEQUENCE.
+Optional SEQUENCES has the same meaning as that specified in the
+function `denote-sequence-get-all-sequences-with-prefix'."
+ (let* ((children-p (denote-sequence--children-implied-p sequence)))
+ (if-let* ((depth (denote-sequence-depth sequence))
+ (all-unfiltered (if children-p
+
(denote-sequence-get-all-sequences-with-prefix
+ (denote-sequence--get-prefix-for-siblings
sequence)
+ sequences)
+ (denote-sequence-get-all-sequences)))
+ (all-schemeless
(denote-sequence-get-all-sequences-with-max-depth depth all-unfiltered))
+ (all (denote-sequence-filter-scheme all-schemeless))
+ ((member sequence all))
+ (largest (if children-p
+ (denote-sequence--get-largest all 'sibling)
+ (denote-sequence--get-largest all 'parent))))
+ (if children-p
+ (pcase-let* ((`(,largest . ,scheme) (denote-sequence-and-scheme-p
largest))
+ (components (denote-sequence-split largest))
+ (butlast (butlast components))
+ (last-component (car (nreverse components)))
+ (new-number (denote-sequence-increment
last-component)))
+ (denote-sequence-join (append butlast (list new-number)) scheme))
+ (number-to-string (+ (string-to-number largest) 1)))
+ (error "Cannot find sequences given sequence `%s' using scheme `%s'"
sequence denote-sequence-scheme))))
+
+(defun denote-sequence-get-new (type &optional sequence sequences)
+ "Return a sequence given TYPE among `denote-sequence-types'.
+If TYPE is either `child' or `sibling', then optional SEQUENCE must be
+non-nil and conform with `denote-sequence-p'.
+
+With optional SEQUENCES consider only those, otherwise operate on the
+return value of `denote-sequence-get-all-sequences'."
+ (pcase type
+ ('parent (denote-sequence--get-new-parent sequences))
+ ('child (denote-sequence--get-new-child sequence sequences))
+ ('sibling (denote-sequence--get-new-sibling sequence sequences))
+ (_ (error "The type `%s' is not among `denote-sequence-types'" type))))
+
+(defun denote-sequence-get-relative (sequence type &optional files)
+ "Get files of TYPE given the SEQUENCE.
+With optional FILES consider only those, otherwise operate on all files
+returned by `denote-sequence-get-all-files'."
+ (let* ((depth (denote-sequence-depth sequence))
+ (scheme (cdr (denote-sequence-and-scheme-p sequence)))
+ (components (denote-sequence-split sequence))
+ (filter-common (lambda (comparison prefix)
+ (seq-filter
+ (lambda (file)
+ (funcall comparison (denote-sequence-depth
(denote-retrieve-filename-signature file)) depth))
+ (denote-sequence-get-all-files-with-prefix prefix
files)))))
+ (pcase type
+ ('all-parents (let ((parents nil)
+ (butlast (butlast components)))
+ (while (>= (length butlast) 1)
+ (when-let* ((prefix (denote-sequence-join butlast
scheme))
+ (parent (seq-find
+ (lambda (file)
+ (string=
(denote-retrieve-filename-signature file) prefix))
+ (denote-sequence-get-all-files
files))))
+ (push parent parents)
+ (setq butlast (butlast butlast))))
+ parents))
+ ('parent (let ((butlast (denote-sequence-join (butlast components)
scheme)))
+ (seq-find
+ (lambda (file)
+ (string= (denote-retrieve-filename-signature file)
butlast))
+ (denote-sequence-get-all-files files))))
+ ('siblings (funcall filter-common '= (denote-sequence-join (butlast
components) scheme)))
+ ('all-children (funcall filter-common '> sequence))
+ ('children (seq-filter
+ (lambda (file)
+ (= (denote-sequence-depth (denote-sequence-file-p file))
(+ depth 1)))
+ (funcall filter-common '> sequence)))
+ (_ (error "The type `%s' is not among the allowed types" type)))))
+
+(defvar denote-sequence-type-history nil
+ "Minibuffer history of `denote-sequence-type-prompt'.")
+
+(defun denote-sequence-annotate-types (type)
+ "Annotate completion candidate of TYPE for `denote-sequence-type-prompt'."
+ (when-let* ((text (pcase type
+ ("parent" "Parent sequence")
+ ("sibling" "Sibling of another sequence")
+ ("child" "Child of another sequence"))))
+ (format "%s-- %s"
+ (propertize " " 'display '(space :align-to 10))
+ (propertize text 'face 'completions-annotations))))
+
+(defun denote-sequence-type-prompt (&optional prompt-text types annotation-fn)
+ "Prompt for sequence type among `denote-sequence-types'.
+Return selected type as a symbol.
+
+With optional PROMPT-TEXT use it instead of the generic prompt.
+
+With optional TYPES use those instead of the `denote-sequence-types'.
+
+With optional ANNOTATION-FN use it to annotate the completion candidates
+instead of the default `denote-sequence-annotate-types'."
+ (let ((default (car denote-sequence-type-history))
+ (completion-extra-properties
+ (list :annotation-function (or annotation-fn
#'denote-sequence-annotate-types))))
+ (intern
+ (completing-read
+ (format-prompt (or prompt-text "Select sequence type") default)
+ (denote--completion-table 'denote-sequence-type (or types
denote-sequence-types))
+ nil :require-match nil
+ 'denote-sequence-type-history default))))
+
+(defvar denote-sequence-file-history nil
+ "Minibuffer history for `denote-sequence-file-prompt'.")
+
+(defun denote-sequence-file-prompt (&optional prompt-text files-with-sequences)
+ "Prompt for file with sequence in variable `denote-directory'.
+A sequence is a Denote signature that conforms with `denote-sequence-p'.
+
+With optional PROMPT-TEXT use it instead of a generic prompt.
+
+With optional FILES-WITH-SEQUENCES as a list of strings, use them as
+completion candidates. Else use `denote-sequence-get-all-files'."
+ (if-let* ((relative-files (mapcar
#'denote-get-file-name-relative-to-denote-directory
+ (or files-with-sequences
(denote-sequence-get-all-files))))
+ (prompt (format-prompt (or prompt-text "Select FILE with
sequence") nil))
+ (input (completing-read
+ prompt
+ (denote--completion-table 'file relative-files)
+ nil :require-match
+ nil 'denote-sequence-file-history)))
+ (concat (denote-directory) input)
+ (error "There are no sequence notes in the `denote-directory'")))
+
+;;;###autoload
+(defun denote-sequence (type &optional file-with-sequence)
+ "Create a new sequence note of TYPE among `denote-sequence-types'.
+If TYPE is either `child' or `sibling', then it is an extension of
+FILE-WITH-SEQUENCE.
+
+When called interactively, prompt for TYPE and, when necessary, for
+FILE-WITH-SEQUENCE whose sequence will be used to derive a new sequence.
+Files available at the minibuffer prompt are those returned by
+`denote-sequence-get-all-files'."
+ (interactive
+ (let ((selected-type (denote-sequence-type-prompt)))
+ (list
+ selected-type
+ (when (memq selected-type (delq 'parent denote-sequence-types))
+ (denote-sequence-file-prompt (format "Make a new %s of SEQUENCE"
selected-type))))))
+ (let* ((sequence (when file-with-sequence
(denote-retrieve-filename-signature file-with-sequence)))
+ (new-sequence (denote-sequence-get-new type sequence))
+ (denote-use-signature new-sequence))
+ (call-interactively 'denote)))
+
+;;;###autoload
+(defun denote-sequence-new-parent ()
+ "Like `denote-sequence' to directly create new parent."
+ (interactive)
+ (let* ((new-sequence (denote-sequence-get-new 'parent))
+ (denote-use-signature new-sequence))
+ (call-interactively 'denote)))
+
+;;;###autoload
+(defun denote-sequence-new-sibling (sequence)
+ "Like `denote-sequence' to directly create new sibling of SEQUENCE.
+When called interactively, SEQUENCE is a file among files in the variable
+`denote-directory' that have a sequence (per `denote-sequence-file-p').
+
+When called from Lisp, SEQUENCE is a string that conforms with
+`denote-sequence-p'."
+ (interactive
+ (list
+ (denote-retrieve-filename-signature
+ (denote-sequence-file-prompt "Make a new sibling of SEQUENCE"))))
+ (let* ((new-sequence (denote-sequence-get-new 'sibling sequence))
+ (denote-use-signature new-sequence))
+ (call-interactively 'denote)))
+
+(defun denote-sequence--get-file-in-dired-or-prompt (prompt-text)
+ "Get the file at point in Dired, the current one, or prompt with
PROMPT-TEXT."
+ (cond
+ ((when-let* (((derived-mode-p 'dired-mode))
+ (file-at-point (dired-get-filename nil t)))
+ (denote-sequence-file-p file-at-point)))
+ ((and buffer-file-name (denote-sequence-file-p buffer-file-name)))
+ (t
+ (denote-retrieve-filename-signature (denote-sequence-file-prompt
prompt-text)))))
+
+;;;###autoload
+(defun denote-sequence-new-sibling-of-current (sequence)
+ "Create a new sibling sequence of the current file with SEQUENCE.
+If the current file does not have a sequence, then behave exactly like
+`denote-sequence-new-sibling'."
+ (interactive (list (denote-sequence--get-file-in-dired-or-prompt "Make a new
sibling of SEQUENCE")))
+ (let* ((new-sequence (denote-sequence-get-new 'sibling sequence))
+ (denote-use-signature new-sequence))
+ (call-interactively 'denote)))
+
+;;;###autoload
+(defun denote-sequence-new-child (sequence)
+ "Like `denote-sequence' to directly create new child of SEQUENCE.
+When called interactively, SEQUENCE is a file among files in the variable
+`denote-directory' that have a sequence (per `denote-sequence-file-p').
+
+When called from Lisp, SEQUENCE is a string that conforms with
+`denote-sequence-p'."
+ (interactive
+ (list
+ (denote-retrieve-filename-signature
+ (denote-sequence-file-prompt "Make a new child of SEQUENCE"))))
+ (let* ((new-sequence (denote-sequence-get-new 'child sequence))
+ (denote-use-signature new-sequence))
+ (call-interactively 'denote)))
+
+;;;###autoload
+(defun denote-sequence-new-child-of-current (sequence)
+ "Create a new child sequence of the current file with SEQUENCE.
+If the current file does not have a sequence, then behave exactly like
+`denote-sequence-new-child'."
+ (interactive (list (denote-sequence--get-file-in-dired-or-prompt "Make a new
child of SEQUENCE")))
+ (let* ((new-sequence (denote-sequence-get-new 'child sequence))
+ (denote-use-signature new-sequence))
+ (call-interactively 'denote)))
+
+(defvar denote-sequence-relative-types
+ '(all-parents parent siblings children all-children)
+ "Types of sequence relatives.")
+
+(defun denote-sequence-annotate-relative-types (type)
+ "Annotate completion candidate of TYPE for `denote-sequence-type-prompt'."
+ (when-let* ((text (pcase type
+ ("all-parents" "All parent sequences")
+ ("parent" "Immediate parent")
+ ("siblings" "All siblings")
+ ("all-children" "All children")
+ ("children" "Immediate children"))))
+ (format "%s-- %s"
+ (propertize " " 'display '(space :align-to 15))
+ (propertize text 'face 'completions-annotations))))
+
+;;;###autoload
+(defun denote-sequence-find (type)
+ "Find all relatives of the given TYPE using the current file's sequence.
+Prompt for TYPE among `denote-sequence-relative-types' and then prompt
+for a file among the matching files."
+ (interactive
+ (list
+ (denote-sequence-type-prompt "Find relatives of TYPE"
+ '(all-parents parent siblings children
all-children)
+ #'denote-sequence-annotate-relative-types)))
+ (if-let* ((sequence (denote-sequence-file-p buffer-file-name)))
+ (if-let* ((matches (denote-sequence-get-relative sequence type))
+ (relatives (delete buffer-file-name matches)))
+ (find-file (if (stringp relatives)
+ relatives
+ (denote-sequence-file-prompt "Select a relative"
relatives)))
+ (user-error "The sequence `%s' has no relatives of type `%s'" sequence
type))
+ (user-error "The current file has no sequence")))
+
+;;;###autoload
+(defun denote-sequence-link (file &optional id-only)
+ "Link to FILE with sequence.
+This is like the `denote-link' command but only accepts to link to a
+file that conforms with `denote-sequence-file-p'. When called
+interactively, only relevant files are shown for minibuffer completion
+from the variable `denote-directory'.
+
+Optional ID-ONLY has the same meaning as the `denote-link' command."
+ (interactive (list (denote-sequence-file-prompt "Link to file with
sequence")))
+ (unless (denote-sequence-file-p file)
+ (error "Can only link to file with a sequence; else use `denote-link' and
related"))
+ (let* ((type (denote-filetype-heuristics buffer-file-name))
+ (description (denote-get-link-description file)))
+ (denote-link file type description id-only)))
+
+(defun denote-sequence-sort-files (files-with-sequence)
+ "Sort FILES-WITH-SEQUENCE according to their sequence."
+ (sort
+ files-with-sequence
+ (lambda (file-with-sequence-1 file-with-sequence-2)
+ (let ((s1 (denote-retrieve-filename-signature file-with-sequence-1))
+ (s2 (denote-retrieve-filename-signature file-with-sequence-2)))
+ (string<
+ (denote-sequence--pad s1 'all)
+ (denote-sequence--pad s2 'all))))))
+
+(defvar denote-sequence-history nil
+ "Minibuffer history of `denote-sequence-prompt'.")
+
+(defun denote-sequence-prompt (&optional prompt-text sequences)
+ "Prompt for a sequence.
+With optional PROMPT-TEXT use it instead of a generic prompt.
+
+With optional SEQUENCES as a list of strings, use them as completion
+candidates. Else use the return value of `denote-sequence-get-all-sequences'.
+A sequence is a string conforming with `denote-sequence-p'. Any other string
+is ignored."
+ (completing-read
+ (format-prompt (or prompt-text "Select an existing sequence (empty for
all)") nil)
+ (or sequences (denote-sequence-get-all-sequences))
+ #'denote-sequence-p :require-match nil 'denote-sequence-history))
+
+(defun denote-sequence-depth-prompt (&optional prompt-text)
+ "Prompt for the depth of a sequence.
+With optional PROMPT-TEXT use it instead of the generic one."
+ (read-number
+ (or prompt-text
+ (format "Get sequences up to this depth %s: "
+ (if (eq denote-sequence-scheme 'alphanumeric)
+ "(e.g. `1a2' is `3' levels of depth)"
+ "(e.g. `1=1=2' is `3' levels of depth)")))))
+
+(defun denote-sequence--get-dired-buffer-name (&optional prefix depth)
+ "Return a string for `denote-sequence-dired' buffer.
+Use optional PREFIX and DEPTH to format the string accordingly."
+ (let ((time (format-time-string "%F %T")))
+ (cond
+ ((and prefix depth)
+ (format-message "*Denote sequences of prefix `%s' and depth `%s', %s*"
prefix depth time))
+ ((and prefix (not (string-empty-p prefix)))
+ (format-message "*Denote sequences of prefix `%s', %s*" prefix time))
+ (t
+ (format "*Denote sequences, %s*" time)))))
+
+;;;###autoload
+(defun denote-sequence-dired (&optional prefix depth)
+ "Produce a Dired listing of all sequence notes.
+Sort sequences from smallest to largest.
+
+With optional PREFIX string, show only files whose sequence matches it.
+
+With optional DEPTH as a number, limit the list to files whose sequence
+is that many levels deep. For example, 1=1=2 is three levels deep.
+
+For a more specialised case, see `denote-sequence-find-relatives-dired'."
+ (interactive
+ (let ((arg (prefix-numeric-value current-prefix-arg)))
+ (cond
+ ((= arg 16)
+ (list
+ (denote-sequence-prompt "Limit to files that extend SEQUENCE (empty
for all)")
+ (denote-sequence-depth-prompt)))
+ ((= arg 4)
+ (list
+ (denote-sequence-prompt "Limit to files that extend SEQUENCE (empty
for all)")))
+ (t
+ nil))))
+ (if-let* ((default-directory (denote-directory))
+ (all (if prefix
+ (denote-sequence-get-all-files-with-prefix prefix)
+ (denote-sequence-get-all-files)))
+ (files-with-depth (if depth
+
(denote-sequence-get-all-files-with-max-depth depth all)
+ all))
+ (files-sorted (denote-sequence-sort-files files-with-depth))
+ (buffer-name (denote-sequence--get-dired-buffer-name prefix
depth)))
+ (let ((dired-buffer (dired (cons buffer-name (mapcar
#'file-relative-name files-sorted)))))
+ (with-current-buffer dired-buffer
+ (setq-local revert-buffer-function
+ (lambda (&rest _)
+ ;; FIXME 2025-01-04: Killing the buffer has
+ ;; the unintended side effect of affecting the
+ ;; window configuration when we call
+ ;; `denote-update-dired-buffers'.
+ (kill-buffer dired-buffer)
+ (denote-sequence-dired prefix depth)))))
+ (user-error "No Denote sequences matching those terms")))
+
+;;;###autoload
+(defun denote-sequence-find-dired (type)
+ "Like `denote-sequence-find' for TYPE but put the matching files in Dired.
+Also see `denote-sequence-dired'."
+ (interactive
+ (list (denote-sequence-type-prompt "Find relatives of TYPE"
+ '(all-parents
+ parent
+ siblings
+ all-children
+ children))))
+ (if-let* ((sequence (denote-sequence-file-p buffer-file-name)))
+ (if-let* ((default-directory (denote-directory))
+ (relatives (delete buffer-file-name
+ (ensure-list
+ (denote-sequence-get-relative sequence
type))))
+ (files-sorted (denote-sequence-sort-files relatives)))
+ (dired (cons (format-message "*`%s' type relatives of `%s'" type
sequence)
+ (mapcar #'file-relative-name files-sorted)))
+ (user-error "The sequence `%s' has no relatives of type `%s'" sequence
type))
+ (user-error "The current file has no sequence")))
+
+;; TODO 2025-01-14: We need to have an operation that reparents
+;; recursively. This can be done inside of the `denote-sequence-reparent',
+;; where if it finds that the current file has children, it prompts
+;; for a confirmation and then continues to reparent all of them.
+;;;###autoload
+(defun denote-sequence-reparent (current-file file-with-sequence)
+ "Re-parent the CURRENT-FILE to be a child of FILE-WITH-SEQUENCE.
+If CURRENT-FILE has a sequence (the Denote file name signature), change
+it. Else create a new one.
+
+When called interactively, CURRENT-FILE is either the current file, or a
+special Org buffer (like those of `org-capture'), or the file at point in
+Dired.
+
+When called interactively, prompt for FILE-WITH-SEQUENCE showing only
+the files in the variable `denote-directory' which have a sequence. If
+no such files exist, throw an error.
+
+When called from Lisp, CURRENT-FILE is a string pointing to a file.
+
+When called from Lisp, FILE-WITH-SEQUENCE is either a file with a
+sequence (per `denote-sequence-file-p') or the sequence string as
+such (per `denote-sequence-p'). In both cases, what matters is to know
+the target sequence."
+ (interactive
+ (list
+ (if (denote--file-type-org-extra-p)
+ denote-last-path-after-rename
+ (denote--rename-dired-file-or-current-file-or-prompt))
+ (denote-sequence-file-prompt
+ (format "Reparent `%s' to be a child of"
+ (propertize
+ (denote--rename-dired-file-or-current-file-or-prompt)
+ 'face 'denote-faces-prompt-current-name)))))
+ (let* ((target-sequence (or (denote-sequence-file-p file-with-sequence)
+ (denote-sequence-p file-with-sequence)
+ (user-error "No sequence of `denote-sequence-p'
found in `%s'" file-with-sequence)))
+ (new-sequence (denote-sequence--get-new-child target-sequence)))
+ (denote-rename-file current-file 'keep-current 'keep-current new-sequence
'keep-current)))
+
+;;;###autoload
+(defun denote-sequence-convert (files)
+ "Convert the sequence scheme of FILES to match `denote-sequence-scheme'.
+When called from inside a Denote file, FILES is just the current file.
+When called from a Dired buffer, FILES are the marked files. If no
+files are marked, then the one at point is considered.
+
+Do not make any changes if the file among the FILES has no sequence or
+if it already matches the value of `denote-sequence-scheme'. A file has
+a sequence when it conforms with `denote-sequence-file-p'.
+
+This command is for users who once used a `denote-sequence-scheme' and
+have since decided to switch to another. IT DOES NOT REPARENT OR ANYHOW
+CHECK THE RESULTING SEQUENCES FOR DUPLICATES."
+ (interactive
+ (list
+ (if (derived-mode-p 'dired-mode)
+ (dired-get-marked-files)
+ buffer-file-name))
+ dired-mode)
+ (unless (listp files)
+ (setq files (list files)))
+ (dolist (file files)
+ (when-let* ((old-sequence (denote-sequence-file-p file))
+ (new-sequence (denote-sequence-make-conversion old-sequence
:is-complete-sequence)))
+ (denote-rename-file file 'keep-current 'keep-current new-sequence
'keep-current)))
+ (denote-update-dired-buffers))
+
+(provide 'denote-sequence)
+;;; denote-sequence.el ends here
diff --git a/tests/denote-sequence-test.el b/tests/denote-sequence-test.el
new file mode 100644
index 0000000000..e337218bd4
--- /dev/null
+++ b/tests/denote-sequence-test.el
@@ -0,0 +1,247 @@
+;;; denote-test.el --- Unit tests for denote-sequence.el -*- lexical-binding:
t -*-
+
+;; Copyright (C) 2023-2025 Free Software Foundation, Inc.
+
+;; Author: Protesilaos Stavrou <i...@protesilaos.com>
+;; Maintainer: Protesilaos Stavrou <i...@protesilaos.com>
+;; URL: https://github.com/protesilaos/denote
+
+;; This file is NOT part of GNU Emacs.
+
+;; 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/>.
+
+;;; Commentary:
+
+;; Tests for denote-sequence.el. Note that we are using Shorthands in
+;; this file, so the "dst-" prefix really is "denote-sequence-test-".
+;; Evaluate the following to learn more:
+;;
+;; (info "(elisp) Shorthands")
+
+;;; Code:
+
+(require 'ert)
+(require 'denote-sequence)
+
+(ert-deftest dst-denote-sequence--get-new-exhaustive ()
+ "Test if we get the correct parent, child, sibling, or relatives of a
sequence.
+Use the function `denote-sequence-get-new' for child and sibling with
+the numeric and alphanumeric `denote-sequence-scheme', as well as the
+function `denote-sequence-get-relative'."
+ (let* ((denote-sequence-scheme 'numeric)
+ (denote-directory (expand-file-name "denote-test"
temporary-file-directory))
+ (files
+ (mapcar
+ (lambda (file)
+ (let ((path (expand-file-name file (denote-directory))))
+ (if (file-exists-p path)
+ path
+ (with-current-buffer (find-file-noselect path)
+ (save-buffer)
+ (kill-buffer (current-buffer)))
+ path)))
+ '("20241230T075023==1--test__testing.txt"
+ "20241230T075023==1=1--test__testing.txt"
+ "20241230T075023==1=1=1--test__testing.txt"
+ "20241230T075023==1=1=2--test__testing.txt"
+ "20241230T075023==1=2--test__testing.txt"
+ "20241230T075023==1=2=1--test__testing.txt"
+ "20241230T075023==1=2=1=1--test__testing.txt"
+ "20241230T075023==2--test__testing.txt"
+ "20241230T075023==10--test__testing.txt"
+ "20241230T075023==10=1--test__testing.txt"
+ "20241230T075023==10=1=1--test__testing.txt"
+ "20241230T075023==10=2--test__testing.txt"
+ "20241230T075023==10=10--test__testing.txt"
+ "20241230T075023==10=10=1--test__testing.txt")))
+ (sequences (denote-sequence-get-all-sequences files)))
+ (should (string= (denote-sequence-get-new 'parent) "11"))
+
+ (should (and (string= (denote-sequence-get-new 'child "1" sequences) "1=3")
+ (string= (denote-sequence-get-new 'child "1=1" sequences)
"1=1=3")
+ (string= (denote-sequence-get-new 'child "1=1=2" sequences)
"1=1=2=1")
+ (string= (denote-sequence-get-new 'child "1=2" sequences)
"1=2=2")
+ (string= (denote-sequence-get-new 'child "1=2=1" sequences)
"1=2=1=2")
+ (string= (denote-sequence-get-new 'child "2" sequences)
"2=1")))
+ (should-error (denote-sequence-get-new 'child "11" sequences))
+
+ (should (and (string= (denote-sequence-get-new 'sibling "1" sequences)
"11")
+ (string= (denote-sequence-get-new 'sibling "1=1" sequences)
"1=3")
+ (string= (denote-sequence-get-new 'sibling "1=1=1" sequences)
"1=1=3")
+ (string= (denote-sequence-get-new 'sibling "1=1=2" sequences)
"1=1=3")
+ (string= (denote-sequence-get-new 'sibling "1=2" sequences)
"1=3")
+ (string= (denote-sequence-get-new 'sibling "1=2=1" sequences)
"1=2=2")
+ (string= (denote-sequence-get-new 'sibling "2" sequences)
"11")))
+ (should-error (denote-sequence-get-new 'sibling "12" sequences))
+
+ (should (string= (denote-sequence-get-relative "1=2=1=1" 'parent files)
+ (expand-file-name
"20241230T075023==1=2=1--test__testing.txt" denote-directory)))
+ (should (string= (denote-sequence-get-relative "10=1=1" 'parent files)
+ (expand-file-name
"20241230T075023==10=1--test__testing.txt" denote-directory)))
+ (should (string= (denote-sequence-get-relative "10=10=1" 'parent files)
+ (expand-file-name
"20241230T075023==10=10--test__testing.txt" denote-directory)))
+ (should (equal (denote-sequence-get-relative "1=2=1=1" 'all-parents files)
+ (list
+ (expand-file-name "20241230T075023==1--test__testing.txt"
denote-directory)
+ (expand-file-name
"20241230T075023==1=2--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==1=2=1--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "10=1=1" 'all-parents files)
+ (list
+ (expand-file-name "20241230T075023==10--test__testing.txt"
denote-directory)
+ (expand-file-name
"20241230T075023==10=1--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "10=10=1" 'all-parents files)
+ (list
+ (expand-file-name "20241230T075023==10--test__testing.txt"
denote-directory)
+ (expand-file-name
"20241230T075023==10=10--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "1=1" 'siblings files)
+ (list
+ (expand-file-name
"20241230T075023==1=1--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==1=2--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "10=1" 'siblings files)
+ (list
+ (expand-file-name
"20241230T075023==10=1--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==10=2--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==10=10--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "1" 'children files)
+ (list
+ (expand-file-name
"20241230T075023==1=1--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==1=2--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "10" 'children files)
+ (list
+ (expand-file-name
"20241230T075023==10=1--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==10=2--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==10=10--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "1=1" 'all-children files)
+ (list
+ (expand-file-name
"20241230T075023==1=1=1--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==1=1=2--test__testing.txt" denote-directory)))))
+
+ (let* ((denote-sequence-scheme 'alphanumeric)
+ (denote-directory (expand-file-name "denote-test"
temporary-file-directory))
+ (files
+ (mapcar
+ (lambda (file)
+ (let ((path (expand-file-name file (denote-directory))))
+ (if (file-exists-p path)
+ path
+ (with-current-buffer (find-file-noselect path)
+ (save-buffer)
+ (kill-buffer (current-buffer)))
+ path)))
+ '("20241230T075023==1--test__testing.txt"
+ "20241230T075023==1a--test__testing.txt"
+ "20241230T075023==1a1--test__testing.txt"
+ "20241230T075023==1a2--test__testing.txt"
+ "20241230T075023==1b--test__testing.txt"
+ "20241230T075023==1b1--test__testing.txt"
+ "20241230T075023==1b1a--test__testing.txt"
+ "20241230T075023==2--test__testing.txt"
+ "20241230T075023==10--test__testing.txt"
+ "20241230T075023==10a--test__testing.txt"
+ "20241230T075023==10b--test__testing.txt")))
+ (sequences (denote-sequence-get-all-sequences files)))
+ (should (string= (denote-sequence-get-new 'parent) "11"))
+
+ (should (and (string= (denote-sequence-get-new 'child "1" sequences) "1c")
+ (string= (denote-sequence-get-new 'child "1a" sequences)
"1a3")
+ (string= (denote-sequence-get-new 'child "1a2" sequences)
"1a2a")
+ (string= (denote-sequence-get-new 'child "1b" sequences)
"1b2")
+ (string= (denote-sequence-get-new 'child "1b1" sequences)
"1b1b")
+ (string= (denote-sequence-get-new 'child "2" sequences)
"2a")))
+ (should-error (denote-sequence-get-new 'child "11" sequences))
+
+ (should (and (string= (denote-sequence-get-new 'sibling "1" sequences)
"11")
+ (string= (denote-sequence-get-new 'sibling "1a" sequences)
"1c")
+ (string= (denote-sequence-get-new 'sibling "1a1" sequences)
"1a3")
+ (string= (denote-sequence-get-new 'sibling "1a2" sequences)
"1a3")
+ (string= (denote-sequence-get-new 'sibling "1b" sequences)
"1c")
+ (string= (denote-sequence-get-new 'sibling "1b1" sequences)
"1b2")
+ (string= (denote-sequence-get-new 'sibling "2" sequences)
"11")))
+ (should-error (denote-sequence-get-new 'sibling "12" sequences))
+
+ (should (string= (denote-sequence-get-relative "1b1a" 'parent files)
+ (expand-file-name
"20241230T075023==1b1--test__testing.txt" denote-directory)))
+ (should (string= (denote-sequence-get-relative "10a" 'parent files)
+ (expand-file-name
"20241230T075023==10--test__testing.txt" denote-directory)))
+ (should (equal (denote-sequence-get-relative "1b1a" 'all-parents files)
+ (list
+ (expand-file-name "20241230T075023==1--test__testing.txt"
denote-directory)
+ (expand-file-name "20241230T075023==1b--test__testing.txt"
denote-directory)
+ (expand-file-name
"20241230T075023==1b1--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "1a" 'siblings files)
+ (list
+ (expand-file-name "20241230T075023==1a--test__testing.txt"
denote-directory)
+ (expand-file-name "20241230T075023==1b--test__testing.txt"
denote-directory))))
+ (should (equal (denote-sequence-get-relative "10a" 'siblings files)
+ (list
+ (expand-file-name
"20241230T075023==10a--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==10b--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "1" 'children files)
+ (list
+ (expand-file-name "20241230T075023==1a--test__testing.txt"
denote-directory)
+ (expand-file-name "20241230T075023==1b--test__testing.txt"
denote-directory))))
+ (should (equal (denote-sequence-get-relative "10" 'children files)
+ (list
+ (expand-file-name
"20241230T075023==10a--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==10b--test__testing.txt" denote-directory))))
+ (should (equal (denote-sequence-get-relative "1a" 'all-children files)
+ (list
+ (expand-file-name
"20241230T075023==1a1--test__testing.txt" denote-directory)
+ (expand-file-name
"20241230T075023==1a2--test__testing.txt" denote-directory))))))
+
+(ert-deftest dst-denote-sequence-split ()
+ "Test that `denote-sequence-split' splits a sequence correctly."
+ (should (and (equal (denote-sequence-split "1") '("1"))
+ (equal (denote-sequence-split "1=1=2") '("1" "1" "2"))
+ (equal (denote-sequence-split "1za5zx") '("1" "za" "5" "zx")))))
+
+(ert-deftest dst-denote-sequence-make-conversion ()
+ "Test that `denote-sequence-make-conversion' converts from alpha to numeric
and vice versa."
+ (should (and (string= (denote-sequence-make-conversion "3") "c")
+ (string= (denote-sequence-make-conversion "18") "r")
+ (string= (denote-sequence-make-conversion "26") "z")
+ (string= (denote-sequence-make-conversion "27") "za")
+ (string= (denote-sequence-make-conversion "130") "zzzzz")
+ (string= (denote-sequence-make-conversion "131") "zzzzza")
+ (string= (denote-sequence-make-conversion "c") "3")
+ (string= (denote-sequence-make-conversion "r") "18")
+ (string= (denote-sequence-make-conversion "z") "26")
+ (string= (denote-sequence-make-conversion "za") "27")
+ (string= (denote-sequence-make-conversion "zzzzz") "130")
+ (string= (denote-sequence-make-conversion "zzzzza") "131")))
+ (should (and (string= (denote-sequence-make-conversion "1=1=2"
:string-is-sequence) "1a2")
+ (string= (denote-sequence-make-conversion "1a2"
:string-is-sequence) "1=1=2")
+ (string= (denote-sequence-make-conversion "1=27=2=55"
:string-is-sequence) "1za2zzc")
+ (string= (denote-sequence-make-conversion "1za2zzc"
:string-is-sequence) "1=27=2=55")
+ (string= (denote-sequence-make-conversion "1=1=2=2=4=1"
:string-is-sequence) "1a2b4a")
+ (string= (denote-sequence-make-conversion "1a2b4a"
:string-is-sequence) "1=1=2=2=4=1")))
+ (should-error (denote-sequence-make-conversion "111=a" :string-is-sequence))
+ (should-error (denote-sequence-make-conversion "a1" :string-is-sequence)))
+
+(ert-deftest dst-denote-sequence-increment ()
+ "Test that `denote-sequence-increment' works with numbers and letters."
+ (should (and (string= (denote-sequence-increment "z") "za")
+ (string= (denote-sequence-increment "ab") "ac")
+ (string= (denote-sequence-increment "az") "aza")
+ (string= (denote-sequence-increment "bbcz") "bbcza")))
+ (should (and (string= (denote-sequence-increment "1") "2")
+ (string= (denote-sequence-increment "10") "11")))
+ (should-error (denote-sequence-increment "1=a")))
+
+(provide 'denote-test)
+;;; denote-test.el ends here
+
+;; Local Variables:
+;; read-symbol-shorthands: (("dst" . "denote-sequence-test-"))
+;; End:
