Mercurial > forge
changeset 9874:67cd7d263dd4 octave-forge
new package generate_latex
author | cdf |
---|---|
date | Sun, 25 Mar 2012 22:57:18 +0000 |
parents | 03c9c820682e |
children | e53f1fe644ba |
files | extra/generate_latex/COPYING extra/generate_latex/DESCRIPTION extra/generate_latex/INDEX extra/generate_latex/inst/generate_package_latex.m extra/generate_latex/inst/get_latex_options.m extra/generate_latex/inst/latex_help_text.m extra/generate_latex/inst/private/get_header_title_and_footer.m extra/generate_latex/inst/private/get_main_filename.m extra/generate_latex/inst/private/get_main_header_title_and_footer.m extra/generate_latex/inst/private/mk_function_dir.m |
diffstat | 10 files changed, 1590 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/COPYING Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/DESCRIPTION Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,12 @@ +Name: generate_latex +Version: 0.0.1 +Date: 2012-03-26 +Author: Soeren Hauberg, Carlo de Falco +Maintainer: Carlo de Falco +Title: Generate LaTeX docs from help texts +Description: This package provides functions for generating a LaTeX document + containing the help texts for a set of functions. +Depends: octave (>= 3.6.0) +SystemRequirements: makeinfo +License: GPL version 3 or later +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/INDEX Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,7 @@ +generate_latex >> Generate LaTeX documents from help texts +Single function functions + latex_help_text +Package functions + generate_package_latex + get_latex_options +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/generate_package_latex.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,287 @@ +## Copyright (C) 2012 Carlo de Falco +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +## -*- texinfo -*- +## @deftypefn {Function File} generate_package_latex (@var{name}, @var{outdir}, @var{options}) +## Generate @t{LaTeX} documentation for a package. +## +## The function reads information about package @var{name} using the +## package system. This is then used to generate a bunch of +## @t{LaTeX} files; one for each function in the package, and one file including them +## all. The files are all placed in the directory @var{outdir}, which defaults +## to the current directory. The @var{options} structure is used to control +## the design of the file. +## +## As an example, the following code generates the manual for the @t{image} +## package. +## +## @example +## options = get_latex_options ("default"); +## generate_package_latex ("image", "image_latex", options); +## @end example +## +## The resulting files will be available in the @t{"image_latex"} directory. The +## main fail will be called @t{"image_html/manual.tex"}. +## +## As a convenience, if @var{options} is a string, a structure will +## be generated by calling @code{get_html_options}. This means the above +## example can be reduced to the following. +## +## @example +## generate_package_latex ("image", "image_latex", "default"); +## @end example +## +## It should be noted that the function only works for installed packages. +## @seealso{get_latex_options} +## @end deftypefn + +function generate_package_latex (name = [], outdir = "latexdocs", options = "default") + + ## Check input + if (isempty (name)) + list = pkg ("list"); + for k = 1:length (list) + generate_package_latex (list {k}.name, outdir, options); + endfor + return; + elseif (isstruct (name)) + desc = name; + if (isfield (name, "name")) + packname = desc.name; + else + packname = ""; + endif + elseif (ischar (name)) + packname = name; + pkg ("load", name); + desc = pkg ("describe", name) {1}; + else + error (["generate_package_latex: first input must either be the name of a ", ... + "package, or a structure giving its description."]); + endif + + if (isempty (outdir)) + outdir = packname; + elseif (! ischar (outdir)) + error ("generate_package_latex: second input argument must be a string"); + endif + + ## Create output directory if needed + if (! exist (outdir, "dir")) + mkdir (outdir); + endif + + packdir = fullfile (outdir, packname); + if (! exist (packdir, "dir")) + mkdir (packdir); + endif + + [local_fundir, fundir] = mk_function_dir (packdir, packname, options); + + ## If options is a string, call get_latex_options + if (ischar (options)) + options = get_latex_options (options); + elseif (! isstruct (options)) + error ("generate_package_latex: third input argument must be a string or a structure"); + endif + + ################################################### + ## Generate latex pages for individual functions ## + ################################################### + options.footer = strrep (options.footer, "@package", packname); + num_categories = length (desc.provides); + anchors = implemented = cell (1, num_categories); + + for k = 1:num_categories + F = desc.provides {k}.functions; + category = desc.provides {k}.category; + anchors {k} = strrep (category, " ", ""); # anchor names + + ## For each function in category + num_functions = length (F); + implemented {k} = cell (1, num_functions); + for l = 1:num_functions + fun = F {l}; + if (any (fun == filesep ())) + at_dir = fileparts (fun); + mkdir (fullfile (fundir, at_dir)); + r = "../../../"; + else + r = "../../"; + endif + outname = fullfile (fundir, sprintf ("%s.tex", fun)); +% try + latex_help_text (fun, outname, options, r); + implemented {k}{l} = true; +% catch +% warning ("marking '%s' as not implemented", fun); +% implemented {k}{l} = false; +% end_try_catch + endfor + endfor + + ######################### + ## Write main file ## + ######################### + first_sentences = cell (1, num_categories); + main_filename = get_main_filename (options, desc.name); + + fid = fopen (fullfile (packdir, main_filename), "w"); + if (fid < 0) + error ("generate_package_latex: couldn't open main file for writing"); + endif + + [header, title, footer] = get_main_header_title_and_footer (options, desc.name, "../"); + + fprintf (fid, "%s\n", header); + fprintf (fid, "\\title{%s}\n", desc.name); + fprintf (fid, "\\begin{document}\n"); + fprintf (fid, "\\maketitle\n"); + if (options.include_toc) + fprintf (fid, "\\tableofcontents\n"); + endif + + + ###################### + ## Write file intro ## + ###################### + + ## Get detailed information about the package + all_list = pkg ("list"); + list = []; + for k = 1:length (all_list) + if (strcmp (all_list {k}.name, packname)) + list = all_list {k}; + endif + endfor + if (isempty (list)) + error ("generate_package_latex: couldn't locate package '%s'", packname); + endif + + ## Write output + fprintf (fid, "%s\n", options.intro_pre); + fprintf (fid, "%s%s%s\n", options.name_pre, __ec__ (desc.name), options.name_post); + fprintf (fid, "%s%s%s\n", options.desc_pre, __ec__ (desc.description), options.desc_post); + fprintf (fid, "%s%s%s\n", options.version_pre, __ec__ (list.version), options.version_post); + fprintf (fid, "%s%s%s\n", options.date_pre, __ec__ (list.date), options.date_post); + fprintf (fid, "%s%s%s\n", options.author_pre, __ec__ (list.author), options.author_post); + fprintf (fid, "%s%s%s\n", options.maintainer_pre, __ec__ (list.maintainer), options.maintainer_post); + fprintf (fid, "%s%s%s\n", options.license_pre, __ec__ (list.license), options.license_post); + if (isfield (list, "depends")) + fprintf (fid, "%s\n", options.deps_pre); + for k = 1:length (list.depends) + vt = __ec__ (list.depends {k}.package); + if (isfield (list.depends {k}, "operator") && isfield (list.depends {k}, "version")) + o = list.depends {k}.operator; + v = list.depends {k}.version; + vt = sprintf ("%s ($%s$ %s), ", vt, o, v); + else + vt = ""; + endif + + fprintf (fid, vt); + endfor + fprintf (fid, "%s\n", options.deps_sep); + endif + fprintf (fid, "%s\n", options.deps_post); + + if (isfield (list, "buildrequires")) + fprintf (fid, "%s%s%s\n", options.buildreq_pre, list.buildrequires, options.buildreq_post); + endif + + if (isfield (list, "autoload")) + if (list.autoload) + a = "Yes"; + else + a = "No"; + endif + fprintf (fid, "%s%s%s\n", options.autoload_pre, a, options.autoload_post); + endif + + fprintf (fid, "%s\n", options.intro_post); + + + ## Generate function list by category + for k = 1:num_categories + F = desc.provides {k}.functions; + category = desc.provides {k}.category; + first_sentences {k} = cell (1, length (F)); + + ## For each function in category + for l = 1:length (F) + fun = F {l}; + if (implemented {k}{l}) + first_sentences {k}{l} = get_first_help_sentence (fun, 200); + first_sentences {k}{l} = strrep (first_sentences {k}{l}, "\n", " "); + + link = sprintf ('%s%s%s.tex', local_fundir, filesep (), fun); + fprintf (fid, "%s%s%s\n", options.function_name_pre, options.function_name_mangle (fun), options.function_name_post); + fprintf (fid, "\\input{%s}\n", link); + else + fprintf (fid, "%s%s%s\n", options.function_name_pre, options.function_name_mangle (fun), options.function_name_post); + fprintf (fid, "Not Implemnted.\n", fun); + endif + endfor + endfor + + if (isfield (options, "include_package_license") && options.include_package_license) + copying_filename = "COPYING.tex"; + fprintf (fid, "\\input{%s}\n", copying_filename); + endif + + fprintf (fid, "\n%s\n\\end{document}", footer); + fclose (fid); + + ######################## + ## Write COPYING file ## + ######################## + + if (isfield (options, "include_package_license") && options.include_package_license) + ## Get detailed information about the package + all_list = pkg ("list"); + list = []; + for k = 1:length (all_list) + if (strcmp (all_list {k}.name, packname)) + list = all_list {k}; + endif + endfor + if (isempty (list)) + error ("generate_package_latex: couldn't locate package '%s'", packname); + endif + + ## Read license + filename = fullfile (list.dir, "packinfo", "COPYING"); + fid = fopen (filename, "r"); + if (fid < 0) + error ("generate_package_latex: couldn't open license for reading"); + endif + contents = char (fread (fid).'); + fclose (fid); + + ## Open output file + fid = fopen (fullfile (packdir, copying_filename), "w"); + if (fid < 0) + error ("generate_package_latex: couldn't open COPYING file for writing"); + endif + + fprintf (fid, "\n%s\n", options.license_file_pre); + fprintf (fid, "%s\n\n", contents); + fprintf (fid, "\n%s\n", options.license_file_post); + fclose (fid); + endif +endfunction +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/get_latex_options.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,186 @@ +## Copyright (C) 2012 Carlo de Falco +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +## -*- texinfo -*- +## @deftypefn {Function File} {@var{options} =} get_latex_options (@var{document_type}) +## Returns a structure containing design options for a latex manual. +## +## Given a string @var{document_type}, the function returns a structure containing +## various types of information for generating latex manual for the specified document type. +## Currently, the accepted values of @var{document_type} are +## +## @table @minus +## @item "amsart_a5" +## amsart document class on a5 paper. +## @item "article_a4" +## amsart document class on a5 paper. +## @end table +## @seealso{generate_package_latex, latex_help_text} +## @end deftypefn + +function options = get_latex_options (project_name) + ## Check input + if (nargin == 0) + error ("get_latex_options: not enough input arguments"); + endif + + if (!ischar (project_name)) + error ("get_latex_options: first input argument must be a string"); + endif + + ## Generate options depending on project + switch (lower (project_name)) + case "amsart_a5" + options = amsart_a5_options (); + case "article_a4" + options = article_a4_options (); + otherwise + error ("get_latex_options: unknown project name: %s", project_name); + endswitch + +endfunction + + +function options = amsart_a5_options () + + ## Basic latex header + hh = "\ +\\documentclass{amsart} \n\ +\\usepackage{geometry} \n\ +\\geometry{a5paper} \n\ +\\usepackage{graphicx} \n\ +\\usepackage{amssymb} \n\ +\\usepackage{epstopdf} \n\ +\\usepackage{cprotect,fancyvrb} \n\ +\\usepackage{float} \n\ +\\floatstyle{ruled} \n\ +\\newfloat{demo}{thp}{dem} \n\ +\\floatname{demo}{Demo} \n\ +\\newfloat{demoout}{thp}{deo} \n\ +\\floatname{demoout}{Demo Output} \n\ +\n"; + + options.function_name_pre = "\\cprotect\\section{\\verb|"; + options.function_name_mangle = @(x) x; + options.function_name_post = "|}\n"; + + ## Options for alphabetical lists + options.intro_pre = "\\section{Package Description}\n"; + options.intro_post = "%end package description\n"; + options.name_pre = "{\\bf Name: } "; + options.name_post = "\\\\ \n"; + options.desc_pre = "{\\bf Description: } \\\\\n"; + options.desc_post = "\\\\\n"; + options.version_pre = "{\\bf Version: } "; + options.version_post = "\\\\ \n"; + options.date_pre = "{\\bf Release Date: } "; + options.date_post = "\\\\ \n"; + options.author_pre = "{\\bf Author: } "; + options.author_post = "\\\\ \n"; + options.maintainer_pre = "{\\bf Maintainer: } "; + options.maintainer_post = "\\\\ \n"; + options.license_pre = "{\\bf License: } "; + options.license_post = "\\\\ \n"; + options.deps_pre = "{\\bf Depends on: } \\\\ \n"; + options.deps_post = "\\null \n"; + options.deps_sep = "\\\\ \n"; + options.buildreq_pre = "{\\bf Build dependencies: } \\\\ \n"; + options.buildreq_post = "\\\\ \n"; + options.autoload_pre = "{\\bf Autoload: } \n"; + options.autoload_post = "\\\\ \n"; + + ## Options for individual function pages + options.header = "\\begin{SaveVerbatim}{VerbBox}\n"; + options.footer = "\\end{SaveVerbatim}\n\\resizebox{.9\\linewidth}{!}{\\BUseVerbatim{VerbBox}}"; + options.include_demos = true; + + ## Options for overview page + options.main_header = sprintf ("%s", hh); + options.main_footer = " "; + options.include_toc = true; + + ## Options for COPYING file + options.include_package_license = true; + options.license_file_pre = "\\begin{Verbatim}"; + options.license_file_post = "\\end{Verbatim}\n\\null\n"; + +endfunction + +function options = article_a4_options () + + ## Basic latex header + hh = "\ +\\documentclass[10pt]{article} \n\ +\\usepackage{geometry} \n\ +\\geometry{a4paper} \n\ +\\usepackage{graphicx} \n\ +\\usepackage{amssymb} \n\ +\\usepackage{epstopdf} \n\ +\\usepackage{cprotect} \n\ +\\usepackage{float} \n\ +\\floatstyle{plain} \n\ +\\newfloat{demo}{thp}{dem} \n\ +\\floatname{demo}{Demo} \n\ +\\newfloat{demoout}{thp}{deo} \n\ +\\floatname{demoout}{Demo Output} \n\ +\n"; + + options.function_name_pre = "\\section{"; + options.function_name_mangle = @(x) __ec__ (x); + options.function_name_post = "}\n"; + + ## Options for alphabetical lists + options.intro_pre = "\\section{Package Description}\n"; + options.intro_post = "%end package description\n"; + options.name_pre = "{\\bf Name: } "; + options.name_post = "\\\\ \n"; + options.desc_pre = "{\\bf Description: } \\\\\n"; + options.desc_post = "\\\\\n"; + options.version_pre = "{\\bf Version: } "; + options.version_post = "\\\\ \n"; + options.date_pre = "{\\bf Release Date: } "; + options.date_post = "\\\\ \n"; + options.author_pre = "{\\bf Author: } "; + options.author_post = "\\\\ \n"; + options.maintainer_pre = "{\\bf Maintainer: } "; + options.maintainer_post = "\\\\ \n"; + options.license_pre = "{\\bf License: } "; + options.license_post = "\\\\ \n"; + options.deps_pre = "{\\bf Depends on: } \\\\ \n"; + options.deps_post = "\\null \n"; + options.deps_sep = "\\\\ \n"; + options.buildreq_pre = "{\\bf Build dependencies: } \\\\ \n"; + options.buildreq_post = "\\\\ \n"; + options.autoload_pre = "{\\bf Autoload: } \n"; + options.autoload_post = "\\\\ \n"; + + ## Options for individual function pages + options.header = "\\begin{verbatim}\n"; + options.footer = "\\end{verbatim}\n"; + options.include_demos = true; + + ## Options for overview page + options.main_header = sprintf ("%s", hh); + options.main_footer = " "; + options.include_toc = true; + + ## Options for COPYING file + options.include_package_license = true; + options.license_file_pre = "\\begin{verbatim}"; + options.license_file_post = "\\end{verbatim}\n\\null\n"; + +endfunction \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/latex_help_text.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,266 @@ +## Copyright (C) 2012 Carlo de Falco +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +## -*- texinfo -*- +## @deftypefn {Function File} latex_help_text (@var{name}, @var{outname}, @var{options}) +## Writes a function help text to disk formatted as @t{LaTeX}. +## +## The help text of the function @var{name} is written to the file @var{outname} +## formatted as @t{LaTeX}. The design of the generated @t{LaTeX} page is controlled +## through the @var{options} variable. This is a structure with the following +## optional fields. +## +## @table @samp +## @item header +## This field contains the @t{LaTeX} header of the generated file. +## @item footer +## This field contains the @t{LaTeX} footer of the generated file. This should +## match the @samp{header} field to ensure all opened tags get closed. +## @end table +## +## @var{options} structures for various projects can be with the @code{get_latex_options} +## function. As a convenience, if @var{options} is a string, a structure will +## be generated by calling @code{get_latex_options}. +## +## @seealso{get_latex_options, generate_package_latex} +## @end deftypefn + +function latex_help_text (name, outname, options = struct (), root = "") + + ## Get the help text of the function + [text, format] = get_help_text (name); + + ## If options is a string, call get_latex_options + if (ischar (options)) + options = get_latex_options (options); + endif + + + ## Take action depending on help text format + switch (lower (format)) + case "plain text" + + header = ""; + text = sprintf ("\n%s\n", text); + footer = ""; + + case "texinfo" + + ## Add easily recognisable text before and after real text + start = "###### OCTAVE START ######"; + stop = "###### OCTAVE STOP ######"; + text = sprintf ("%s\n%s\n%s\n", start, text, stop); + + ## Handle @seealso + if (isfield (options, "seealso")) + seealso = @(args) options.seealso (root, args); + else + seealso = @(args) latex_see_also_with_prefix (root, args {:}); + endif + + ## Run makeinfo + [text, status] = __makeinfo__ (text, "plain text", seealso); + if (status != 0) + error ("latex_help_text: couln't parse file '%s'", name); + endif + + ## Split text into header, body, and footer using the text we added above + start_idx = strfind (text, start); + stop_idx = strfind (text, stop); + header = text (1:start_idx - 1); + footer = text (stop_idx + length (stop):end); + text = text (start_idx + length (start):stop_idx - 1); + + case "not found" + error ("latex_help_text: `%s' not found\n", name); + otherwise + error ("latex_help_text: internal error: unsupported help text format: '%s'\n", format); + endswitch + + ## Read 'options' input argument + [header, title, footer] = get_header_title_and_footer (options, name, root); + + ## Add demo:// links if requested + if (isfield (options, "include_demos") && options.include_demos) + + ## Determine if we have demos + [code, idx] = test (name, "grabdemo"); + + ## Demos to the main text + demo_text = ""; + if (length (idx) > 1) + + outdir = fileparts (outname); + imagedir = "images"; + full_imagedir = fullfile (outdir, imagedir); + num_demos = length (idx) - 1; + demo_num = 0; + + for k = 1:num_demos + + ## Run demo + code_k = code (idx (k):idx (k+1)-1); + + try + [output, images] = get_output (code_k, imagedir, full_imagedir, name); + catch + lasterr () + continue; + end_try_catch + + has_text = ! isempty (output); + has_images = ! isempty (images); + + if (length (images) > 1) + ft = "s"; + else + ft = ""; + endif + + ## Create text + demo_num ++; + + demo_header = "\\begin{demo}\\centering\n"; + demo_footer = "\\end{demo}\n"; + + demo_out_header = "\\begin{demoout}\\centering\n"; + demo_out_footer = "\\end{demoout}\n"; + + fig_header = "\\begin{figure}\\centering\n"; + fig_footer = "\\end{figure}\n"; + + demo_label = sprintf ("\\label{fig:%s_demo_%d}\n", name, demo_num); + demo_caption = sprintf ("\\caption{Demo number %d for function %s}\n", demo_num, __ec__ (name)); + + output_label = sprintf ("\\label{fig:%s_output_%d}\n", name, demo_num); + output_caption = sprintf ("\\caption{Output from demo number %d for function %s}\n", demo_num, __ec__ (name)); + + figure_label = sprintf ("\\label{fig:%s_figure_%d}\n", name, demo_num); + figure_caption = sprintf ("\\caption{Figure%s produced by demo number %d for function %s}\n", ft, demo_num, __ec__ (name)); + + indx = 1; + demo_k {indx++} = strcat ("\n\n\n", demo_header, "\\begin{verbatim}\n", code_k, "\n\\end{verbatim}\n", demo_caption, demo_label, demo_footer); + + if (has_text) + + demo_k {indx++} = sprintf ("\n\n%s\n%s\n%s\n%s\n%s\n\n", + demo_out_header, output, + output_caption, output_label, demo_out_footer); + endif + + if (has_images) + + imgtxt = sprintf ("\\includegraphics[width=.7\\linewidth]{%s%s%s}\n", "function", filesep (), images {:}); + demo_k {indx++} = strcat (fig_header, imgtxt, figure_caption, figure_label, fig_footer); + + endif + + demo_text = strcat (demo_text, demo_k {:}); + + endfor + + endif + + ## Write result to disk + fid = fopen (outname, "w"); + + if (fid < 0) + error ("latex_help_text: could not open '%s' for writing", outname); + endif + + fprintf (fid, "%s\n%s\n%s\n%s\\clearpage\n", header, text, footer, demo_text); + fclose (fid); + + endif + +endfunction + +function expanded = latex_see_also_with_prefix (prefix, root, varargin) + header = "\n"; + footer = "\n"; + + format = sprintf ("%%s", prefix); + + varargin2 = cell (1, 2*length (varargin)); + varargin2 (1:2:end) = varargin; + varargin2 (2:2:end) = varargin; + + list = sprintf (format, varargin2 {:}); + + expanded = strcat (header, list, footer); +endfunction + +function [text, images] = get_output (code, imagedir, full_imagedir, fileprefix) + ## Clear everything + close all + diary_file = "__diary__.txt"; + if (exist (diary_file, "file")) + delete (diary_file); + endif + + unwind_protect + ## Setup figure and pager properties + def = get (0, "defaultfigurevisible"); + set (0, "defaultfigurevisible", "off"); + more_val = page_screen_output (false); + + ## Evaluate the code + diary (diary_file); + eval (code); + diary ("off"); + + ## Read the results + fid = fopen (diary_file, "r"); + diary_data = char (fread (fid).'); + fclose (fid); + + ## Remove 'diary ("off");' from the diary + idx = strfind (diary_data, "diary (\"off\");"); + if (isempty (idx)) + text = diary_data; + else + text = diary_data (1:idx (end)-1); + endif + text = strtrim (text); + + ## Save figures + if (!isempty (get (0, "currentfigure")) && !exist (full_imagedir, "dir")) + mkdir (full_imagedir); + endif + + images = {}; + while (!isempty (get (0, "currentfigure"))) + fig = gcf (); + r = round (1000*rand ()); + name = sprintf ("%s_%d.png", fileprefix, r); + full_filename = fullfile (full_imagedir, name); + filename = fullfile (imagedir, name); + print (fig, full_filename); + images {end+1} = filename; + close (fig); + endwhile + + ## Reverse image list, since we got them latest-first + images = images (end:-1:1); + + unwind_protect_cleanup + delete (diary_file); + set (0, "defaultfigurevisible", def); + page_screen_output (more_val); + end_unwind_protect +endfunction +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/private/get_header_title_and_footer.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,34 @@ +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +function [header, title, footer] = get_header_title_and_footer (options, name = "", root = "") + + if (isfield (options, "header")) + header = options.header; + else + header = "\\begin{verbatim}\n"; + endif + + header = strrep (header, "%root", root); + title = ""; + + if (isfield (options, "footer")) + footer = options.footer; + else + footer = "\\end{verbatim}\n"; + endif + +endfunction
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/private/get_main_filename.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,29 @@ +## Copyright (C) 2012 Carlo de Falco +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +## THIS FUNCTION SHOULD BE private + +function overview_filename = get_main_filename (options, name) + if (isfield (options, "overview_filename")) + overview_filename = options.overview_filename; + overview_filename = strrep (overview_filename, "%name", name); + else + overview_filename = sprintf ("manual.tex", name); + endif + + overview_filename = strrep (overview_filename, " ", "_"); +endfunction
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/private/get_main_header_title_and_footer.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,63 @@ +## Copyright (C) 2012 Carlo de Falco +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +function [header, title, footer] = get_main_header_title_and_footer (options, name, root = "") + if (isfield (options, "main_header")) + header = options.main_header; + elseif (isfield (options, "header")) + header = options.header; + else + header = "<html><head><title></title><head><body>"; + endif + + if (isfield (options, "css")) + header = strrep (header, "%css", options.css); + endif + + header = strrep (header, "%root", root); + if (isfield (options, "pack_body_cmd")) + header = strrep (header, "%body_command", options.pack_body_cmd); + elseif (isfield (options, "body_command")) + header = strrep (header, "%body_command", options.body_command); + endif + + if (isfield (options, "main_title")) + title = options.main_title; + elseif (isfield (options, "title")) + title = options.title; + else + title = "List of Functions for the '%name' package"; + endif + title = strrep (title, "%name", name); + title_start_idx = strfind (lower (header), "<title>"); + title_stop_idx = strfind (lower (header), "</title>"); + if (!isempty (title_start_idx) && !isempty (title_stop_idx)) + header = sprintf ("%s<title>%s%s", header (1:title_start_idx-1), title, + header (title_stop_idx:end)); + else + header = strrep (header, "%title", title); + endif + + ## Write footer of main page + if (isfield (options, "main_footer")) + footer = options.main_footer; + elseif (isfield (options, "footer")) + footer = options.footer; + else + footer = "</body></html>"; + endif +endfunction
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/extra/generate_latex/inst/private/mk_function_dir.m Sun Mar 25 22:57:18 2012 +0000 @@ -0,0 +1,32 @@ +## Copyright (C) 2008 Soren Hauberg +## +## This program is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## This program is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +function [location, full_location] = mk_function_dir (outdir, options) + if (isfield (options, "function_dir")) + location = options.function_dir; + else + location = "function"; + endif + + full_location = fullfile (outdir, location); + %location = strcat (outdir, "/", location); + + ## Create output directory if needed + if (!exist (full_location, "dir")) + mkdir (full_location); + endif + +endfunction