summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2023-07-17 05:17:47 +0300
committerPaul Buetow <paul@buetow.org>2023-07-17 05:17:47 +0300
commit1ad2c43693f6a61e451c56beea40233db43e0da8 (patch)
tree36c79c1e16e9eb625039083bf323dadbdbc295fc
parent10bded3269bfbdb240f8afd210c80873fe34b12a (diff)
parent410d6e1e589c667502431b87d07ba5b6354a5bd8 (diff)
Merge branch 'develop'2.1.0
-rw-r--r--LICENSE698
-rw-r--r--README.md39
-rw-r--r--extras/html/footer.html.part2
-rw-r--r--extras/html/intelone-mono/intelone-mono-font-family-regular.ttfbin0 -> 64104 bytes
-rw-r--r--extras/html/intelone-mono/license93
-rw-r--r--extras/html/style.css9
-rwxr-xr-xgemtexter20
-rw-r--r--gemtexter-paul.buetow.org.conf (renamed from gemtexter-paul.cyou.conf)8
-rw-r--r--gemtexter.conf3
-rw-r--r--lib/assert.source.sh14
-rw-r--r--lib/generate.source.sh1
-rw-r--r--lib/git.source.sh4
-rw-r--r--lib/html.source.sh208
13 files changed, 1012 insertions, 87 deletions
diff --git a/LICENSE b/LICENSE
index fdddb29..f288702 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,24 +1,674 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <https://unlicense.org>
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/README.md b/README.md
index b4eb9de..330fbae 100644
--- a/README.md
+++ b/README.md
@@ -26,12 +26,17 @@ These are the requirements for running the `gemtexter` static site generator scr
* GNU Sed
* GNU Date
* GNU Grep
+* GNU Source Highlight (optional for source code highlighting of bare text blocks)
* Git (optional for version control)
* ShellCheck installed (optional for testing)
* XMLLint (optional for validating the atom feed syntax)
The script is tested on a recent Fedora Linux. For *BSD or macOS, you would need to install GNU Sed, GNU Date, GNU Grep and a newer version of Bash.
+## Why Bash?
+
+This project is too complex for a Bash script. Writing it in Bash was to try out how maintainable a "larger" Bash script could be. It's still pretty maintainable and helps me try new Bash tricks here and then!
+
## Usage
So you want such a pretty internet site too?
@@ -104,6 +109,20 @@ Once your capsule reaches a certain size it can become annoying to re-generate e
This will help you to quickly review the results once in a while. Once you are happy you should always re-generate the whole capsule before publishing it! Note, that there will be no Atom feed generation in filter mode so before publishing it you should always run a full `--generate`.
+### Source code highlighting
+
+The HTML output supports source code highlighting. The requirement is to have the `source-highlight` command, which is GNU Source Highlight, to be installed. Once done, you can annotate a bare block with the language to be highlighted. E.g.:
+
+```
+ ```bash
+ if [ -n "$foo" ]; then
+ echo "$foo"
+ fi
+ ...
+```
+
+Please run `source-highlight --lang-list` for a list of all supported languages.
+
### Templating
Since version `2.0.0`, Gemtexter supports templating. A template file name must have the suffix `gmi.tpl`. A template must be put into the same directory as the Gemtext `.gmi` file to be generated. Gemtexter will generate a Gemtext file `index.gmi` from a given template `index.gmi.tpl`. All lines starting with `<< ` will be evaluated as a single line of Bash code and the output will be written into the resulting Gemtext file. A `<<<` and `>>>` encloses a multiline template.
@@ -183,6 +202,26 @@ You will find the `./extras/html/header.html.part` and `./extras/html/footer.htm
`gemtexter` will never touch the `$BASE_CONTENT_DIR/html/.domains`, as this is a required file for a Codeberg page. Furthermore, the `robots.txt` file won't be overridden as well.
+### HTML Mastadon verification
+
+https://joinmastodon.org/verification explains how it works on Mastadon. So we have to hyperlink to the Mastadon profile to be verified and also include a `rel='me'` into the tag. In order to do that add this to the `gemtexter.conf` (replace the URI to your Mastadon profile accordingly):
+
+```
+declare -xr MASTADON_URI='https://fosstodon.org/@snonux'
+```
+
+and add the following into your `index.gmi`:
+
+```
+=> https://fosstodon.org/@snonux Me at Mastaton
+```
+
+The resulting line in the HTML output will be something as follows:
+
+```
+<a href="https://fosstodon.org/@snonux" rel='me'>Me at mastadon</a>
+```
+
### Special Markdown configuration for GitHub pages
`gemtexter` will never touch the `$BASE_CONTENT_DIR/md/_config.yml` file (if it exists). That's a particular configuration file for GitHub Pages. `gemtexter` also will never modify the file `$BASE_CONTENT_DIR/md/CNAME`, as this is also a file required by GitHub pages for using custom domains.
diff --git a/extras/html/footer.html.part b/extras/html/footer.html.part
index 997364c..9da59e5 100644
--- a/extras/html/footer.html.part
+++ b/extras/html/footer.html.part
@@ -1,5 +1,5 @@
<p class="footer">
-Generated with <a href="https://codeberg.org/snonux/gemtexter">Gemtexter</a> |
+Generated by <a href="https://codeberg.org/snonux/gemtexter">%%GEMTEXTER%%</a> |
served by <a href="https://www.OpenBSD.org">OpenBSD</a>/<a href="https://man.openbsd.org/httpd.8">httpd(8)</a> |
<a href="https://www.%%DOMAIN%%/site-mirrors.html">Site Mirrors</a>
</p>
diff --git a/extras/html/intelone-mono/intelone-mono-font-family-regular.ttf b/extras/html/intelone-mono/intelone-mono-font-family-regular.ttf
new file mode 100644
index 0000000..2711179
--- /dev/null
+++ b/extras/html/intelone-mono/intelone-mono-font-family-regular.ttf
Binary files differ
diff --git a/extras/html/intelone-mono/license b/extras/html/intelone-mono/license
new file mode 100644
index 0000000..2159440
--- /dev/null
+++ b/extras/html/intelone-mono/license
@@ -0,0 +1,93 @@
+Copyright (c) 2023 Intel Corp. with Reserved Font Name "Intel One Mono", "IntelOne Mono"
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+
+This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/extras/html/style.css b/extras/html/style.css
index b3d6052..0001a3a 100644
--- a/extras/html/style.css
+++ b/extras/html/style.css
@@ -21,7 +21,8 @@
body {
font-family: text;
max-width: 1024px;
- padding: 0 20px;
+ padding: 20px 20px;
+ margin: 20px auto;
border-image: linear-gradient(#f6b73c, #4d9f0c) 30;
border-width: 1px;
border-style: solid;
@@ -46,16 +47,16 @@ a.textlink:before {
padding-left: 11px;
}
-p.quote {
+.quote {
font-style: italic;
}
-p.quote:before {
+.quote:before {
content: "« ";
padding-left: 2px;
}
-p.quote:after {
+.quote:after {
content: " »";
padding-right: 2px;
}
diff --git a/gemtexter b/gemtexter
index 119d4fa..1ee879e 100755
--- a/gemtexter
+++ b/gemtexter
@@ -5,13 +5,15 @@
declare -r ARG="$1"; shift
declare CONTENT_FILTER="$1"; shift
-declare -r VERSION=2.0.1
-declare -r VERSION_DESCR=bugfix
+declare -r VERSION=2.1.0
+declare -r VERSION_DESCR='release'
+declare -r GEMTEXTER="Gemtexter $VERSION-$VERSION_DESCR"
declare -r DATE_FORMAT='--iso-8601=seconds'
declare DATE=date
declare SED=sed
declare GREP=grep
declare XMLLINT=''
+declare SOURCE_HIGHLIGHT=''
which gdate &>/dev/null && DATE=gdate
which gsed &>/dev/null && SED=gsed
which ggrep &>/dev/null && GREP=ggrep
@@ -26,6 +28,8 @@ test -z "$GIT_COMMIT_MESSAGE" && GIT_COMMIT_MESSAGE=''
test -z "$LOG_VERBOSE" && LOG_VERBOSE=''
test -z "$PRE_GENERATE_HOOK" && PRE_GENERATE_HOOK=''
test -z "$POST_PUBLISH_HOOK" && POST_PUBLISH_HOOK=''
+test -z "$HTML_VARIANT" && HTML_VARIANT=''
+test -z "$MASTADON_URI" && MASTADON_URI=''
set -euf -o pipefail
@@ -37,6 +41,12 @@ else
source ./gemtexter.conf
fi
+if [[ -z "$HTML_VARIANT" ]]; then
+ export HTML_VARIANT_TO_USE=default
+else
+ export HTML_VARIANT_TO_USE="$HTML_VARIANT"
+fi
+
source ./lib/assert.source.sh
source ./lib/atomfeed.source.sh
source ./lib/gemfeed.source.sh
@@ -88,6 +98,12 @@ check_dependencies () {
else
export XMLLINT=xmllint
fi
+
+ if ! source-highlight --version &>/dev/null; then
+ log WARN "WARN, GNU \"source-highlight\" command is not installed, but it's recommended!"
+ else
+ export SOURCE_HIGHLIGHT=source-highlight
+ fi
}
setup () {
diff --git a/gemtexter-paul.cyou.conf b/gemtexter-paul.buetow.org.conf
index c7f1fca..d1c4f86 100644
--- a/gemtexter-paul.cyou.conf
+++ b/gemtexter-paul.buetow.org.conf
@@ -1,14 +1,16 @@
# Alternate config for my other domain
-declare -xr DOMAIN=paul.cyou
+declare -xr DOMAIN=paul.buetow.org
declare -xr SUBTITLE="Paul Buetow's contact information"
declare -xr AUTHOR='Paul Buetow'
-declare -xr EMAIL='hi@paul.cyou'
+declare -xr EMAIL='contact@mx.buetow.org'
+declare -xr MASTADON_URI='https://fosstodon.org/@snonux'
declare -xr IMAGE_PATTERN='\.(jpg|png|gif)$'
declare -xr ATOM_MAX_ENTRIES=42
-declare -xr CONTENT_BASE_DIR=../paul.cyou-content
+declare -xr CONTENT_BASE_DIR=../paul.buetow.org-content
declare -xr HTML_HEADER=./extras/html/header.html.part
declare -xr HTML_FOOTER=./extras/html/footer.html.part
declare -xr HTML_CSS_STYLE=./extras/html/style.css
+declare -xr HTML_VARIANT=exact
declare -xr HTML_WEBFONT_TEXT=./extras/html/roboto-slab/RobotoSlab-Regular.ttf
declare -xr HTML_WEBFONT_CODE=./extras/html/hack/Hack-Regular.ttf
declare -xr HTML_WEBFONT_HANDNOTES=./extras/html/khand/khand.ttf
diff --git a/gemtexter.conf b/gemtexter.conf
index 5095d22..a928b27 100644
--- a/gemtexter.conf
+++ b/gemtexter.conf
@@ -1,7 +1,7 @@
declare -xr DOMAIN=foo.zone
declare -xr SUBTITLE='To be in the .zone!'
declare -xr AUTHOR='Paul Buetow'
-declare -xr EMAIL='hi@paul.cyou'
+declare -xr EMAIL='paul@dev.buetow.org'
declare -xr IMAGE_PATTERN='\.(jpg|png|gif)$'
declare -xr ATOM_MAX_ENTRIES=42
declare -xr CONTENT_BASE_DIR=../foo.zone-content
@@ -10,6 +10,7 @@ declare -xr POST_PUBLISH_HOOK=./post_publish_hook.sh
declare -xr HTML_HEADER=./extras/html/header.html.part
declare -xr HTML_FOOTER=./extras/html/footer.html.part
declare -xr HTML_CSS_STYLE=./extras/html/style.css
+declare -xr HTML_VARIANT=exact
declare -xr HTML_WEBFONT_TEXT=./extras/html/hack/Hack-Regular.ttf
declare -xr HTML_WEBFONT_CODE=./extras/html/hack/Hack-Regular.ttf
declare -xr HTML_WEBFONT_HANDNOTES=./extras/html/khand/khand.ttf
diff --git a/lib/assert.source.sh b/lib/assert.source.sh
index a1713c3..990194c 100644
--- a/lib/assert.source.sh
+++ b/lib/assert.source.sh
@@ -31,6 +31,20 @@ assert::not_empty () {
log VERBOSE "Result in $callee as expected not empty"
}
+# Unit test for whether a given string contains a substring
+assert::contains () {
+ local -r content="$1"; shift
+ local -r substring="$1"; shift
+ local -r callee=${FUNCNAME[1]}
+
+ if ! $GREP -q -F "$substring" <<< "$content"; then
+ log ERROR "In $callee expected '$content' to contain substring '$substring'"
+ exit 2
+ fi
+
+ log VERBOSE "Substring check in $callee as expected, contains '$substring'"
+}
+
# Unit test for whether a given string matches a regex.
assert::matches () {
local -r name="$1"; shift
diff --git a/lib/generate.source.sh b/lib/generate.source.sh
index cc6b3cc..8cc3329 100644
--- a/lib/generate.source.sh
+++ b/lib/generate.source.sh
@@ -112,6 +112,7 @@ generate::_to_output_format () {
fi
$SED -i "s|%%TITLE%%|$title|g;
s|%%DOMAIN%%|$DOMAIN|g;
+ s|%%GEMTEXTER%%|$GEMTEXTER|g;
s|%%STYLESHEET%%|$stylesheet|g;
s|%%STYLESHEET_OVERRIDE%%|$stylesheet_override|g;" "$dest.tmp"
diff --git a/lib/git.source.sh b/lib/git.source.sh
index 8048aad..c2b216a 100644
--- a/lib/git.source.sh
+++ b/lib/git.source.sh
@@ -30,7 +30,9 @@ git::_add_all () {
done
local -r format="$(basename "$content_dir")"
- git commit -a -m "$message for $format"
+ if ! git commit -a -m "$message for $format"; then
+ log INFO 'Nothing new to be added'
+ fi
cd "$pwd"
}
diff --git a/lib/html.source.sh b/lib/html.source.sh
index d99220b..371866a 100644
--- a/lib/html.source.sh
+++ b/lib/html.source.sh
@@ -1,9 +1,10 @@
-# Convert special characters to their HTML codes
+# Convert specia characters to their HTML codes
html::encode () {
$SED '
s|\&|\&amp;|g;
s|<|\&lt;|g;
s|>|\&gt;|g;
+ s|'\''|\&#39;|g;
' <<< "$@"
}
@@ -11,7 +12,13 @@ html::encode () {
html::make_paragraph () {
local -r text="$1"; shift
- if [[ -n "$text" ]]; then
+ if [ "$HTML_VARIANT_TO_USE" = exact ]; then
+ if [ -n "$text" ]; then
+ echo "<span>$(html::encode "$text")</span><br />"
+ else
+ echo '<br />'
+ fi
+ elif [ -n "$text" ]; then
echo "<p>$(html::encode "$text")</p>"
fi
}
@@ -20,13 +27,23 @@ html::make_paragraph () {
html::make_heading () {
local -r text=$($SED -E 's/^#+ //' <<< "$1"); shift
local -r level="$1"; shift
- echo "<h${level}>$(html::encode "$text")</h${level}>"
+
+ if [ "$HTML_VARIANT_TO_USE" = exact ]; then
+ #echo "<span class='h${level}'>$(html::encode "$text")</span><br />"
+ echo "<h${level} style='display: inline'>$(html::encode "$text")</h${level}><br />"
+ else
+ echo "<h${level}>$(html::encode "$text")</h${level}><br />"
+ fi
}
# Make a HTML quotation
html::make_quote () {
local -r quote="${1/> }"
- echo "<p class=\"quote\"><i>$(html::encode "$quote")</i></p>"
+ if [ "$HTML_VARIANT_TO_USE" = exact ]; then
+ echo "<span class='quote'>$(html::encode "$quote")</span><br />"
+ else
+ echo "<p class='quote'><i>$(html::encode "$quote")</i></p>"
+ fi
}
# Make a HTML image
@@ -35,12 +52,10 @@ html::make_img () {
local descr="$1"; shift
if [ -z "$descr" ]; then
- echo -n "<a href=\"$link\"><img src=\"$link\" /></a>"
+ echo "<a href='$link'><img src='$link' /></a><br />"
else
- echo -n "<a href=\"$link\"><img alt=\"$descr\" title=\"$descr\" src=\"$link\" /></a>"
+ echo "<a href='$link'><img alt='$descr' title='$descr' src='$link' /></a><br />"
fi
-
- echo "<br />"
}
# Make a HTML hyperlink
@@ -56,17 +71,16 @@ html::make_link () {
descr="$link"
fi
- echo "<a class=\"textlink\" href=\"$link\">$descr</a><br />"
-}
+ local mastadon_verify=''
+ if [[ "$link" = "$MASTADON_URI" ]]; then
+ mastadon_verify=" rel='me'"
+ fi
-# Make inline code!
-html::process_inline_code () {
- $SED -E 's|`([^`]+)`|<span class="inlinecode">\1</span>|g'
+ echo "<a class='textlink' href='$(html::encode "$link")'$mastadon_verify>$descr</a><br />"
}
html::process_inline () {
- # As of now we only inlinde "code blocks", but we can chain more here later!
- html::process_inline_code
+ $SED -E "s|\`([^\`]+)\`|<span class='inlinecode'>\\1</span>|g"
}
html::add_extras () {
@@ -82,16 +96,41 @@ html::add_extras () {
cp "$override_source" "$override_dest"
fi
done < <(find "$html_base_dir" -mindepth 1 -maxdepth 1 -type d | $GREP -E -v '(\.git)')
- cp "$HTML_WEBFONT_TEXT" "$html_base_dir/text.ttf"
- cp "$HTML_WEBFONT_CODE" "$html_base_dir/code.ttf"
- cp "$HTML_WEBFONT_HANDNOTES" "$html_base_dir/handnotes.ttf"
- cp "$HTML_WEBFONT_TYPEWRITER" "$html_base_dir/typewriter.ttf"
+
+ if [ -f "$HTML_WEBFONT_TEXT" ]; then
+ cp "$HTML_WEBFONT_TEXT" "$html_base_dir/text.ttf"
+ fi
+ if [ -f "$HTML_WEBFONT_CODE" ]; then
+ cp "$HTML_WEBFONT_CODE" "$html_base_dir/code.ttf"
+ fi
+ if [ -f "$HTML_WEBFONT_HANDNOTES" ]; then
+ cp "$HTML_WEBFONT_HANDNOTES" "$html_base_dir/handnotes.ttf"
+ fi
+ if [ -f "$HTML_WEBFONT_TYPEWRITER" ]; then
+ cp "$HTML_WEBFONT_TYPEWRITER" "$html_base_dir/typewriter.ttf"
+ fi
+}
+
+html::source_highlight () {
+ local -r bare_text="$1"; shift
+ local -r language="$1"; shift
+
+ if [[ -z "$language" || -z "$SOURCE_HIGHLIGHT" ]]; then
+ echo '<pre>'
+ html::encode "$bare_text"
+ echo '</pre>'
+ else
+ $SOURCE_HIGHLIGHT --src-lang="$language" <<< "$bare_text" |
+ $SED 's|<tt>||; s|</tt>||;'
+ fi
}
# Convert Gemtext to HTML
html::fromgmi () {
local is_list=no
- local is_plain=no
+ local is_bare=no
+ local bare_text=''
+ local language=''
while IFS='' read -r line; do
if [[ "$is_list" == yes ]]; then
@@ -100,16 +139,25 @@ html::fromgmi () {
html::process_inline
else
is_list=no
- echo "</ul>"
+ if [ "$HTML_VARIANT_TO_USE" = exact ]; then
+ echo "</ul><br />"
+ else
+ echo "</ul>"
+ fi
fi
continue
- elif [[ "$is_plain" == yes ]]; then
+ elif [[ "$is_bare" == yes ]]; then
if [[ "$line" == '```'* ]]; then
- echo "</pre>"
- is_plain=no
+ html::source_highlight "$bare_text" "$language"
+ is_bare=no
+ bare_text=''
+ language=''
+ elif [ -z "$bare_text" ]; then
+ bare_text="$line"
else
- html::encode "$line"
+ bare_text="$bare_text
+$line"
fi
continue
fi
@@ -122,8 +170,8 @@ html::fromgmi () {
html::process_inline
;;
'```'*)
- is_plain=yes
- echo '<pre>'
+ language=$(cut -d'`' -f4 <<< "$line")
+ is_bare=yes
;;
'# '*)
html::make_heading "$line" 1 | html::process_inline
@@ -141,18 +189,16 @@ html::fromgmi () {
generate::make_link html "$line" | html::process_inline
;;
*)
- if [[ "$is_plain" == no ]]; then
- html::make_paragraph "$line" | html::process_inline
- else
- html::make_paragraph "$line"
- fi
+ html::make_paragraph "$line" | html::process_inline
;;
esac
done
}
-# Test HTML package.
-html::test () {
+# Test default HTML variant.
+html::test::default () {
+ MASTADON_URI=''
+
local line='Hello world! This is a paragraph.'
assert::equals "$(html::make_paragraph "$line")" '<p>Hello world! This is a paragraph.</p>'
@@ -165,39 +211,99 @@ html::test () {
line='echo foo 2>&1'
assert::equals "$(html::make_paragraph "$line")" '<p>echo foo 2&gt;&amp;1</p>'
- line='# Header 1'
- assert::equals "$(html::make_heading "$line" 1)" '<h1>Header 1</h1>'
-
- line='## Header 2'
- assert::equals "$(html::make_heading "$line" 2)" '<h2>Header 2</h2>'
-
- line='### Header 3'
- assert::equals "$(html::make_heading "$line" 3)" '<h3>Header 3</h3>'
-
line='> This is a quote'
- assert::equals "$(html::make_quote "$line")" '<p class="quote"><i>This is a quote</i></p>'
+ assert::equals "$(html::make_quote "$line")" "<p class='quote'><i>This is a quote</i></p>"
line='Testing: `hello_world.sh --debug` :-) `another one`!'
- assert::equals "$(echo "$line" | html::process_inline_code)" \
- 'Testing: <span class="inlinecode">hello_world.sh --debug</span> :-) <span class="inlinecode">another one</span>!'
+ assert::equals "$(echo "$line" | html::process_inline)" \
+ "Testing: <span class='inlinecode'>hello_world.sh --debug</span> :-) <span class='inlinecode'>another one</span>!"
line='=> https://example.org'
assert::equals "$(generate::make_link html "$line")" \
- '<a class="textlink" href="https://example.org">https://example.org</a><br />'
+ "<a class='textlink' href='https://example.org'>https://example.org</a><br />"
+
+ line="=> https://example.org/foo'bar"
+ assert::equals "$(generate::make_link html "$line")" \
+ "<a class='textlink' href='https://example.org/foo&#39;bar'>https://example.org/foo'bar</a><br />"
line='=> index.html'
assert::equals "$(generate::make_link html "$line")" \
- '<a class="textlink" href="index.html">index.html</a><br />'
+ "<a class='textlink' href='index.html'>index.html</a><br />"
line='=> http://example.org Description of the link'
assert::equals "$(generate::make_link html "$line")" \
- '<a class="textlink" href="http://example.org">Description of the link</a><br />'
+ "<a class='textlink' href='http://example.org'>Description of the link</a><br />"
+
+ # Test Mastadon verification.
+ MASTADON_URI='https://fosstodon.org/@snonux'
+ line='=> https://fosstodon.org/@snonux Me at Mastadon'
+ assert::equals "$(generate::make_link html "$line")" \
+ "<a class='textlink' href='https://fosstodon.org/@snonux' rel='me'>Me at Mastadon</a><br />"
+ MASTADON_URI=''
line='=> http://example.org/image.png'
assert::equals "$(generate::make_link html "$line")" \
- '<a href="http://example.org/image.png"><img src="http://example.org/image.png" /></a><br />'
+ "<a href='http://example.org/image.png'><img src='http://example.org/image.png' /></a><br />"
line='=> http://example.org/image.png Image description'
assert::equals "$(generate::make_link html "$line")" \
- '<a href="http://example.org/image.png"><img alt="Image description" title="Image description" src="http://example.org/image.png" /></a><br />'
+ "<a href='http://example.org/image.png'><img alt='Image description' title='Image description' src='http://example.org/image.png' /></a><br />"
+
+
+ local input_block='```
+this
+ is
+ a
+ bare block
+```'
+
+ local output_block='<pre>
+this
+ is
+ a
+ bare block
+</pre>'
+
+ assert::equals "$(html::fromgmi <<< "$input_block")" "$output_block"
+
+ if [ -n "$SOURCE_HIGHLIGHT" ]; then
+ input_block='```bash
+if [ -z $foo ]; then
+ echo $foo
+fi
+```'
+ assert::contains "$(html::fromgmi <<< "$input_block")" 'GNU source-highlight'
+ fi
+}
+
+# Test exact HTML variant.
+html::test::exact () {
+ local line='Hello world! This is a paragraph.'
+ assert::equals "$(html::make_paragraph "$line")" "<span>Hello world! This is a paragraph.</span><br />"
+
+ line=''
+ assert::equals "$(html::make_paragraph "$line")" '<br />'
+
+ line='Foo &<>& Bar!'
+ assert::equals "$(html::make_paragraph "$line")" "<span>Foo &amp;&lt;&gt;&amp; Bar!</span><br />"
+
+ line='echo foo 2>&1'
+ assert::equals "$(html::make_paragraph "$line")" "<span>echo foo 2&gt;&amp;1</span><br />"
+
+ line='# Header 1'
+ assert::equals "$(html::make_heading "$line" 1)" "<h1 style='display: inline'>Header 1</h1><br />"
+
+ line='## Header 2'
+ assert::equals "$(html::make_heading "$line" 2)" "<h2 style='display: inline'>Header 2</h2><br />"
+
+ line='### Header 3'
+ assert::equals "$(html::make_heading "$line" 3)" "<h3 style='display: inline'>Header 3</h3><br />"
+
+ line='> This is a quote'
+ assert::equals "$(html::make_quote "$line")" "<span class='quote'>This is a quote</span><br />"
+}
+
+html::test () {
+ HTML_VARIANT_TO_USE=default html::test::default
+ HTML_VARIANT_TO_USE=exact html::test::exact
}