From 413e921582d4a58c7329c70f599d2163f82db026 Mon Sep 17 00:00:00 2001 From: "Jakob L. Kreuze" Date: Sun, 20 Jul 2025 11:07:37 -0400 Subject: Docs, branding --- LICENSE | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 41 ++++ flashcards.html | 35 --- script.js | 402 --------------------------------- srs-anywhere.html | 76 +++++++ srs-anywhere.js | 433 +++++++++++++++++++++++++++++++++++ style.css | 56 +++++ 7 files changed, 1267 insertions(+), 437 deletions(-) create mode 100644 LICENSE create mode 100644 README.md delete mode 100644 flashcards.html delete mode 100644 script.js create mode 100644 srs-anywhere.html create mode 100644 srs-anywhere.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f2c843c --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# SRS Anywhere + +SRS Anywhere is a free, browser-based flash card application using the [Free Spaced Repetition Scheduler (FSRS)](https://github.com/open-spaced-repetition/free-spaced-repetition-scheduler) algorithm. +It is similar to [Anki](https://en.wikipedia.org/wiki/Anki_(software)), except that it is entirely contained within static files and can therefore be used anywhere a web browser is available. +No server is necessary. + +SRS Anywhere is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +SRS Anywhere 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 Affero General Public License for more details. +You should have received a copy of the GNU Affero General Public License along with SRS Anywhere. If not, see . + +## Usage + +Open `srs-anywhere.html` in a web browser and press the "Browse..." button in the top right-hand corner to load a deck of cards. +The "?" button will display the available keyboard shortcuts. +When the review is complete, you will be prompted to download a JSON file. +This contains the deck of cards updated with new scheduling parameters for your next review. + +### Format for Cards + +The `cards.json` file is an array of objects containing at least the keys `id`, `front`, and `back`. +The only requirement for `id` is that it's unique across the deck: it could be a UUID, but it could also be something more descriptive. +`front` and `back` are HTML fragments that are injected into the page when the card is shown. +Additional keys are permissible. +Keys generated and modified by SRS Anywhere are prefixed by the `_` character. + +#### Example + +```json +[ + { + "id": "cca013c4-450a-41a1-abed-28abdc73413a", + "front": "What is the capital of Virginia?", + "back": "Richmond." + }, + { + "id": "a8fc5101-2d22-4b20-b475-1db00f120654", + "front": "What is accomplished by Article II of the United States Constitution?", + "back": "Article II of the United States Constitution establishes the executive branch of the federal government, which carries out and enforces federal laws." + } +] +``` diff --git a/flashcards.html b/flashcards.html deleted file mode 100644 index 72706ab..0000000 --- a/flashcards.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - Flashcard - - - -
-
-
-
- -
-
- No cards loaded! -
-
- -
- -
- - - - -
- -
-
- - - - diff --git a/script.js b/script.js deleted file mode 100644 index ad58179..0000000 --- a/script.js +++ /dev/null @@ -1,402 +0,0 @@ -function reportException(e) { - const error = e instanceof Error ? e : new Error(e.toString()); - console.log(JSON.stringify(error.stack)); - showToast(`An error has occurred!\n\n${error}\n\n${error.stack}`); -} - -/*********************************************************************** - * Actual FSRS5 algorithm * - ***********************************************************************/ - -const W = [ - 0.40255, 1.18385, 3.173, 15.69105, 7.1949, 0.5345, 1.4604, 0.0046, 1.54575, 0.1192, 1.01925, - 1.9395, 0.11, 0.29605, 2.2698, 0.2315, 2.9898, 0.51655, 0.6621, -]; - -const F = 19.0 / 81.0; -const C = -0.5; - -const Grade = { - forgot: 1.0, - hard: 2.0, - good: 3.0, - easy: 4.0 -}; - -function retrievability(t, s) { - return Math.pow(1.0 + F * (t / s), C); -} - -function interval(r_d, s) { - return (s / F) * (Math.pow(r_d, 1.0 / C) - 1.0); -} - -function s_0(g) { - switch (g) { - case Grade.forgot: return W[0]; - case Grade.hard: return W[1]; - case Grade.good: return W[2]; - case Grade.easy: return W[3]; - } -} - -function s_success(d, s, r, g) { - const t_d = 11.0 - d; - const t_s = Math.pow(s, -W[9]); - const t_r = Math.exp(W[10] * (1.0 - r)) - 1.0; - const h = g === Grade.hard ? W[15] : 1.0; - const b = g === Grade.easy ? W[16] : 1.0; - const c = Math.exp(W[8]); - const alpha = 1.0 + t_d * t_s * t_r * h * b * c; - return s * alpha; -} - -function s_fail(d, s, r) { - const d_f = Math.pow(d, -W[12]); - const s_f = Math.pow(s + 1.0, W[13]) - 1.0; - const r_f = Math.exp(W[14] * (1.0 - r)); - const c_f = W[11]; - const result = d_f * s_f * r_f * c_f; - return Math.min(result, s); -} - -function stability(d, s, r, g) { - return g === Grade.forgot ? s_fail(d, s, r) : s_success(d, s, r, g); -} - -function clamp_d(d) { - return Math.min(10.0, Math.max(1.0, d)); -} - -function d_0(g) { - return clamp_d(W[4] - Math.exp(W[5] * (g - 1.0)) + 1.0); -} - -function difficulty(d, g) { - return clamp_d(W[7] * d_0(Grade.easy) + (1.0 - W[7]) * dp(d, g)); -} - -function dp(d, g) { - return d + delta_d(g) * ((10.0 - d) / 9.0); -} - -function delta_d(g) { - return -W[6] * (g - 3.0); -} - -function sim(grades) { - let t = 0.0; - const r_d = 0.9; - const steps = []; - - // Initial review - if (grades.length === 0) { - throw new Error("Grades cannot be empty"); - } - - let gradesCopy = [...grades]; - let g = gradesCopy.shift(); // Remove the first grade - let s = s_0(g); - let d = d_0(g); - let i = Math.max(Math.round(interval(r_d, s)), 1.0); - - steps.push({ t, s, d, i }); - - // n-th review - for (let g of gradesCopy) { - t += i; - const r = retrievability(i, s); - s = stability(d, s, r, g); - d = difficulty(d, g); - i = Math.max(Math.round(interval(r_d, s)), 1.0); - steps.push({ t, s, d, i }); - } - - return steps; -} - -/*********************************************************************** - * State file processing * - ***********************************************************************/ - -function statusString() { - const now = Date.now(); - const elapsedSeconds = Math.floor((now - window.started) / 1000); - const minutes = Math.floor(elapsedSeconds / 60); - const seconds = elapsedSeconds % 60; - const pad = (n) => n < 10 ? '0' + n : n; - return `Card ${window.index + 1} of ${window.cards.length} scheduled for review, ${window.allCards.length} total -Current session: ${pad(minutes)}:${pad(seconds)}`; -} - -function loadCard(card) { - window.card.revealed = false; - window.card.front.innerHTML = card.front; - window.card.front.style.display = "block"; - window.card.back.innerHTML = card.back; - window.card.back.style.display = "none"; - window.buttons.style.display = "none"; -} - -function flipCard() { - if (window.index >= window.cards.length) { - return; - } - - window.card.revealed = true; - - // Reveal the "back". - if (window.card.front.style.display !== "block") { - window.card.front.style.display = "block"; - window.card.back.style.display = "none"; - } else { - window.card.front.style.display = "none"; - window.card.back.style.display = "block"; - } - - // Reveal the buttons. - window.buttons.style.display = "flex"; -} - -function endReview() { - clearInterval(window.updateInterval); - window.statusInfo.innerHTML = "Session complete!"; - window.flashcard.style.display = "none"; - window.buttons.style.display = "none"; - updateAllCards(); - downloadJSON(window.allCards); -} - -function rateCard(difficulty) { - if (!window.card.revealed) { - return; - } - - const card = window.cards[window.index]; - - const r_d = 0.9; - const s = card.scheduler.s; - const d = card.scheduler.d; - const i = card.scheduler.i; - const g = card.flagged ? Grade.forgot : Grade[difficulty]; - - let s_n = undefined, d_n = undefined, i_n = undefined; - - if (s == null || d == null || i == null) { - s_n = s_0(g); - d_n = d_0(g); - } else { - const r = retrievability(i, s); - s_n = stability(d, s, r, g); - d_n = difficulty(d, g); - } - i_n = Math.max(Math.round(interval(r_d, s)), 1.0); - - let scheduled = today(); - scheduled.setDate(scheduled.getDate() + i_n); - - if (difficulty === "forgot") { - // Shift forgotten card to end. - window.cards.push(card); - window.cards.splice(window.index, 1); - loadCard(window.cards[window.index]); - } else { - // Unflag and update scheduler parameters. - delete card.flagged; - card.scheduler.s = s_n; - card.scheduler.d = d_n; - card.scheduler.i = i_n; - card.scheduled = scheduled; - - if (++window.index < window.cards.length) { - loadCard(window.cards[window.index]); - } else { - endReview(); - } - } -} - -// Update `window.allCards` with new scheduler parameters. -function updateAllCards() { - for (let i = 0; i < window.allCards.length; i++) { - const updated = window.cards.find((card) => card.id == window.allCards[i].id); - if (updated) { - window.allCards[i] = updated; - } - } -} - -function downloadJSON(obj) { - // Convert the object to a JSON string (with default formatting) - const jsonString = JSON.stringify(obj, null, 2); // 'null, 2' adds indentation for readability - - // Create a Blob with the JSON content - const blob = new Blob([jsonString], { type: 'application/json' }); - - // Generate a URL for the Blob - const url = URL.createObjectURL(blob); - - // Create an anchor element - const a = document.createElement('a'); - a.href = url; - a.download = 'data.json'; // Default filename - - // Append the anchor to the body (required for some browsers) - document.body.appendChild(a); - - // Simulate a click on the anchor to trigger the download - a.click(); - - // Clean up - document.body.removeChild(a); - URL.revokeObjectURL(url); -} - -function today() { - let today = new Date(); - today.setHours(0, 0, 0, 0); - return today; -} - -function checkCards(cards) { - for (let i = 0; i < cards.length; i++) { - const card = cards[i]; - if (!card.id) { - throw new Error("malformed card: missing id") - } else if (!card.front) { - throw new Error(`malformed card ${card.id}: missing front`) - } else if (!card.back) { - throw new Error(`malformed card ${card.id}: missing bacak`) - } - if (!card.scheduled) { - card.scheduled = today().toJSON(); - } - if (!card.scheduler) { - card.scheduler = { - s: null, - d: null, - i: null - } - } - } -} - -function shuffleArray(array) { - let currentIndex = array.length; - let randomIndex; - - // While there remain elements to shuffle. - while (currentIndex !== 0) { - // Pick a remaining element. - randomIndex = Math.floor(Math.random() * currentIndex); - currentIndex--; - - // And swap it with the current element. - [array[currentIndex], array[randomIndex]] = [ - array[randomIndex], - array[currentIndex], - ]; - } - - return array; -} - -function loadCards(data) { - checkCards(data); - - document.getElementById('flashcard').style.display = "block"; - - window.allCards = data; - window.index = 0; - window.started = Date.now(); - window.statusInfo = document.getElementById('status-info'); - window.buttons = document.getElementById('button-container'); - window.card = { - front: document.getElementById('flashcard-front'), - back: document.getElementById('flashcard-back') - }; - - document.getElementById('rating-button-forgot') - .addEventListener('click', () => rateCard('forgot')); - document.getElementById('rating-button-hard') - .addEventListener('click', () => rateCard('hard')); - document.getElementById('rating-button-good') - .addEventListener('click', () => rateCard('good')); - document.getElementById('rating-button-easy') - .addEventListener('click', () => rateCard('easy')); - - let today = new Date(); - // Granularity only at the day level. - today.setHours(0, 0, 0, 0); - window.cards = data.filter((card) => { - return (new Date(card.scheduled)) <= today; - }); - shuffleArray(window.cards); - - loadCard(window.cards[0]); - - window.updateInterval = setInterval(() => { - window.statusInfo.innerText = statusString() - }, 1000); -} - -/*********************************************************************** - * Status display * - ***********************************************************************/ - -function showToast(message, duration = 3000) { - const toast = document.getElementById("toast"); - toast.innerHTML = "
" + message + "
"; - - // Show the toast - toast.classList.add("show"); - - // Hide the toast after specified time - setTimeout(() => { - toast.classList.remove("show"); - }, duration); -} - -window.addEventListener("load", (event) => { - document.getElementById('cards-input').addEventListener('change', function(event) { - const file = event.target.files[0]; - if (!file) return; - - const reader = new FileReader(); - reader.onload = function(e) { - try { - const content = e.target.result; - loadCards(JSON.parse(content)); - } catch (e) { - reportException(e); - } - }; - - reader.onerror = function(error) { - document.getElementById('result').textContent = "Error reading file: " + error; - reportException(error); - }; - - reader.readAsText(file); // Read the file as text - }); - - document.getElementById('flashcard').addEventListener('click', function(event) { - flipCard(); - }); -}); - -window.addEventListener('keydown', (event) => { - if (event.code === 'Space') { - flipCard(); - } else if (event.code === 'Digit1' || event.code === "Numpad1") { - rateCard('forgot'); - } else if (event.code === 'Digit2' || event.code === "Numpad2") { - rateCard('easy'); - } else if (event.code === 'Digit3' || event.code === "Numpad3") { - rateCard('good'); - } else if (event.code === 'Digit4' || event.code === "Numpad4") { - rateCard('hard'); - } else if (event.code === 'KeyQ') { - endReview(); - } -}); diff --git a/srs-anywhere.html b/srs-anywhere.html new file mode 100644 index 0000000..220d54f --- /dev/null +++ b/srs-anywhere.html @@ -0,0 +1,76 @@ + + + + + + SRS Anywhere + + + +
+
+
+
+ +
+
+ No cards loaded! +
+
+ + +
+ +
+ + + + +
+ +
+
+ + + + + + diff --git a/srs-anywhere.js b/srs-anywhere.js new file mode 100644 index 0000000..8d587ed --- /dev/null +++ b/srs-anywhere.js @@ -0,0 +1,433 @@ +/* Copyright © 2025 Jakob L. Kreuze + + This file is part of SRS Anywhere. + + SRS Anywhere is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + SRS Anywhere 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 + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public + License along with SRS Anywhere. If not, see . */ + +function reportException(e) { + const error = e instanceof Error ? e : new Error(e.toString()); + console.log(JSON.stringify(error.stack)); + showToast(`An error has occurred!\n\n${error}\n\n${error.stack}`); +} + +/*********************************************************************** + * Actual FSRS5 algorithm * + ***********************************************************************/ + +const W = [ + 0.40255, 1.18385, 3.173, 15.69105, 7.1949, 0.5345, 1.4604, 0.0046, 1.54575, 0.1192, 1.01925, + 1.9395, 0.11, 0.29605, 2.2698, 0.2315, 2.9898, 0.51655, 0.6621, +]; + +const F = 19.0 / 81.0; +const C = -0.5; + +const Grade = { + forgot: 1.0, + hard: 2.0, + good: 3.0, + easy: 4.0 +}; + +function retrievability(t, s) { + return Math.pow(1.0 + F * (t / s), C); +} + +function interval(r_d, s) { + return (s / F) * (Math.pow(r_d, 1.0 / C) - 1.0); +} + +function s_0(g) { + switch (g) { + case Grade.forgot: return W[0]; + case Grade.hard: return W[1]; + case Grade.good: return W[2]; + case Grade.easy: return W[3]; + } +} + +function s_success(d, s, r, g) { + const t_d = 11.0 - d; + const t_s = Math.pow(s, -W[9]); + const t_r = Math.exp(W[10] * (1.0 - r)) - 1.0; + const h = g === Grade.hard ? W[15] : 1.0; + const b = g === Grade.easy ? W[16] : 1.0; + const c = Math.exp(W[8]); + const alpha = 1.0 + t_d * t_s * t_r * h * b * c; + return s * alpha; +} + +function s_fail(d, s, r) { + const d_f = Math.pow(d, -W[12]); + const s_f = Math.pow(s + 1.0, W[13]) - 1.0; + const r_f = Math.exp(W[14] * (1.0 - r)); + const c_f = W[11]; + const result = d_f * s_f * r_f * c_f; + return Math.min(result, s); +} + +function stability(d, s, r, g) { + return g === Grade.forgot ? s_fail(d, s, r) : s_success(d, s, r, g); +} + +function clamp_d(d) { + return Math.min(10.0, Math.max(1.0, d)); +} + +function d_0(g) { + return clamp_d(W[4] - Math.exp(W[5] * (g - 1.0)) + 1.0); +} + +function difficulty(d, g) { + return clamp_d(W[7] * d_0(Grade.easy) + (1.0 - W[7]) * dp(d, g)); +} + +function dp(d, g) { + return d + delta_d(g) * ((10.0 - d) / 9.0); +} + +function delta_d(g) { + return -W[6] * (g - 3.0); +} + +function sim(grades) { + let t = 0.0; + const r_d = 0.9; + const steps = []; + + // Initial review + if (grades.length === 0) { + throw new Error("Grades cannot be empty"); + } + + let gradesCopy = [...grades]; + let g = gradesCopy.shift(); // Remove the first grade + let s = s_0(g); + let d = d_0(g); + let i = Math.max(Math.round(interval(r_d, s)), 1.0); + + steps.push({ t, s, d, i }); + + // n-th review + for (let g of gradesCopy) { + t += i; + const r = retrievability(i, s); + s = stability(d, s, r, g); + d = difficulty(d, g); + i = Math.max(Math.round(interval(r_d, s)), 1.0); + steps.push({ t, s, d, i }); + } + + return steps; +} + +/*********************************************************************** + * State file processing * + ***********************************************************************/ + +function statusString() { + const now = Date.now(); + const elapsedSeconds = Math.floor((now - window.started) / 1000); + const minutes = Math.floor(elapsedSeconds / 60); + const seconds = elapsedSeconds % 60; + const pad = (n) => n < 10 ? '0' + n : n; + return `Card ${window.index + 1} of ${window.cards.length} scheduled for review, ${window.allCards.length} total +Current session: ${pad(minutes)}:${pad(seconds)}`; +} + +function loadCard(card) { + window.card.revealed = false; + window.card.front.innerHTML = card.front; + window.card.front.style.display = "block"; + window.card.back.innerHTML = card.back; + window.card.back.style.display = "none"; + window.buttons.style.display = "none"; +} + +function flipCard() { + if (window.index >= window.cards.length) { + return; + } + + window.card.revealed = true; + + // Reveal the "back". + if (window.card.front.style.display !== "block") { + window.card.front.style.display = "block"; + window.card.back.style.display = "none"; + } else { + window.card.front.style.display = "none"; + window.card.back.style.display = "block"; + } + + // Reveal the buttons. + window.buttons.style.display = "flex"; +} + +function endReview() { + clearInterval(window.updateInterval); + window.statusInfo.innerHTML = "Session complete!"; + window.flashcard.style.display = "none"; + window.buttons.style.display = "none"; + updateAllCards(); + downloadJSON(window.allCards); +} + +function rateCard(difficulty) { + if (!window.card.revealed) { + return; + } + + const card = window.cards[window.index]; + + const r_d = 0.9; + const s = card._scheduler.s; + const d = card._scheduler.d; + const i = card._scheduler.i; + const g = card._flagged ? Grade.forgot : Grade[difficulty]; + + let s_n = undefined, d_n = undefined, i_n = undefined; + + if (s == null || d == null || i == null) { + s_n = s_0(g); + d_n = d_0(g); + } else { + const r = retrievability(i, s); + s_n = stability(d, s, r, g); + d_n = difficulty(d, g); + } + i_n = Math.max(Math.round(interval(r_d, s)), 1.0); + + let scheduled = today(); + scheduled.setDate(scheduled.getDate() + i_n); + + if (difficulty === "forgot") { + // Shift forgotten card to end. + window.cards.push(card); + window.cards.splice(window.index, 1); + loadCard(window.cards[window.index]); + } else { + // Unflag and update scheduler parameters. + delete card._flagged; + card._scheduler.s = s_n; + card._scheduler.d = d_n; + card._scheduler.i = i_n; + card._scheduled = scheduled; + + if (++window.index < window.cards.length) { + loadCard(window.cards[window.index]); + } else { + endReview(); + } + } +} + +// Update `window.allCards` with new scheduler parameters. +function updateAllCards() { + for (let i = 0; i < window.allCards.length; i++) { + const updated = window.cards.find((card) => card.id == window.allCards[i].id); + if (updated) { + window.allCards[i] = updated; + } + } +} + +function downloadJSON(obj) { + // Convert the object to a JSON string (with default formatting) + const jsonString = JSON.stringify(obj, null, 2); // 'null, 2' adds indentation for readability + + // Create a Blob with the JSON content + const blob = new Blob([jsonString], { type: 'application/json' }); + + // Generate a URL for the Blob + const url = URL.createObjectURL(blob); + + // Create an anchor element + const a = document.createElement('a'); + a.href = url; + a.download = 'data.json'; // Default filename + + // Append the anchor to the body (required for some browsers) + document.body.appendChild(a); + + // Simulate a click on the anchor to trigger the download + a.click(); + + // Clean up + document.body.removeChild(a); + URL.revokeObjectURL(url); +} + +function today() { + let today = new Date(); + today.setHours(0, 0, 0, 0); + return today; +} + +function checkCards(cards) { + for (let i = 0; i < cards.length; i++) { + const card = cards[i]; + if (!card.id) { + throw new Error("malformed card: missing id") + } else if (!card.front) { + throw new Error(`malformed card ${card.id}: missing front`) + } else if (!card.back) { + throw new Error(`malformed card ${card.id}: missing bacak`) + } + if (!card._scheduled) { + card._scheduled = today().toJSON(); + } + if (!card._scheduler) { + card._scheduler = { + s: null, + d: null, + i: null + } + } + } +} + +function shuffleArray(array) { + let currentIndex = array.length; + let randomIndex; + + // While there remain elements to shuffle. + while (currentIndex !== 0) { + // Pick a remaining element. + randomIndex = Math.floor(Math.random() * currentIndex); + currentIndex--; + + // And swap it with the current element. + [array[currentIndex], array[randomIndex]] = [ + array[randomIndex], + array[currentIndex], + ]; + } + + return array; +} + +function loadCards(data) { + checkCards(data); + + document.getElementById('flashcard').style.display = "block"; + + window.allCards = data; + window.index = 0; + window.started = Date.now(); + window.statusInfo = document.getElementById('status-info'); + window.buttons = document.getElementById('button-container'); + window.card = { + front: document.getElementById('flashcard-front'), + back: document.getElementById('flashcard-back') + }; + + document.getElementById('rating-button-forgot') + .addEventListener('click', () => rateCard('forgot')); + document.getElementById('rating-button-hard') + .addEventListener('click', () => rateCard('hard')); + document.getElementById('rating-button-good') + .addEventListener('click', () => rateCard('good')); + document.getElementById('rating-button-easy') + .addEventListener('click', () => rateCard('easy')); + + let today = new Date(); + // Granularity only at the day level. + today.setHours(0, 0, 0, 0); + window.cards = data.filter((card) => { + return (new Date(card._scheduled)) <= today; + }); + shuffleArray(window.cards); + + loadCard(window.cards[0]); + + window.updateInterval = setInterval(() => { + window.statusInfo.innerText = statusString() + }, 1000); +} + +/*********************************************************************** + * Status display * + ***********************************************************************/ + +function showToast(message, duration = 3000) { + const toast = document.getElementById("toast"); + toast.innerHTML = "
" + message + "
"; + + // Show the toast + toast.classList.add("show"); + + // Hide the toast after specified time + setTimeout(() => { + toast.classList.remove("show"); + }, duration); +} + +window.addEventListener("load", (event) => { + document.getElementById('cards-input').addEventListener('change', function(event) { + const file = event.target.files[0]; + if (!file) return; + + const reader = new FileReader(); + reader.onload = function(e) { + try { + const content = e.target.result; + loadCards(JSON.parse(content)); + } catch (e) { + reportException(e); + } + }; + + reader.onerror = function(error) { + document.getElementById('result').textContent = "Error reading file: " + error; + reportException(error); + }; + + reader.readAsText(file); // Read the file as text + }); + + document.getElementById('flashcard').addEventListener('click', function(event) { + flipCard(); + }); + + const modal = document.getElementById('modal'); + const openBtn = document.getElementById('open-modal'); + const closeBtn = document.getElementById('close-modal'); + + // Show the modal when "Open Modal" is clicked + openBtn.addEventListener('click', () => { + modal.style.display = 'block'; + }); + + // Hide the modal when "OK" is clicked + closeBtn.addEventListener('click', () => { + modal.style.display = 'none'; + }); +}); + +window.addEventListener('keydown', (event) => { + if (event.code === 'Space') { + flipCard(); + } else if (event.code === 'Digit1' || event.code === "Numpad1") { + rateCard('forgot'); + } else if (event.code === 'Digit2' || event.code === "Numpad2") { + rateCard('easy'); + } else if (event.code === 'Digit3' || event.code === "Numpad3") { + rateCard('good'); + } else if (event.code === 'Digit4' || event.code === "Numpad4") { + rateCard('hard'); + } else if (event.code === 'KeyQ') { + endReview(); + } +}); diff --git a/style.css b/style.css index 6c77a0c..54f548b 100644 --- a/style.css +++ b/style.css @@ -79,3 +79,59 @@ body { filter: drop-shadow(2px 2px 5px gray); box-shadow: 2px 2px 5px gray; } + +/* Modal Background (Overlay) */ +.modal { + display: none; /* Hidden by default */ + position: fixed; /* Stay in place */ + z-index: 1000; /* Sit on top */ + left: 0; + top: 0; + width: 100%; + height: 100%; + overflow: auto; + background-color: rgba(0, 0, 0, 0.5); /* Semi-transparent black */ +} + +/* Modal Content Box */ +.modal-content { + background-color: #fff; + margin: 2rem auto; + padding: 20px; + border: 1px solid #888; + width: 50%; + text-align: center; + border-radius: 8px; + box-shadow: 0 4px 10px rgba(0, 0, 0, 0.2); +} + +/* OK Button Style */ +.ok-button { + margin-top: 10px; + padding: 10px 20px; + font-size: 16px; + cursor: pointer; + border: none; + border-radius: 5px; + background-color: #007bff; + color: white; + transition: background-color 0.3s ease; +} + +.ok-button:hover { + background-color: #0056b3; +} + +table { + width: 100%; + border-collapse: collapse; + font-family: Arial, sans-serif; +} +th, td { + border: 1px solid #ccc; + padding: 10px; + text-align: left; +} +th { + background-color: #f4f4f4; +} -- cgit v1.3