1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Fri Apr 12 00:24:51 2019 +0200
1.3 @@ -0,0 +1,65 @@
1.4 +Introduction
1.5 +============
1.6 +
1.7 +MoinLight is a distribution of libraries and tools for interpreting document
1.8 +content in the MoinMoin wiki format together with other formats employed in
1.9 +wiki content.
1.10 +
1.11 +Getting Started
1.12 +===============
1.13 +
1.14 +The moinconvert tool provides a convenient way of converting content from Moin
1.15 +format to other formats. For example, the supplied documentation can be
1.16 +converted as follows:
1.17 +
1.18 +./moinconvert --all --input-dir docs/wiki --format html \
1.19 + --output-dir docs/html --macros --document-index index.html
1.20 +
1.21 +This converts all documents in the indicated input directory to HTML format,
1.22 +storing the converted documents in the indicated output directory, evaluating
1.23 +all macros embedded in the input documents. A document index filename is
1.24 +specified for filesystem browsing of the output documents.
1.25 +
1.26 +The result of the above command is a collection of documents in docs/html that
1.27 +can be viewed using a Web browser, with the docs/html/index.html file being
1.28 +the front page of this collection. These documents do not need to be served
1.29 +using a Web browser.
1.30 +
1.31 +By omitting the --document-index option (and accompanying filename), a version
1.32 +of the documents can be produced that is more appropriate for serving by a Web
1.33 +browser, featuring links that do not include the index.html filename.
1.34 +
1.35 +See the bundled documentation for more details of the software and how it can
1.36 +be used:
1.37 +
1.38 + * docs/wiki/FrontPage (and accompanying files) are the documentation files in
1.39 + Moin format
1.40 +
1.41 + * docs/html/index.html is the front page of the documentation converted to HTML
1.42 + format
1.43 +
1.44 +Test Suite
1.45 +==========
1.46 +
1.47 +A test suite is provided to exercise the toolchain and expose regressions.
1.48 +More information is available by running the test_parser.py script (found in
1.49 +the tests directory) with the appropriate option:
1.50 +
1.51 +tests/test_parser.py --help
1.52 +
1.53 +Running it with the --quiet option provides a quick way of verifying the
1.54 +tested behaviour of the software.
1.55 +
1.56 +Contact, Copyright and Licence Information
1.57 +==========================================
1.58 +
1.59 +See the following Web pages for more information about this work:
1.60 +
1.61 +http://projects.boddie.org.uk/MoinLight
1.62 +
1.63 +The author can be contacted at the following e-mail address:
1.64 +
1.65 +paul@boddie.org.uk
1.66 +
1.67 +Copyright and licence information can be found in the docs directory - see
1.68 +docs/COPYING.txt and docs/gpl-3.0.txt for more information.
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
2.2 +++ b/docs/COPYING.txt Fri Apr 12 00:24:51 2019 +0200
2.3 @@ -0,0 +1,17 @@
2.4 +Licence Agreement
2.5 +-----------------
2.6 +
2.7 +Copyright (C) 2017, 2018, 2019 Paul Boddie <paul@boddie.org.uk>
2.8 +
2.9 +This program is free software; you can redistribute it and/or modify it under
2.10 +the terms of the GNU General Public License as published by the Free Software
2.11 +Foundation; either version 3 of the License, or (at your option) any later
2.12 +version.
2.13 +
2.14 +This program is distributed in the hope that it will be useful, but WITHOUT
2.15 +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
2.16 +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
2.17 +details.
2.18 +
2.19 +You should have received a copy of the GNU General Public License along with
2.20 +this program. If not, see <http://www.gnu.org/licenses/>.
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
3.2 +++ b/docs/gpl-3.0.txt Fri Apr 12 00:24:51 2019 +0200
3.3 @@ -0,0 +1,674 @@
3.4 + GNU GENERAL PUBLIC LICENSE
3.5 + Version 3, 29 June 2007
3.6 +
3.7 + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
3.8 + Everyone is permitted to copy and distribute verbatim copies
3.9 + of this license document, but changing it is not allowed.
3.10 +
3.11 + Preamble
3.12 +
3.13 + The GNU General Public License is a free, copyleft license for
3.14 +software and other kinds of works.
3.15 +
3.16 + The licenses for most software and other practical works are designed
3.17 +to take away your freedom to share and change the works. By contrast,
3.18 +the GNU General Public License is intended to guarantee your freedom to
3.19 +share and change all versions of a program--to make sure it remains free
3.20 +software for all its users. We, the Free Software Foundation, use the
3.21 +GNU General Public License for most of our software; it applies also to
3.22 +any other work released this way by its authors. You can apply it to
3.23 +your programs, too.
3.24 +
3.25 + When we speak of free software, we are referring to freedom, not
3.26 +price. Our General Public Licenses are designed to make sure that you
3.27 +have the freedom to distribute copies of free software (and charge for
3.28 +them if you wish), that you receive source code or can get it if you
3.29 +want it, that you can change the software or use pieces of it in new
3.30 +free programs, and that you know you can do these things.
3.31 +
3.32 + To protect your rights, we need to prevent others from denying you
3.33 +these rights or asking you to surrender the rights. Therefore, you have
3.34 +certain responsibilities if you distribute copies of the software, or if
3.35 +you modify it: responsibilities to respect the freedom of others.
3.36 +
3.37 + For example, if you distribute copies of such a program, whether
3.38 +gratis or for a fee, you must pass on to the recipients the same
3.39 +freedoms that you received. You must make sure that they, too, receive
3.40 +or can get the source code. And you must show them these terms so they
3.41 +know their rights.
3.42 +
3.43 + Developers that use the GNU GPL protect your rights with two steps:
3.44 +(1) assert copyright on the software, and (2) offer you this License
3.45 +giving you legal permission to copy, distribute and/or modify it.
3.46 +
3.47 + For the developers' and authors' protection, the GPL clearly explains
3.48 +that there is no warranty for this free software. For both users' and
3.49 +authors' sake, the GPL requires that modified versions be marked as
3.50 +changed, so that their problems will not be attributed erroneously to
3.51 +authors of previous versions.
3.52 +
3.53 + Some devices are designed to deny users access to install or run
3.54 +modified versions of the software inside them, although the manufacturer
3.55 +can do so. This is fundamentally incompatible with the aim of
3.56 +protecting users' freedom to change the software. The systematic
3.57 +pattern of such abuse occurs in the area of products for individuals to
3.58 +use, which is precisely where it is most unacceptable. Therefore, we
3.59 +have designed this version of the GPL to prohibit the practice for those
3.60 +products. If such problems arise substantially in other domains, we
3.61 +stand ready to extend this provision to those domains in future versions
3.62 +of the GPL, as needed to protect the freedom of users.
3.63 +
3.64 + Finally, every program is threatened constantly by software patents.
3.65 +States should not allow patents to restrict development and use of
3.66 +software on general-purpose computers, but in those that do, we wish to
3.67 +avoid the special danger that patents applied to a free program could
3.68 +make it effectively proprietary. To prevent this, the GPL assures that
3.69 +patents cannot be used to render the program non-free.
3.70 +
3.71 + The precise terms and conditions for copying, distribution and
3.72 +modification follow.
3.73 +
3.74 + TERMS AND CONDITIONS
3.75 +
3.76 + 0. Definitions.
3.77 +
3.78 + "This License" refers to version 3 of the GNU General Public License.
3.79 +
3.80 + "Copyright" also means copyright-like laws that apply to other kinds of
3.81 +works, such as semiconductor masks.
3.82 +
3.83 + "The Program" refers to any copyrightable work licensed under this
3.84 +License. Each licensee is addressed as "you". "Licensees" and
3.85 +"recipients" may be individuals or organizations.
3.86 +
3.87 + To "modify" a work means to copy from or adapt all or part of the work
3.88 +in a fashion requiring copyright permission, other than the making of an
3.89 +exact copy. The resulting work is called a "modified version" of the
3.90 +earlier work or a work "based on" the earlier work.
3.91 +
3.92 + A "covered work" means either the unmodified Program or a work based
3.93 +on the Program.
3.94 +
3.95 + To "propagate" a work means to do anything with it that, without
3.96 +permission, would make you directly or secondarily liable for
3.97 +infringement under applicable copyright law, except executing it on a
3.98 +computer or modifying a private copy. Propagation includes copying,
3.99 +distribution (with or without modification), making available to the
3.100 +public, and in some countries other activities as well.
3.101 +
3.102 + To "convey" a work means any kind of propagation that enables other
3.103 +parties to make or receive copies. Mere interaction with a user through
3.104 +a computer network, with no transfer of a copy, is not conveying.
3.105 +
3.106 + An interactive user interface displays "Appropriate Legal Notices"
3.107 +to the extent that it includes a convenient and prominently visible
3.108 +feature that (1) displays an appropriate copyright notice, and (2)
3.109 +tells the user that there is no warranty for the work (except to the
3.110 +extent that warranties are provided), that licensees may convey the
3.111 +work under this License, and how to view a copy of this License. If
3.112 +the interface presents a list of user commands or options, such as a
3.113 +menu, a prominent item in the list meets this criterion.
3.114 +
3.115 + 1. Source Code.
3.116 +
3.117 + The "source code" for a work means the preferred form of the work
3.118 +for making modifications to it. "Object code" means any non-source
3.119 +form of a work.
3.120 +
3.121 + A "Standard Interface" means an interface that either is an official
3.122 +standard defined by a recognized standards body, or, in the case of
3.123 +interfaces specified for a particular programming language, one that
3.124 +is widely used among developers working in that language.
3.125 +
3.126 + The "System Libraries" of an executable work include anything, other
3.127 +than the work as a whole, that (a) is included in the normal form of
3.128 +packaging a Major Component, but which is not part of that Major
3.129 +Component, and (b) serves only to enable use of the work with that
3.130 +Major Component, or to implement a Standard Interface for which an
3.131 +implementation is available to the public in source code form. A
3.132 +"Major Component", in this context, means a major essential component
3.133 +(kernel, window system, and so on) of the specific operating system
3.134 +(if any) on which the executable work runs, or a compiler used to
3.135 +produce the work, or an object code interpreter used to run it.
3.136 +
3.137 + The "Corresponding Source" for a work in object code form means all
3.138 +the source code needed to generate, install, and (for an executable
3.139 +work) run the object code and to modify the work, including scripts to
3.140 +control those activities. However, it does not include the work's
3.141 +System Libraries, or general-purpose tools or generally available free
3.142 +programs which are used unmodified in performing those activities but
3.143 +which are not part of the work. For example, Corresponding Source
3.144 +includes interface definition files associated with source files for
3.145 +the work, and the source code for shared libraries and dynamically
3.146 +linked subprograms that the work is specifically designed to require,
3.147 +such as by intimate data communication or control flow between those
3.148 +subprograms and other parts of the work.
3.149 +
3.150 + The Corresponding Source need not include anything that users
3.151 +can regenerate automatically from other parts of the Corresponding
3.152 +Source.
3.153 +
3.154 + The Corresponding Source for a work in source code form is that
3.155 +same work.
3.156 +
3.157 + 2. Basic Permissions.
3.158 +
3.159 + All rights granted under this License are granted for the term of
3.160 +copyright on the Program, and are irrevocable provided the stated
3.161 +conditions are met. This License explicitly affirms your unlimited
3.162 +permission to run the unmodified Program. The output from running a
3.163 +covered work is covered by this License only if the output, given its
3.164 +content, constitutes a covered work. This License acknowledges your
3.165 +rights of fair use or other equivalent, as provided by copyright law.
3.166 +
3.167 + You may make, run and propagate covered works that you do not
3.168 +convey, without conditions so long as your license otherwise remains
3.169 +in force. You may convey covered works to others for the sole purpose
3.170 +of having them make modifications exclusively for you, or provide you
3.171 +with facilities for running those works, provided that you comply with
3.172 +the terms of this License in conveying all material for which you do
3.173 +not control copyright. Those thus making or running the covered works
3.174 +for you must do so exclusively on your behalf, under your direction
3.175 +and control, on terms that prohibit them from making any copies of
3.176 +your copyrighted material outside their relationship with you.
3.177 +
3.178 + Conveying under any other circumstances is permitted solely under
3.179 +the conditions stated below. Sublicensing is not allowed; section 10
3.180 +makes it unnecessary.
3.181 +
3.182 + 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
3.183 +
3.184 + No covered work shall be deemed part of an effective technological
3.185 +measure under any applicable law fulfilling obligations under article
3.186 +11 of the WIPO copyright treaty adopted on 20 December 1996, or
3.187 +similar laws prohibiting or restricting circumvention of such
3.188 +measures.
3.189 +
3.190 + When you convey a covered work, you waive any legal power to forbid
3.191 +circumvention of technological measures to the extent such circumvention
3.192 +is effected by exercising rights under this License with respect to
3.193 +the covered work, and you disclaim any intention to limit operation or
3.194 +modification of the work as a means of enforcing, against the work's
3.195 +users, your or third parties' legal rights to forbid circumvention of
3.196 +technological measures.
3.197 +
3.198 + 4. Conveying Verbatim Copies.
3.199 +
3.200 + You may convey verbatim copies of the Program's source code as you
3.201 +receive it, in any medium, provided that you conspicuously and
3.202 +appropriately publish on each copy an appropriate copyright notice;
3.203 +keep intact all notices stating that this License and any
3.204 +non-permissive terms added in accord with section 7 apply to the code;
3.205 +keep intact all notices of the absence of any warranty; and give all
3.206 +recipients a copy of this License along with the Program.
3.207 +
3.208 + You may charge any price or no price for each copy that you convey,
3.209 +and you may offer support or warranty protection for a fee.
3.210 +
3.211 + 5. Conveying Modified Source Versions.
3.212 +
3.213 + You may convey a work based on the Program, or the modifications to
3.214 +produce it from the Program, in the form of source code under the
3.215 +terms of section 4, provided that you also meet all of these conditions:
3.216 +
3.217 + a) The work must carry prominent notices stating that you modified
3.218 + it, and giving a relevant date.
3.219 +
3.220 + b) The work must carry prominent notices stating that it is
3.221 + released under this License and any conditions added under section
3.222 + 7. This requirement modifies the requirement in section 4 to
3.223 + "keep intact all notices".
3.224 +
3.225 + c) You must license the entire work, as a whole, under this
3.226 + License to anyone who comes into possession of a copy. This
3.227 + License will therefore apply, along with any applicable section 7
3.228 + additional terms, to the whole of the work, and all its parts,
3.229 + regardless of how they are packaged. This License gives no
3.230 + permission to license the work in any other way, but it does not
3.231 + invalidate such permission if you have separately received it.
3.232 +
3.233 + d) If the work has interactive user interfaces, each must display
3.234 + Appropriate Legal Notices; however, if the Program has interactive
3.235 + interfaces that do not display Appropriate Legal Notices, your
3.236 + work need not make them do so.
3.237 +
3.238 + A compilation of a covered work with other separate and independent
3.239 +works, which are not by their nature extensions of the covered work,
3.240 +and which are not combined with it such as to form a larger program,
3.241 +in or on a volume of a storage or distribution medium, is called an
3.242 +"aggregate" if the compilation and its resulting copyright are not
3.243 +used to limit the access or legal rights of the compilation's users
3.244 +beyond what the individual works permit. Inclusion of a covered work
3.245 +in an aggregate does not cause this License to apply to the other
3.246 +parts of the aggregate.
3.247 +
3.248 + 6. Conveying Non-Source Forms.
3.249 +
3.250 + You may convey a covered work in object code form under the terms
3.251 +of sections 4 and 5, provided that you also convey the
3.252 +machine-readable Corresponding Source under the terms of this License,
3.253 +in one of these ways:
3.254 +
3.255 + a) Convey the object code in, or embodied in, a physical product
3.256 + (including a physical distribution medium), accompanied by the
3.257 + Corresponding Source fixed on a durable physical medium
3.258 + customarily used for software interchange.
3.259 +
3.260 + b) Convey the object code in, or embodied in, a physical product
3.261 + (including a physical distribution medium), accompanied by a
3.262 + written offer, valid for at least three years and valid for as
3.263 + long as you offer spare parts or customer support for that product
3.264 + model, to give anyone who possesses the object code either (1) a
3.265 + copy of the Corresponding Source for all the software in the
3.266 + product that is covered by this License, on a durable physical
3.267 + medium customarily used for software interchange, for a price no
3.268 + more than your reasonable cost of physically performing this
3.269 + conveying of source, or (2) access to copy the
3.270 + Corresponding Source from a network server at no charge.
3.271 +
3.272 + c) Convey individual copies of the object code with a copy of the
3.273 + written offer to provide the Corresponding Source. This
3.274 + alternative is allowed only occasionally and noncommercially, and
3.275 + only if you received the object code with such an offer, in accord
3.276 + with subsection 6b.
3.277 +
3.278 + d) Convey the object code by offering access from a designated
3.279 + place (gratis or for a charge), and offer equivalent access to the
3.280 + Corresponding Source in the same way through the same place at no
3.281 + further charge. You need not require recipients to copy the
3.282 + Corresponding Source along with the object code. If the place to
3.283 + copy the object code is a network server, the Corresponding Source
3.284 + may be on a different server (operated by you or a third party)
3.285 + that supports equivalent copying facilities, provided you maintain
3.286 + clear directions next to the object code saying where to find the
3.287 + Corresponding Source. Regardless of what server hosts the
3.288 + Corresponding Source, you remain obligated to ensure that it is
3.289 + available for as long as needed to satisfy these requirements.
3.290 +
3.291 + e) Convey the object code using peer-to-peer transmission, provided
3.292 + you inform other peers where the object code and Corresponding
3.293 + Source of the work are being offered to the general public at no
3.294 + charge under subsection 6d.
3.295 +
3.296 + A separable portion of the object code, whose source code is excluded
3.297 +from the Corresponding Source as a System Library, need not be
3.298 +included in conveying the object code work.
3.299 +
3.300 + A "User Product" is either (1) a "consumer product", which means any
3.301 +tangible personal property which is normally used for personal, family,
3.302 +or household purposes, or (2) anything designed or sold for incorporation
3.303 +into a dwelling. In determining whether a product is a consumer product,
3.304 +doubtful cases shall be resolved in favor of coverage. For a particular
3.305 +product received by a particular user, "normally used" refers to a
3.306 +typical or common use of that class of product, regardless of the status
3.307 +of the particular user or of the way in which the particular user
3.308 +actually uses, or expects or is expected to use, the product. A product
3.309 +is a consumer product regardless of whether the product has substantial
3.310 +commercial, industrial or non-consumer uses, unless such uses represent
3.311 +the only significant mode of use of the product.
3.312 +
3.313 + "Installation Information" for a User Product means any methods,
3.314 +procedures, authorization keys, or other information required to install
3.315 +and execute modified versions of a covered work in that User Product from
3.316 +a modified version of its Corresponding Source. The information must
3.317 +suffice to ensure that the continued functioning of the modified object
3.318 +code is in no case prevented or interfered with solely because
3.319 +modification has been made.
3.320 +
3.321 + If you convey an object code work under this section in, or with, or
3.322 +specifically for use in, a User Product, and the conveying occurs as
3.323 +part of a transaction in which the right of possession and use of the
3.324 +User Product is transferred to the recipient in perpetuity or for a
3.325 +fixed term (regardless of how the transaction is characterized), the
3.326 +Corresponding Source conveyed under this section must be accompanied
3.327 +by the Installation Information. But this requirement does not apply
3.328 +if neither you nor any third party retains the ability to install
3.329 +modified object code on the User Product (for example, the work has
3.330 +been installed in ROM).
3.331 +
3.332 + The requirement to provide Installation Information does not include a
3.333 +requirement to continue to provide support service, warranty, or updates
3.334 +for a work that has been modified or installed by the recipient, or for
3.335 +the User Product in which it has been modified or installed. Access to a
3.336 +network may be denied when the modification itself materially and
3.337 +adversely affects the operation of the network or violates the rules and
3.338 +protocols for communication across the network.
3.339 +
3.340 + Corresponding Source conveyed, and Installation Information provided,
3.341 +in accord with this section must be in a format that is publicly
3.342 +documented (and with an implementation available to the public in
3.343 +source code form), and must require no special password or key for
3.344 +unpacking, reading or copying.
3.345 +
3.346 + 7. Additional Terms.
3.347 +
3.348 + "Additional permissions" are terms that supplement the terms of this
3.349 +License by making exceptions from one or more of its conditions.
3.350 +Additional permissions that are applicable to the entire Program shall
3.351 +be treated as though they were included in this License, to the extent
3.352 +that they are valid under applicable law. If additional permissions
3.353 +apply only to part of the Program, that part may be used separately
3.354 +under those permissions, but the entire Program remains governed by
3.355 +this License without regard to the additional permissions.
3.356 +
3.357 + When you convey a copy of a covered work, you may at your option
3.358 +remove any additional permissions from that copy, or from any part of
3.359 +it. (Additional permissions may be written to require their own
3.360 +removal in certain cases when you modify the work.) You may place
3.361 +additional permissions on material, added by you to a covered work,
3.362 +for which you have or can give appropriate copyright permission.
3.363 +
3.364 + Notwithstanding any other provision of this License, for material you
3.365 +add to a covered work, you may (if authorized by the copyright holders of
3.366 +that material) supplement the terms of this License with terms:
3.367 +
3.368 + a) Disclaiming warranty or limiting liability differently from the
3.369 + terms of sections 15 and 16 of this License; or
3.370 +
3.371 + b) Requiring preservation of specified reasonable legal notices or
3.372 + author attributions in that material or in the Appropriate Legal
3.373 + Notices displayed by works containing it; or
3.374 +
3.375 + c) Prohibiting misrepresentation of the origin of that material, or
3.376 + requiring that modified versions of such material be marked in
3.377 + reasonable ways as different from the original version; or
3.378 +
3.379 + d) Limiting the use for publicity purposes of names of licensors or
3.380 + authors of the material; or
3.381 +
3.382 + e) Declining to grant rights under trademark law for use of some
3.383 + trade names, trademarks, or service marks; or
3.384 +
3.385 + f) Requiring indemnification of licensors and authors of that
3.386 + material by anyone who conveys the material (or modified versions of
3.387 + it) with contractual assumptions of liability to the recipient, for
3.388 + any liability that these contractual assumptions directly impose on
3.389 + those licensors and authors.
3.390 +
3.391 + All other non-permissive additional terms are considered "further
3.392 +restrictions" within the meaning of section 10. If the Program as you
3.393 +received it, or any part of it, contains a notice stating that it is
3.394 +governed by this License along with a term that is a further
3.395 +restriction, you may remove that term. If a license document contains
3.396 +a further restriction but permits relicensing or conveying under this
3.397 +License, you may add to a covered work material governed by the terms
3.398 +of that license document, provided that the further restriction does
3.399 +not survive such relicensing or conveying.
3.400 +
3.401 + If you add terms to a covered work in accord with this section, you
3.402 +must place, in the relevant source files, a statement of the
3.403 +additional terms that apply to those files, or a notice indicating
3.404 +where to find the applicable terms.
3.405 +
3.406 + Additional terms, permissive or non-permissive, may be stated in the
3.407 +form of a separately written license, or stated as exceptions;
3.408 +the above requirements apply either way.
3.409 +
3.410 + 8. Termination.
3.411 +
3.412 + You may not propagate or modify a covered work except as expressly
3.413 +provided under this License. Any attempt otherwise to propagate or
3.414 +modify it is void, and will automatically terminate your rights under
3.415 +this License (including any patent licenses granted under the third
3.416 +paragraph of section 11).
3.417 +
3.418 + However, if you cease all violation of this License, then your
3.419 +license from a particular copyright holder is reinstated (a)
3.420 +provisionally, unless and until the copyright holder explicitly and
3.421 +finally terminates your license, and (b) permanently, if the copyright
3.422 +holder fails to notify you of the violation by some reasonable means
3.423 +prior to 60 days after the cessation.
3.424 +
3.425 + Moreover, your license from a particular copyright holder is
3.426 +reinstated permanently if the copyright holder notifies you of the
3.427 +violation by some reasonable means, this is the first time you have
3.428 +received notice of violation of this License (for any work) from that
3.429 +copyright holder, and you cure the violation prior to 30 days after
3.430 +your receipt of the notice.
3.431 +
3.432 + Termination of your rights under this section does not terminate the
3.433 +licenses of parties who have received copies or rights from you under
3.434 +this License. If your rights have been terminated and not permanently
3.435 +reinstated, you do not qualify to receive new licenses for the same
3.436 +material under section 10.
3.437 +
3.438 + 9. Acceptance Not Required for Having Copies.
3.439 +
3.440 + You are not required to accept this License in order to receive or
3.441 +run a copy of the Program. Ancillary propagation of a covered work
3.442 +occurring solely as a consequence of using peer-to-peer transmission
3.443 +to receive a copy likewise does not require acceptance. However,
3.444 +nothing other than this License grants you permission to propagate or
3.445 +modify any covered work. These actions infringe copyright if you do
3.446 +not accept this License. Therefore, by modifying or propagating a
3.447 +covered work, you indicate your acceptance of this License to do so.
3.448 +
3.449 + 10. Automatic Licensing of Downstream Recipients.
3.450 +
3.451 + Each time you convey a covered work, the recipient automatically
3.452 +receives a license from the original licensors, to run, modify and
3.453 +propagate that work, subject to this License. You are not responsible
3.454 +for enforcing compliance by third parties with this License.
3.455 +
3.456 + An "entity transaction" is a transaction transferring control of an
3.457 +organization, or substantially all assets of one, or subdividing an
3.458 +organization, or merging organizations. If propagation of a covered
3.459 +work results from an entity transaction, each party to that
3.460 +transaction who receives a copy of the work also receives whatever
3.461 +licenses to the work the party's predecessor in interest had or could
3.462 +give under the previous paragraph, plus a right to possession of the
3.463 +Corresponding Source of the work from the predecessor in interest, if
3.464 +the predecessor has it or can get it with reasonable efforts.
3.465 +
3.466 + You may not impose any further restrictions on the exercise of the
3.467 +rights granted or affirmed under this License. For example, you may
3.468 +not impose a license fee, royalty, or other charge for exercise of
3.469 +rights granted under this License, and you may not initiate litigation
3.470 +(including a cross-claim or counterclaim in a lawsuit) alleging that
3.471 +any patent claim is infringed by making, using, selling, offering for
3.472 +sale, or importing the Program or any portion of it.
3.473 +
3.474 + 11. Patents.
3.475 +
3.476 + A "contributor" is a copyright holder who authorizes use under this
3.477 +License of the Program or a work on which the Program is based. The
3.478 +work thus licensed is called the contributor's "contributor version".
3.479 +
3.480 + A contributor's "essential patent claims" are all patent claims
3.481 +owned or controlled by the contributor, whether already acquired or
3.482 +hereafter acquired, that would be infringed by some manner, permitted
3.483 +by this License, of making, using, or selling its contributor version,
3.484 +but do not include claims that would be infringed only as a
3.485 +consequence of further modification of the contributor version. For
3.486 +purposes of this definition, "control" includes the right to grant
3.487 +patent sublicenses in a manner consistent with the requirements of
3.488 +this License.
3.489 +
3.490 + Each contributor grants you a non-exclusive, worldwide, royalty-free
3.491 +patent license under the contributor's essential patent claims, to
3.492 +make, use, sell, offer for sale, import and otherwise run, modify and
3.493 +propagate the contents of its contributor version.
3.494 +
3.495 + In the following three paragraphs, a "patent license" is any express
3.496 +agreement or commitment, however denominated, not to enforce a patent
3.497 +(such as an express permission to practice a patent or covenant not to
3.498 +sue for patent infringement). To "grant" such a patent license to a
3.499 +party means to make such an agreement or commitment not to enforce a
3.500 +patent against the party.
3.501 +
3.502 + If you convey a covered work, knowingly relying on a patent license,
3.503 +and the Corresponding Source of the work is not available for anyone
3.504 +to copy, free of charge and under the terms of this License, through a
3.505 +publicly available network server or other readily accessible means,
3.506 +then you must either (1) cause the Corresponding Source to be so
3.507 +available, or (2) arrange to deprive yourself of the benefit of the
3.508 +patent license for this particular work, or (3) arrange, in a manner
3.509 +consistent with the requirements of this License, to extend the patent
3.510 +license to downstream recipients. "Knowingly relying" means you have
3.511 +actual knowledge that, but for the patent license, your conveying the
3.512 +covered work in a country, or your recipient's use of the covered work
3.513 +in a country, would infringe one or more identifiable patents in that
3.514 +country that you have reason to believe are valid.
3.515 +
3.516 + If, pursuant to or in connection with a single transaction or
3.517 +arrangement, you convey, or propagate by procuring conveyance of, a
3.518 +covered work, and grant a patent license to some of the parties
3.519 +receiving the covered work authorizing them to use, propagate, modify
3.520 +or convey a specific copy of the covered work, then the patent license
3.521 +you grant is automatically extended to all recipients of the covered
3.522 +work and works based on it.
3.523 +
3.524 + A patent license is "discriminatory" if it does not include within
3.525 +the scope of its coverage, prohibits the exercise of, or is
3.526 +conditioned on the non-exercise of one or more of the rights that are
3.527 +specifically granted under this License. You may not convey a covered
3.528 +work if you are a party to an arrangement with a third party that is
3.529 +in the business of distributing software, under which you make payment
3.530 +to the third party based on the extent of your activity of conveying
3.531 +the work, and under which the third party grants, to any of the
3.532 +parties who would receive the covered work from you, a discriminatory
3.533 +patent license (a) in connection with copies of the covered work
3.534 +conveyed by you (or copies made from those copies), or (b) primarily
3.535 +for and in connection with specific products or compilations that
3.536 +contain the covered work, unless you entered into that arrangement,
3.537 +or that patent license was granted, prior to 28 March 2007.
3.538 +
3.539 + Nothing in this License shall be construed as excluding or limiting
3.540 +any implied license or other defenses to infringement that may
3.541 +otherwise be available to you under applicable patent law.
3.542 +
3.543 + 12. No Surrender of Others' Freedom.
3.544 +
3.545 + If conditions are imposed on you (whether by court order, agreement or
3.546 +otherwise) that contradict the conditions of this License, they do not
3.547 +excuse you from the conditions of this License. If you cannot convey a
3.548 +covered work so as to satisfy simultaneously your obligations under this
3.549 +License and any other pertinent obligations, then as a consequence you may
3.550 +not convey it at all. For example, if you agree to terms that obligate you
3.551 +to collect a royalty for further conveying from those to whom you convey
3.552 +the Program, the only way you could satisfy both those terms and this
3.553 +License would be to refrain entirely from conveying the Program.
3.554 +
3.555 + 13. Use with the GNU Affero General Public License.
3.556 +
3.557 + Notwithstanding any other provision of this License, you have
3.558 +permission to link or combine any covered work with a work licensed
3.559 +under version 3 of the GNU Affero General Public License into a single
3.560 +combined work, and to convey the resulting work. The terms of this
3.561 +License will continue to apply to the part which is the covered work,
3.562 +but the special requirements of the GNU Affero General Public License,
3.563 +section 13, concerning interaction through a network will apply to the
3.564 +combination as such.
3.565 +
3.566 + 14. Revised Versions of this License.
3.567 +
3.568 + The Free Software Foundation may publish revised and/or new versions of
3.569 +the GNU General Public License from time to time. Such new versions will
3.570 +be similar in spirit to the present version, but may differ in detail to
3.571 +address new problems or concerns.
3.572 +
3.573 + Each version is given a distinguishing version number. If the
3.574 +Program specifies that a certain numbered version of the GNU General
3.575 +Public License "or any later version" applies to it, you have the
3.576 +option of following the terms and conditions either of that numbered
3.577 +version or of any later version published by the Free Software
3.578 +Foundation. If the Program does not specify a version number of the
3.579 +GNU General Public License, you may choose any version ever published
3.580 +by the Free Software Foundation.
3.581 +
3.582 + If the Program specifies that a proxy can decide which future
3.583 +versions of the GNU General Public License can be used, that proxy's
3.584 +public statement of acceptance of a version permanently authorizes you
3.585 +to choose that version for the Program.
3.586 +
3.587 + Later license versions may give you additional or different
3.588 +permissions. However, no additional obligations are imposed on any
3.589 +author or copyright holder as a result of your choosing to follow a
3.590 +later version.
3.591 +
3.592 + 15. Disclaimer of Warranty.
3.593 +
3.594 + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
3.595 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
3.596 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
3.597 +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
3.598 +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
3.599 +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
3.600 +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
3.601 +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
3.602 +
3.603 + 16. Limitation of Liability.
3.604 +
3.605 + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3.606 +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
3.607 +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
3.608 +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
3.609 +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
3.610 +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
3.611 +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
3.612 +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
3.613 +SUCH DAMAGES.
3.614 +
3.615 + 17. Interpretation of Sections 15 and 16.
3.616 +
3.617 + If the disclaimer of warranty and limitation of liability provided
3.618 +above cannot be given local legal effect according to their terms,
3.619 +reviewing courts shall apply local law that most closely approximates
3.620 +an absolute waiver of all civil liability in connection with the
3.621 +Program, unless a warranty or assumption of liability accompanies a
3.622 +copy of the Program in return for a fee.
3.623 +
3.624 + END OF TERMS AND CONDITIONS
3.625 +
3.626 + How to Apply These Terms to Your New Programs
3.627 +
3.628 + If you develop a new program, and you want it to be of the greatest
3.629 +possible use to the public, the best way to achieve this is to make it
3.630 +free software which everyone can redistribute and change under these terms.
3.631 +
3.632 + To do so, attach the following notices to the program. It is safest
3.633 +to attach them to the start of each source file to most effectively
3.634 +state the exclusion of warranty; and each file should have at least
3.635 +the "copyright" line and a pointer to where the full notice is found.
3.636 +
3.637 + <one line to give the program's name and a brief idea of what it does.>
3.638 + Copyright (C) <year> <name of author>
3.639 +
3.640 + This program is free software: you can redistribute it and/or modify
3.641 + it under the terms of the GNU General Public License as published by
3.642 + the Free Software Foundation, either version 3 of the License, or
3.643 + (at your option) any later version.
3.644 +
3.645 + This program is distributed in the hope that it will be useful,
3.646 + but WITHOUT ANY WARRANTY; without even the implied warranty of
3.647 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3.648 + GNU General Public License for more details.
3.649 +
3.650 + You should have received a copy of the GNU General Public License
3.651 + along with this program. If not, see <http://www.gnu.org/licenses/>.
3.652 +
3.653 +Also add information on how to contact you by electronic and paper mail.
3.654 +
3.655 + If the program does terminal interaction, make it output a short
3.656 +notice like this when it starts in an interactive mode:
3.657 +
3.658 + <program> Copyright (C) <year> <name of author>
3.659 + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
3.660 + This is free software, and you are welcome to redistribute it
3.661 + under certain conditions; type `show c' for details.
3.662 +
3.663 +The hypothetical commands `show w' and `show c' should show the appropriate
3.664 +parts of the General Public License. Of course, your program's commands
3.665 +might be different; for a GUI interface, you would use an "about box".
3.666 +
3.667 + You should also get your employer (if you work as a programmer) or school,
3.668 +if any, to sign a "copyright disclaimer" for the program, if necessary.
3.669 +For more information on this, and how to apply and follow the GNU GPL, see
3.670 +<http://www.gnu.org/licenses/>.
3.671 +
3.672 + The GNU General Public License does not permit incorporating your program
3.673 +into proprietary programs. If your program is a subroutine library, you
3.674 +may consider it more useful to permit linking proprietary applications with
3.675 +the library. If this is what you want to do, use the GNU Lesser General
3.676 +Public License instead of this License. But first, please read
3.677 +<http://www.gnu.org/philosophy/why-not-lgpl.html>.
4.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
4.2 +++ b/docs/wiki/FrontPage Fri Apr 12 00:24:51 2019 +0200
4.3 @@ -0,0 +1,115 @@
4.4 += MoinLight =
4.5 +
4.6 +MoinLight is a distribution of programs and libraries for working with content
4.7 +encoded in the [[https://moinmo.in/|MoinMoin]] wiki markup format. This markup
4.8 +format is generally concise and supports many kinds of HTML document features
4.9 +using intelligible plain text representations.
4.10 +
4.11 +########## The graph below shows the architecture of the system...
4.12 +
4.13 +{{{#!graphviz
4.14 +#format svg
4.15 +#transform notugly
4.16 +digraph architecture {
4.17 + node [shape=box,fontsize="13.0",fontname="Helvetica"];
4.18 + rankdir=LR;
4.19 +
4.20 + subgraph {
4.21 + rank=same;
4.22 + input [label="Input context",URL="Input"];
4.23 + markup [label="Moin content",shape=folder,style=filled,fillcolor=cyan];
4.24 + }
4.25 +
4.26 + parser [label="Parser",URL="Parsers"];
4.27 +
4.28 + subgraph {
4.29 + rank=same;
4.30 + tree [label="Document tree",shape=folder,style=filled,fillcolor=cyan];
4.31 + evaluation [label="Macro evaluation",shape=ellipse];
4.32 + }
4.33 +
4.34 + serialiser [label="Serialiser",URL="Serialisers"];
4.35 +
4.36 + theme [label="Theme",URL="Themes"];
4.37 +
4.38 + subgraph {
4.39 + rank=same;
4.40 + output [label="Output context",URL="Output"];
4.41 + pages [label="Web content",shape=folder,style=filled,fillcolor=cyan];
4.42 + }
4.43 +
4.44 + markup -> input -> parser -> tree -> evaluation -> tree -> serialiser ->
4.45 + theme -> output -> pages;
4.46 +}
4.47 +}}}
4.48 +
4.49 +##########
4.50 +
4.51 +Although it is obviously possible to use the MoinMoin software (hereafter
4.52 +referred to as Moin) to work such such content, there are a few advantages in
4.53 +developing independent tools instead:
4.54 +
4.55 + * To eliminate any dependency on the Moin code, its bundled libraries, or on
4.56 + its external dependencies (of which there are many for Moin 2.0)
4.57 +
4.58 + * To focus on areas of functionality that are considered priorities, such as
4.59 + the publishing of content as static Web sites, which may not be adequately
4.60 + or optimally supported by Moin
4.61 +
4.62 + * To provide other implementations of parsers and serialisers for the markup
4.63 + format, thus establishing it as more genuinely interoperable markup
4.64 + standard
4.65 +
4.66 + * To be able to work with the content more easily and to develop tools for
4.67 + doing so
4.68 +
4.69 +== Getting Started ==
4.70 +
4.71 +To convert a collection of wiki pages in a directory (with `pages` containing
4.72 +the original pages and `htdocs` being the desired output directory), run the
4.73 +`moinconvert` program as follows:
4.74 +
4.75 +{{{
4.76 +moinconvert --input-dir pages --output-dir htdocs --all
4.77 +}}}
4.78 +
4.79 +To convert a single file from such a collection (such as `FrontPage`), run the
4.80 +program as follows:
4.81 +
4.82 +{{{
4.83 +moinconvert --input-dir pages FrontPage
4.84 +}}}
4.85 +
4.86 +This will produce the serialised page on standard output rather than writing
4.87 +it to a file.
4.88 +
4.89 +Other options are typically useful when running the program, such as `--theme`
4.90 +for styling and wrapping the output, `--macros` for expanding macros in
4.91 +documents, and `--format` for choosing alternative output formats.
4.92 +
4.93 +== Abstractions and Architecture ==
4.94 +
4.95 +MoinLight provides a number of abstractions for working with Moin wiki content:
4.96 +
4.97 + * [[/Parsers]] interpret various forms of markup-related content, producing a
4.98 + document tree representation that can be inspected and processed
4.99 +
4.100 + * [[/Serialisers]] convert the document tree representation into other
4.101 + content formats such as HTML or even back into Moin format
4.102 +
4.103 + * [[/Themes]] augment serialised content with additional details and
4.104 + resources
4.105 +
4.106 + * [[/Macros]] define locations in documents where content is to be inserted
4.107 + or expanded
4.108 +
4.109 + * [[/Input]] contexts permit the interpretation of existing content in
4.110 + certain ways so that a collection of text files can be treated like a wiki
4.111 +
4.112 + * [[/Output]] contexts permit the publishing of content in certain
4.113 + ways so that wiki content can be shared on the Web
4.114 +
4.115 +A major objective with MoinLight is to be able to produce static files that
4.116 +can be served using a typical Web server without any need for scripts,
4.117 +applications or other kinds of dynamic content. Other objectives are described
4.118 +in the [[/Roadmap]] document.
5.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
5.2 +++ b/docs/wiki/Input Fri Apr 12 00:24:51 2019 +0200
5.3 @@ -0,0 +1,22 @@
5.4 += Input =
5.5 +
5.6 +Input contexts determine how content provided for processing should be interpreted.
5.7 +Typically, wiki content will either be provided as a single file containing a
5.8 +single wiki page or as collections of such files arranged within a directory
5.9 +hierarchy.
5.10 +
5.11 +The following input contexts are supported:
5.12 +
5.13 +{{{#!table
5.14 +'''Name''' || '''Format''' || '''Details'''
5.15 +==
5.16 +directory
5.17 +|| A directory containing wiki page files
5.18 +|| Each file contains a different wiki page with its filename indicating the
5.19 +.. page name, and with any configured `input_separator` being used in
5.20 +.. filenames to construct hierarchical page relationships
5.21 +==
5.22 +standalone
5.23 +|| A standalone wiki page file
5.24 +|| A single file containing a single wiki page
5.25 +}}}
6.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
6.2 +++ b/docs/wiki/Parsers Fri Apr 12 00:24:51 2019 +0200
6.3 @@ -0,0 +1,21 @@
6.4 += Parsers =
6.5 +
6.6 +The following parsers are currently supported:
6.7 +
6.8 +{{{#!table
6.9 +'''Name''' || '''Format''' || '''Details'''
6.10 +==
6.11 +graphviz
6.12 +|| [[http://graphviz.org/|Graphviz]] DOT language
6.13 +|| A complete graph description with optional processing directives
6.14 +==
6.15 +moin
6.16 +|| [[https://moinmo.in/|Moin]] markup
6.17 +|| Plain text with additional
6.18 +.. [[https://moinmo.in/HelpOnMoinWikiSyntax|syntax]] for formatting
6.19 +==
6.20 +table
6.21 +|| Multiline table
6.22 +|| Moin markup with multiline table
6.23 +.. [[https://moinmo.in/ParserMarket/ImprovedTableParser|syntax enhancements]]
6.24 +}}}
7.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
7.2 +++ b/docs/wiki/Roadmap Fri Apr 12 00:24:51 2019 +0200
7.3 @@ -0,0 +1,58 @@
7.4 += Roadmap =
7.5 +
7.6 +Some future objectives for the software.
7.7 +
7.8 +== HTML Parsing ==
7.9 +
7.10 +Parsing of HTML fragments would be done to permit translation into the Moin
7.11 +document tree. This would then allow round-trip conversion:
7.12 +
7.13 +########## A graph showing the process is given below...
7.14 +
7.15 +{{{#!graphviz
7.16 +//format=svg
7.17 +//transform=notugly
7.18 +digraph htmlparsing {
7.19 + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="The MoinLight architecture"];
7.20 + edge [tooltip="The MoinLight architecture"];
7.21 + rankdir=LR;
7.22 +
7.23 + moin [label="Moin content",shape=folder,style=filled,fillcolor=cyan];
7.24 +
7.25 + subgraph {
7.26 + rank=same;
7.27 + moinparser [label="Moin parser"];
7.28 + moinserialiser [label="Moin serialiser"];
7.29 + }
7.30 +
7.31 + subgraph {
7.32 + rank=same;
7.33 + tree1 [label="Document tree",shape=folder,style=filled,fillcolor=cyan];
7.34 + tree2 [label="Document tree",shape=folder,style=filled,fillcolor=cyan];
7.35 + }
7.36 +
7.37 + subgraph {
7.38 + rank=same;
7.39 + htmlserialiser [label="HTML serialiser"];
7.40 + htmlparser [label="HTML parser"];
7.41 + }
7.42 +
7.43 + html [label="HTML content",shape=folder,style=filled,fillcolor=cyan];
7.44 +
7.45 + moin -> moinparser -> tree1 -> htmlserialiser -> html -> htmlparser -> tree2 -> moinserialiser -> moin;
7.46 +}
7.47 +}}}
7.48 +
7.49 +########
7.50 +
7.51 +Pages could be retained for storage in Moin format, presented in a Web browser
7.52 +in HTML, edited using HTML editing controls, and then converted back for
7.53 +storage.
7.54 +
7.55 +In order to maintain various details of the original document, additional
7.56 +annotations would be employed in the generated HTML. Such annotations would
7.57 +appear within `class` attribute values, encoding details of the original
7.58 +content such as indentation, padding and other aspects of that content which
7.59 +are superfluous or inappropriate to the core HTML representation of the
7.60 +document, but which can be interpreted in order to restore the form of the
7.61 +original document.
8.1 --- a/moinconvert Fri Mar 15 18:37:41 2019 +0100
8.2 +++ b/moinconvert Fri Apr 12 00:24:51 2019 +0200
8.3 @@ -19,7 +19,8 @@
8.4 this program. If not, see <http://www.gnu.org/licenses/>.
8.5 """
8.6
8.7 -from moinformat import make_parser, make_serialiser, Metadata, parse, serialise
8.8 +from moinformat import errors, make_parser, make_serialiser, Metadata, parse, \
8.9 + serialise
8.10 from os.path import split
8.11 import sys
8.12
8.13 @@ -84,6 +85,7 @@
8.14
8.15 # Option values.
8.16
8.17 + attachments_dir = []
8.18 document_indexes = []
8.19 filenames = []
8.20 formats = []
8.21 @@ -111,20 +113,35 @@
8.22
8.23 for arg in args:
8.24
8.25 - # Detect tree output.
8.26 + # Flags with no following arguments.
8.27 +
8.28 + # Detect all documents.
8.29
8.30 - if arg == "--tree":
8.31 - tree = True
8.32 + if arg == "--all":
8.33 + all = True
8.34 +
8.35 + # Detect fragment output (if serialising).
8.36 +
8.37 + elif arg == "--fragment":
8.38 + fragment = True
8.39
8.40 # Detect macro evaluation.
8.41
8.42 elif arg == "--macros":
8.43 macros = True
8.44
8.45 - # Detect all documents.
8.46 + # Detect tree output.
8.47 +
8.48 + elif arg == "--tree":
8.49 + tree = True
8.50
8.51 - elif arg == "--all":
8.52 - all = True
8.53 + # Options with following arguments.
8.54 +
8.55 + # Switch to document index.
8.56 +
8.57 + elif arg == "--attachments-dir":
8.58 + l = attachments_dir
8.59 + continue
8.60
8.61 # Switch to document index.
8.62
8.63 @@ -132,11 +149,6 @@
8.64 l = document_indexes
8.65 continue
8.66
8.67 - # Detect fragment output (if serialising).
8.68 -
8.69 - elif arg == "--fragment":
8.70 - fragment = True
8.71 -
8.72 # Switch to collecting formats.
8.73
8.74 elif arg == "--format":
8.75 @@ -224,6 +236,7 @@
8.76 # Define metadata.
8.77
8.78 metadata = Metadata({
8.79 + "attachments" : getvalue(attachments_dir, "attachments"),
8.80 "document_index" : getvalue(document_indexes),
8.81 "input_context" : input_dir and \
8.82 getvalue(input_dir_types, "directory") or \
8.83 @@ -379,6 +392,9 @@
8.84 """
8.85
8.86 if __name__ == "__main__":
8.87 - main()
8.88 + try:
8.89 + main()
8.90 + except errors.ProcessingError, exc:
8.91 + print str(exc)
8.92
8.93 # vim: tabstop=4 expandtab shiftwidth=4
9.1 --- a/moinformat/__init__.py Fri Mar 15 18:37:41 2019 +0100
9.2 +++ b/moinformat/__init__.py Fri Apr 12 00:24:51 2019 +0200
9.3 @@ -3,7 +3,7 @@
9.4 """
9.5 Moin wiki format tools.
9.6
9.7 -Copyright (C) 2017, 2018 Paul Boddie <paul@boddie.org.uk>
9.8 +Copyright (C) 2017, 2018, 2019 Paul Boddie <paul@boddie.org.uk>
9.9
9.10 This program is free software; you can redistribute it and/or modify it under
9.11 the terms of the GNU General Public License as published by the Free Software
9.12 @@ -26,5 +26,6 @@
9.13 from moinformat.parsers import get_parser, make_parser, parse
9.14 from moinformat.serialisers import get_serialiser, make_serialiser, serialise
9.15 from moinformat.themes import make_theme
9.16 +import moinformat.errors as errors
9.17
9.18 # vim: tabstop=4 expandtab shiftwidth=4
10.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
10.2 +++ b/moinformat/errors.py Fri Apr 12 00:24:51 2019 +0200
10.3 @@ -0,0 +1,35 @@
10.4 +#!/usr/bin/env python
10.5 +
10.6 +"""
10.7 +Moin wiki processing errors.
10.8 +
10.9 +Copyright (C) 2019 Paul Boddie <paul@boddie.org.uk>
10.10 +
10.11 +This program is free software; you can redistribute it and/or modify it under
10.12 +the terms of the GNU General Public License as published by the Free Software
10.13 +Foundation; either version 3 of the License, or (at your option) any later
10.14 +version.
10.15 +
10.16 +This program is distributed in the hope that it will be useful, but WITHOUT
10.17 +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10.18 +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
10.19 +details.
10.20 +
10.21 +You should have received a copy of the GNU General Public License along with
10.22 +this program. If not, see <http://www.gnu.org/licenses/>.
10.23 +"""
10.24 +
10.25 +class ProcessingError(Exception):
10.26 +
10.27 + "A generic processing error."
10.28 +
10.29 + def __init__(self, errors):
10.30 + self.errors = errors
10.31 +
10.32 + def __repr__(self):
10.33 + return "%s(%r)" % (self.__class__.__name__, self.errors)
10.34 +
10.35 + def __str__(self):
10.36 + return "Error: %s\nMessage: %s\n" % (self.__class__.__name__, self.errors)
10.37 +
10.38 +# vim: tabstop=4 expandtab shiftwidth=4
11.1 --- a/moinformat/input/directory.py Fri Mar 15 18:37:41 2019 +0100
11.2 +++ b/moinformat/input/directory.py Fri Apr 12 00:24:51 2019 +0200
11.3 @@ -3,7 +3,7 @@
11.4 """
11.5 Directory input context.
11.6
11.7 -Copyright (C) 2018 Paul Boddie <paul@boddie.org.uk>
11.8 +Copyright (C) 2018, 2019 Paul Boddie <paul@boddie.org.uk>
11.9
11.10 This program is free software; you can redistribute it and/or modify it under
11.11 the terms of the GNU General Public License as published by the Free Software
11.12 @@ -45,13 +45,27 @@
11.13
11.14 self.level_sep = metadata.get("input_separator", sep)
11.15
11.16 + # Search recursively in nested directories for pages and files.
11.17 +
11.18 + self.nested = self.level_sep == sep
11.19 +
11.20 + # Support attachments directories.
11.21 +
11.22 + self.attachments_dir = metadata.get("attachments", "attachments")
11.23 +
11.24 def all(self):
11.25
11.26 "Return all pages in the context."
11.27
11.28 # Ignore dotfiles.
11.29
11.30 - return map(self.to_pagename, self.dir.select_files("[!.]*"))
11.31 + return map(self.to_pagename, self.dir.select_files("[!.]*", self.nested))
11.32 +
11.33 + def all_attachments(self):
11.34 +
11.35 + "Return all attachment filenames in the context."
11.36 +
11.37 + return self.dir.select_files("%s/*" % self.attachments_dir, self.nested)
11.38
11.39 # Page characteristics.
11.40
11.41 @@ -60,7 +74,7 @@
11.42 "Return the subpage filenames of 'pagename'."
11.43
11.44 pattern = self.to_filename("%s/*" % pagename)
11.45 - return self.dir.select_files(pattern)
11.46 + return self.dir.select_files(pattern, self.nested)
11.47
11.48 def subpages(self, pagename):
11.49
12.1 --- a/moinformat/links/common.py Fri Mar 15 18:37:41 2019 +0100
12.2 +++ b/moinformat/links/common.py Fri Apr 12 00:24:51 2019 +0200
12.3 @@ -19,6 +19,27 @@
12.4 this program. If not, see <http://www.gnu.org/licenses/>.
12.5 """
12.6
12.7 +class Link:
12.8 +
12.9 + "A link abstraction."
12.10 +
12.11 + def __init__(self, target, label, type):
12.12 +
12.13 + "Initialise the link with the given 'target', 'label' and 'type'."
12.14 +
12.15 + self.target = target
12.16 + self.label = label
12.17 + self.type = type
12.18 +
12.19 + def get_target(self):
12.20 + return self.target
12.21 +
12.22 + def get_label(self):
12.23 + return self.label or self.target
12.24 +
12.25 + def get_type(self):
12.26 + return self.type
12.27 +
12.28 class Linker:
12.29
12.30 "Translate Moin links into other forms."
12.31 @@ -41,6 +62,7 @@
12.32
12.33 self.mapping = metadata.get("mapping", {})
12.34 self.root_pagename = metadata.get("root_pagename", "FrontPage")
12.35 + self.attachments_dir = metadata.get("attachments", "attachments")
12.36
12.37 def resolve(path, pagename, root_pagename):
12.38
13.1 --- a/moinformat/links/html.py Fri Mar 15 18:37:41 2019 +0100
13.2 +++ b/moinformat/links/html.py Fri Apr 12 00:24:51 2019 +0200
13.3 @@ -19,7 +19,7 @@
13.4 this program. If not, see <http://www.gnu.org/licenses/>.
13.5 """
13.6
13.7 -from moinformat.links.common import Linker, resolve
13.8 +from moinformat.links.common import Link, Linker, resolve
13.9 from urllib import quote, quote_plus
13.10 from urlparse import urlparse
13.11
13.12 @@ -70,17 +70,17 @@
13.13 # Fragments. Remove the leading hash for the label.
13.14
13.15 if target.startswith("#"):
13.16 - return self.quote(target), target.lstrip("#")
13.17 + return Link(self.quote(target), target.lstrip("#"), "fragment")
13.18
13.19 # Sub-pages. Remove the leading slash for the label.
13.20
13.21 if target.startswith("/"):
13.22 - return self.translate_pagename(target), target.lstrip("/")
13.23 + return Link(self.translate_pagename(target), target.lstrip("/"), "page")
13.24
13.25 # Sibling (of ancestor) pages.
13.26
13.27 if target.startswith("../"):
13.28 - return self.translate_pagename(target), None
13.29 + return Link(self.translate_pagename(target), None, "page")
13.30
13.31 # Attachment or interwiki link.
13.32
13.33 @@ -92,11 +92,11 @@
13.34
13.35 rewritten = self.is_url(target)
13.36 if rewritten:
13.37 - return rewritten, None
13.38 + return Link(rewritten, None, "url")
13.39
13.40 # Top-level pages.
13.41
13.42 - return self.translate_pagename(target), None
13.43 + return Link(self.translate_pagename(target), None, "page")
13.44
13.45 def translate_pagename(self, target):
13.46
13.47 @@ -130,8 +130,8 @@
13.48 def translate_qualified_link(self, target):
13.49
13.50 """
13.51 - Translate a possible qualified link 'target', returning a tuple
13.52 - containing a rewritten target and a suitable default label.
13.53 + Translate a possible qualified link 'target', returning a link object
13.54 + retaining a rewritten target and a suitable default label.
13.55
13.56 Return None if the link is not suitable.
13.57 """
13.58 @@ -145,13 +145,13 @@
13.59 # Attachment links.
13.60
13.61 if prefix == "attachment":
13.62 - return self.translate_attachment(target), target
13.63 + return Link(self.translate_attachment(target), target, "attachment")
13.64
13.65 # Interwiki links.
13.66
13.67 url = self.mapping.get(prefix)
13.68 if url:
13.69 - return self.translate_interwiki(url, target), target
13.70 + return Link(self.translate_interwiki(url, target), target, "interwiki")
13.71
13.72 return None
13.73
13.74 @@ -161,7 +161,7 @@
13.75
13.76 "Return a translation of the given attachment 'target'."
13.77
13.78 - return self.quote("./attachments/%s" % target)
13.79 + return self.quote("./%s/%s" % (self.attachments_dir, target))
13.80
13.81 def translate_interwiki(self, url, target):
13.82
14.1 --- a/moinformat/serialisers/html/graphviz.py Fri Mar 15 18:37:41 2019 +0100
14.2 +++ b/moinformat/serialisers/html/graphviz.py Fri Apr 12 00:24:51 2019 +0200
14.3 @@ -20,7 +20,7 @@
14.4 """
14.5
14.6 from moinformat.serialisers.common import Serialiser, escape_attr, escape_text
14.7 -from moinformat.utils.graphviz import Graphviz, GraphvizError, IMAGE_FORMATS, \
14.8 +from moinformat.utils.graphviz import Graphviz, IMAGE_FORMATS, \
14.9 get_output_identifier
14.10
14.11 # Utility functions.
14.12 @@ -121,7 +121,7 @@
14.13 # Make sure that page attachments can be stored.
14.14
14.15 self.output.ensure_attachments(pagename)
14.16 - target, _label = self.linker.translate("attachment:%s" % attachment)
14.17 + link = self.linker.translate("attachment:%s" % attachment)
14.18
14.19 # No filename is defined for inline output.
14.20
14.21 @@ -156,12 +156,12 @@
14.22 self.raw(graphviz.get_output())
14.23 attributes["usemap"] = "#%s" % im_attributes["id"]
14.24
14.25 - self.image(target, attributes)
14.26 + self.image(link.get_target(), attributes)
14.27
14.28 # For other output, create a file and embed the object.
14.29
14.30 elif not inline:
14.31 - self.object(target, attributes)
14.32 + self.object(link.get_target(), attributes)
14.33
14.34 # Or for inline output, emit it in the document itself.
14.35
15.1 --- a/moinformat/serialisers/html/moin.py Fri Mar 15 18:37:41 2019 +0100
15.2 +++ b/moinformat/serialisers/html/moin.py Fri Apr 12 00:24:51 2019 +0200
15.3 @@ -252,11 +252,9 @@
15.4 self.out("<br />")
15.5
15.6 def _link(self, target, nodes, tag, attr):
15.7 - label = None
15.8 - if self.linker:
15.9 - href, label = self.linker.translate(target)
15.10 + link = self.linker and self.linker.translate(target) or None
15.11
15.12 - self.out('<%s %s="%s"' % (tag, attr, escape_attr(href)))
15.13 + self.out('<%s %s="%s"' % (tag, attr, escape_attr(link.get_target())))
15.14
15.15 if nodes:
15.16 for node in nodes[1:]:
15.17 @@ -268,7 +266,7 @@
15.18 if nodes:
15.19 nodes[0].to_string(self)
15.20 else:
15.21 - self.out(escape_text(label or target))
15.22 + self.out(escape_text(link.get_label()))
15.23
15.24 self.out("</%s>" % tag)
15.25
16.1 --- a/moinformat/utils/directory.py Fri Mar 15 18:37:41 2019 +0100
16.2 +++ b/moinformat/utils/directory.py Fri Apr 12 00:24:51 2019 +0200
16.3 @@ -3,7 +3,7 @@
16.4 """
16.5 Directory context functionality.
16.6
16.7 -Copyright (C) 2018 Paul Boddie <paul@boddie.org.uk>
16.8 +Copyright (C) 2018, 2019 Paul Boddie <paul@boddie.org.uk>
16.9
16.10 This program is free software; you can redistribute it and/or modify it under
16.11 the terms of the GNU General Public License as published by the Free Software
16.12 @@ -132,11 +132,12 @@
16.13
16.14 rename(self.get_filename(old), self.get_filename(new))
16.15
16.16 - def select_files(self, pattern):
16.17 + def select_files(self, pattern, recursive=False):
16.18
16.19 """
16.20 Return a list of filenames found within the directory matching
16.21 - 'pattern'. These filenames are relative to the directory.
16.22 + 'pattern'. These filenames are relative to the directory. If 'recursive'
16.23 + is specified and is a true value, subdirectories are also searched.
16.24 """
16.25
16.26 selected = []
16.27 @@ -144,6 +145,9 @@
16.28 # Obtain pathnames, directory names and filenames within the directory.
16.29
16.30 for dirpath, dirnames, filenames in walk(self.filename):
16.31 + if not recursive and dirpath != self.filename:
16.32 + continue
16.33 +
16.34 for filename in filenames:
16.35
16.36 # Qualify filenames with the directory path.
17.1 --- a/moinformat/utils/graphviz.py Fri Mar 15 18:37:41 2019 +0100
17.2 +++ b/moinformat/utils/graphviz.py Fri Apr 12 00:24:51 2019 +0200
17.3 @@ -3,7 +3,7 @@
17.4 """
17.5 Graphviz utilities.
17.6
17.7 -Copyright (C) 2018 Paul Boddie <paul@boddie.org.uk>
17.8 +Copyright (C) 2018, 2019 Paul Boddie <paul@boddie.org.uk>
17.9
17.10 This program is free software; you can redistribute it and/or modify it under
17.11 the terms of the GNU General Public License as published by the Free Software
17.12 @@ -19,6 +19,7 @@
17.13 this program. If not, see <http://www.gnu.org/licenses/>.
17.14 """
17.15
17.16 +from moinformat.errors import ProcessingError
17.17 from os.path import exists, join
17.18 from StringIO import StringIO
17.19 from subprocess import Popen, PIPE
17.20 @@ -184,12 +185,11 @@
17.21
17.22 # Classes for interacting with Graphviz.
17.23
17.24 -class GraphvizError(Exception):
17.25 +class GraphvizError(ProcessingError):
17.26
17.27 "An error produced when using Graphviz."
17.28
17.29 - def __init__(self, errors):
17.30 - self.errors = errors
17.31 + pass
17.32
17.33 class Graphviz:
17.34
18.1 --- a/tests/test_parser.py Fri Mar 15 18:37:41 2019 +0100
18.2 +++ b/tests/test_parser.py Fri Apr 12 00:24:51 2019 +0200
18.3 @@ -25,7 +25,9 @@
18.4
18.5 "Compare serialised output from 'd' with its original form 's'."
18.6
18.7 - metadata = Metadata()
18.8 + metadata = Metadata({
18.9 + "pagename" : "TestPage",
18.10 + })
18.11
18.12 output = make_output(metadata)
18.13 expected = output.encode(s)
18.14 @@ -203,9 +205,25 @@
18.15 if __name__ == "__main__":
18.16 args = sys.argv[1:]
18.17
18.18 - quiet = "-q" in args
18.19 - if quiet:
18.20 - del args[args.index("-q")]
18.21 + if "--help" in args:
18.22 + print >>sys.stderr, """\
18.23 +Usage: %s [ -q ] [ <filename>... ]
18.24 +
18.25 +Run the test suite or, if filenames are indicated, specific test files.
18.26 +The following options are supported:
18.27 +
18.28 +-q Suppress test output, reporting only success or failure
18.29 +--quiet Equivalent to -q
18.30 +"""
18.31 + sys.exit(1)
18.32 +
18.33 + for arg in ["-q", "--quiet"]:
18.34 + if arg in args:
18.35 + del args[args.index(arg)]
18.36 + quiet = True
18.37 + break
18.38 + else:
18.39 + quiet = False
18.40
18.41 metadata = Metadata({
18.42 "input_context" : "directory",