diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bae5a75 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,58 @@ +# Contributing to the TeXmacs markdown plugin + +Follow the setup instructions in [README.md](README.md) to get started. + +**TODO:** this document is a stub. + +## Code organization + +Conversion is done in two stages: + +1. From TeXmacs to an internal stree representation: `tmmarkdown.scm`. +2. From the internal representation to markdown: `markdownout.scm`. + +The plugin is loaded in `init-markdown.scm`, and some utilities are provided in +`markdown-utils.scm`. Extensions to TeXmacs menus are in `markdown-menus.scm`. + +Tests are in `tests/` and are can be run from within TeXmacs with the markdown +menu. + +## Conversion from TeXmacs to internal representation + +The entry point is `tm->markdown*` in `tmmarkdown.scm`. The function takes a +TeXmacs tree and returns an slist of markdown elements. This is also a +pre-processing step does things like dropping TeXmacs-specific info, adding +labels to equations, setting up counters, etc. + +Parsing functions always return an slist. Some arguments are processed and +`tm->markdown*` is typically called on the remaining ones recursively. + + +## Conversion from internal representation to markdown + +The entry point is `serialize-markdown` in `markdownout.scm`. + +## Some suggestions for development + +Like all TeXmacs code, the entry point for each module is located at the +bottom of the file. + +Scheme sessions inside TeXmacs documents are very useful to prototype ideas. +First you want to add whatever tag it is that you are interested, say `mytag` +to the top of the document, then you read it into scheme with: + +```scheme +(select (buffer-get-body (current-buffer)) '(:* mytag)) +``` + +This will return a list of trees with the tag `mytag`. You can then pick any +one of them and process it with the `tm-` prefixed built-in functions: +* `(tm-ref x pos)`: returns the `pos`th child of `x`. +* `(tm->string x)`: returns a string representation of `x`. +* `(tm->markdown* x)`: returns an slist of markdown elements. + +## Testing + +Tests are located in `tests/` and are run from within TeXmacs with the markdown +menu. Each test reads a TeXmacs file and compares it with a homonymous markdown +file in the same directory. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..20d40b6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. \ No newline at end of file diff --git a/README.md b/README.md index 8872161..28df7ae 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,18 @@ possibility of exporting them as html into the markdown file. The plugin has been developed for its use in two specific websites, [Paperwhy](https://paperwhy.8027.org/) and appliedAI's -[TransferLab](https://transferlab.appliedai.de/), and can use multiple -extensions specific to the static website generator [Hugo](https://gohugo.io/). -There might still be some code very specific to those sites, YMMV. +[TransferLab](https://transferlab.ai/), and can use multiple extensions +specific to the static website generator [Hugo](https://gohugo.io/). There +might still be some code very specific to those sites, YMMV. ## Setup -Clone this repository into your `~/.TeXmacs/plugins` directory as `markdown`. -For Linux / OSX this is: +Clone this repository into your `~/.TeXmacs/plugins` directory as `markdown` +and checkout the `master` branch. For Linux / OSX this is: ```shell -git clone https://github.com/texmacs/markdown.git ~/.TeXmacs/plugins/markdown +git clone -b master https://github.com/texmacs/markdown.git +~/.TeXmacs/plugins/markdown ``` For Windows, the path (usually?) is @@ -55,7 +56,9 @@ package -> Markdown -> markdown` to enable: * Support for alternate image formats between TeXmacs and markdown via ``. This is useful e.g. to provide - SVG and EPS/PDF versions of images for print and web respectively. + SVG and EPS/PDF versions of images for print and web respectively. The same + effect can be achieved with `` and + ``. * Macros for labels in equation arrays. Using positioning tricks with `` results in LaTeX code that MathJax does not support, namely `\hfill`. For this reason, we provide two macros @@ -107,7 +110,11 @@ All custom shortcodes are in `extensions/hugo/`. * Figures are converted to `{{< figure >}}`. * For arbitrary shortcodes, use ``, e.g. - `` for `{{< toc >}}`. + `` for `{{< toc >}}`. In order to pass + named arguments, use + ``. For + positional arguments, replace the argument names by `#f` as in + ``. * Citations using `` and `` (of any arity) are automatically detected and converted to `{{< cite ref >}}`, and all of them are gathered in the frontmatter as well, for indization by Hugo's diff --git a/doc/markdown.en.tm b/doc/markdown.en.tm index fa813fd..96a683f 100644 --- a/doc/markdown.en.tm +++ b/doc/markdown.en.tm @@ -1,9 +1,9 @@ - + <\body> - + > markdown plugin> @@ -16,7 +16,7 @@ The plugin has been developed for its use in two specific websites, and appliedAI's - , and can use multiple + , and can use multiple extensions specific to the static website generator . There might still be some code very specific to those sites, YMMV. @@ -24,10 +24,11 @@ Clone this repository into your directory as - . For Linux / OSX this is: + and checkout the branch. For Linux / OSX + this is: <\shell-code> - git clone https://github.com/texmacs/markdown.git + git clone -b master https://github.com/texmacs/markdown.git ~/.TeXmacs/plugins/markdown @@ -73,7 +74,9 @@ Support for alternate image formats between and markdown via . This is useful e.g. to provide SVG and EPS/PDF versions of images for print and web - respectively. + respectively. The same effect can be achieved with + > and + >. Macros for labels in equation arrays. Using positioning tricks with results in code that does not @@ -143,7 +146,10 @@ \}}>. For arbitrary shortcodes, use , e.g. - for toc \}}>. + for toc \}}>. In + order to pass named arguments, use >. + For positional arguments, replace the argument names by as in + >. Citations using and (of any arity) are automatically detected and @@ -189,4 +195,4 @@ <\collection> - + \ No newline at end of file diff --git a/packages/markdown/hugo.ts b/packages/markdown/hugo.ts index 0dbe8dc..47ace55 100644 --- a/packages/markdown/hugo.ts +++ b/packages/markdown/hugo.ts @@ -1,4 +1,4 @@ - + @@ -28,6 +28,8 @@ + >|green>>> + >> > diff --git a/progs/markdown-menus.scm b/progs/markdown-menus.scm index 9638c6d..02c900b 100644 --- a/progs/markdown-menus.scm +++ b/progs/markdown-menus.scm @@ -102,3 +102,8 @@ (menu-bind texmacs-extra-menu (if (and (supports-markdown?) (markdown-menu-show?)) (=> "Markdown" (link markdown-menu)))) + +(menu-bind specific-menu + (when (not (selection-active-large?)) + (former) + ("Markdown" (make-specific "markdown")))) \ No newline at end of file diff --git a/progs/markdownout.scm b/progs/markdownout.scm index 915f381..3420669 100644 --- a/progs/markdownout.scm +++ b/progs/markdownout.scm @@ -136,10 +136,9 @@ (define (md-abstract x) (if (hugo-extensions?) (with-md-globals 'paragraph-width #f - (with-md-globals 'disable-shortcodes #t - (md-hugo-frontmatter + (md-hugo-frontmatter `(hugo-front "summary" ,(serialize-markdown* (cdr x)))))) - (md-paragraph `(concat (strong "Abstract: ") (em ,(cdr x)))))) + (md-paragraph `(concat (strong "Abstract: ") (em ,(cdr x))))) (define (must-adjust? t) (tm-in? t '(strong em tt strike math concat cite cite-detail @@ -394,7 +393,7 @@ (with citations (filter (lambda (x) (and (string? x) (not (string-null? x)))) (cdr x)) (md-set 'refs (append (md-get 'refs) citations)) - (md-hugo-shortcode + (md-hugo-shortcode* (cons 'cite (map (lambda (s) `(#f . ,s)) citations)))))) (define (md-cite-detail x) @@ -423,8 +422,8 @@ (begin (set! args (assoc-remove-many args '(body name caption))) (set! args (assoc-append? args 'class (md-get 'html-class))) - (md-hugo-shortcode `(,type ,@args) - `(document ,body (concat ,name ,caption)))) + (md-hugo-shortcode* `(,type ,@args) + `(document ,body (concat ,name ,caption)))) (with content (if (assoc 'src args) `(image ,(assoc-ref args 'src) ,body) body) @@ -464,7 +463,12 @@ (map set-pair! (list->assoc (cdr x)))))) "") -(define (md-hugo-shortcode x . inner) +(define (md-hugo-shortcode x) + "Processes '(hugo-short shortcode-name (args)) where args is a list of tuples (name val). For unnamed arguments, use (#f val)" + (md-hugo-shortcode* (cdr x))) + +(define (md-hugo-shortcode* x . inner) + "Inner processing of shortcodes" (if (not (md-get 'disable-shortcodes)) (let ((shortcode (symbol->string (car x))) (args (cdr x)) @@ -485,14 +489,14 @@ (define (md-bibliography x) (if (hugo-extensions?) - (md-hugo-shortcode '(references)) + (md-hugo-shortcode* '(references)) (md-style '(strong "Bibliography not implemented for raw Markdown")))) (define (md-sidenote-sub x numbered?) (if (hugo-extensions?) (let ((numbered (if numbered? '((numbered . "numbered")) '())) (args (cdr x))) - (md-hugo-shortcode + (md-hugo-shortcode* (append `(sidenote (halign . ,(md-marginal-style (first args))) (valign . ,(md-marginal-style (second args)))) numbered) @@ -574,71 +578,71 @@ (define serialize-hash (make-ahash-table)) (map (lambda (l) (apply (cut ahash-set! serialize-hash <> <>) l)) - (list (list 'identity skip) - (list 'markdown md-markdown) - (list 'localize md-translate) - (list 'labels md-labels) - (list 'strong md-style) - (list 'em md-style) - (list 'tt md-style) - (list 'strike md-style) - (list 'underline md-style) - (list 'block md-block) - (list 'quotation md-quotation) - (list 'document md-document) - (list 'std-env (md-make-environment 'em)) - (list 'std-env* (md-make-environment* 'em)) - (list 'plain-env (md-make-environment 'identity)) - (list 'plain-env* (md-make-environment* 'identity)) - (list 'dueto md-dueto) - (list 'math md-math) - (list 'equation md-numbered-equation) - (list 'equation* md-equation) - (list 'eqnarray md-numbered-equation) - (list 'eqnarray* md-equation) - (list 'concat md-concat) - (list 'item md-item) - (list 'itemize md-list) - (list 'enumerate md-list) - (list 'h1 (md-header 1)) - (list 'h2 (md-header 2)) - (list 'h3 (md-header 3)) - (list 'para md-para) - (list 'doc-date md-doc-date) - (list 'doc-title md-doc-title) - (list 'doc-subtitle md-doc-subtitle) - (list 'doc-author md-doc-author) - (list 'abstract md-abstract) - (list 'paper-author-name paper-author-add) ; Paperwhy extension - (list 'cite md-cite) - (list 'cite-detail md-cite-detail) - (list 'eqref md-eqref) - (list 'label md-label) - (list 'reference md-reference) - (list 'footnote md-footnote) - (list 'todo md-todo) - (list 'image md-image) - (list 'html-class md-html-class) - (list 'small-figure (md-figure 'tmfigure '(class . "small-figure"))) - (list 'big-figure - (md-figure 'tmfigure - '(marginal-caption . #t) '(class . "big-figure"))) - (list 'wide-figure (md-figure 'tmfigure '(class . "wide-figure"))) - (list 'marginal-figure (md-figure 'sidefigure)) - (list 'small-table (md-figure 'tmfigure)) - (list 'big-table (md-figure 'tmfigure )) - (list 'tabular md-tabular) - (list 'hlink md-hlink) - (list 'tags md-hugo-tags) ; Hugo extension (DEPRECATED) - (list 'hugo-short md-hugo-shortcode) ; Hugo extension - (list 'hugo-front md-hugo-frontmatter) ; Hugo extension - (list 'table-of-contents md-toc) ; Hugo extension - (list 'bibliography md-bibliography) ; TfL extension - (list 'marginal-note md-sidenote) ; TfL extension - (list 'marginal-note* md-sidenote*) ; TfL extension - (list 'explain-macro md-explain-macro) - (list 'tmdoc-copyright md-tmdoc-copyright) - )) + (list + (list 'abstract md-abstract) + (list 'bibliography md-bibliography) ; TfL extension + (list 'big-figure + (md-figure 'tmfigure '(marginal-caption . #t) '(class . "big-figure"))) + (list 'big-table (md-figure 'tmfigure )) + (list 'block md-block) + (list 'cite-detail md-cite-detail) + (list 'cite md-cite) + (list 'concat md-concat) + (list 'doc-author md-doc-author) + (list 'doc-date md-doc-date) + (list 'doc-subtitle md-doc-subtitle) + (list 'doc-title md-doc-title) + (list 'document md-document) + (list 'dueto md-dueto) + (list 'em md-style) + (list 'enumerate md-list) + (list 'eqnarray* md-equation) + (list 'eqnarray md-numbered-equation) + (list 'eqref md-eqref) + (list 'equation* md-equation) + (list 'equation md-numbered-equation) + (list 'explain-macro md-explain-macro) + (list 'footnote md-footnote) + (list 'h1 (md-header 1)) + (list 'h2 (md-header 2)) + (list 'h3 (md-header 3)) + (list 'hlink md-hlink) + (list 'html-class md-html-class) + (list 'hugo-front md-hugo-frontmatter) ; Hugo extension + (list 'hugo-short md-hugo-shortcode) ; Hugo extension + (list 'identity skip) + (list 'image md-image) + (list 'itemize md-list) + (list 'item md-item) + (list 'label md-label) + (list 'labels md-labels) + (list 'localize md-translate) + (list 'marginal-figure (md-figure 'sidefigure)) + (list 'marginal-note md-sidenote) ; TfL extension + (list 'marginal-note* md-sidenote*) ; TfL extension + (list 'markdown md-markdown) + (list 'math md-math) + (list 'paper-author-name paper-author-add) ; Paperwhy extension + (list 'para md-para) + (list 'plain-env (md-make-environment 'identity)) + (list 'plain-env* (md-make-environment* 'identity)) + (list 'quotation md-quotation) + (list 'reference md-reference) + (list 'small-figure (md-figure 'tmfigure '(class . "small-figure"))) + (list 'small-table (md-figure 'tmfigure)) + (list 'std-env (md-make-environment 'em)) + (list 'std-env* (md-make-environment* 'em)) + (list 'strike md-style) + (list 'strong md-style) + (list 'table-of-contents md-toc) ; Hugo extension + (list 'tabular md-tabular) + (list 'tags md-hugo-tags) ; Hugo extension (DEPRECATED) + (list 'tmdoc-copyright md-tmdoc-copyright) + (list 'todo md-todo) + (list 'tt md-style) + (list 'underline md-style) + (list 'wide-figure (md-figure 'tmfigure '(class . "wide-figure"))) + )) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Public interface diff --git a/progs/tmmarkdown.scm b/progs/tmmarkdown.scm index 23cd6b2..758fe22 100644 --- a/progs/tmmarkdown.scm +++ b/progs/tmmarkdown.scm @@ -413,190 +413,204 @@ first empty label" (define (parse-verbatim x) (cons 'tt (cdr x))) +(define (parse-specific x) + (let* ((medium (tm->string (tm-ref x 0))) + (content (tm-ref x 1))) + (cond ((== medium "texmacs") (drop content)) + ((== medium "latex") (drop content)) + ((== medium "html") (drop content)) + ((== medium "markdown") (texmacs->markdown* content)) + ((== medium "screen") (drop content)) + ((== medium "printer") (drop content)) + (else (error "Invalid medium for specific tag: " medium))))) + +(define (parse-hugo-short x) + `(hugo-short ,(string->symbol (tm->string (second x))) + ,(md-map texmacs->markdown* (cddr x)))) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Dispatch ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define conversion-hash (make-ahash-table)) (map (lambda (l) (apply (cut ahash-set! conversion-hash <> <>) l)) - (list (list 'localize keep) - (list 'strong keep) - (list 'dfn (change-to 'strong)) - (list 'em keep) - (list 'strike-through (change-to 'strike)) ; non-standard extension - (list 'underline keep) ; TODO: html extension - (list 'hrule hrule-hack) - (list 'name keep) ; TODO: html extension - (list 'tt keep) - (list 'nbsp (change-to " ")) - (list 'samp (change-to 'tt)) - (list 'python parse-verbatim) - (list 'cpp parse-verbatim) - (list 'scm parse-verbatim) - (list 'mmx parse-verbatim) - (list 'scilab parse-verbatim) - (list 'shell parse-verbatim) - (list 'verbatim parse-verbatim) - (list 'code* parse-verbatim) - (list 'verbatim-code (code-block "")) - (list 'code (code-block "")) - (list 'scm-code (code-block "scheme")) - (list 'cpp-code (code-block "c++")) - (list 'mmx-code (code-block "mmx")) - (list 'python-code (code-block "python")) - (list 'scilab-code (code-block "scilab")) - (list 'shell-code (code-block "shell")) - (list 'doc-date keep) - (list 'doc-author keep) - (list 'author-data keep) - (list 'author-name keep) - (list 'author-email drop) - (list 'abstract keep) - (list 'document keep) - (list 'quotation keep) - (list 'acknowledgments (count parse-plain-env 'env)) - (list 'acknowledgments* parse-plain-env*) - (list 'algorithm (count parse-alg 'alg)) - (list 'algorithm* parse-alg*) - (list 'named-algorithm (count parse-named-alg 'alg)) - (list 'specified-algorithm (count parse-specified-alg 'alg)) - (list 'specified-algorithm* parse-specified-alg*) - (list 'answer (count parse-plain-env 'env)) - (list 'answer* parse-plain-env*) - (list 'axiom (count parse-env 'env)) - (list 'axiom* parse-env*) - (list 'conjecture (count parse-env 'env)) - (list 'conjecture* parse-env*) - (list 'convention (count parse-plain-env 'env)) - (list 'convention* parse-plain-env*) - (list 'corollary (count parse-env 'env)) - (list 'corollary* parse-env*) - (list 'definition (count parse-env 'env)) - (list 'definition* parse-env*) - (list 'example (count parse-plain-env 'env)) - (list 'example* parse-plain-env*) - (list 'exercise (count parse-plain-env 'env)) - (list 'exercise* parse-plain-env*) - (list 'lemma (count parse-env 'env)) - (list 'lemma* parse-env*) - (list 'notation (count parse-env 'env)) - (list 'notation* parse-env*) - (list 'note (count parse-plain-env 'env)) - (list 'note* parse-plain-env*) - (list 'problem (count parse-plain-env 'env)) - (list 'problem* parse-plain-env*) - (list 'proof parse-proof) - (list 'proposition (count parse-env 'env)) - (list 'proposition* parse-env*) - (list 'question (count parse-plain-env 'env)) - (list 'question* parse-plain-env*) - (list 'remark (count parse-plain-env 'env)) - (list 'remark* parse-plain-env*) - (list 'solution (count parse-plain-env 'env)) - (list 'solution* parse-plain-env*) - (list 'theorem (count parse-env 'env)) - (list 'theorem* parse-env*) - (list 'warning (count parse-plain-env 'env)) - (list 'warning* parse-plain-env*) - (list 'dueto keep) - (list 'math parse-math) - (list 'equation (with-counter parse-math 'equation)) - (list 'equation* parse-math) - (list 'eqnarray (with-counter parse-math 'equation)) ; does this exist? - (list 'eqnarray* (with-counter parse-math 'equation)) - (list 'concat keep) - (list 'doc-title keep) - (list 'doc-subtitle keep) - (list 'doc-running-author keep) - (list 'section (count (make-header 'h1) 'h1)) - (list 'section* (count-not (change-to 'h1) 'h1)) - (list 'subsection (count (make-header 'h2) 'h2)) - (list 'subsection* (count-not (change-to 'h2) 'h2)) - (list 'subsubsection (count (make-header 'h3) 'h3)) - (list 'subsubsection* (count-not (change-to 'h3) 'h3)) - (list 'paragraph (change-to 'para)) - (list 'paragraph* (change-to 'para)) - (list 'subparagraph (change-to 'para)) - (list 'subparagraph* (change-to 'para)) - (list 'with parse-with) - (list 'itemize keep) - (list 'itemize-minus (change-to 'itemize)) - (list 'itemize-dot (change-to 'itemize)) - (list 'itemize-arrow (change-to 'itemize)) - (list 'enumerate keep) - (list 'enumerate-numeric (change-to 'enumerate)) - (list 'enumerate-roman (change-to 'enumerate)) - (list 'enumerate-Roman (change-to 'enumerate)) - (list 'enumerate-alpha (change-to 'enumerate)) - (list 'enumerate-Alpha (change-to 'enumerate)) - (list 'item keep) - (list 'cite keep-verbatim) - (list 'cite-detail keep-verbatim) - (list 'hlink parse-link) - (list 'eqref parse-reference) - (list 'label parse-label) - (list 'flag drop) - (list 'reference parse-reference) - (list 'smart-ref parse-smart-reference) - (list 'make-eqref parse-make-eqref) - (list 'image parse-image) - (list 'html-class keep) - (list 'small-figure (count parse-figure 'figure)) - (list 'small-figure* parse-figure*) - (list 'render-small-figure parse-render-figure) - (list 'big-figure (count parse-figure 'figure)) - (list 'big-figure* parse-figure*) - (list 'render-big-figure parse-render-figure) - (list 'wide-figure (count parse-figure 'figure)) - (list 'wide-figure* parse-figure*) - (list 'marginal-figure (count parse-marginal-figure 'figure)) - (list 'marginal-figure* parse-marginal-figure*) - (list 'small-table (count parse-table 'table)) - (list 'small-table* parse-table*) - (list 'big-table (count parse-table 'table)) - (list 'big-table* parse-table*) - (list 'tabular parse-tabular) - (list 'tabular* parse-tabular) ; TODO: centered contents - (list 'block parse-tabular) - (list 'block* parse-tabular) ; TODO: centered contents - (list 'wide-tabular parse-tabular) - (list 'footnote keep) - (list 'marginal-note keep) - (list 'marginal-note* keep) - (list 'todo keep) - (list 'hide-preamble drop) - (list 'TeXmacs (change-to "TeXmacs")) - (list 'LaTeX (change-to "LaTeX")) - (list 'LaTeX* (change-to "(La)TeX")) - (list 'LaTeXe (change-to "LaTeXe")) - (list 'BibTeX (change-to "BibTeX")) - - (list 'bibliography keep) ; tfl extension only - (list 'table-of-contents keep) ; tfl extension only - (list 'tags keep) ; paperwhy extension (DEPRECATED) - (list 'hugo-short keep) ; Hugo extension (arbitrary shortcodes) - (list 'hugo-front identity) ; Hugo extension (frontmatter) - (list 'text-dots (change-to "...")) - - (list 'md-alt-image (skip-to 2)) - ;; tm-doc style - (list 'menu (parse-menu 0)) - (list 'submenu (parse-menu 1)) - (list 'subsubmenu (parse-menu 2)) - (list 'subsubsubmenu (parse-menu 3)) - (list 'subsubsubsubmenu (parse-menu 4)) - (list 'markup (change-to 'tt)) - (list 'explain-macro keep) - (list 'src-var (skip-to)) - (list 'tmdoc-title (count (change-to 'h1) 'h1)) - (list 'tmdoc-copyright keep) - (list 'tmdoc-license (change-to 'em)) - - (list 'page-break drop) - (list 'page-break* drop) - (list 'no-break-here drop) - (list 'no-break-here* drop) - )) + (list + (list 'abstract keep) + (list 'acknowledgments (count parse-plain-env 'env)) + (list 'acknowledgments* parse-plain-env*) + (list 'algorithm (count parse-alg 'alg)) + (list 'algorithm* parse-alg*) + (list 'answer (count parse-plain-env 'env)) + (list 'answer* parse-plain-env*) + (list 'assign drop) + (list 'author-data keep) + (list 'author-email drop) + (list 'author-name keep) + (list 'axiom (count parse-env 'env)) + (list 'axiom* parse-env*) + (list 'bibliography keep) ; tfl extension only + (list 'BibTeX (change-to "BibTeX")) + (list 'big-figure (count parse-figure 'figure)) + (list 'big-figure* parse-figure*) + (list 'big-table (count parse-table 'table)) + (list 'big-table* parse-table*) + (list 'block parse-tabular) + (list 'block* parse-tabular) ; TODO: centered contents + (list 'cite-detail keep-verbatim) + (list 'cite keep-verbatim) + (list 'code (code-block "")) + (list 'code* parse-verbatim) + (list 'concat keep) + (list 'conjecture (count parse-env 'env)) + (list 'conjecture* parse-env*) + (list 'convention (count parse-plain-env 'env)) + (list 'convention* parse-plain-env*) + (list 'corollary (count parse-env 'env)) + (list 'corollary* parse-env*) + (list 'cpp-code (code-block "c++")) + (list 'cpp parse-verbatim) + (list 'definition (count parse-env 'env)) + (list 'definition* parse-env*) + (list 'dfn (change-to 'strong)) + (list 'doc-author keep) + (list 'doc-date keep) + (list 'doc-running-author keep) + (list 'doc-subtitle keep) + (list 'doc-title keep) + (list 'document keep) + (list 'dueto keep) + (list 'em keep) + (list 'enumerate-alpha (change-to 'enumerate)) + (list 'enumerate-Alpha (change-to 'enumerate)) + (list 'enumerate keep) + (list 'enumerate-numeric (change-to 'enumerate)) + (list 'enumerate-roman (change-to 'enumerate)) + (list 'enumerate-Roman (change-to 'enumerate)) + (list 'eqnarray* (with-counter parse-math 'equation)) + (list 'eqnarray (with-counter parse-math 'equation)) ; does this exist? + (list 'eqref parse-reference) + (list 'equation* parse-math) + (list 'equation (with-counter parse-math 'equation)) + (list 'example (count parse-plain-env 'env)) + (list 'example* parse-plain-env*) + (list 'exercise (count parse-plain-env 'env)) + (list 'exercise* parse-plain-env*) + (list 'explain-macro keep) + (list 'flag drop) + (list 'footnote keep) + (list 'hide-preamble drop) + (list 'hlink parse-link) + (list 'hrule hrule-hack) + (list 'html-class keep) + (list 'hugo-front identity) ; Hugo extension (frontmatter) + (list 'hugo-short parse-hugo-short) ; Hugo extension (arbitrary shortcodes) + (list 'image parse-image) + (list 'itemize-arrow (change-to 'itemize)) + (list 'itemize-dot (change-to 'itemize)) + (list 'itemize keep) + (list 'itemize-minus (change-to 'itemize)) + (list 'item keep) + (list 'label parse-label) + (list 'LaTeX (change-to "LaTeX")) + (list 'LaTeX* (change-to "(La)TeX")) + (list 'LaTeXe (change-to "LaTeXe")) + (list 'lemma (count parse-env 'env)) + (list 'lemma* parse-env*) + (list 'localize keep) + (list 'make-eqref parse-make-eqref) + (list 'marginal-figure (count parse-marginal-figure 'figure)) + (list 'marginal-figure* parse-marginal-figure*) + (list 'marginal-note keep) + (list 'marginal-note* keep) + (list 'markup (change-to 'tt)) + (list 'math parse-math) + (list 'md-alt-image (skip-to 2)) + (list 'menu (parse-menu 0)) + (list 'mmx-code (code-block "mmx")) + (list 'mmx parse-verbatim) + (list 'named-algorithm (count parse-named-alg 'alg)) + (list 'name keep) ; TODO: html extension + (list 'nbsp (change-to " ")) + (list 'no-break-here drop) + (list 'no-break-here* drop) + (list 'notation (count parse-env 'env)) + (list 'notation* parse-env*) + (list 'note (count parse-plain-env 'env)) + (list 'note* parse-plain-env*) + (list 'page-break drop) + (list 'page-break* drop) + (list 'paragraph (change-to 'para)) + (list 'paragraph* (change-to 'para)) + (list 'problem (count parse-plain-env 'env)) + (list 'problem* parse-plain-env*) + (list 'proof parse-proof) + (list 'proposition (count parse-env 'env)) + (list 'proposition* parse-env*) + (list 'python-code (code-block "python")) + (list 'python parse-verbatim) + (list 'question (count parse-plain-env 'env)) + (list 'question* parse-plain-env*) + (list 'quotation keep) + (list 'reference parse-reference) + (list 'remark (count parse-plain-env 'env)) + (list 'remark* parse-plain-env*) + (list 'render-big-figure parse-render-figure) + (list 'render-small-figure parse-render-figure) + (list 'samp (change-to 'tt)) + (list 'scilab-code (code-block "scilab")) + (list 'scilab parse-verbatim) + (list 'scm-code (code-block "scheme")) + (list 'scm parse-verbatim) + (list 'section (count (make-header 'h1) 'h1)) + (list 'section* (count-not (change-to 'h1) 'h1)) + (list 'shell-code (code-block "shell")) + (list 'shell parse-verbatim) + (list 'small-figure (count parse-figure 'figure)) + (list 'small-figure* parse-figure*) + (list 'small-table (count parse-table 'table)) + (list 'small-table* parse-table*) + (list 'smart-ref parse-smart-reference) + (list 'solution (count parse-plain-env 'env)) + (list 'solution* parse-plain-env*) + (list 'specific parse-specific) + (list 'specified-algorithm (count parse-specified-alg 'alg)) + (list 'specified-algorithm* parse-specified-alg*) + (list 'src-var (skip-to)) + (list 'strike-through (change-to 'strike)) ; non-standard extension + (list 'strong keep) + (list 'submenu (parse-menu 1)) + (list 'subparagraph (change-to 'para)) + (list 'subparagraph* (change-to 'para)) + (list 'subsection (count (make-header 'h2) 'h2)) + (list 'subsection* (count-not (change-to 'h2) 'h2)) + (list 'subsubmenu (parse-menu 2)) + (list 'subsubsection (count (make-header 'h3) 'h3)) + (list 'subsubsection* (count-not (change-to 'h3) 'h3)) + (list 'subsubsubmenu (parse-menu 3)) + (list 'subsubsubsubmenu (parse-menu 4)) + (list 'table-of-contents keep) ; tfl extension only + (list 'tabular parse-tabular) + (list 'tabular* parse-tabular) ; TODO: centered contents + (list 'tags keep) ; paperwhy extension (DEPRECATED) + (list 'TeXmacs (change-to "TeXmacs")) + (list 'text-dots (change-to "...")) + (list 'theorem (count parse-env 'env)) + (list 'theorem* parse-env*) + (list 'tmdoc-copyright keep) + (list 'tmdoc-license (change-to 'em)) + (list 'tmdoc-title (count (change-to 'h1) 'h1)) + (list 'todo keep) + (list 'tt keep) + (list 'underline keep) ; TODO: html extension + (list 'verbatim-code (code-block "")) + (list 'verbatim parse-verbatim) + (list 'warning (count parse-plain-env 'env)) + (list 'warning* parse-plain-env*) + (list 'wide-figure (count parse-figure 'figure)) + (list 'wide-figure* parse-figure*) + (list 'wide-tabular parse-tabular) + (list 'with parse-with) + )) ;; Copy from smart ref table (map (lambda (l) diff --git a/tests/hugo/frontmatter.md b/tests/hugo/frontmatter.md index 0250fac..c751593 100644 --- a/tests/hugo/frontmatter.md +++ b/tests/hugo/frontmatter.md @@ -15,7 +15,7 @@ series: - "Inter-dimensional travel via portal gun" spotlight: true subtitle: "with applications to low-dimensional portals" -summary: "Recent interest in essentially Riemannian, Gauß–Milnor subrings has centered on constructing super-closed, naturally minimal, reversible fields. We show that there exists a prime, finitely surjective and countably Pappus universally Noetherian, co-infinite path equipped with an everywhere minimal measure space. Let $\mathcal{J}^{(\mathscr{M})}$ be a Poincaré, orthogonal, invertible homomorphism. We show that $\pi \lesssim \sin (\|n\|\- z') \mathcal{J}^{(\mathscr{M})}$. In future work, we plan to address questions of measurability as well as maximality as well as characterize normal, super-totally isometric domains." +summary: "Recent interest in essentially Riemannian, Gauß–Milnor subrings has centered on constructing super-closed, naturally minimal, reversible fields. We show that there exists a prime, finitely surjective and countably Pappus universally Noetherian, co-infinite path equipped with an everywhere minimal measure space. Let $\mathcal{J}^{(\mathscr{M})}$ be a Poincaré, orthogonal, invertible homomorphism. We show that $\pi \lesssim \sin (\|n\|- z') \mathcal{J}^{(\mathscr{M})}$. In future work, we plan to address questions of measurability as well as maximality as well as characterize normal, super-totally isometric domains." title: "On the properties of $L^{\infty}$-Gauß-Milnor knots" --- diff --git a/tests/vanilla/specific.md b/tests/vanilla/specific.md new file mode 100644 index 0000000..a2c20d4 --- /dev/null +++ b/tests/vanilla/specific.md @@ -0,0 +1,9 @@ +This should not export to markdown: + +* TeXmacs-only: +* LaTeX only: +* Screen only: +* HTML only: +* Printer only: + +And here is some markdown-specific content: Hello **hugo** diff --git a/tests/vanilla/specific.tm b/tests/vanilla/specific.tm new file mode 100644 index 0000000..f53edd9 --- /dev/null +++ b/tests/vanilla/specific.tm @@ -0,0 +1,29 @@ + + + + +<\body> + This should not export to markdown: + + <\itemize-dot> + -only: + + only: + + Screen only: + + HTML only: + + Printer only: + + + And here is some markdown-specific content: > + + +<\initial> + <\collection> + + + + \ No newline at end of file