From 06f9b346417e497677b87aec533fefc425247d71 Mon Sep 17 00:00:00 2001 From: Yawar Amin Date: Sat, 15 Jun 2024 16:17:33 -0400 Subject: [PATCH] docs --- COPYING.txt | 674 -------------------- README.md | 169 ----- dream-html/Dream_html/.dummy | 0 dream-html/Dream_html/Aria/index.html | 2 +- dream-html/Dream_html/Form/index.html | 33 + dream-html/Dream_html/HTML/index.html | 2 +- dream-html/Dream_html/Hx/index.html | 2 +- dream-html/Dream_html/Livereload/index.html | 2 +- dream-html/Dream_html/MathML/index.html | 2 +- dream-html/Dream_html/SVG/index.html | 2 +- dream-html/Dream_html/index.html | 23 +- dream-html/index.html | 2 +- odoc.support/odoc.css | 2 +- pure-html/Pure_html/Aria/index.html | 2 +- pure-html/Pure_html/HTML/index.html | 2 +- pure-html/Pure_html/Hx/index.html | 2 +- pure-html/Pure_html/MathML/index.html | 2 +- pure-html/Pure_html/SVG/index.html | 2 +- pure-html/Pure_html/index.html | 2 +- pure-html/index.html | 2 +- 20 files changed, 69 insertions(+), 860 deletions(-) delete mode 100644 COPYING.txt delete mode 100644 README.md delete mode 100644 dream-html/Dream_html/.dummy create mode 100644 dream-html/Dream_html/Form/index.html diff --git a/COPYING.txt b/COPYING.txt deleted file mode 100644 index f288702..0000000 --- a/COPYING.txt +++ /dev/null @@ -1,674 +0,0 @@ - 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 -. diff --git a/README.md b/README.md deleted file mode 100644 index 6b607aa..0000000 --- a/README.md +++ /dev/null @@ -1,169 +0,0 @@ -## dream-html - generate HTML markup from your Dream backend server - -Copyright 2023 Yawar Amin - -This file is part of dream-html. - -dream-html 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. - -dream-html 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 -dream-html. If not, see . - -## What - -This is a set of helper functions I am using to generate HTML markup from inside -my [Dream](https://aantron.github.io/dream) backend. It works pretty well but has -not been proven at large scale or anything like that. - -Most HTML elements and attributes from the -[Mozilla Developer Network references](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference) -are now implemented. I have deliberately left out almost all non-standard or -deprecated tags/attributes. Also, supporting CSS is out of scope for this library. -However, I have included the core [htmx](https://htmx.org/) attributes as I am -personally using them. - -## Why - -Having tried TyXML, I found that too complex. Dream's built-in eml (Embedded ML) -templating system has a few disadvantages, e.g. no editor support, somewhat -quirky syntax that can be hard to debug when it starts erroring, and a rather -large limitation that you need to manually set up a conversion rule in your `dune` -file for each separate template file. - -Dream-html is most similar in approach to Daniel Buenzli's -[Webs](https://erratique.ch/software/webs/doc/Webs_html/index.html) HTML library -(in OCaml land, in other languages many people have published similar code-first -approach libraries). The philosophy is to do some minimal type checking and not -dive deep into a typed HTML rabbit hole like TyXML. - -Let's compare how the following HTML would look in either of Webs or dream-html: - -```html -

Hello, World!

-``` - -Webs: - -```ocaml -open Webs_html -open El -open At - -let greeting = p ~at:[class' "text-lg"; id "hello"] [txt "Hello, World!"] -``` - -Dream-html: - -```ocaml -open Dream_html -open Tag -open Attr - -let greeting = p[class_ "text-lg"; id "hello"][txt "Hello, World!"] -``` - -Note, this is not meant to be a demonstration of how many characters you're -saving. It's just a different style which I have found we can take advantage of -thanks to OCaml being whitespace-insensitive. Normally you wouldn't format OCaml -code like this, but I feel that the domain justifies it. - -## Details - -Attribute and text values are escaped using -[`Dream.html_escape`](https://aantron.github.io/dream/#val-html_escape): - -``` -utop # open Dream_html;; -utop # let user_input = "";; -utop # open Tag;; -utop # let safe = p[][txt "%s" user_input];; -utop # to_string safe;; -- : string = -"

<script>alert('You have been pwned')</script>

" -``` - -## Usage - -A convenience is provided to respond with an HTML node from a handler: - -```ocaml -Dream_html.respond greeting -``` - -You can compose multiple HTML nodes together into a single node without an extra -DOM node, like [React fragments](https://react.dev/reference/react/Fragment): - -```ocaml -let view = Tag.null[ - p[][txt "Hello"]; - p[][txt "World"]] -``` - -You can do string interpolation using the `txt` node constructor and of any -attribute which takes a string value: - -```ocaml -let greet name = p[id "greet-%s" name][txt "Hello, %s!" name] -``` - -You can conditionally render an attribute, and -[void elements](https://developer.mozilla.org/en-US/docs/Glossary/Void_element) -are statically enforced as childless: - -```ocaml -let entry = input[ - if should_focus then autofocus else null; - id "email"; - name "email"; - value "Email address"] -``` - -You can also embed HTML comments in the generated document: - -```ocaml -div[][ - comment "TODO: xyz."; - p[][txt "Hello!"]] -``` - -## Explore in the REPL - -``` -$ utop -utop # #require "dream_html";; -utop # open Dream_html;; -utop # open Tag;; -utop # open Attr;; -utop # #install_printer pp;; -utop # p[class_ "hello"][txt "world"];; -- : node =

world

-``` - -## Test - -Run the test and print out diff if it fails: - - dune runtest # Will also exit 1 on failure - -Set the new version of the output as correct: - - dune promote - -## Prior art/design notes - -Surface design obviously lifted straight from -[elm-html](https://package.elm-lang.org/packages/elm/html/latest/). - -Similar to [Webs](https://erratique.ch/software/webs/doc/Webs_html/index.html) as -mentioned earlier (it turns out there are only a limited number of ways to do -this kind of library). - -Implementation inspired by both elm-html and -[Scalatags](https://com-lihaoyi.github.io/scalatags/). diff --git a/dream-html/Dream_html/.dummy b/dream-html/Dream_html/.dummy deleted file mode 100644 index e69de29..0000000 diff --git a/dream-html/Dream_html/Aria/index.html b/dream-html/Dream_html/Aria/index.html index 7c76acf..70099a0 100644 --- a/dream-html/Dream_html/Aria/index.html +++ b/dream-html/Dream_html/Aria/index.html @@ -1,2 +1,2 @@ -Aria (dream-html.Dream_html.Aria)

Module Dream_html.Aria

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/

  • since 3.0.0.
val activedescendant : _ string_attr
val atomic : attr
val autocomplete : [ `inline | `list | `both ] to_attr
val braillelabel : _ string_attr
val brailleroledescription : _ string_attr
val busy : attr
val checked : [ `false_ | `true_ | `mixed ] to_attr
val colcount : int to_attr
val colindextext : _ string_attr
val colspan : int to_attr
val controls : _ string_attr
val current : [ `page | `step | `location | `date | `time | `true_ ] to_attr
val describedby : _ string_attr
val description : _ string_attr
val details : _ string_attr
val disabled : attr
val errormessage : _ string_attr
val expanded : bool to_attr
val flowto : _ string_attr
val haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attr
val hidden : bool to_attr
val invalid : [ `grammar | `spelling | `true_ ] to_attr
val keyshortcuts : _ string_attr
val label : _ string_attr
val labelledby : _ string_attr
val level : int to_attr
val live : [ `assertive | `polite ] to_attr
val modal : attr
val multiline : attr
val multiselectable : attr
val orientation : [ `horizontal | `vertical ] to_attr
val owns : _ string_attr
val placeholder : _ string_attr
val posinset : int to_attr
val pressed : [ `false_ | `mixed | `true_ ] to_attr
val readonly : attr
val relevant : [ `additions | `all | `removals | `text ] to_attr
val required : attr
val roledescription : _ string_attr
val rowcount : int to_attr
val rowindex : int to_attr
val rowindextext : _ string_attr
val rowspan : int to_attr
val selected : bool to_attr
val setsize : int to_attr
val sort : [ `ascending | `descending | `other ] to_attr
val valuemax : float to_attr
val valuemin : float to_attr
val valuenow : float to_attr
val valuetext : _ string_attr
+Aria (dream-html.Dream_html.Aria)

Module Dream_html.Aria

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/

  • since 3.0.0.
val activedescendant : _ string_attr
val atomic : attr
val autocomplete : [ `inline | `list | `both ] to_attr
val braillelabel : _ string_attr
val brailleroledescription : _ string_attr
val busy : attr
val checked : [ `false_ | `true_ | `mixed ] to_attr
val colcount : int to_attr
val colindextext : _ string_attr
val colspan : int to_attr
val controls : _ string_attr
val current : [ `page | `step | `location | `date | `time | `true_ ] to_attr
val describedby : _ string_attr
val description : _ string_attr
val details : _ string_attr
val disabled : attr
val errormessage : _ string_attr
val expanded : bool to_attr
val flowto : _ string_attr
val haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attr
val hidden : bool to_attr
val invalid : [ `grammar | `spelling | `true_ ] to_attr
val keyshortcuts : _ string_attr
val label : _ string_attr
val labelledby : _ string_attr
val level : int to_attr
val live : [ `assertive | `polite ] to_attr
val modal : attr
val multiline : attr
val multiselectable : attr
val orientation : [ `horizontal | `vertical ] to_attr
val owns : _ string_attr
val placeholder : _ string_attr
val posinset : int to_attr
val pressed : [ `false_ | `mixed | `true_ ] to_attr
val readonly : attr
val relevant : [ `additions | `all | `removals | `text ] to_attr
val required : attr
val roledescription : _ string_attr
val rowcount : int to_attr
val rowindex : int to_attr
val rowindextext : _ string_attr
val rowspan : int to_attr
val selected : bool to_attr
val setsize : int to_attr
val sort : [ `ascending | `descending | `other ] to_attr
val valuemax : float to_attr
val valuemin : float to_attr
val valuenow : float to_attr
val valuetext : _ string_attr
diff --git a/dream-html/Dream_html/Form/index.html b/dream-html/Dream_html/Form/index.html new file mode 100644 index 0000000..c328299 --- /dev/null +++ b/dream-html/Dream_html/Form/index.html @@ -0,0 +1,33 @@ + +Form (dream-html.Dream_html.Form)

Module Dream_html.Form

Typed, extensible HTML form decoder with error reporting for all form field validation failures.

See the bottom of the page for complete examples.

  • since 3.7.0.

Basic type decoders

type 'a ty = string -> ('a, string) Stdlib.result

The type of a decoder for a single form field value of type 'a which can successfully decode the field value or fail with an error message key.

In the following type decoders, the minimum and maximum values are all inclusive.

val bool : bool ty
val char : ?min:char -> ?max:char -> char ty
val float : ?min:float -> ?max:float -> float ty
val int : ?min:int -> ?max:int -> int ty
val int32 : ?min:int32 -> ?max:int32 -> int32 ty
val int64 : ?min:int64 -> ?max:int64 -> int64 ty
val string : ?min_length:int -> ?max_length:int -> string ty

Forms and fields

type 'a t

The type of a form (a form field by itself is also considered a form) which can decode values of type 'a or fail with a list of error message keys.

val list : ?min_length:int -> ?max_length:int -> 'a ty -> string -> 'a list t

list ?min_length ?max_length ty name is a form field which can decode a list of values which can each be decoded by ty. The list must have at least min_length and at most max_length (inclusive).

val optional : 'a ty -> string -> 'a option t

optional ty name is a form field which can decode an optional value from the form.

val required : ?default:'a -> 'a ty -> string -> 'a t

required ?default ty name is a form field which can decode a required value from the form. If at least one value corresponding to the given name does not appear in the form, and if a default value is not specified, the decoding fails with an error.

val ensure : + string -> + ('b -> bool) -> + ('a ty -> string -> 'b t) -> + 'a ty -> + string -> + 'b t

ensure message condition field ty name is a form field which imposes an additional condition on top of the existing field. If the condition fails, the result is an error message. It is suggested that the message be a translation key so that the application can be localized to different languages.

Form decoders

val let+ : 'a t -> ('a -> 'b) -> 'b t

let+ email = required string "email" decodes a form field named email as a string.

val and+ : 'a t -> 'b t -> ('a * 'b) t

and+ password = required string "password" continues decoding in an existing form declaration and decodes a form field password as a string.

val or : 'a t -> 'a t -> 'a t

form1 or form2 is form1 if it succeeds, else form2.

val validate : + 'a t -> + (string * string) list -> + ('a, (string * string) list) Stdlib.result

validate form values is a result of validating the given form's values. It may be either some value of type 'a or a list of form field names and the corresponding error message keys.

val pp_error : (string * string) list Fmt.t

pp_error is a helper pretty-printer for debugging/troubleshooting form validation errors.

Error keys

When errors are reported, the following keys are used instead of English strings. These keys can be used for localizing the error messages. The suggested default English translations are given below.

These keys are modelled after Play Framework.

val error_expected_bool : string

Please enter true or false.

val error_expected_char : string

Please enter a single character.

val error_expected_single : string

Please enter a single value.

val error_expected_int : string

Please enter a valid integer.

val error_expected_int32 : string

Please enter a valid 32-bit integer.

val error_expected_int64 : string

Please enter a valid 64-bit integer.

val error_expected_number : string

Please enter a valid number.

val error_length : string

Please enter a value of the expected length.

val error_range : string

Please enter a value in the expected range.

val error_required : string

Please enter a value.

Examples

Basic complete example:

type user = { name : string; age : int option}
+
+open Dream_html.Form
+
+let user_form =
+  let+ name = required string "name"
+  and+ age = optional (int ~min:16) "age" in (* Thanks, Australia! *)
+  { name; age }
+
+let dream_form = ["age", "42"; "name", "Bob"]
+let user_result = validate user_form dream_form

Result: Ok { name = "Bob"; age = Some 42 }

Sad path:

validate user_form ["age", "none"]

Result: Error [("age", "error.expected.int"); ("name", "error.required")]

Notice that validation errors for all fields are reported. This is a critical design decision that differentiates this module from others available in OCaml.

Decode list of values from form:

type plan = { id : string; features : string list }
+
+let plan_form =
+  let+ id = required string "id"
+  and+ features = list string "features" in
+  { id; features }
+
+validate plan_form ["id", "foo"]

Result: Ok {id = "foo"; features = []}

validate plan_form ["id", "foo"; "features", "f1"; "features", "f2"]

Result: Ok {id = "foo"; features = ["f1"; "f2"]}

Note that the names can be anything, eg "features[]" if you prefer.

Add further requirements to field values:

let plan_form =
+  let+ id = ensure "error.expected.nonempty" (( <> ) "") required string "id"
+  and+ features = list string "features" in
+  { id; features }
+
+validate plan_form ["id", ""]

Result: Error [("id", "error.expected.nonempty")]

diff --git a/dream-html/Dream_html/HTML/index.html b/dream-html/Dream_html/HTML/index.html index ae92ff7..ca2b2a3 100644 --- a/dream-html/Dream_html/HTML/index.html +++ b/dream-html/Dream_html/HTML/index.html @@ -1,5 +1,5 @@ -HTML (dream-html.Dream_html.HTML)

Module Dream_html.HTML

All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.

Attributes

Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.

All string-valued attributes allow formatting (interpolation):

div [id "section-%d" section_id] []

Or plain strings:

p [id "toast"] []

Most boolean attributes are plain values and don't need to be constructed with function calls:

input [required]

However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:

div [contenteditable true] [
+HTML (dream-html.Dream_html.HTML)
Module Dream_html.HTML
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Attributes
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []
Or plain strings:
p [id "toast"] []
Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]
However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div [contenteditable true] [
   p [] [txt "Edit me!"];
   p [contenteditable false] [txt "Can't edit me!"];
 ]
Enumerated attributes accept specific values:
input [inputmode `tel]
  • since 1.0.0.
type enctype = [ 
  1. | `urlencoded
  2. | `formdata
  3. | `text_plain
 ]
type method_ = [ 
  1. | `GET
  2. | `POST
  3. | `dialog
    (*
    • since 2.1.0
    *)
 ]
val null_ : attr
An attribute that will not be rendered in the markup. Useful for conditional logic where you sometimes want to render an attribute and sometimes not.
p [if should_show then null_ else style_ "display:none"] [txt "Show and tell"]
val accept : _ string_attr
val accept_charset : _ string_attr
val accesskey : _ string_attr
val action : _ string_attr
val align : _ string_attr
  • deprecated See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
val allow : _ string_attr
val alt : _ string_attr
val async : attr
val autocapitalize : 
diff --git a/dream-html/Dream_html/Hx/index.html b/dream-html/Dream_html/Hx/index.html
index 15e01db..d0e2442 100644
--- a/dream-html/Dream_html/Hx/index.html
+++ b/dream-html/Dream_html/Hx/index.html
@@ -1,2 +1,2 @@
 
-Hx (dream-html.Dream_html.Hx)
Module Dream_html.Hx
htmx support https://htmx.org/reference/
val __ : _ string_attr
This attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
  • since 0.1.0.
val boost : bool to_attr
val confirm : _ string_attr
val delete : _ string_attr
val disable : attr
val disinherit : _ string_attr
val encoding_formdata : attr
Hardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attr
val get : _ string_attr
val headers : _ string_attr
val history_false : attr
Hardcoding of the hx-history attribute to false.
val history_elt : attr
val include_ : _ string_attr
val indicator : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val on : _ string_attr
Note that the value of this attribute is not escaped.
  • deprecated See https://htmx.org/attributes/hx-on/#hx-on-deprecated
val on_ : event:string -> _ string_attr
The hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
  • since 2.1.0.
val params : _ string_attr
val patch : _ string_attr
val post : _ string_attr
val preload : attr
The preload extension: https://htmx.org/extensions/preload/
val preserve : attr
val prompt : _ string_attr
val push_url : _ string_attr
val put : _ string_attr
val replace_url : _ string_attr
val request : _ string_attr
val select : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sse_connect : _ string_attr
val sse_swap : _ string_attr
val swap : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sync : _ string_attr
val target : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attr
Note that the value of this attribute is not escaped.
val validate : attr
val vals : _ string_attr
val ws_connect : _ string_attr
val ws_send : attr

+Hx (dream-html.Dream_html.Hx)
Module Dream_html.Hx
htmx support https://htmx.org/reference/
val __ : _ string_attr
This attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
  • since 0.1.0.
val boost : bool to_attr
val confirm : _ string_attr
val delete : _ string_attr
val disable : attr
val disabled_elt : _ string_attr
  • since 3.6.0.
val disinherit : _ string_attr
val encoding_formdata : attr
Hardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attr
val get : _ string_attr
val headers : _ string_attr
val history_false : attr
Hardcoding of the hx-history attribute to false.
val history_elt : attr
val include_ : _ string_attr
val indicator : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val inherit_ : _ string_attr
  • since 3.6.0.
val on : _ string_attr
Note that the value of this attribute is not escaped.
  • deprecated See https://htmx.org/attributes/hx-on/#hx-on-deprecated
val on_ : event:string -> _ string_attr
The hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
  • since 2.1.0.
val params : _ string_attr
val patch : _ string_attr
val post : _ string_attr
val preload : attr
The preload extension: https://htmx.org/extensions/preload/
val preserve : attr
val prompt : _ string_attr
val push_url : _ string_attr
val put : _ string_attr
val replace_url : _ string_attr
val request : _ string_attr
val select : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sse_close : _ string_attr
  • since 3.6.0.
val sse_connect : _ string_attr
val sse_swap : _ string_attr
val swap : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sync : _ string_attr
val target : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attr
Note that the value of this attribute is not escaped.
val validate : attr
val vals : _ string_attr
val ws_connect : _ string_attr
val ws_send : attr

diff --git a/dream-html/Dream_html/Livereload/index.html b/dream-html/Dream_html/Livereload/index.html
index b24b4d2..900539e 100644
--- a/dream-html/Dream_html/Livereload/index.html
+++ b/dream-html/Dream_html/Livereload/index.html
@@ -1,5 +1,5 @@
 
-Livereload (dream-html.Dream_html.Livereload)
Module Dream_html.Livereload
Live reload script injection and handling. Adapted from Dream.livereload middleware. This version is not a middleware so it's not as plug-and-play as that, but on the other hand it's much simpler to implement because it uses type-safe dream-html nodes rather than parsing and printing raw HTML. See below for the 3-step process to use it.
This module is adapted from Dream, released under the MIT license. For details, visit https://github.com/aantron/dream.
Copyright 2021-2023 Thibaut Mattio, Anton Bachin.
  • since 3.4.0.
val route : Dream.route
(1) Put this in your top-level router:
let () = Dream.run
+Livereload (dream-html.Dream_html.Livereload)
Module Dream_html.Livereload
Live reload script injection and handling. Adapted from Dream.livereload middleware. This version is not a middleware so it's not as plug-and-play as that, but on the other hand it's much simpler to implement because it uses type-safe dream-html nodes rather than parsing and printing raw HTML. See below for the 3-step process to use it.
This module is adapted from Dream, released under the MIT license. For details, visit https://github.com/aantron/dream.
Copyright 2021-2023 Thibaut Mattio, Anton Bachin.
  • since 3.4.0.
val route : Dream.route
(1) Put this in your top-level router:
let () = Dream.run
   @@ Dream.logger
   @@ Dream.router [
     Dream_html.Livereload.route;
diff --git a/dream-html/Dream_html/MathML/index.html b/dream-html/Dream_html/MathML/index.html
index 4e13382..d4da082 100644
--- a/dream-html/Dream_html/MathML/index.html
+++ b/dream-html/Dream_html/MathML/index.html
@@ -1,2 +1,2 @@
 
-MathML (dream-html.Dream_html.MathML)
Module Dream_html.MathML
  • since 3.1.0.
val accent : bool to_attr
val accentunder : bool to_attr
val columnspan : int to_attr
val depth : _ string_attr
val dir : [ `ltr | `rtl ] to_attr
val display_block : attr
See https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attr
val fence : bool to_attr
val height : _ string_attr
val largeop : bool to_attr
val linethickness : _ string_attr
val lspace : _ string_attr
val mathvariant : _ string_attr
val maxsize : _ string_attr
val minsize : _ string_attr
val movablelimits : bool to_attr
val rowspan : int to_attr
val rspace : _ string_attr
val scriptlevel : _ string_attr
val separator : bool to_attr
val stretchy : bool to_attr
val symmetric : bool to_attr
val voffset : _ string_attr
val xmlns : attr
val annotation : std_tag
val annotation_xml : std_tag
val math : std_tag
val merror : std_tag
val mfrac : std_tag
val mi : std_tag
val mmultiscripts : std_tag
val mn : std_tag
val mo : std_tag
val mover : std_tag
val mpadded : std_tag
val mphantom : std_tag
val mroot : std_tag
val mrow : std_tag
val ms : std_tag
val mspace : std_tag
val msqrt : std_tag
val mstyle : std_tag
val msub : std_tag
val msubsup : std_tag
val msup : std_tag
val mtable : std_tag
val mtd : std_tag
val mtext : std_tag
val mtr : std_tag
val munder : std_tag
val munderover : std_tag
val semantics : std_tag

+MathML (dream-html.Dream_html.MathML)
Module Dream_html.MathML
  • since 3.1.0.
val accent : bool to_attr
val accentunder : bool to_attr
val columnspan : int to_attr
val depth : _ string_attr
val dir : [ `ltr | `rtl ] to_attr
val display_block : attr
See https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attr
val fence : bool to_attr
val height : _ string_attr
val largeop : bool to_attr
val linethickness : _ string_attr
val lspace : _ string_attr
val mathvariant : _ string_attr
val maxsize : _ string_attr
val minsize : _ string_attr
val movablelimits : bool to_attr
val rowspan : int to_attr
val rspace : _ string_attr
val scriptlevel : _ string_attr
val separator : bool to_attr
val stretchy : bool to_attr
val symmetric : bool to_attr
val voffset : _ string_attr
val xmlns : attr
val annotation : std_tag
val annotation_xml : std_tag
val math : std_tag
val merror : std_tag
val mfrac : std_tag
val mi : std_tag
val mmultiscripts : std_tag
val mn : std_tag
val mo : std_tag
val mover : std_tag
val mpadded : std_tag
val mphantom : std_tag
val mroot : std_tag
val mrow : std_tag
val ms : std_tag
val mspace : std_tag
val msqrt : std_tag
val mstyle : std_tag
val msub : std_tag
val msubsup : std_tag
val msup : std_tag
val mtable : std_tag
val mtd : std_tag
val mtext : std_tag
val mtr : std_tag
val munder : std_tag
val munderover : std_tag
val semantics : std_tag

diff --git a/dream-html/Dream_html/SVG/index.html b/dream-html/Dream_html/SVG/index.html
index d6f0f61..4c422e5 100644
--- a/dream-html/Dream_html/SVG/index.html
+++ b/dream-html/Dream_html/SVG/index.html
@@ -1,3 +1,3 @@
 
-SVG (dream-html.Dream_html.SVG)
Module Dream_html.SVG
  • since 1.1.0.
val d : _ string_attr
val fill : _ string_attr
val stroke : _ string_attr
val stroke_linecap : [< `butt | `round | `square ] to_attr
val stroke_linejoin : 
+SVG (dream-html.Dream_html.SVG)
Module Dream_html.SVG
  • since 1.1.0.
val d : _ string_attr
val fill : _ string_attr
val stroke : _ string_attr
val stroke_linecap : [< `butt | `round | `square ] to_attr
val stroke_linejoin : 
   [< `arcs | `bevel | `miter | `miter_clip | `round ] to_attr
val stroke_width : _ string_attr
val viewbox : min_x:int -> min_y:int -> width:int -> height:int -> attr
val xmlns : attr
val path : std_tag
val svg : std_tag

diff --git a/dream-html/Dream_html/index.html b/dream-html/Dream_html/index.html
index 12b3162..bb5c1e4 100644
--- a/dream-html/Dream_html/index.html
+++ b/dream-html/Dream_html/index.html
@@ -1,5 +1,24 @@
 
-Dream_html (dream-html.Dream_html)
Module Dream_html
include module type of Pure_html
Core types
These are the types of the final values which get rendered.
type attr
E.g. id="toast".
type node
Either a tag, a comment, or text data in the markup.
Output
val to_string : node -> string
val to_xml : node -> string
Same as to_string but render void tags as XML-style self-closing tags.
  • since 3.3.0.
val pp : Stdlib.Format.formatter -> node -> unit
val pp_xml : Stdlib.Format.formatter -> node -> unit
Same as pp but render void tags as XML-style self-closing tags.
  • since 3.3.0.
Constructing nodes and attributes
type 'a to_attr = 'a -> attr
Attributes can be created from typed values.
type 'a string_attr = ('a, unit, string, attr) Stdlib.format4 -> 'a
Special handling for string-value attributes so they can use format strings i.e. string interpolation.
type std_tag = attr list -> node list -> node
A 'standard' tag with attributes and children.
type void_tag = attr list -> node
A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.
type 'a text_tag = attr list -> ('a, unit, string, node) Stdlib.format4 -> 'a
Tags which can have attributes but can contain only text. The text can be formatted.
val attr : string -> attr
attr name is a new attribute which does not carry any payload. E.g.
let required = attr "required"
  • since 0.1.0.
val string_attr : string -> ?raw:bool -> _ string_attr
string_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.
val uri_attr : string -> _ string_attr
Convenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.
Examples
a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
+Dream_html (dream-html.Dream_html)
Module Dream_html
Input
module Form : sig ... end
Typed, extensible HTML form decoder with error reporting for all form field validation failures.
val form : 
+  'a Form.t ->
+  ?csrf:bool ->
+  Dream.request ->
+  [> 'a Dream.form_result | `Invalid of (string * string) list ] Dream.promise
Type-safe wrapper for Dream.form. Similarly to that, you can match on the result:
type new_user = { name : string; email : string }
+let new_user =
+  let open Dream_html.Form in
+  let+ name = required string "name"
+  and+ email = required string "email" in
+  { name; email }
+
+(* POST /users *)
+let post_users req =
+  match%lwt Dream_html.form new_user req with
+  | `Ok { name; email } -> (* ... *)
+  | `Invalid errors -> Dream.json ~code:422 ( (* ...render errors... *) )
+  | _ -> Dream.empty `Bad_Request
  • since 3.8.0
val query : 
+  'a Form.t ->
+  Dream.request ->
+  [> `Ok of 'a | `Invalid of (string * string) list ]
Type-safe wrapper for Dream.all_queries. Can be used to decode the query parameters into a typed value.
  • since 3.8.0
Output
include module type of Pure_html
Core types
These are the types of the final values which get rendered.
type attr
E.g. id="toast".
type node
Either a tag, a comment, or text data in the markup.
Output
val to_string : node -> string
val to_xml : ?header:bool -> node -> string
Same as to_string but render void tags as XML-style self-closing tags.
  • parameter header 
    print the XML header string if true. This is to allow both use cases where the XML code is embedded inside HTML, and standalone XML documents. Default is false. Since 3.6.0.
  • since 3.3.0.
val pp : Stdlib.Format.formatter -> node -> unit
val pp_xml : Stdlib.Format.formatter -> ?header:bool -> node -> unit
Same as pp but render void tags as XML-style self-closing tags.
  • parameter header 
    print the XML header string if true. This is to allow both use cases where the XML code is embedded inside HTML, and standalone XML documents. Default is false. Since 3.6.0.
  • since 3.3.0.
Constructing nodes and attributes
type 'a to_attr = 'a -> attr
Attributes can be created from typed values.
type 'a string_attr = ('a, unit, string, attr) Stdlib.format4 -> 'a
Special handling for string-value attributes so they can use format strings i.e. string interpolation.
type std_tag = attr list -> node list -> node
A 'standard' tag with attributes and children.
type void_tag = attr list -> node
A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.
type 'a text_tag = attr list -> ('a, unit, string, node) Stdlib.format4 -> 'a
Tags which can have attributes but can contain only text. The text can be formatted.
val attr : string -> attr
attr name is a new attribute which does not carry any payload. E.g.
let required = attr "required"
  • since 0.1.0.
val string_attr : string -> ?raw:bool -> _ string_attr
string_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.
val uri_attr : string -> _ string_attr
Convenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.
Examples
a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
 ==>
 <a href="/blog?tags=iamsafe%22%3E%3C/a%3E%3Cscript%3Ealert('Pwned')%3C/script%3E">Tags: tag1 | tag2</a>
 
@@ -8,7 +27,7 @@
 <a href="/foo?a=1&amp;b=2%203&amp;c=4%3C5&amp;d=6%3E5">Test</a>
val bool_attr : string -> bool to_attr
val float_attr : string -> float to_attr
val int_attr : string -> int to_attr
val std_tag : string -> std_tag
val void_tag : string -> void_tag
val text_tag : string -> ?raw:bool -> _ text_tag
Build a tag which can contain only text.
val txt : ?raw:bool -> ('a, unit, string, node) Stdlib.format4 -> 'a
A text node inside the DOM e.g. the 'hi' in <b>hi</b>. Allows string interpolation using the same formatting features as Printf.sprintf:
b [] [txt "Hello, %s!" name]
Or without interpolation:
b [] [txt "Bold of you."]
HTML-escapes the text value. You can use the ~raw param to bypass escaping:
let user_input = "<script>alert('I like HTML injection')</script>" in
 txt ~raw:true "%s" user_input
val comment : string -> node
A comment that will be embedded in the rendered HTML, i.e. <!-- comment -->. The text is HTML-escaped.
Accessors for tags
val (+@) : node -> attr -> node
Add an attribute to a tag.
let toast msg = p [id "toast"] [txt "%s" msg]
 let toast_oob = toast "ok." +@ Hx.swap_oob "true"
  • raises Invalid_argument 
    if the node is not a tag (i.e. if it is a text or comment node).
  • since 0.0.3.
val (-@) : node -> string -> node
Remove an attribute from a tag.
  • raises Invalid_argument 
    if the node is not a tag (i.e. if it is a text or comment node).
  • since 0.0.3.
val (.@[]) : node -> string -> string
Get the value of an existing attribute.
let toast = p [id "toast"] [txt "OK."]
-let toast_id = toast.@["id"]
  • raises Invalid_argument 
    if the node is not a tag (i.e. if it is a text or comment node).
  • raises Not_found 
    if the tag does not have the given attribute.
  • since 0.0.3.
val is_null : node -> bool
Get whether a node is null (empty) or not. Useful for conditional rendering of UIs when you are passed in a node and you don't know if it's empty or not.
  • since 1.2.0.
val is_null_ : attr -> bool
Get whether an attribute is null (empty) or not.
  • since 1.2.0.
Standard attributes and tags
module HTML : sig ... end
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
module SVG : sig ... end
module MathML : sig ... end
ARIA support
module Aria : sig ... end
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
htmx support
module Hx : sig ... end
htmx support https://htmx.org/reference/
Output
val respond : 
+let toast_id = toast.@["id"]
  • raises Invalid_argument 
    if the node is not a tag (i.e. if it is a text or comment node).
  • raises Not_found 
    if the tag does not have the given attribute.
  • since 0.0.3.
val is_null : node -> bool
Get whether a node is null (empty) or not. Useful for conditional rendering of UIs when you are passed in a node and you don't know if it's empty or not.
  • since 1.2.0.
val is_null_ : attr -> bool
Get whether an attribute is null (empty) or not.
  • since 1.2.0.
Standard attributes and tags
module HTML : sig ... end
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
module SVG : sig ... end
module MathML : sig ... end
ARIA support
module Aria : sig ... end
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
htmx support
module Hx : sig ... end
htmx support https://htmx.org/reference/
val respond : 
   ?status:[< Dream.status ] ->
   ?code:int ->
   ?headers:(string * string) list ->
diff --git a/dream-html/index.html b/dream-html/index.html
index b4ff5c1..4791a13 100644
--- a/dream-html/index.html
+++ b/dream-html/index.html
@@ -1,2 +1,2 @@
 
-index (dream-html.index)
dream-html index
Library dream-html
The entry point of this library is the module: Dream_html.

+index (dream-html.index)
dream-html index
Library dream-html
The entry point of this library is the module: Dream_html.

diff --git a/odoc.support/odoc.css b/odoc.support/odoc.css
index 71148de..15240b5 100644
--- a/odoc.support/odoc.css
+++ b/odoc.support/odoc.css
@@ -1,7 +1,7 @@
 @charset "UTF-8";
 /* Copyright (c) 2016 The odoc contributors. All rights reserved.
    Distributed under the ISC license, see terms at the end of the file.
-   odoc 2.4.2 */
+   odoc 2.4.3 */
 
 /* Fonts */
 /* noticia-text-regular - latin */
diff --git a/pure-html/Pure_html/Aria/index.html b/pure-html/Pure_html/Aria/index.html
index 54ebf1c..9e48cae 100644
--- a/pure-html/Pure_html/Aria/index.html
+++ b/pure-html/Pure_html/Aria/index.html
@@ -1,2 +1,2 @@
 
-Aria (pure-html.Pure_html.Aria)
Module Pure_html.Aria
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
  • since 3.0.0.
val activedescendant : _ string_attr
val atomic : attr
val autocomplete : [ `inline | `list | `both ] to_attr
val braillelabel : _ string_attr
val brailleroledescription : _ string_attr
val busy : attr
val checked : [ `false_ | `true_ | `mixed ] to_attr
val colcount : int to_attr
val colindextext : _ string_attr
val colspan : int to_attr
val controls : _ string_attr
val current : [ `page | `step | `location | `date | `time | `true_ ] to_attr
val describedby : _ string_attr
val description : _ string_attr
val details : _ string_attr
val disabled : attr
val errormessage : _ string_attr
val expanded : bool to_attr
val flowto : _ string_attr
val haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attr
val hidden : bool to_attr
val invalid : [ `grammar | `spelling | `true_ ] to_attr
val keyshortcuts : _ string_attr
val label : _ string_attr
val labelledby : _ string_attr
val level : int to_attr
val live : [ `assertive | `polite ] to_attr
val modal : attr
val multiline : attr
val multiselectable : attr
val orientation : [ `horizontal | `vertical ] to_attr
val owns : _ string_attr
val placeholder : _ string_attr
val posinset : int to_attr
val pressed : [ `false_ | `mixed | `true_ ] to_attr
val readonly : attr
val relevant : [ `additions | `all | `removals | `text ] to_attr
val required : attr
val roledescription : _ string_attr
val rowcount : int to_attr
val rowindex : int to_attr
val rowindextext : _ string_attr
val rowspan : int to_attr
val selected : bool to_attr
val setsize : int to_attr
val sort : [ `ascending | `descending | `other ] to_attr
val valuemax : float to_attr
val valuemin : float to_attr
val valuenow : float to_attr
val valuetext : _ string_attr

+Aria (pure-html.Pure_html.Aria)
Module Pure_html.Aria
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
  • since 3.0.0.
val activedescendant : _ string_attr
val atomic : attr
val autocomplete : [ `inline | `list | `both ] to_attr
val braillelabel : _ string_attr
val brailleroledescription : _ string_attr
val busy : attr
val checked : [ `false_ | `true_ | `mixed ] to_attr
val colcount : int to_attr
val colindextext : _ string_attr
val colspan : int to_attr
val controls : _ string_attr
val current : [ `page | `step | `location | `date | `time | `true_ ] to_attr
val describedby : _ string_attr
val description : _ string_attr
val details : _ string_attr
val disabled : attr
val errormessage : _ string_attr
val expanded : bool to_attr
val flowto : _ string_attr
val haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attr
val hidden : bool to_attr
val invalid : [ `grammar | `spelling | `true_ ] to_attr
val keyshortcuts : _ string_attr
val label : _ string_attr
val labelledby : _ string_attr
val level : int to_attr
val live : [ `assertive | `polite ] to_attr
val modal : attr
val multiline : attr
val multiselectable : attr
val orientation : [ `horizontal | `vertical ] to_attr
val owns : _ string_attr
val placeholder : _ string_attr
val posinset : int to_attr
val pressed : [ `false_ | `mixed | `true_ ] to_attr
val readonly : attr
val relevant : [ `additions | `all | `removals | `text ] to_attr
val required : attr
val roledescription : _ string_attr
val rowcount : int to_attr
val rowindex : int to_attr
val rowindextext : _ string_attr
val rowspan : int to_attr
val selected : bool to_attr
val setsize : int to_attr
val sort : [ `ascending | `descending | `other ] to_attr
val valuemax : float to_attr
val valuemin : float to_attr
val valuenow : float to_attr
val valuetext : _ string_attr

diff --git a/pure-html/Pure_html/HTML/index.html b/pure-html/Pure_html/HTML/index.html
index 998fede..abddb8f 100644
--- a/pure-html/Pure_html/HTML/index.html
+++ b/pure-html/Pure_html/HTML/index.html
@@ -1,5 +1,5 @@
 
-HTML (pure-html.Pure_html.HTML)
Module Pure_html.HTML
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Attributes
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []
Or plain strings:
p [id "toast"] []
Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]
However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div [contenteditable true] [
+HTML (pure-html.Pure_html.HTML)
Module Pure_html.HTML
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Attributes
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []
Or plain strings:
p [id "toast"] []
Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]
However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div [contenteditable true] [
   p [] [txt "Edit me!"];
   p [contenteditable false] [txt "Can't edit me!"];
 ]
Enumerated attributes accept specific values:
input [inputmode `tel]
  • since 1.0.0.
type enctype = [ 
  1. | `urlencoded
  2. | `formdata
  3. | `text_plain
 ]
type method_ = [ 
  1. | `GET
  2. | `POST
  3. | `dialog
    (*
    • since 2.1.0
    *)
 ]
val null_ : attr
An attribute that will not be rendered in the markup. Useful for conditional logic where you sometimes want to render an attribute and sometimes not.
p [if should_show then null_ else style_ "display:none"] [txt "Show and tell"]
val accept : _ string_attr
val accept_charset : _ string_attr
val accesskey : _ string_attr
val action : _ string_attr
val align : _ string_attr
  • deprecated See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
val allow : _ string_attr
val alt : _ string_attr
val async : attr
val autocapitalize : 
diff --git a/pure-html/Pure_html/Hx/index.html b/pure-html/Pure_html/Hx/index.html
index c4638a0..9a38edb 100644
--- a/pure-html/Pure_html/Hx/index.html
+++ b/pure-html/Pure_html/Hx/index.html
@@ -1,2 +1,2 @@
 
-Hx (pure-html.Pure_html.Hx)
Module Pure_html.Hx
htmx support https://htmx.org/reference/
val __ : _ string_attr
This attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
  • since 0.1.0.
val boost : bool to_attr
val confirm : _ string_attr
val delete : _ string_attr
val disable : attr
val disinherit : _ string_attr
val encoding_formdata : attr
Hardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attr
val get : _ string_attr
val headers : _ string_attr
val history_false : attr
Hardcoding of the hx-history attribute to false.
val history_elt : attr
val include_ : _ string_attr
val indicator : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val on : _ string_attr
Note that the value of this attribute is not escaped.
  • deprecated See https://htmx.org/attributes/hx-on/#hx-on-deprecated
val on_ : event:string -> _ string_attr
The hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
  • since 2.1.0.
val params : _ string_attr
val patch : _ string_attr
val post : _ string_attr
val preload : attr
The preload extension: https://htmx.org/extensions/preload/
val preserve : attr
val prompt : _ string_attr
val push_url : _ string_attr
val put : _ string_attr
val replace_url : _ string_attr
val request : _ string_attr
val select : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sse_connect : _ string_attr
val sse_swap : _ string_attr
val swap : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sync : _ string_attr
val target : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attr
Note that the value of this attribute is not escaped.
val validate : attr
val vals : _ string_attr
val ws_connect : _ string_attr
val ws_send : attr

+Hx (pure-html.Pure_html.Hx)
Module Pure_html.Hx
htmx support https://htmx.org/reference/
val __ : _ string_attr
This attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
  • since 0.1.0.
val boost : bool to_attr
val confirm : _ string_attr
val delete : _ string_attr
val disable : attr
val disabled_elt : _ string_attr
  • since 3.6.0.
val disinherit : _ string_attr
val encoding_formdata : attr
Hardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attr
val get : _ string_attr
val headers : _ string_attr
val history_false : attr
Hardcoding of the hx-history attribute to false.
val history_elt : attr
val include_ : _ string_attr
val indicator : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val inherit_ : _ string_attr
  • since 3.6.0.
val on : _ string_attr
Note that the value of this attribute is not escaped.
  • deprecated See https://htmx.org/attributes/hx-on/#hx-on-deprecated
val on_ : event:string -> _ string_attr
The hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
  • since 2.1.0.
val params : _ string_attr
val patch : _ string_attr
val post : _ string_attr
val preload : attr
The preload extension: https://htmx.org/extensions/preload/
val preserve : attr
val prompt : _ string_attr
val push_url : _ string_attr
val put : _ string_attr
val replace_url : _ string_attr
val request : _ string_attr
val select : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sse_close : _ string_attr
  • since 3.6.0.
val sse_connect : _ string_attr
val sse_swap : _ string_attr
val swap : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val sync : _ string_attr
val target : _ string_attr
Note that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attr
Note that the value of this attribute is not escaped.
val validate : attr
val vals : _ string_attr
val ws_connect : _ string_attr
val ws_send : attr

diff --git a/pure-html/Pure_html/MathML/index.html b/pure-html/Pure_html/MathML/index.html
index 7dafdb2..53664e0 100644
--- a/pure-html/Pure_html/MathML/index.html
+++ b/pure-html/Pure_html/MathML/index.html
@@ -1,2 +1,2 @@
 
-MathML (pure-html.Pure_html.MathML)
Module Pure_html.MathML
  • since 3.1.0.
val accent : bool to_attr
val accentunder : bool to_attr
val columnspan : int to_attr
val depth : _ string_attr
val dir : [ `ltr | `rtl ] to_attr
val display_block : attr
See https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attr
val fence : bool to_attr
val height : _ string_attr
val largeop : bool to_attr
val linethickness : _ string_attr
val lspace : _ string_attr
val mathvariant : _ string_attr
val maxsize : _ string_attr
val minsize : _ string_attr
val movablelimits : bool to_attr
val rowspan : int to_attr
val rspace : _ string_attr
val scriptlevel : _ string_attr
val separator : bool to_attr
val stretchy : bool to_attr
val symmetric : bool to_attr
val voffset : _ string_attr
val xmlns : attr
val annotation : std_tag
val annotation_xml : std_tag
val math : std_tag
val merror : std_tag
val mfrac : std_tag
val mi : std_tag
val mmultiscripts : std_tag
val mn : std_tag
val mo : std_tag
val mover : std_tag
val mpadded : std_tag
val mphantom : std_tag
val mroot : std_tag
val mrow : std_tag
val ms : std_tag
val mspace : std_tag
val msqrt : std_tag
val mstyle : std_tag
val msub : std_tag
val msubsup : std_tag
val msup : std_tag
val mtable : std_tag
val mtd : std_tag
val mtext : std_tag
val mtr : std_tag
val munder : std_tag
val munderover : std_tag
val semantics : std_tag

+MathML (pure-html.Pure_html.MathML)
Module Pure_html.MathML
  • since 3.1.0.
val accent : bool to_attr
val accentunder : bool to_attr
val columnspan : int to_attr
val depth : _ string_attr
val dir : [ `ltr | `rtl ] to_attr
val display_block : attr
See https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attr
val fence : bool to_attr
val height : _ string_attr
val largeop : bool to_attr
val linethickness : _ string_attr
val lspace : _ string_attr
val mathvariant : _ string_attr
val maxsize : _ string_attr
val minsize : _ string_attr
val movablelimits : bool to_attr
val rowspan : int to_attr
val rspace : _ string_attr
val scriptlevel : _ string_attr
val separator : bool to_attr
val stretchy : bool to_attr
val symmetric : bool to_attr
val voffset : _ string_attr
val xmlns : attr
val annotation : std_tag
val annotation_xml : std_tag
val math : std_tag
val merror : std_tag
val mfrac : std_tag
val mi : std_tag
val mmultiscripts : std_tag
val mn : std_tag
val mo : std_tag
val mover : std_tag
val mpadded : std_tag
val mphantom : std_tag
val mroot : std_tag
val mrow : std_tag
val ms : std_tag
val mspace : std_tag
val msqrt : std_tag
val mstyle : std_tag
val msub : std_tag
val msubsup : std_tag
val msup : std_tag
val mtable : std_tag
val mtd : std_tag
val mtext : std_tag
val mtr : std_tag
val munder : std_tag
val munderover : std_tag
val semantics : std_tag

diff --git a/pure-html/Pure_html/SVG/index.html b/pure-html/Pure_html/SVG/index.html
index b632bf1..ecc69b2 100644
--- a/pure-html/Pure_html/SVG/index.html
+++ b/pure-html/Pure_html/SVG/index.html
@@ -1,3 +1,3 @@
 
-SVG (pure-html.Pure_html.SVG)
Module Pure_html.SVG
  • since 1.1.0.
val d : _ string_attr
val fill : _ string_attr
val stroke : _ string_attr
val stroke_linecap : [< `butt | `round | `square ] to_attr
val stroke_linejoin : 
+SVG (pure-html.Pure_html.SVG)
Module Pure_html.SVG
  • since 1.1.0.
val d : _ string_attr
val fill : _ string_attr
val stroke : _ string_attr
val stroke_linecap : [< `butt | `round | `square ] to_attr
val stroke_linejoin : 
   [< `arcs | `bevel | `miter | `miter_clip | `round ] to_attr
val stroke_width : _ string_attr
val viewbox : min_x:int -> min_y:int -> width:int -> height:int -> attr
val xmlns : attr
val path : std_tag
val svg : std_tag

diff --git a/pure-html/Pure_html/index.html b/pure-html/Pure_html/index.html
index b3be775..20777fe 100644
--- a/pure-html/Pure_html/index.html
+++ b/pure-html/Pure_html/index.html
@@ -1,5 +1,5 @@
 
-Pure_html (pure-html.Pure_html)
Module Pure_html
Use this module for constructing HTML without any dependency on the Dream web framework.
  • since 3.5.0.
Core types
These are the types of the final values which get rendered.
type attr
E.g. id="toast".
type node
Either a tag, a comment, or text data in the markup.
Output
val to_string : node -> string
val to_xml : node -> string
Same as to_string but render void tags as XML-style self-closing tags.
  • since 3.3.0.
val pp : Stdlib.Format.formatter -> node -> unit
val pp_xml : Stdlib.Format.formatter -> node -> unit
Same as pp but render void tags as XML-style self-closing tags.
  • since 3.3.0.
Constructing nodes and attributes
type 'a to_attr = 'a -> attr
Attributes can be created from typed values.
type 'a string_attr = ('a, unit, string, attr) Stdlib.format4 -> 'a
Special handling for string-value attributes so they can use format strings i.e. string interpolation.
type std_tag = attr list -> node list -> node
A 'standard' tag with attributes and children.
type void_tag = attr list -> node
A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.
type 'a text_tag = attr list -> ('a, unit, string, node) Stdlib.format4 -> 'a
Tags which can have attributes but can contain only text. The text can be formatted.
val attr : string -> attr
attr name is a new attribute which does not carry any payload. E.g.
let required = attr "required"
  • since 0.1.0.
val string_attr : string -> ?raw:bool -> _ string_attr
string_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.
val uri_attr : string -> _ string_attr
Convenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.
Examples
a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
+Pure_html (pure-html.Pure_html)
Module Pure_html
Use this module for constructing HTML without any dependency on the Dream web framework.
  • since 3.5.0.
Core types
These are the types of the final values which get rendered.
type attr
E.g. id="toast".
type node
Either a tag, a comment, or text data in the markup.
Output
val to_string : node -> string
val to_xml : ?header:bool -> node -> string
Same as to_string but render void tags as XML-style self-closing tags.
  • parameter header 
    print the XML header string if true. This is to allow both use cases where the XML code is embedded inside HTML, and standalone XML documents. Default is false. Since 3.6.0.
  • since 3.3.0.
val pp : Stdlib.Format.formatter -> node -> unit
val pp_xml : Stdlib.Format.formatter -> ?header:bool -> node -> unit
Same as pp but render void tags as XML-style self-closing tags.
  • parameter header 
    print the XML header string if true. This is to allow both use cases where the XML code is embedded inside HTML, and standalone XML documents. Default is false. Since 3.6.0.
  • since 3.3.0.
Constructing nodes and attributes
type 'a to_attr = 'a -> attr
Attributes can be created from typed values.
type 'a string_attr = ('a, unit, string, attr) Stdlib.format4 -> 'a
Special handling for string-value attributes so they can use format strings i.e. string interpolation.
type std_tag = attr list -> node list -> node
A 'standard' tag with attributes and children.
type void_tag = attr list -> node
A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.
type 'a text_tag = attr list -> ('a, unit, string, node) Stdlib.format4 -> 'a
Tags which can have attributes but can contain only text. The text can be formatted.
val attr : string -> attr
attr name is a new attribute which does not carry any payload. E.g.
let required = attr "required"
  • since 0.1.0.
val string_attr : string -> ?raw:bool -> _ string_attr
string_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.
val uri_attr : string -> _ string_attr
Convenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.
Examples
a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
 ==>
 <a href="/blog?tags=iamsafe%22%3E%3C/a%3E%3Cscript%3Ealert('Pwned')%3C/script%3E">Tags: tag1 | tag2</a>
 
diff --git a/pure-html/index.html b/pure-html/index.html
index a4dbecd..940eb24 100644
--- a/pure-html/index.html
+++ b/pure-html/index.html
@@ -1,2 +1,2 @@
 
-index (pure-html.index)
pure-html index
Library pure-html
The entry point of this library is the module: Pure_html.

+index (pure-html.index)
pure-html index
Library pure-html
The entry point of this library is the module: Pure_html.