[
{
"path": ".gitignore",
"content": "target/\n.idea/\n*.iml\n"
},
{
"path": "CODEOWNERS",
"content": "# This is the CODEOWNERS file for the textricator repo.\n\n# These owners will be the default owners for everything in the repo, unless a\n# later match takes precedence.\n* @lschumann-mfj @wstumbo-mfj\n\n# Make sure that DevOps is aware of anything GitHub related\n/.github/ @lschumann-mfj @wstumbo-mfj @SB-MFJ @meghanbissonnette-mfj"
},
{
"path": "COPYING",
"content": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n.\n"
},
{
"path": "NOTICE",
"content": "Textricator\nCopyright 2018 Measures for Justice Institute.\n"
},
{
"path": "README.md",
"content": "# \n\n_Textricator_ is a tool to extract text from documents and generate structured data.\n\nIf you have a bunch of PDFs with the same format (or one big, consistently formatted PDF)\nand you want to extract the data to CSV, XML, or JSON, _Textricator_ can help!\nIt can even work on OCR'ed documents!\n\n_Textricator_ is released under the\n[GNU Affero General Public License Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html).\n\n_Textricator_ is deployed to [Maven Central](https://repo1.maven.org/maven2/io/mfj/textricator/) with GAV `io.mfj:textricator`.\n\nThis application is actively used and developed by [Measures for Justice](https://measuresforjustice.org).\nWe welcome feedback, bug reports, and contributions. Create an issue, send a pull request,\nor email us at . If you use _Textricator_, please let us know.\nSend us your mailing address and we will mail you a sticker.\n\n`io.mfj.textricator.Textricator` is the main entry point for library usage.\n\n`io.mfj.textricator.cli.TextricatorCli` is the command-line interface.\n\nThe CLI has three subcommands, to use the three main features of Textricator:\n * text - Extract text from the PDF and generate JSON.\n * table - Parse the text that is in columns and rows. See [Table](#table) section.\n * form - Parse the text with a configured finite state machine. See [Form](#form) section.\n\n## Quick Start\n\n- Install Java (version 11+)\n * Windows & Macos: Download from [https://java.com](https://java.com) and install.\n * Linux: Use your package manager.\n- Download the latest build of _Textricator_ from [https://repo1.maven.org/maven2/io/mfj/textricator/](https://repo1.maven.org/maven2/io/mfj/textricator/) - click on the directory for the latest version and download `textricator-VERSION-bin.tgz` (or `textricator-VERSION-bin.zip` for Windows).\n- Extract it.\n- Run a shell\n * Windows: run _Windows Powershell_ (it should be in the start menu)\n * The following examples start with `./textricator`. On Windows, use `.\\textricator.bat`.\n * MacOS: Run _Terminal_ (type \"terminal\" in Spotlight)\n- Show help\n - `./textricator --help`\n- Download the example files to the textricator directory:\n * https://github.com/measuresforjustice/textricator/blob/main/src/test/resources/io/mfj/textricator/examples/school-employee-list.pdf\n * https://github.com/measuresforjustice/textricator/blob/main/src/test/resources/io/mfj/textricator/examples/school-employee-list.yml\n- Extract raw text from a PDF to standard out\n - `./textricator text --input-format=pdf.pdfbox school-employee-list.pdf`\n- Parse a PDF to CSV\n - `./textricator form --config=school-employee-list.yml school-employee-list.pdf school-employee-list.csv`\n * This uses the configuration file `school-employee-list.yml` to parse `school-employee-list.pdf`.\n To parse your own PDF form, you will need to write your own configuration file.\n See the [Form](#form) section for details.\n If your PDF has a tabular layout, see the [Table](#table) section.\n\n## Logging\n\nUse the `--debug` flag to log everything.\nLogging is written to standard error.\n\nTextricator uses [SLF4J](https://slf4j.org) for logging, with the [Logback](https://logback.qos.ch) implementation.\nIf you are using Textricator as a library, you may want to exclude `ch.qos.logback:logback-classic`.\nTextricator does *not* include a `/logback.xml`, so it will not conflict with other logging configurations,\nso long as `TextricatorCli.main()` is not invoked.\n\n## Extracting text\n\nTo extract the text from a PDF, run\n`textrictor text --input-format=pdf.itext5 input.pdf input-text.csv`\nfor any `input.pdf` and then open `input-text.csv` in your favorite spreadsheet program.\nIt will show you every bit of text that Textricator sees with its position, size,\nand font information. This information is very useful for building configuration to parse\ntables or forms using Textricator (see the following two sections).\n\nTry `--input-format=pdf.itext7` and `--input-format=pdf.pdfbox` to see how Textricator\nextracts the texts using the different parser engines. Some work better for some documents\nthan others.\n\n## Table\n\nIn table mode, the data is grouped into columns based on the x-coordinate of the text.\n\n### Example\n\nThis is an example for `src/test/resources/io/mfj/textricator/examples/probes.pdf`.\n\n```yaml\n# All measurements are in points. 1 point = 1/72 of an inch.\n# x-coordinates are from the left edge of the page.\n# y-coordinates are from the top edge of the page.\n\n# Use the built-in pdfbox extractor\nextractor: \"pdf.pdfbox\"\n\n# Ignore everything above 88pt from the top\ntop: 88\n\n# Ignore everything below 170pt from the top\nbottom: 170\n\n# If multiple text segments are withing 2pt vertically, consider them in the same row.\nmaxRowDistance: 2\n\n# Define the columns, based on the x-coordinate where the column starts:\ncols:\n \"name\": 0\n \"launched\": 132\n \"speed\": 235\n \"cospar\": 249\n \"power\": 355\n \"mass\": 415\n\ntypes:\n \"name\":\n label: \"Name\"\n\n \"launched\":\n label: \"Launch Date\"\n\n \"speed\":\n label: \"Speed (km/s)\"\n type: \"number\"\n\n \"cospar\":\n label: \"COSPAR ID\"\n\n \"power\":\n label: \"Power (watts)\"\n type: \"number\"\n\n \"mass\":\n label: \"Mass (pounds)\"\n # Add .0 to the end of mass\n replacements:\n -\n pattern: \"^(.*)$\"\n replacement: \"$1.0\"\n\n# Omit if Power is less than 200\nfilter: 'power >= 200'\n```\n\n## Form\n\nIn form mode, the data is parsed by Textricator using a\n[finite-state machine](https://en.wikipedia.org/wiki/Finite-state_machine) (FSM),\nand the FSM and additional parsing and formatting parameters are configured with\n[YAML](https://en.wikipedia.org/wiki/YAML), indicated by command line option `--config`.\n\n### Conditions\n\nState transitions are selected by evaluating conditions. Conditions are expressions parsed by\n[Expr](https://github.com/measuresforjustice/expr).\n\n#### Available variables:\n\n * `ulx` - x coordinate of the upper-left corner of the text box\n * `uly` - y coordinate of the upper-left corner of the text box\n * `lrx` - x coordinate of the lower-right corner of the text box\n * `lry` - y coordinate of the lower-right corner of the text box\n * `text` - the text\n * `page` - page number\n * `page_prev` - page number of the previous text\n * `fontSize` - font size\n * `font` - font name\n * `color` - text color\n * `bgcolor` - background color\n * `width` - width of the text box\n * `height` - height of the text box\n * `ulx_rel` - difference in `ulx` between the previous and current texts\n * `uly_rel` - difference in `uly` between the previous and current texts\n * `lrx_rel` - difference in `lrx` between the previous and current texts\n * `lry_rel` - difference in `lry` between the previous and current texts\n * [added Variables](#variables)\n\n### Example\n\nThis is an example for `src/test/resources/io/mfj/textricator/examples/school-employee-list.pdf`.\n\n```yaml\n# Use the built-in pdfbox parser\nextractor: \"pdf.pdfbox\"\n\n# All measurements are in points. 1 point = 1/72 of an inch.\n# x-coordinates are from the left edge of the page.\n# y-coordinates are from the top edge of the page.\nheader:\n # ignore anything less than this many points from the top, default and per-page\n default: 130\nfooter:\n # ignore anything more than this many points from the top, default and per-page\n default: 700\n\n# Text segments are generally parsed in order, top to bottom, left to right.\n# If two text segments have y-coordinates within this many points, consider them on the same line,\n# and process the one further left first, even if it is 0.4pt lower on the page.\nmaxRowDistance: 2\n\n# Define the output data record.\n# Since the main record type we're collecting information on is our employees,\n# we'll have that be the root type for our harvested information.\nrootRecordType: employee\nrecordTypes:\n employee:\n label: \"employee\" # Labels are used when nested recordTypes come into play, like this document.\n valueTypes:\n # Not sure what to name a valueType? Just make something up!\n - employee\n - name\n - hiredate\n - occupation\n - showinfo\n - bool1\n - bool2\n - bool3\n - salary\n children:\n # In this example, there are multiple children nested under an employee,\n # so we'll treat it as a 'child' to the 'employee' recordType.\n - child\n child:\n label: \"child\"\n valueTypes:\n - child\n - grade\n\nvalueTypes:\n employee:\n # In the CSV, use \"Employee ID\" as the column header instead of \"employee\".\n label: \"Employee ID\"\n name:\n label: \"Name\"\n hiredate:\n label: \"Hire Date\"\n occupation:\n label: \"Occupation\"\n salary:\n label: \"Salary\"\n showinfo:\n label: \"Important Info?\"\n bool1:\n label: \"Boolean 1\"\n bool2:\n label: \"Boolean 2\"\n bool3:\n label: \"Boolean 3\"\n child:\n label: \"Attending Child\"\n grade:\n label: \"Grade\"\n\n# Now we define the finite-state machine\n# Let's name the state that our machine starts off with:\ninitialState: \"INIT\"\n\n# When each text segment is encountered, each transition for the current state is checked.\nstates:\n INIT:\n transitions:\n # The first bit of text we reach is 'ID-0001', so we'll try the only transition that should work here.\n -\n # If this condition matches (which it should)\n condition: employee # Curious about the condition? Sxroll further down to the conditions section of this YAML.\n # Then we'll switch to the 'employee' state!\n nextState: employee\n\n employee: # ID number with the format 'ID-####'\n startRecord: true # When we enter this stage, we'll create a new \"case\" record.\n transitions:\n - # Now we move on to the name label. Once again, by varifying the condition and moving on after that.\n condition: namelabel\n nextState: namelabel\n\n namelabel:\n include: false # The label isn't important information in and of itself, so we can just not include it in the data.\n transitions:\n -\n condition: name\n nextState: name\n\n name:\n transitions:\n -\n # Sometimes a name will be in two segments, and we'll hit another 'name' text segment before anything else.\n # In that case, a state can transition to itself, compounding the information picked up in it.\n condition: name\n nextState: name\n -\n # Does the first condition not match the text? We move onto the next one.\n condition: hiredateLabel\n nextState: hiredateLabel\n\n hiredateLabel:\n include: false\n transitions:\n -\n condition: hiredateLabel\n nextState: hiredateLabel\n -\n condition: hiredate\n nextState: hiredate\n\n hiredate:\n transitions:\n -\n condition: occupationLabel\n nextState: occupationLabel\n\n occupationLabel:\n include: false\n transitions:\n -\n condition: occupation\n nextState: occupation\n\n occupation:\n transitions:\n -\n condition: occupation\n nextState: occupation\n -\n # This state and the next are an example of how you can choose, using conditions, what to include or not.\n # They share the same area of a document, but have qualities to them that can be distinguishable.\n # Does it meet 'showinfo' conditions? Then we go to the 'showinfo' state that includes it.\n condition: showinfo\n nextState: showinfo\n -\n # Doesn't meet 'showinfo'? Then check for 'notinfo' and exclude it.\n condition: notinfo\n nextState: notinfo\n showinfo:\n transitions:\n -\n condition: showinfo\n nextState: showinfo\n -\n condition: bool1\n nextState: bool1\n notinfo:\n include: false\n transitions:\n -\n condition: notinfo\n nextState: notinfo\n -\n condition: bool1\n nextState: bool1\n\n bool1:\n transitions:\n -\n condition: bool2\n nextState: bool2\n bool2:\n transitions:\n -\n condition: bool3\n nextState: bool3\n bool3:\n transitions:\n -\n condition: salaryLabel\n nextState: salaryLabel\n\n salaryLabel:\n include: false\n transitions:\n -\n condition: salary\n nextState: salary\n\n salary:\n transitions:\n -\n condition: childrenLabel\n nextState: childrenLabel\n -\n condition: employee\n nextState: employee\n -\n condition: end\n nextState: end\n\n childrenLabel:\n include: false\n transitions:\n -\n condition: childrenLabel\n nextState: childrenLabel\n -\n condition: childLabel\n nextState: childLabel\n\n childLabel:\n include: false\n transitions:\n -\n condition: child\n nextState: child\n\n child:\n # Here we reach a datatype nested within another datatype. We can start records using this child datatype.\n # In the process, we'll be making multiple rows for the parent datatype, each one holding onto it's own child.\n startRecord: true\n transitions:\n -\n condition: child\n nextState: child\n -\n condition: gradeLabel\n nextState: gradeLabel\n -\n condition: childLabel\n nextState: childLabel\n\n gradeLabel:\n include: false\n transitions:\n -\n # Normally, there would always been an instance of a grade appearing right after the label.\n # But in this document, we have one instance of that not happening under ID-0007's child.\n condition: grade\n nextState: grade\n -\n # So we just account for that possibility by adding a transition out of the label.\n condition: employee\n nextState: employee\n\n grade:\n transitions:\n -\n condition: employee\n nextState: employee\n -\n condition: childLabel\n nextState: childLabel\n -\n # Reach the end of the usable info in a document, but there's still text left to go?\n # An easy fix is to just create a looping, not-included state to finish the document off.\n condition: end\n nextState: end\n\n end:\n # We reached a point in the document where all the useful information is gone, but we still have text to go.\n include: false\n transitions:\n -\n # By using an always-true condition such as 'any', we can loop this state until the document has been completely gone through.\n condition: any\n nextState: end\n\n# Here we define the conditions:\nconditions:\n\n # An example of comparing text with regex.\n # In this case, we're making sure that the text contains the characters 'ID-' followed by any amount of numbers.\n employee: 'text =~ /ID-(\\\\d)*/'\n\n # You can match based on the x- and y- coordinates of the upper left and lower right corners of the rectangle\n # containing the text. ulx = Upper-Left X-coordinate. lry = Lower-Right Y-coordinate. Also uly and lrx.\n # You can define the lower and upper limit for each, inclusive.\n namelabel: '70 < ulx < 80 and font = \"BCDFEE+Calibri-Bold\"'\n\n # You can also match based on the type of font used, including if it was bolded or italicized.\n name: '112 < ulx < 200 and font = \"BCDEEE+Calibri\"'\n\n hiredateLabel: '230 < ulx < 270 and font = \"BCDFEE+Calibri-Bold\"'\n\n hiredate: '280 < ulx < 290 and font = \"BCDEEE+Calibri\"'\n\n occupationLabel: '391 < ulx < 393 and font = \"BCDFEE+Calibri-Bold\"'\n\n occupation: '394 < ulx < 700 and font = \"BCDEEE+Calibri\"'\n\n showinfo: 'font = \"BCDJEE+Georgia\"'\n\n notinfo: 'font = \"BCDEEE+Calibri\"'\n\n bool1: 'font = \"BCDIEE+Cambria\"'\n\n bool2: 'font = \"BCDIEE+Cambria\"'\n\n bool3: 'font = \"BCDIEE+Cambria\"'\n\n salaryLabel: '391 < ulx < 393 and font = \"BCDFEE+Calibri-Bold\"'\n\n salary: '394 < ulx < 700 and font = \"BCDEEE+Calibri\"'\n\n childrenLabel: '70 < ulx < 140 and font = \"BCDFEE+Calibri-Bold\" and text =~ /(Attending)|(Children:)/'\n\n childLabel: '230 < ulx < 240 and font = \"BCDFEE+Calibri-Bold\"'\n\n child: '230 < ulx < 380 and font = \"BCDEEE+Calibri\"'\n\n gradeLabel: '391 < ulx < 393 and font = \"BCDFEE+Calibri-Bold\"'\n\n grade: '394 < ulx < 700 and font = \"BCDEEE+Calibri\"'\n\n # You can also match based on the size of the font and on specific text.\n end: 'fontSize = 16.0 and text = \"TOTAL:\"'\n\n # Need a condition that is always true? \"1=1\" does that for you.\n any: \"1 = 1\"\n```\n\n### Advanced functionality\n\n#### Regex matching\n\nYou can use regular expression matching instead of exact string matching in conditions:\n\n```yaml\nconditions:\n caseTypeLabel: 'text =~ /Case Type:?/' # maybe sometimes they forgot the \":\"\n```\n\n#### Font matching\n\nYou can match font and font size:\n\n```yaml\nconditions:\n helvetica8: 'font =~ /.*Helvetica.*/ and fontSize = 8'\n```\n\n#### Page number matching\n\nYou can match the page number\n\n```yaml\nconditions:\n # Match the textbox that starts at 100pt,120pt on page 9.\n specificTextbox: 'page = 9 and ulx = 100 and uly = 120'\n```\n\n#### Requiring intermediate state\n\nThere may be cases where you want to transition from state \"B\" to state \"A\" and start a new record,\nbut ONLY if you were in state \"C\" since last starting a new record:\n\n```yaml\nstates:\n A:\n startRecord: true\n startRecordRequiredState: C\n # ...\n```\n\n#### Combining states\n\nYou may have 2 different states that you want to combine into one column in the output:\n\n```yaml\nrecordTypes:\n record:\n label: \"Record\"\n valueTypes:\n - A\n # no A2\n - B\n\nstates:\n A:\n # ...\n A2:\n valueTypes: [ A ] # combine this with state \"A\".\n # ...\n```\n\n#### Joining text segments in a state\n\nWhen there are multiple text segments in the same state, by default they are concatenated with a space in between.\nAny string, including an empty string, can be used as the separator:\n\n```yaml\nvalueTypes:\n recordId:\n # concatenate without spaces between\n label: \"Record ID\"\n separator: \"\"\n description:\n # put newlines between text segments\n label: \"Description\"\n separator: \"\n\"\n```\n\n#### Exclude types from output\n\nA value type (`dataRecordMember`) can be excluded from the output.\nThis is useful if the type is repeated on the PDF and needed as a data type to set new records,\nbut should not be in the output.\n\n```yaml\nvalueTypes:\n repeatedId:\n include: false\n```\n#### Relative offsets\n\nConditions can evaluate coordinates relative to the coordinates of the previous text.\nThis is useful for matching only something on the next line:\n\n```yaml\nmaxRowDistance: 2\nconditions:\n # These should generally be the same (absolute value) as maxRowDistance\n descriptionSameLine: '-2 <= uly_rel <= 2'\n descriptionOneLineDown: '12 <= uly_rel <= 16' # for 12pt, single-spaced font.\n```\n\n#### Control which page number in output\n\nIf a complex data record spans multiple pages, which page number is used for the output can be controlled.\nEach type (`dataRecordType`) has a page priority (default: 0).\nThe page number for the record comes from the type with the highest priority.\n\n```yaml\nrecordTypes:\n agency:\n label: \"Agency\"\n valueTypes:\n - agencyName\n children:\n - case\n # Agency may span hundreds of pages\n # default page priority of 0\n case:\n label: \"Case\"\n valueTypes:\n - caseNumber\n - name\n children:\n - charge\n # Case record may span multiple pages.\n # Higher priority than agency but lower than charges,\n so case is used if there are no charges.\n pagePriority: 1\n charge:\n label: \"Charge\"\n valueTypes:\n - chargeNumber\n # Highest priority. Use charge's page number.\n pagePriority: 2\n```\n\n#### Exclude \n\nText segments can be excluded before processing by the finite-state machine\nby adding condition name to the `excludeConditions` list.\nIf any of the conditions match, the text segment is excluded.\n\nFor example, to exclude all text segments that consist solely of underscores:\n\n```yaml\nexcludeConditions:\n - underline\n \nconditions:\n underline: 'text =~ /_+/'\n```\n\n#### Starting new records for each value\n\nTODO\n\n#### Regex replacement of values\n\nSometimes the value contains a label, or other text you want to remove.\nIn a `dataRecordMember`, add a `replacement`, which has a `pattern`,\nwhich is a regular expression with capturing groups,\nand `replacement`, which is a replacement string with group references.\nSee `java.util.regex.Pattern` and `java.util.regex.Matcher` for details.\n\n```yaml\n# Replace \"Bond Agency: Fred's Bonds\" with \"Fred's Bonds\"\nvalueTypes:\n bondagency:\n label: \"Bond Agency\"\n replacements:\n -\n pattern: \"Bond Agency:\\ *(.*)\"\n replacement: \"$1\"\n```\n\n#### Variables\n\nOn entering a state, a variable can be set.\n\nIn `State`, add a `setVariable`, which has `name` of the variable and the `value` to set.\n\nIf the `value` starts with `{` and ends with `}`, the content can be any built-in variable or previously\nset `variable` - the same things usable as variables for conditions.\n\nFor example: a condition checks that has the same background color as the last caseNo:\n\n```yaml\nstates:\n caseNo:\n setVariables:\n -\n name: \"lastCaseBgColor\"\n value: \"{bgcolor}\"\n\nconditions:\n sameBgColor: >\n 145 <= ulx\n and fontSize = 8\n and bgcolor = lastCaseBgColor\n```\n\n#### Splitting one PDF field into multiple CSV columns\n\nOne field in the PDF can be broken up into multiple columns in the CSV file, based on\ndifferent regular expressions and replacements:\n\n```yaml\n# Take a field that contains lastName,firstName and split it into 2 fields - lastName and firstName\nrecordTypes:\n inmateName:\n label: \"inmateName\"\n valueTypes:\n - lastName\n - firstName\n\nvalueTypes:\n lastName:\n label: \"Last Name\"\n replacements:\n -\n # lastName column will contain what's before comma\n pattern: \"(.*),.*\"\n replacement: \"$1\"\n firstName:\n label: \"First Name\"\n replacements:\n -\n # firstName column will contain what's after comma\n pattern: \".*,(.*)\"\n replacement: \"$1\"\n\nstates:\n name:\n # when FSM hits state \"name\", split data into lastName and firstName\n valueTypes:\n - lastName\n - firstName\n```\n\n#### Hyperlinks\n\nIf the text is a hyperlink, the URL can be used intead of the text by\nsetting `valueTypes.attribute` to `url`.\n\nThis is supported only by the `itext5` and `itext7` parsers.\n\n```yaml\nrecordTypes:\n company:\n label: \"Company\"\n valueTypes:\n - name\n - website\n\nvalueTypes:\n name:\n label: \"Company Name\"\n website:\n label: \"Website\"\n attribute: url # use the link URL instead of the text.\n\nstates:\n name:\n # Put the value in both \"name\" and \"website\" to get both the\n # text and the url into the output.\n valueTypes:\n - name\n - website\n```\n\n#### Filtering records\n\nRecords can be filtered before output by setting a filter on the `dataRecordType`. Root records\nwith a non-matching filter will not be output. Child records with a non-matching filter will\nbe removed from their parent - the root will still be output.\n\nFilters are expressions parsed by\n[Expr](https://github.com/measuresforjustice/expr)\n\nThe variables are the fields in the record. The default type for variables is `STRING`.\nThe type can be set by setting `type` in the `dataRecordMember` to `string` or `number`.\n\n```yaml\nrecordTypes:\n case:\n label: \"Case\"\n # Only include cases in 2009-2013\n filter: \"2009 <= year <= 2013\"\n valueTypes:\n - year\n - name\n children:\n - charge\n charge:\n label: \"Charge\"\n # omit charges of type \"dummy\"\n filter: >\n not( type = \"dummy\" )\n valueTypes:\n - code\n - type\n\nvalueTypes:\n year:\n type: number\n```\n\nFiltering happens after replacements and before member include checking.\nThis allows splitting a field (e.g.: extracting a year from a date)\nto use in the filter, and not including the split field in the output.\n\n#### Processing multiple files together\n\nMultiple files using the same form config can be parsed and written to a single output\nwith the `forms` CLI subcommand or with `io.mfj.textricator.Textricator.parseForms`.\nThe output will include the source file name for each record.\n\n## Extractors\n\nExtractors extract text (instances of `io.mfj.textricator.text.Text`) from a source.\nThere are four included extractors:\n\n * _pdf.pdfbox_ - Extract text from PDF files using [Apache PDFBox](https://pdfbox.apache.org).\n * _pdf.itext5_ - Extract text from PDF files using [iText 5](https://itextpdf.com/itext-5-core).\n * _pdf.itext7_ - Extract text from PDF files using [iText 7](https://itextpdf.com/itext-7-core).\n * _json_ - Parse text from the JSON format generated by the \"text\" subcommand of the CLI and by `io.mfj.textricator.Textricator.parseText()`.\n * _csv_ - Parse text from the CSV format generatetd by the \"text\" subcommand of the CLI and by `io.mfj.textricator.Textricator.parseText()`\n\nOther extractors modules may be loaded, which may support different source types,\ncapture different information or split the text up differently.\nAn extractor module is loaded by adding a properties file\n`io/mfj/textricator/extractor/textExtractor.properties` to the classpath with a single property -\nthe key is the extractor name and the value is the fully-qualified class name of an implementation of\n`io.mfj.textricator.extractor.TextExtractorFactory`.\nTypically an extractor module will be distributed as a JAR that includes `textExtractor.properties`.\n\nIndicate which extractor to use by setting `extractor` in the yaml configuration,\nor overriding it by passing the extractor name to the `inputFormat`/`--input-format` option.\nIf the extractor is not specified and the input is PDF, `pdf.itext5` is used.\n\n## Versioning\n\n_Textricator_'s version is of the format `major.minor.build`.\n\nThe major number is incremented for breaking changes or major new features.\n\nThe minor number is incremented for minor new features.\n\nThe build number is generated by [Measures for Justice](https://measuresforjustice.org)'s private CI tool.\nIt is incremented for each build, regardless of the major and minor numbers\n(it does not reset to zero when minor or major numbers are increased).\n\n## Acknowledgements\n\nMuch credit is due to some people who do not show up in the commit history:\n\n* Joe Hale, for the original idea and prototype\n* John Castaneda and Abbie Miehle who, as the first end users, provided excellent\nbug reports, improvements, documentation, and examples.\n\n\n"
},
{
"path": "pom.xml",
"content": "\n\n 4.0.0\n\n io.mfj\n textricator\n 10.2-SNAPSHOT\n\n ${project.groupId}:${project.artifactId}\n A tool to extract text from documents and generate structured data\n\n https://textricator.mfj.io/\n\n \n \n Measures for Justice\n opensource@measuresforjustice.org\n Measures for Justice\n https://measuresforjustice.org/\n \n \n\n \n \n GNU Affero General Public License, Version 3\n https://www.gnu.org/licenses/agpl-3.0.txt\n \n \n\n \n 11\n 11\n 11\n 1.9.25\n UTF-8\n 2025\n https://github.com/measuresforjustice/textricator\n \n\n \n \n org.jetbrains.kotlinx\n kotlinx-coroutines-core\n 1.7.3\n \n\n \n org.jetbrains.kotlin\n kotlin-stdlib-jdk8\n ${kotlin.version}\n \n \n \n org.jetbrains.kotlin\n kotlin-test-junit\n ${kotlin.version}\n \n test\n \n \n \n org.jetbrains.kotlin\n kotlin-reflect\n ${kotlin.version}\n \n \n\n \n io.mfj\n expr\n 6.2.39\n \n \n\n \n \n org.apache.pdfbox\n pdfbox\n 2.0.30\n \n \n \n org.apache.pdfbox\n pdfbox-tools\n 2.0.30\n \n \n\n \n \n com.itextpdf\n itextpdf\n 5.5.13.3\n \n \n \n org.bouncycastle\n bcprov-jdk18on\n 1.78\n \n \n\n \n \n com.itextpdf\n kernel\n 8.0.2\n \n \n \n com.itextpdf\n layout\n 8.0.2\n \n \n\n \n com.fasterxml.jackson.core\n jackson-databind\n 2.15.3\n \n \n \n com.fasterxml.jackson.dataformat\n jackson-dataformat-xml\n 2.15.3\n \n \n \n com.fasterxml.jackson.dataformat\n jackson-dataformat-yaml\n 2.15.3\n \n \n \n com.fasterxml.jackson.module\n jackson-module-kotlin\n 2.15.3\n \n \n \n org.jetbrains.kotlin\n kotlin-stdlib\n \n \n org.jetbrains.kotlin\n kotlin-reflect\n \n \n \n\n \n org.slf4j\n slf4j-api\n 2.0.9\n \n \n \n ch.qos.logback\n logback-classic\n 1.4.12\n \n\n \n org.apache.commons\n commons-csv\n 1.10.0\n \n \n\n \n com.offbytwo\n docopt\n 0.6.0.20150202\n \n \n\n \n\n \n\n \n \n \n \n src/main/resources\n true\n \n **/version.properties\n \n \n \n src/main/resources\n false\n \n **/version.properties\n \n \n \n\n \n \n org.jetbrains.kotlin\n kotlin-maven-plugin\n ${kotlin.version}\n \n \n compile\n compile\n \n compile\n \n \n \n ${project.basedir}/src/main/java\n \n \n \n \n test-compile\n test-compile\n \n test-compile\n \n \n \n ${project.basedir}/src/test/java\n \n \n \n \n \n \n org.jetbrains.dokka\n dokka-maven-plugin\n 2.0.0\n \n \n prepare-package\n \n dokka\n javadoc\n javadocJar\n \n \n \n \n \n org.apache.maven.plugins\n maven-source-plugin\n 3.2.1\n \n \n attach-sources\n \n jar\n \n \n \n \n \n org.apache.maven.plugins\n maven-surefire-plugin\n 2.22.1\n \n false\n \n \n \n org.apache.maven.plugins\n maven-assembly-plugin\n 3.3.0\n \n \n package\n \n single\n \n \n \n \n \n src/assembly/tgz.xml\n src/assembly/zip.xml\n \n \n \n\n \n org.apache.maven.plugins\n maven-enforcer-plugin\n 1.4.1\n \n \n enforce-no-snapshots\n \n enforce\n \n \n \n \n Cannot have snapshot dependencies of a release!\n true\n true\n true\n \n \n true\n \n \n \n \n \n \n\n\n"
},
{
"path": "src/assembly/tgz.xml",
"content": "\n\tbin\n\t\n\t\ttgz\n\t\n\t\n\t\t\n\t\t\t/\n\t\t\t${project.basedir}/src/scripts\n\t\t\t\n\t\t\t\ttextricator\n\t\t\t\n\t\t\t0755\n\t\t\n\t\t\n\t\t\t${project.basedir}\n\t\t\t\n\t\t\t\tREADME.*\n\t\t\t\tNOTICE\n\t\t\t\tCOPYING\n\t\t\t\texamples/\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\tlib\n\t\t\n\t\n\n"
},
{
"path": "src/assembly/zip.xml",
"content": "\n\tbin\n\t\n\t\tzip\n\t\n\t\n\t\t\n\t\t\t/\n\t\t\t${project.basedir}/src/scripts\n\t\t\t\n\t\t\t\ttextricator.bat\n\t\t\t\n\t\t\n\t\t\n\t\t\t${project.basedir}\n\t\t\t\n\t\t\t\tREADME.*\n\t\t\t\tNOTICE\n\t\t\t\tCOPYING\n\t\t\t\texamples/\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\tlib\n\t\t\n\t\n\n"
},
{
"path": "src/main/java/io/mfj/textricator/Textricator.kt",
"content": "/*\nThis file is part of Textricator.\nCopyright 2018 Measures for Justice Institute.\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License version 3 as published by the\nFree Software Foundation.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see .\n*/\n\npackage io.mfj.textricator\n\nimport io.mfj.textricator.table.TableParser\nimport io.mfj.textricator.table.config.TableParseConfig\nimport io.mfj.textricator.extractor.TextExtractor\nimport io.mfj.textricator.extractor.TextExtractorFactory\nimport io.mfj.textricator.extractor.TextExtractorOptions\nimport io.mfj.textricator.form.*\nimport io.mfj.textricator.form.config.FormParseConfig\nimport io.mfj.textricator.form.config.FormParseConfigUtil\nimport io.mfj.textricator.record.Record\nimport io.mfj.textricator.record.RecordFilter\nimport io.mfj.textricator.record.RecordModel\nimport io.mfj.textricator.record.output.*\nimport io.mfj.textricator.table.config.TableParseConfigUtil\nimport io.mfj.textricator.text.*\nimport io.mfj.textricator.text.output.CsvTextOutput\nimport io.mfj.textricator.text.output.JsonTextOutput\nimport io.mfj.textricator.text.output.TextOutput\n\nimport java.io.File\nimport java.io.InputStream\nimport java.io.OutputStream\n\nimport org.slf4j.LoggerFactory\n\n/**\n * Textricator. This is the primary starting point.\n */\nobject Textricator {\n\n const val DEFAULT_PDF_PARSER = \"pdf.itext5\"\n\n const val TEXT_OUTPUT_FORMAT_CSV = \"csv\"\n const val TEXT_OUTPUT_FORMAT_JSON = \"json\"\n\n const val RECORD_OUTPUT_FORMAT_CSV = \"csv\"\n const val RECORD_OUTPUT_FORMAT_JSON = \"json\"\n const val RECORD_OUTPUT_FORMAT_JSON_FLAT = \"json-flat\"\n const val RECORD_OUTPUT_FORMAT_NULL = \"null\"\n const val RECORD_OUTPUT_FORMAT_XML = \"xml\"\n\n private val log = LoggerFactory.getLogger( Textricator::class.java )\n\n // extract text\n\n @JvmStatic\n fun extractText(\n input:InputStream, inputFormat:String,\n output:OutputStream, outputFormat:String,\n pageFilter:PageFilter = ALL_PAGES,\n textExtractorOptions:TextExtractorOptions = TextExtractorOptions(),\n maxRowDistance:Float = 0f ) {\n\n when ( outputFormat ) {\n TEXT_OUTPUT_FORMAT_CSV -> CsvTextOutput(output)\n TEXT_OUTPUT_FORMAT_JSON -> JsonTextOutput(output)\n else -> throw Exception( \"Invalid output format: ${outputFormat}\" )\n }.use { textOutput ->\n getExtractor( input, inputFormat, textExtractorOptions ).use { extractor ->\n extractText( extractor, textOutput, maxRowDistance, pageFilter )\n }\n }\n }\n\n @JvmStatic\n fun extractText(\n extractor:TextExtractor,\n output:TextOutput,\n maxRowDistance:Float = 0f,\n pageFilter:PageFilter = ALL_PAGES ) {\n\n output.write( extractText( extractor, maxRowDistance, pageFilter ) )\n\n }\n\n @JvmStatic\n fun extractText(\n extractor:TextExtractor,\n maxRowDistance:Float = 0f,\n pageFilter:PageFilter = ALL_PAGES ): Sequence {\n\n return extract( extractor, pageFilter ).groupRows( maxRowDistance )\n\n }\n\n // parse form to records\n\n @JvmStatic\n fun parseForm(\n inputFile:File,\n outputFile:File,\n configFile:File ) {\n\n val config = FormParseConfigUtil.parseYaml(configFile)\n val inputFormat = inputFile.extension.lowercase()\n val outputFormat = outputFile.extension.lowercase()\n\n inputFile.inputStream().use { input ->\n outputFile.outputStream().use { output ->\n\n parseForm(\n input, inputFormat,\n output, outputFormat,\n config )\n\n }\n\n }\n }\n\n @JvmStatic\n fun parseForm(\n inputFile:File,\n outputFile:File,\n config:FormParseConfig ) {\n\n val inputFormat = inputFile.extension.lowercase()\n val outputFormat = outputFile.extension.lowercase()\n\n inputFile.inputStream().use { input ->\n outputFile.outputStream().use { output ->\n\n parseForm(\n input, inputFormat,\n output, outputFormat,\n config )\n\n }\n\n }\n }\n\n @JvmStatic\n fun parseForm(\n input:InputStream, inputFormat:String,\n output:OutputStream, outputFormat:String,\n config:FormParseConfig,\n eventListener:FormParseEventListener = LoggingEventListener\n ) {\n\n getExtractor( input, inputFormat, config ).use { extractor ->\n getRecordOutput( outputFormat, output, config, includeSource=false ).use { recordOutput ->\n parseForm( source=null, extractor, recordOutput, config, eventListener )\n }\n }\n }\n\n @JvmStatic\n fun parseForms(\n inputs:SequenceInputStream,String>>,\n output:OutputStream, outputFormat:String,\n config:FormParseConfig,\n eventListener:FormParseEventListener = LoggingEventListener\n ) {\n getRecordOutput( outputFormat, output, config, includeSource=true ).use { recordOutput ->\n val records = sequence {\n inputs.forEach { (filename,input,inputFormat) ->\n input().use { inputStream ->\n getExtractor( inputStream, inputFormat, config ).use { extractor ->\n val records = parseForm(filename,extractor,config,eventListener)\n yieldAll(records)\n }\n }\n }\n }\n recordOutput.write(records)\n }\n }\n\n @JvmStatic\n fun parseForm(\n source:String?=null,\n extractor:TextExtractor,\n recordOutput:RecordOutput,\n config:FormParseConfig,\n eventListener:FormParseEventListener = LoggingEventListener\n ) {\n val records = parseForm(\n source,\n extractor,\n config,\n eventListener )\n\n recordOutput.write( records )\n }\n\n @JvmStatic\n fun parseForm(\n source:String?,\n extractor:TextExtractor,\n config:FormParseConfig,\n eventListener:FormParseEventListener = LoggingEventListener\n ): Sequence {\n\n // TextExtractor parses PDF to sequence of Text\n val textSeq = extract( extractor, config.pages.toPageFilter() ).groupRows( config.maxRowDistance )\n\n // FSMParser parse sequence of Text to sequence of StateValue\n val stateTextsSeq = FsmParser( source, config, eventListener ).parse( textSeq )\n\n // RecordParser parses sequence of StateValue to sequence of Record\n val recSeq = RecordParser( config, eventListener ).parse( stateTextsSeq )\n\n // RecordFilter filters out non-matching records.\n val filteredRecSeq = RecordFilter( config ).filter( recSeq )\n\n return filteredRecSeq\n }\n\n @JvmStatic\n private fun getRecordOutput( outputFormat:String, output:OutputStream, config:RecordModel, includeSource:Boolean):RecordOutput {\n return when ( outputFormat ) {\n RECORD_OUTPUT_FORMAT_CSV -> CsvRecordOutput(config,output,includeSource)\n RECORD_OUTPUT_FORMAT_JSON -> JsonRecordOutput(config,output)\n RECORD_OUTPUT_FORMAT_JSON_FLAT -> JsonFlatRecordOutput(config,output,includeSource)\n RECORD_OUTPUT_FORMAT_XML -> XmlRecordOutput(config,output)\n RECORD_OUTPUT_FORMAT_NULL -> NullOutput\n else -> throw IllegalArgumentException( \"Unsupported output format \\\"${outputFormat}\\\".\" )\n }\n }\n\n // parse table to records\n\n @JvmStatic\n fun parseTable(\n inputFile:File,\n outputFile:File,\n configFile:File ) {\n\n val config = TableParseConfigUtil.parseYaml(configFile)\n val inputFormat = inputFile.extension.lowercase()\n val outputFormat = outputFile.extension.lowercase()\n\n inputFile.inputStream().use { input ->\n outputFile.outputStream().use { output ->\n parseTable(\n input, inputFormat,\n output, outputFormat,\n config )\n }\n }\n }\n\n @JvmStatic\n fun parseTable(\n input:InputStream, inputFormat:String,\n output:OutputStream, outputFormat:String,\n config:TableParseConfig) {\n\n getExtractor( input, inputFormat, config ).use { extractor ->\n getRecordOutput(outputFormat,output,config,includeSource=false).use { output ->\n parseTable( extractor, output, config )\n }\n }\n }\n\n @JvmStatic\n fun parseTable(\n extractor:TextExtractor,\n output:RecordOutput,\n config:TableParseConfig) {\n\n val records = parseTable( extractor, config )\n\n output.write( records )\n }\n\n @JvmStatic\n fun parseTable(\n extractor:TextExtractor,\n config:TableParseConfig): Sequence {\n\n // TextExtractor parses PDF to sequence of Text\n val pages = extractPages( extractor, config.pages.toPageFilter() ).groupRowsPaged( config.maxRowDistance )\n\n val recSeq = TableParser(config).parse( pages )\n\n // RecordFilter filters out non-matching records.\n val filteredRecSeq = RecordFilter(config).filter( recSeq )\n\n return filteredRecSeq\n }\n\n @JvmStatic\n fun getExtractor( input:InputStream, inputFormat:String, options:TextExtractorOptions ): TextExtractor {\n\n val extractorName:String =\n if ( options.extractor == null ) {\n inputFormat\n } else {\n val i = inputFormat.indexOf(\".\")\n val fileType = if ( i > 0 ) inputFormat.substring(0,i) else inputFormat\n if ( options.extractor!!.startsWith( \"${fileType}.\" ) ) {\n options.extractor!!\n } else {\n // Using a different input format than [options.extractor] is set for.\n inputFormat\n }\n }\n .let { extractorName -> if ( extractorName == \"pdf\" ) DEFAULT_PDF_PARSER else extractorName }\n\n log.debug( \"Using extractor \\\"${extractorName}\\\" for input format \\\"${inputFormat}\\\".\" )\n\n return TextExtractorFactory\n .getFactory( extractorName )\n .create( input, options )\n }\n\n @JvmStatic\n fun extract( extractor:TextExtractor, pageFilter:PageFilter = ALL_PAGES ): Sequence =\n (1..extractor.getPageCount())\n .asSequence()\n .filter { pageNumber ->\n pageFilter( pageNumber )\n }\n .flatMap { pageNumber ->\n extractor.extract( pageNumber ).asSequence()\n }\n\n @JvmStatic\n fun extractPages( extractor:TextExtractor, pageFilter:PageFilter = ALL_PAGES ): Sequence =\n (1..extractor.getPageCount())\n .asSequence()\n .filter { pageNumber ->\n pageFilter( pageNumber )\n }\n .map { pageNumber ->\n Page( pageNumber, extractor.extract( pageNumber ) )\n }\n\n}\n"
},
{
"path": "src/main/java/io/mfj/textricator/Version.kt",
"content": "/*\nThis file is part of Textricator.\nCopyright 2018 Measures for Justice Institute.\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License version 3 as published by the\nFree Software Foundation.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see .\n*/\n\npackage io.mfj.textricator\n\nimport java.util.*\n\nobject Version {\n\n val version:String\n val copyrightYear:String\n val sourceLocation:String\n\n init {\n val props = Properties().apply {\n Version::class.java.getResourceAsStream( \"version.properties\" ).use { input ->\n load( input )\n }\n }\n version = props.getProperty(\"version\")\n copyrightYear = props.getProperty(\"copyright.year\")\n sourceLocation = props.getProperty(\"source.location\")\n }\n\n}\n"
},
{
"path": "src/main/java/io/mfj/textricator/cli/TextricatorCli.kt",
"content": "/*\nThis file is part of Textricator.\nCopyright 2018 Measures for Justice Institute.\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License version 3 as published by the\nFree Software Foundation.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see .\n*/\n\npackage io.mfj.textricator.cli\n\nimport io.mfj.textricator.*\nimport io.mfj.textricator.extractor.TextExtractorFactory\nimport io.mfj.textricator.extractor.TextExtractorOptions\nimport io.mfj.textricator.form.config.FormParseConfigUtil\nimport io.mfj.textricator.table.config.TableParseConfigUtil\nimport io.mfj.textricator.text.toPageFilter\n\nimport java.io.File\nimport java.io.InputStream\n\nimport ch.qos.logback.classic.Logger\nimport ch.qos.logback.classic.Level\n\nimport org.docopt.Docopt\n\nimport org.slf4j.LoggerFactory\nimport kotlin.system.exitProcess\n\n/**\n * Command-line interface to [Textricator].\n *\n * Can just extract text or also run the form or table parser.\n */\nobject TextricatorCli {\n\n private val help = \"\"\"\n Textricator\n\n Textricator extracts content from PDFs.\n\n \"text\" extracts the text from a PDF and outputs to CSV or JSON.\n \"form\" parse a form (using a finite state machine) and generate records.\n \"table\" parses a table and generates records.\n\n Output is to standard out if not specified.\n\n Usage:\n textricator text [--debug] [--pages=] [--max-row-distance=] [--box-precision=] [--box-ignore-colors=] [--input-format=] [--output-format=] [