Mercurial > forge
changeset 12516:5f0efa033fab octave-forge
maint: moved generate_html to individual hg repository.
| author | carandraug |
|---|---|
| date | Sun, 17 Aug 2014 18:55:51 +0000 |
| parents | ac9b1d7fb7b2 |
| children | dca94127b8c5 |
| files | extra/generate_html/COPYING extra/generate_html/DESCRIPTION extra/generate_html/INDEX extra/generate_html/NEWS extra/generate_html/inst/generate_alphabet.m extra/generate_html/inst/generate_html_manual.m extra/generate_html/inst/generate_operators.m extra/generate_html/inst/generate_package_html.m extra/generate_html/inst/get_html_options.m extra/generate_html/inst/html_help_text.m extra/generate_html/inst/private/find_package.m extra/generate_html/inst/private/get_alpha_database.m extra/generate_html/inst/private/get_header_title_and_footer.m extra/generate_html/inst/private/get_index_header_title_and_footer.m extra/generate_html/inst/private/get_overview_filename.m extra/generate_html/inst/private/get_overview_header_title_and_footer.m extra/generate_html/inst/private/get_pkg_list_item_filename.m extra/generate_html/inst/private/get_root.m extra/generate_html/inst/private/get_texi_conf.m extra/generate_html/inst/private/get_txi_files.m extra/generate_html/inst/private/mk_chapter_dir.m extra/generate_html/inst/private/mk_function_dir.m extra/generate_html/inst/private/mk_various_dir.m extra/generate_html/inst/private/octave_forge_seealso.m extra/generate_html/inst/texi2html.m extra/generate_html/inst/txi2index.m extra/generate_html/inst/txi2reference.m |
| diffstat | 27 files changed, 0 insertions(+), 2990 deletions(-) [+] |
line wrap: on
line diff
--- a/extra/generate_html/COPYING Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,674 +0,0 @@ - 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>.
--- a/extra/generate_html/DESCRIPTION Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -Name: generate_html -Version: 0.1.5 -Date: 2012-10-12 -Author: Søren Hauberg <soren@hauberg.org> -Maintainer: Octave-Forge community <octave-dev@lists.sourceforge.net> -Title: Generate HTML web page from help texts -Description: This package provides functions for generating HTML pages that - contain the help texts for a set of functions. The package is designed to be - as general as possible, but also contains convenience functions for generating - a set of pages for entire packages. -Depends: octave (>= 3.2.0) -SystemRequirements: makeinfo [Debian] texinfo -License: GPLv3+
--- a/extra/generate_html/INDEX Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,12 +0,0 @@ -generate_html >> Generate HTML web page from help texts -Single function functions - html_help_text -Package functions - generate_package_html - get_html_options - generate_html_manual -Utility Functions - txi2index - txi2reference - texi2html -
--- a/extra/generate_html/NEWS Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ - ** Support including NEWS and prepared package documentation in html. - -Summary of important user-visible changes for generate_html 0.1.5: -------------------------------------------------------------------- - - ** Updated link for the Octave Forge SVN repository. - -Summary of important user-visible changes for generate_html 0.1.4: -------------------------------------------------------------------- - - ** HTML pages with documentation of each function now mention the - package that the function belongs too and have a link for the - package main page. - - ** Autoload field when generating a package index.html page is now - correct. - - ** keywords on the `See also:' will be interpreted properly (rather - than just function names).
--- a/extra/generate_html/inst/generate_alphabet.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_alphabet (@var{directory}, @var{data_file}, @ -## @var{root}, @var{options}) -## @end deftypefn - -function generate_alphabet (directory, data_file, root, options = struct ()) - ## Check input - if (!ischar (directory)) - error ("generate_alphabet: first input argument must be a string"); - endif - - if (!ischar (data_file)) - error ("generate_alphabet: second input argument must be a string"); - endif - - if (!ischar (root)) - error ("generate_alphabet: third input argument must be a string"); - endif - - ## If options is a string, call get_html_options - if (ischar (options)) - options = get_html_options (options); - elseif (!isstruct (options)) - error ("generate_alphabet: fourth input argument must be a string or a structure"); - endif - - ## Load data - data = load (data_file); - data = data.functions; - - ## Sort data - data = sort (data); - - ## Convert data to lower case but also keep the original in memory - ldata = lower (data); - - ## Iterate over each function - ## First we find the first function that starts with 'a' - for a = 1:length (data) - if (ldata {a}(1) >= "a") - break; - endif - endfor - - ## Then we iterate over each function until we get something that doesn't start with 'z' - current = data {a}(1); - [fid, footer] = new_file (directory, current, options); - for idx = a:length (data) - ## Are we still working on the same file - if (ldata {idx}(1) != current) - fprintf (fid, "</div\n%s", footer); - fclose (fid); - current = ldata {idx}(1); - [fid, footer] = new_file (directory, current, options); - endif - - ## Write the actual function to the file - fun = data {idx}; - fprintf (fid, "<div class=\"func\"><b><a href=\"%s/function/%s.html\">%s</a></b></div>\n", - root, fun, fun); - try - sentence = get_first_help_sentence (fun, 200); - catch - warning ("Marking '%s' as not implemented", fun); - sentence = "Not implemented"; - end_try_catch - fprintf (fid, "<div class=\"ftext\">%s</div>\n", sentence); - endfor - - fprintf (fid, "</div\n%s", footer); - fclose (fid); -endfunction - -function [fid, footer] = new_file (directory, current, options) - current = upper (current); - filename = fullfile (directory, sprintf ("%s.html", current)); - fid = fopen (filename, "w"); - if (fid <= 0) - error ("generate_alphabet: could not open '%s' for writing", filename); - endif - - options.body_command = 'onload="javascript:fix_top_menu (); javascript:alphabetical_menu ();"'; - title = sprintf ("Alphabetical List of Functions: %s", current); - [header, title, footer] = get_overview_header_title_and_footer (options, title, "../"); - - fprintf (fid, "%s\n", header); - fprintf (fid, "<h2><a name=\"%s\">%s</a></h2>\n<div>\n", current, current); -endfunction -
--- a/extra/generate_html/inst/generate_html_manual.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,148 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_html_manual (@var{srcdir}, @var{outdir}) -## @end deftypefn - -function generate_html_manual (srcdir, outdir = "htdocs", options = struct ()) - ## Check input - if (nargin == 0) - print_usage (); - endif - - if (!ischar (srcdir)) - error ("generate_html_manual: first input argument must be a string"); - endif - - if (!ischar (outdir)) - error ("generate_html_manual: second input argument must be a string"); - endif - - ## If options is a string, call get_html_options - if (ischar (options)) - options = get_html_options (options); - elseif (!isstruct (options)) - error ("generate_html_manual: third input argument must be a string or a structure"); - endif - - ## Create directories - if (!exist (outdir, "dir")) - mkdir (outdir); - endif - %outdir = fullfile (outdir, "octave"); - %if (!exist (outdir, "dir")) - % mkdir (outdir); - %endif - - %chapter_dir = mk_chapter_dir (outdir, options); - %mk_function_dir (outdir, options); - % - %ds_handler = @(fun) docstring_handler (fun); - - ## Get file list - %file_list = get_txi_files (srcdir); - %txi_dir = fileparts (file_list {1}); - % - %texi_header = sprintf ("%s\n", get_texi_conf (srcdir)); - - ## Copy images from Octave build - %txi_dir = fullfile (srcdir, "doc", "interpreter"); - %pngs = fullfile (txi_dir, "*.png"); - %copyfile (pngs, "."); - - ## Set javascript startup - %if (!isfield (options, "body_command")) - % if (isfield (options, "manual_body_cmd")) - % options.body_command = options.manual_body_cmd; - % else - % options.body_command = ""; # XXX: do we need this? - % endif - %endif - - ## Process each file - %for k = 1:length (file_list) - % file = file_list {k}; - % [notused, name] = fileparts (file); - % - % text = txi2reference (file, ds_handler); - % - % text = strcat (texi_header, text); - % - % ## Remove numbers from headings as this has been broken since we handle - % ## each chapter as a seperate file - % text = strrep (text, "@chapter", "@unnumbered"); - % text = strrep (text, "@appendix", "@unnumbered"); - % text = strrep (text, "@section", "@unnumberedsec"); - % text = strrep (text, "@subsection", "@unnumberedsubsec"); - % text = strrep (text, "@subsubsection", "@unnumberedsubsubsec"); - % - % ## Make sure any @include's work - % include = "@include "; - % include_with_path = sprintf ("@include %s%s", txi_dir, filesep ()); - % text = strrep (text, include, include_with_path); - % - % ## Add 'op' index - % text = strcat ("@defindex op\n\n", text); - % - % ## Convert to HTML and write to disc - % [header, body, footer] = texi2html (text, options, "../../"); - % - % fid = fopen (fullfile (chapter_dir, sprintf ("%s.html", name)), "w"); - % fprintf (fid, "%s\n%s\n%s\n", header, body, footer); - % fclose (fid); - %endfor - - ## Move images into the chapter dir - %movefile ("*.png", chapter_dir); - - ################################################### - ## Generate reference for individual functions ## - ################################################### - - ## Get INDEX structure - indices = txi2index (srcdir); - index = struct (); - index.provides = {}; - index.name = "octave"; - index.description = "GNU Octave comes with a large set of general-prupose functions that are listed below. This is the core set of functions that is available without any packages installed."; - for k = 1:length (indices) - if (!isempty (indices {k})) - ikp = indices {k}.provides; - index.provides (end+1:end+length (ikp)) = ikp; - endif - endfor - - ## Generate the documentation - options.include_package_list_item = false; - options.include_package_page = false; - options.include_package_license = false; - - generate_package_html (index, outdir, options); - %for k = 1:length (index) - % if (!isempty (index {k})) - % printf ("Chapter: %s\n", index {k}.name); fflush (stdout); - % index {k}.name = ""; # remove the name to avoid each chapter having its own dir - % generate_package_html (index {k}, outdir, options); - % endif - %endfor -endfunction - -function retval = docstring_handler (fun) - retval = sprintf ("@ifhtml\n@html\n<div class='seefun'>See <a href='../function/%s.html'>%s</a></div>\n@end html\n@end ifhtml\n", - fun, fun); -endfunction -
--- a/extra/generate_html/inst/generate_operators.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,127 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_operators (@var{outdir}, @var{options}) -## Generate a HTML page with a list of operators available in GNU Octave. -## @end deftypefn - -function generate_operators (outdir = "htdocs", options = struct ()) - ## Check input - if (!ischar (outdir)) - error ("generate_operators: first input argument must be a string"); - endif - - ## If options is a string, call get_html_options - if (ischar (options)) - options = get_html_options (options); - elseif (!isstruct (options)) - error ("generate_operators: second input argument must be a string or a structure"); - endif - - ## Create directories if needed - if (!exist (outdir, "dir")) - mkdir (outdir); - endif - name = fullfile (outdir, "operators.html"); - - ## Generate html - title = "Operators and Keywords"; - options.body_command = 'onload="javascript:fix_top_menu ();"'; - [header, title, footer] = get_overview_header_title_and_footer (options, title); - - fid = fopen (name, "w"); - if (fid < 0) - error ("generate_operators: couldn't open file for writing"); - endif - - fprintf (fid, "%s\n", header); - - fprintf (fid, "<h2 class=\"tbdesc\">Operators</h2>\n\n"); - write_list (__operators__, fid, false); - - fprintf (fid, "<h2 class=\"tbdesc\">Keywords</h2>\n\n"); - write_list (__keywords__, fid, true); - - fprintf (fid, "\n%s\n", footer); - fclose (fid); -endfunction - -function write_list (list, fid, write_anchors) - for k = 1:length (list) - elem = list {k}; - [text, format] = get_help_text (elem); - if (strcmp (format, "texinfo")) - text = strip_defs (text); - text = __makeinfo__ (text, "plain text"); - endif - if (write_anchors) - fprintf (fid, "<a name=\"%s\">\n", elem); - endif - fprintf (fid, "<div class=\"func\"><b>%s</b></div>\n", elem); - fprintf (fid, "<div class=\"ftext\">%s</div>\n", text); # XXX: don't use text - if (write_anchors) - fprintf (fid, "</a>\n\n"); - endif - endfor -endfunction - -function text = strip_defs (text) - ## Lines ending with "@\n" are continuation lines, so they should be concatenated - ## with the following line. - text = strrep (text, "@\n", " "); - - ## Find, and remove, lines that start with @def. This should remove things - ## such as @deftypefn, @deftypefnx, @defvar, etc. - keep = true (size (text)); - def_idx = strfind (text, "@def"); - if (!isempty (def_idx)) - endl_idx = find (text == "\n"); - for k = 1:length (def_idx) - endl = endl_idx (find (endl_idx > def_idx (k), 1)); - if (isempty (endl)) - keep (def_idx (k):end) = false; - else - keep (def_idx (k):endl) = false; - endif - endfor - - ## Remove the @end ... that corresponds to the @def we removed above - def1 = def_idx (1); - space_idx = find (text == " "); - space_idx = space_idx (find (space_idx > def1, 1)); - bracket_idx = find (text == "{" | text == "}"); - bracket_idx = bracket_idx (find (bracket_idx > def1, 1)); - if (isempty (space_idx) && isempty (bracket_idx)) - error ("generate_operators: couldn't parse texinfo"); - endif - sep_idx = min (space_idx, bracket_idx); - def_type = text (def1+1:sep_idx-1); - - end_idx = strfind (text, sprintf ("@end %s", def_type)); - if (isempty (end_idx)) - error ("generate_operators: couldn't parse texinfo"); - endif - endl = endl_idx (find (endl_idx > end_idx, 1)); - if (isempty (endl)) - keep (end_idx:end) = false; - else - keep (end_idx:endl) = false; - endif - - text = text (keep); - endif -endfunction
--- a/extra/generate_html/inst/generate_package_html.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,577 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_html (@var{name}, @var{outdir}, @var{options}) -## Generate @t{HTML} documentation for a package. -## -## The function reads information about package @var{name} using the -## package system. This is then used to generate bunch of -## @t{HTML} files; one for each function in the package, and one overview -## page. 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 web pages. -## -## As an example, the following code generates the web pages for the @t{image} -## package, with a design suitable for the @t{Octave-Forge} project. -## -## @example -## options = get_html_options ("octave-forge"); -## generate_package_html ("image", "image_html", options); -## @end example -## -## The resulting files will be available in the @t{"image_html"} directory. The -## overview page will be called @t{"image_html/overview.html"}. -## -## 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_html ("image", "image_html", "octave-forge"); -## @end example -## -## If you want to include prepared package documentation in html format, -## you have to set @var{options}.package_doc manually with the filename -## of its texinfo source, which must be in the packages "doc" directory. -## Contained images are automatically copied if they are at the paths -## specified in the texinfo source relative to the packages "doc" -## directory. -## -## It should be noted that the function only works for installed packages. -## @seealso{get_html_options} -## @end deftypefn - -function generate_package_html (name = [], outdir = "htdocs", options = struct ()) - ## Check input - if (isempty (name)) - list = pkg ("list"); - for k = 1:length (list) - generate_package_html (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_html: 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_html: 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_html_options - if (ischar (options)) - options = get_html_options (options); - elseif (!isstruct (options)) - error ("generate_package_html: third input argument must be a string or a structure"); - endif - - ################################################## - ## Generate html pages for individual functions ## - ################################################## - - ## Set javascript startup - if (!isfield (options, "body_command")) - if (isfield (options, "pack_body_cmd")) - options.body_command = options.pack_body_cmd; - else - options.body_command = ""; - endif - endif - - 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.html", fun)); - try - html_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 overview file ## - ######################### - first_sentences = cell (1, num_categories); - if (isfield (options, "include_overview") && options.include_overview) - overview_filename = get_overview_filename (options, desc.name); - - fid = fopen (fullfile (packdir, overview_filename), "w"); - if (fid < 0) - error ("generate_package_html: couldn't open overview file for writing"); - endif - - [header, title, footer] = get_overview_header_title_and_footer (options, desc.name, "../"); - - fprintf (fid, "%s\n", header); - fprintf (fid, "<h2 class=\"tbdesc\">%s</h2>\n\n", desc.name); - - fprintf (fid, " <div class=\"package_description\">\n"); - fprintf (fid, " %s\n", desc.description); - fprintf (fid, " </div>\n\n"); - - fprintf (fid, "<p>Select category: <select name=\"cat\" onchange=\"location = this.options[this.selectedIndex].value;\">\n"); - for k = 1:num_categories - category = desc.provides {k}.category; - fprintf (fid, " <option value=\"#%s\">%s</option>\n", anchors {k}, category); - endfor - fprintf (fid, " </select></p>\n\n"); - - ## Generate function list by category - for k = 1:num_categories - F = desc.provides {k}.functions; - category = desc.provides {k}.category; - fprintf (fid, " <h3 class=\"category\"><a name=\"%s\">%s</a></h3>\n\n", - anchors {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.html", local_fundir, fun); - fprintf (fid, " <div class=\"func\"><b><a href=\"%s\">%s</a></b></div>\n", - link, fun); - fprintf (fid, " <div class=\"ftext\">%s</div>\n\n", first_sentences {k}{l}); - else - fprintf (fid, " <div class=\"func\"><b>%s</b></div>\n", fun); - fprintf (fid, " <div class=\"ftext\">Not implemented.</div>\n\n"); - endif - endfor - endfor - - fprintf (fid, "\n%s\n", footer); - fclose (fid); - endif - - ################################################ - ## Write function data for alphabetical lists ## - ################################################ - if (isfield (options, "include_alpha") && options.include_alpha) - for letter = "a":"z" - [name_filename, desc_filename] = get_alpha_database (outdir, desc.name, letter); - name_fid = fopen (name_filename, "w"); - desc_fid = fopen (desc_filename, "w"); - if (name_fid == -1 || desc_fid == -1) - error ("generate_package_html: could not open alphabet database for writing"); - endif - - for k = 1:num_categories - F = desc.provides {k}.functions; - for l = 1:length (F) - fun = F {l}; - if (implemented {k}{l} && lower (fun (1)) == letter) - fs = first_sentences {k}{l}; - - fprintf (name_fid, "%s\n", fun); - fprintf (desc_fid, "%s\n", fs); - endif - endfor - endfor - - fclose (name_fid); - fclose (desc_fid); - endfor - endif - - ##################################################### - ## Write short description for forge overview page ## - ##################################################### - - if (isfield (options, "include_package_list_item") && options.include_package_list_item) - pkg_list_item_filename = get_pkg_list_item_filename (desc.name, outdir); - - text = strrep (options.package_list_item, "%name", desc.name); - text = strrep (text, "%version", desc.version); - text = strrep (text, "%extension", "tar.gz"); - text = strrep (text, "%shortdescription", desc.description); - - fid = fopen (pkg_list_item_filename, "w"); - if (fid > 0) - fprintf (fid, text); - fclose (fid); - else - error ("generate_package_html: unable to open file %s.", pkg_list_item_filename); - endif - endif - - ###################### - ## Write index file ## - ###################### - if (isfield (options, "include_package_page") && options.include_package_page) - ## 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_html: couldn't locate package '%s'", packname); - endif - - if (isfield (options, "package_doc")) - write_package_documentation = true; - [~, doc_fn, doc_ext] = fileparts (options.package_doc); - doc_root_dir = fullfile (list.dir, "doc"); - doc_src = fullfile (doc_root_dir, [doc_fn, doc_ext]); - doc_subdir = "package_doc"; - doc_out_dir = fullfile (packdir, doc_subdir); - else - write_package_documentation = false; - endif - - ## Open output file - index_filename = "index.html"; - - fid = fopen (fullfile (packdir, index_filename), "w"); - if (fid < 0) - error ("generate_package_html: couldn't open index file for writing"); - endif - - ## Write output - [header, title, footer] = get_index_header_title_and_footer (options, desc.name, "../"); - - fprintf (fid, "%s\n", header); - fprintf (fid, "<h2 class=\"tbdesc\">%s</h2>\n\n", desc.name); - - fprintf (fid, "<table>\n"); - fprintf (fid, "<tr><td rowspan=\"2\" class=\"box_table\">\n"); - fprintf (fid, "<div class=\"package_box\">\n"); - fprintf (fid, " <div class=\"package_box_header\"></div>\n"); - fprintf (fid, " <div class=\"package_box_contents\">\n"); - fprintf (fid, " <table>\n"); - fprintf (fid, " <tr><td class=\"package_table\">Package Version:</td><td>%s</td></tr>\n", - list.version); - fprintf (fid, " <tr><td class=\"package_table\">Last Release Date:</td><td>%s</td></tr>\n", - list.date); - fprintf (fid, " <tr><td class=\"package_table\">Package Author:</td><td>%s</td></tr>\n", - list.author); - fprintf (fid, " <tr><td class=\"package_table\">Package Maintainer:</td><td>%s</td></tr>\n", - list.maintainer); - fprintf (fid, " <tr><td class=\"package_table\">License:</td><td><a href=\"COPYING.html\">"); - if (isfield (list, "license")) - fprintf (fid, "%s</a></td></tr>\n", list.license); - else - fprintf (fid, "Read license</a></td></tr>\n"); - endif - fprintf (fid, " </table>\n"); - fprintf (fid, " </div>\n"); - fprintf (fid, "</div>\n"); - fprintf (fid, "</td>\n\n"); - - fprintf (fid, "<td>\n"); - if (isfield (options, "download_link")) - fprintf (fid, "<div class=\"download_package\">\n"); - fprintf (fid, " <table><tr><td>\n"); - fprintf (fid, " <img src=\"../download.png\"/>\n"); - fprintf (fid, " </td><td>\n"); - link = strrep (options.download_link, "%name", desc.name); - link = strrep (link, "%version", desc.version); - fprintf (fid, " <a href=\"%s\"\n", link); - fprintf (fid, " class=\"download_link\">\n"); - fprintf (fid, " Download Package\n"); - fprintf (fid, " </a><br>\n"); - fprintf (fid, " <a href=\"http://sourceforge.net/projects/octave/files/\""); - fprintf (fid, " class=\"older_versions_download\">(older versions)</a>\n"); - fprintf (fid, " </td></tr></table>\n"); - fprintf (fid, "</div>\n"); - endif - fprintf (fid, "</td></tr>\n"); - fprintf (fid, "<tr><td>\n"); - fprintf (fid, "<div class=\"package_function_reference\">\n"); - fprintf (fid, " <table><tr><td>\n"); - fprintf (fid, " <img src=\"../doc.png\"/>\n"); - fprintf (fid, " </td><td>\n"); - fprintf (fid, " <a href=\"%s\" class=\"function_reference_link\">\n", overview_filename); - fprintf (fid, " Function Reference\n"); - fprintf (fid, " </a>\n"); - fprintf (fid, " </td></tr></table>\n"); - fprintf (fid, "</div>\n"); - fprintf (fid, "<div class=\"news_file\">\n"); - fprintf (fid, " <table><tr><td>\n"); - fprintf (fid, " </td><td>\n"); - fprintf (fid, " <a href=\"NEWS.html\" class=\"news_file\">\n"); - fprintf (fid, " NEWS\n"); - fprintf (fid, " </a>\n"); - fprintf (fid, " </td></tr></table>\n"); - fprintf (fid, "</div>\n"); - if (write_package_documentation) - fprintf (fid, "<div class=\"package_doc\">\n"); - fprintf (fid, " <table><tr><td>\n"); - fprintf (fid, " </td><td>\n"); - fprintf (fid, " <a href=\"%s\" class=\"package_doc\">\n", - fullfile (doc_subdir, "index.html")); - fprintf (fid, " Package Documentation\n"); - fprintf (fid, " </a>\n"); - fprintf (fid, " </td></tr></table>\n"); - fprintf (fid, "</div>\n"); - endif - fprintf (fid, "</td></tr>\n"); - fprintf (fid, "</table>\n\n"); - - fprintf (fid, "<h3>Description</h3>\n"); - fprintf (fid, " <div id=\"description_box\">\n") - fprintf (fid, list.description); - fprintf (fid, " </div>\n\n") - - fprintf (fid, "<h3>Details</h3>\n"); - fprintf (fid, " <table id=\"extra_package_table\">\n"); - - if (isfield (list, "depends")) - fprintf (fid, " <tr><td>Dependencies: </td><td>\n"); - for k = 1:length (list.depends) - p = 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) ", o, v); - else - vt = ""; - endif - - if (strcmpi (p, "octave")) - fprintf (fid, "<a href=\"http://www.octave.org\">Octave</a> "); - else - fprintf (fid, "<a href=\"../%s/index.html\">%s</a> ", p, p); - endif - fprintf (fid, vt); - endfor - fprintf (fid, "</td></tr>\n"); - endif - - if (isfield (list, "buildrequires")) - fprintf (fid, " <tr><td>Build Dependencies:</td><td>%s</td></tr>\n", list.buildrequires); - endif - - ## if the package does not specify, then it is not autoloaded. Also, sometimes - ## the value is 1 (true) but other times the value is a string - if (isfield (list, "autoload") && (list.autoload == 1 || - any (strcmpi ({"yes", "on", "true"}, list.autoload)))) - a = "Yes"; - else - a = "No"; - endif - fprintf (fid, " <tr><td>Autoload:</td><td>%s</td></tr>\n", a); - - fprintf (fid, " </table>\n\n"); - - fprintf (fid, "\n%s\n", footer); - fclose (fid); - endif - - ###################### - ## 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_html: 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_html: couldn't open license for reading"); - endif - contents = char (fread (fid).'); - fclose (fid); - - ## Open output file - copying_filename = "COPYING.html"; - - fid = fopen (fullfile (packdir, copying_filename), "w"); - if (fid < 0) - error ("generate_package_html: couldn't open COPYING file for writing"); - endif - - ## Write output - [header, title, footer] = get_index_header_title_and_footer (options, desc.name, "../"); - - fprintf (fid, "%s\n", header); - fprintf (fid, "<h2 class=\"tbdesc\">License for '%s' Package</h2>\n\n", desc.name); - fprintf (fid, "<p><a href=\"index.html\">Return to the '%s' package</a></p>\n\n", desc.name); - - fprintf (fid, "<pre>%s</pre>\n\n", contents); - - fprintf (fid, "\n%s\n", footer); - fclose (fid); - endif - - ##################### - ## Write NEWS file ## - ##################### - if (isfield (options, "include_package_news") && options.include_package_news) - ## 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_html: couldn't locate package '%s'", packname); - endif - - ## Read news - filename = fullfile (list.dir, "packinfo", "NEWS"); - fid = fopen (filename, "r"); - if (fid < 0) - error ("generate_package_html: couldn't open NEWS for reading"); - endif - contents = char (fread (fid).'); - fclose (fid); - - ## Open output file - news_filename = "NEWS.html"; - - fid = fopen (fullfile (packdir, news_filename), "w"); - if (fid < 0) - error ("generate_package_html: couldn't open NEWS file for writing"); - endif - - ## Write output - [header, title, footer] = get_index_header_title_and_footer (options, desc.name, "../"); - - fprintf (fid, "%s\n", header); - fprintf (fid, "<h2 class=\"tbdesc\">NEWS for '%s' Package</h2>\n\n", desc.name); - fprintf (fid, "<p><a href=\"index.html\">Return to the '%s' package</a></p>\n\n", desc.name); - - fprintf (fid, "<pre>%s</pre>\n\n", contents); - - fprintf (fid, "\n%s\n", footer); - fclose (fid); - endif - - ################################# - ## Write package documentation ## - ################################# - if (write_package_documentation) - - ## Convert texinfo source - status = system (sprintf ("%s --html -o %s %s", - makeinfo_program (), - doc_out_dir, - doc_src)); - if (status == 127) - error ("program `%s' not found", makeinfo_program ()); - elseif (status) - error ("program `%s' returned failure code %i", - makeinfo_program (), status); - endif - - ## Read image references from generated files and copy images - filelist = glob (fullfile (doc_out_dir, "*")); - for id = 1 : numel (filelist) - copy_images (filelist{id}, doc_root_dir, doc_out_dir); - endfor - - endif - -endfunction - -function copy_images (file, doc_root_dir, doc_out_dir) - - if ((fid = fopen (file)) < 0) - error ("couldn't open %s for reading", file); - endif - while (! isnumeric (l = fgetl (fid))) - m = regexp (l, "<img.+src=""([^""]+)"".*>", "tokens"); - if (! isempty (m)) - url = m{1}{1}; - ## exclude external links - if (isempty (strfind (url, "//"))) - if (! isempty (strfind (url, ".."))) - warning ("not copying image %s because path contains '..'", - url); - else - if (! isempty (imgdir = fileparts (url)) && - ! strcmp (imgdir, "./") && - ! exist (imgoutdir = fullfile (doc_out_dir, imgdir), "dir")) - mkdir (imgoutdir); - endif - if (! ([status, msg] = copyfile (fullfile (doc_root_dir, url), - fullfile (doc_out_dir, url)))) - warning ("could not copy image file %s: %s", url, msg); - endif - endif - endif - endif - endwhile - fclose (fid); - -endfunction
--- a/extra/generate_html/inst/get_html_options.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,205 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_html_options (@var{project_name}) -## Returns a structure containing design options for various project web sites. -## -## Given a string @var{project_name}, the function returns a structure containing -## various types of information for generating web pages for the specified project. -## Currently, the accepted values of @var{project_name} are -## -## @table @t -## @item "octave-forge" -## Design corresponding to the pages at @t{http://octave.sf.net}. -## -## @item "octave" -## Design corresponding to the pages at @t{http://octave.org}. The pages are -## meant to be processed with the @code{m4} preprocessor, using the macros for -## the site. -## -## @item "docbrowser" -## Design corresponding to the pages in the documentation browser. -## @end table -## @seealso{generate_package_html, html_help_text} -## @end deftypefn - -function options = get_html_options (project_name) - ## Check input - if (nargin == 0) - error ("get_html_options: not enough input arguments"); - endif - - if (!ischar (project_name)) - error ("get_html_options: first input argument must be a string"); - endif - - ## Generate options depending on project - switch (lower (project_name)) - case "octave-forge" - ## Basic HTML header - hh = "\ -<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n\ - \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n\ -<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">\n\ - <head>\n\ - <meta http-equiv=\"content-type\" content=\"text/html; charset=iso-8859-1\" />\n\ - <meta name=\"date\" content=\"%date\"/>\n\ - <meta name=\"author\" content=\"The Octave-Forge Community\" />\n\ - <meta name=\"description\" content=\"Octave-Forge is a collection of packages\ - providing extra functionality for GNU Octave.\" />\n\ - <meta name=\"keywords\" lang=\"en\" content=\"Octave-Forge, Octave, extra packages\" />\n\ - <title>%title</title>\n\ - <link rel=\"stylesheet\" type=\"text/css\" href=\"%root%css\" />\n\ - <script src=\"%rootfixed.js\" type=\"text/javascript\"></script>\n\ - <script src=\"%rootjavascript.js\" type=\"text/javascript\"></script>\n\ - <link rel=\"shortcut icon\" href=\"%rootfavicon.ico\" />\n\ - </head>\n\ - <body %body_command>\n\ - <div id=\"top-menu\" class=\"menu\">\n\ - <table class=\"menu\">\n\ - <tr>\n\ - <td style=\"width: 90px;\" class=\"menu\" rowspan=\"2\">\n\ - <a name=\"top\">\n\ - <img src=\"%rootoct.png\" alt=\"Octave logo\" />\n\ - </a>\n\ - </td>\n\ - <td class=\"menu\" style=\"padding-top: 0.9em;\">\n\ - <big class=\"menu\">Octave-Forge</big><small class=\"menu\"> - Extra packages for GNU Octave</small>\n\ - </td>\n\ - </tr>\n\ - <tr>\n\ - <td class=\"menu\">\n\ -\n\ - <a href=\"%rootindex.html\" class=\"menu\">Home</a> ·\n\ - <a href=\"%rootpackages.php\" class=\"menu\">Packages</a> ·\n\ - <a href=\"%rootdevelopers.html\" class=\"menu\">Developers</a> ·\n\ - <a href=\"%rootdocs.html\" class=\"menu\">Documentation</a> ·\n\ - <a href=\"%rootFAQ.html\" class=\"menu\">FAQ</a> ·\n\ - <a href=\"%rootbugs.html\" class=\"menu\">Bugs</a> ·\n\ - <a href=\"%rootarchive.html\" class=\"menu\">Mailing Lists</a> ·\n\ - <a href=\"%rootlinks.html\" class=\"menu\">Links</a> ·\n\ - <a href=\"http://octave.sourceforge.net/code.html\" class=\"menu\">Code</a>\n\ -\n\ - </td>\n\ - </tr>\n\ - </table>\n\ - </div>\n\ -<div id=\"left-menu\">\n\ - <h3>Navigation</h3>\n\ - <p class=\"left-menu\"><a class=\"left-menu-link\" href=\"%rootoperators.html\">Operators and Keywords</a></p>\n\ - <p class=\"left-menu\"><a class=\"left-menu-link\" href=\"%rootfunction_list.html\">Function List:</a>\n\ - <ul class=\"left-menu-list\">\n\ - <li class=\"left-menu-list\">\n\ - <a class=\"left-menu-link\" href=\"%rootoctave/overview.html\">» Octave core</a>\n\ - </li>\n\ - <li class=\"left-menu-list\">\n\ - <a class=\"left-menu-link\" href=\"%rootfunctions_by_package.php\">» by package</a>\n\ - </li>\n\ - <li class=\"left-menu-list\">\n\ - <a class=\"left-menu-link\" href=\"%rootfunctions_by_alpha.php\">» alphabetical</a>\n\ - </li>\n\ - </ul>\n\ - </p>\n\ - <p class=\"left-menu\"><a class=\"left-menu-link\" href=\"%rootdoxygen/html\">C++ API</a></p>\n\ -</div>\n\ -<div id=\"doccontent\">\n"; - - ## CSS - options.css = "octave-forge.css"; - - ## Options for alphabetical lists - options.include_alpha = true; - - ## Options for individual function pages - options.pack_body_cmd = 'onload="javascript:fix_top_menu (); javascript:show_left_menu ();"'; - options.header = strrep (hh, "%date", date ()); - options.footer = "<p>Package: <a href=\"../index.html\">%package</a></p>\n<div id=\"sf_logo\">\n\ - <a href=\"http://sourceforge.net\">\ - <img src=\"http://sourceforge.net/sflogo.php?group_id=2888&type=1\"\ - width=\"88\" height=\"31\" style=\"border: 0;\" alt=\"SourceForge.net Logo\"/>\ - </a>\n</div>\n</div>\n</body>\n</html>\n"; - options.title = "Function Reference: %name"; - options.include_demos = true; - options.seealso = @octave_forge_seealso; - - ## Options for overview page - options.include_overview = true; - #options.overview_header = strrep (strrep (hh, "%date", date ()), "%body_command", ""); - options.manual_body_cmd = 'onload="javascript:fix_top_menu (); javascript:manual_menu ();"'; - - ## Options for package list page - options.include_package_list_item = true; - options.package_list_item = ... -"<div class=\"package\" id=\"%name\">\n\ -<table class=\"package\"><tr>\n\ -<td><b><a href=\"javascript:unfold('%name');\" class=\"package_head_link\">\n\ -<img src=\"show.png\" id=\"%name_im\" alt=\"show/hide\" style=\"padding-right: 0.5em; border: none;\"/> %name </a></b></td>\n\ -<td style=\"text-align: right;\">» <a href=\"./%name/index.html\" class=\"package_link\">details</a> |\n\ -<a class=\"package_link\" href=\"http://downloads.sourceforge.net/octave/%name-%version.%extension?download\">download</a></td>\n\ -</tr></table>\n\ -<p id=\"%name_detailed\" style=\"display: none;\"> %shortdescription </p>\n\ -</div>\n"; - - ## Options for index package - options.index_title = "The '%name' Package"; - options.download_link = "http://downloads.sourceforge.net/octave/%name-%version.tar.gz?download"; - options.include_package_page = true; - options.include_package_license = true; - options.include_package_news = true; - options.index_body_command = "onload=\"javascript:fix_top_menu ();\""; - - case "octave" - options.header = "__HEADER__(`%title')"; - options.footer = "__OCTAVE_TRAILER__"; - options.title = "Function Reference: %name"; - options.include_overview = true; - - case "docbrowser" - ## Basic HTML header - hh = "\ -<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n\ - \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n\ -<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">\n\ - <head>\n\ - <meta http-equiv=\"content-type\" content=\"text/html; charset=iso-8859-1\" />\n\ - <meta name=\"date\" content=\"%date\"/>\n\ - <meta name=\"author\" content=\"The Octave Community\" />\n\ - <title>%title</title>\n\ - <link rel=\"stylesheet\" type=\"text/css\" href=\"%css\" />\n\ - </head>\n\ -<body>\n\ -<div id=\"top\">Function Reference</div>\n\ -<div id=\"doccontent\">\n"; - hh = strrep (hh, "%date", date ()); - - ## Options for individual function pages - css = "doc.css"; - options.header = strrep (hh, "%css", css); - options.footer = "</div>\n</body>\n</html>\n"; - options.title = "Function: %name"; - options.include_demos = true; - - ## Options for overview page - options.include_overview = true; - options.overview_header = strrep (hh, "%css", sprintf ("../%s", css)); - options.overview_title = "Overview: %name"; - - otherwise - error ("get_html_options: unknown project name: %s", project_name); - endswitch - -endfunction
--- a/extra/generate_html/inst/html_help_text.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,249 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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} html_help_text (@var{name}, @var{outname}, @var{options}) -## Writes a function help text to disk formatted as @t{HTML}. -## -## The help text of the function @var{name} is written to the file @var{outname} -## formatted as @t{HTML}. The design of the generated @t{HTML} 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{HTML} header of the generated file. Through this -## things such as @t{CSS} style sheets can be set. -## @item footer -## This field contains the @t{HTML} footer of the generated file. This should -## match the @samp{header} field to ensure all opened tags get closed. -## @item title -## This field sets the title of the @t{HTML} page. This is enforced even if the -## @samp{header} field contains a title. -## @end table -## -## @var{options} structures for various projects can be with the @code{get_html_options} -## function. As a convenience, if @var{options} is a string, a structure will -## be generated by calling @code{get_html_options}. -## -## @seealso{get_html_options, generate_package_html} -## @end deftypefn - -function html_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_html_options - if (ischar (options)) - options = get_html_options (options); - endif - - ## Take action depending on help text format - switch (lower (format)) - case "plain text" - header = "<html><head><title></title></head><body>\n"; - text = sprintf ("<pre>%s</pre>\n", text); - footer = "</body></html>\n"; - - 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) html_see_also_with_prefix (root, args {:}); - endif - - ## Run makeinfo - [text, status] = __makeinfo__ (text, "html", seealso); - if (status != 0) - error ("html_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); - - ## Hack around 'makeinfo' bug that forgets to put <p>'s before function declarations - text = strrep (text, "—", "<p class=\"functionfile\">"); - - case "not found" - error ("html_help_text: `%s' not found\n", name); - otherwise - error ("html_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"); - if (length (idx) > 1) - ## Demos to the main text - demo_text = ""; - - 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 = "figures"; - else - ft = "figure"; - endif - - ## Create text - demo_num ++; - demo_header = sprintf ("<h2>Demonstration %d</h2>\n<div class=\"demo\">\n", demo_num); - demo_footer = "</div>\n"; - - demo_k {1} = "<p>The following code</p>\n"; - demo_k {2} = sprintf ("<pre class=\"example\">%s</pre>\n", code_k); - if (has_text && has_images) - demo_k {3} = "<p>Produces the following output</p>\n"; - demo_k {4} = sprintf ("<pre class=\"example\">%s</pre>\n", output); - demo_k {5} = sprintf ("<p>and the following %s</p>\n", ft); - demo_k {6} = sprintf ("<p>%s</p>\n", images_in_html (images)); - elseif (has_text) # no images - demo_k {3} = "<p>Produces the following output</p>\n"; - demo_k {4} = sprintf ("<pre class=\"example\">%s</pre>\n", output); - elseif (has_images) # no text - demo_k {3} = sprintf ("<p>Produces the following %s</p>\n", ft); - demo_k {6} = sprintf ("<p>%s</p>\n", images_in_html (images)); - else # neither text nor images - demo_k {3} = sprintf ("<p>gives an example of how '%s' is used.</p>\n", name); - endif - - demo_text = strcat (demo_text, demo_header, demo_k {:}, demo_footer); - endfor - - text = strcat (text, demo_text); - endif - endif - - ## Write result to disk - fid = fopen (outname, "w"); - if (fid < 0) - error ("html_help_text: could not open '%s' for writing", outname); - endif - fprintf (fid, "%s\n%s\n%s", header, text, footer); - fclose (fid); - -endfunction - -function expanded = html_see_also_with_prefix (prefix, root, varargin) - header = "@html\n<div class=\"seealso\">\n<b>See also</b>: "; - footer = "\n</div>\n@end html\n"; - - format = sprintf (" <a href=\"%s%%s.html\">%%s</a> ", 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 - -function text = images_in_html (images) - header = "<table class=\"images\">\n<tr>\n"; - footer = "</tr></table>\n"; - headers = sprintf ("<th class=\"images\">Figure %d</th>\n", 1:numel (images)); - ims = sprintf ("<td class=\"images\"><img src=\"%s\" class=\"demo\"/></td>\n", images {:}); - text = strcat (header, headers, "</tr><tr>\n", ims, footer); -endfunction
--- a/extra/generate_html/inst/private/find_package.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -## Copyright (C) 2009 Soren Hauberg <soren@hauberg.org> -## -## 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/>. - -## Internal function -function [package, found] = find_package (name) - package = "octave"; - p = which (name); - found = !isempty (p); - l = pkg ("list"); - - for k = 1:length (l) - d = l {k}.dir; - idx = strfind (p, d); - if (numel (idx) == 1 && idx == 1) - package = l {k}.name; - break; - endif - endfor -endfunction
--- a/extra/generate_html/inst/private/get_alpha_database.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,29 +0,0 @@ -## Copyright (C) 2009 Soren Hauberg <soren@hauberg.org> -## -## 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 [name_filename, desc_filename] = get_alpha_database (outdir, name, letter); - directory = fullfile (outdir, name); - if (!exist (directory, "dir")) - [succ, msg] = mkdir (directory); - if (!succ) - error ("get_alpha_database: could not create '%s': %s", directory, msg); - endif - endif - - name_filename = fullfile (directory, sprintf ("function_names_%s", letter)); - desc_filename = fullfile (directory, sprintf ("function_descriptions_%s", letter)); -endfunction -
--- a/extra/generate_html/inst/private/get_header_title_and_footer.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,53 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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 = "<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, "body_command")) - header = strrep (header, "%body_command", options.body_command); - endif - - if (isfield (options, "title")) - title = options.title; - else - title = "%name"; - 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 - - if (isfield (options, "footer")) - footer = options.footer; - else - footer = "</body></html>"; - endif -endfunction
--- a/extra/generate_html/inst/private/get_index_header_title_and_footer.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,62 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_index_header_title_and_footer (options, name, root = "") - if (isfield (options, "index_header")) - header = options.index_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, "index_body_command")) - header = strrep (header, "%body_command", options.index_body_command); - elseif (isfield (options, "body_command")) - header = strrep (header, "%body_command", options.body_command); - endif - - if (isfield (options, "index_title")) - title = options.index_title; - elseif (isfield (options, "title")) - title = options.title; - else - title = "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 index page - if (isfield (options, "index_footer")) - footer = options.index_footer; - elseif (isfield (options, "footer")) - footer = options.footer; - else - footer = "</body></html>"; - endif -endfunction
--- a/extra/generate_html/inst/private/get_overview_filename.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,28 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_overview_filename (options, name) - if (isfield (options, "overview_filename")) - overview_filename = options.overview_filename; - overview_filename = strrep (overview_filename, "%name", name); - else - overview_filename = sprintf ("overview.html", name); - endif - - overview_filename = strrep (overview_filename, " ", "_"); -endfunction
--- a/extra/generate_html/inst/private/get_overview_header_title_and_footer.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,62 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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_overview_header_title_and_footer (options, name, root = "") - if (isfield (options, "overview_header")) - header = options.overview_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, "overview_title")) - title = options.overview_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 overview page - if (isfield (options, "overview_footer")) - footer = options.overview_footer; - elseif (isfield (options, "footer")) - footer = options.footer; - else - footer = "</body></html>"; - endif -endfunction
--- a/extra/generate_html/inst/private/get_pkg_list_item_filename.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,35 +0,0 @@ -## Copyright (C) 2009 Carlo de Falco <carlo.defalco@gmail.com> -## -## 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 pkg_list_item_filename = get_pkg_list_item_filename (name, outdir) - - filename = "short_package_description"; - ld = fullfile (outdir, name); - - if (!exist (ld, "dir")) - [succ, msg] = mkdir (ld); - if (!succ) - error ("generate_package_html: unable to create directory %s:\n %s", - ld, msg); - endif - endif - - pkg_list_item_filename = fullfile (ld, filename); - -endfunction -
--- a/extra/generate_html/inst/private/get_root.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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 root = get_root (outdir, subdir) - web_sep = '/'; - - if (outdir (end) == web_sep) - outdir (end) = []; - endif - - if (subdir (end) == web_sep) - subdir (end) = []; - endif - - n = sum (subdir == web_sep) - sum (outdir == web_sep); - root = repmat ("../", 1, n); -endfunction
--- a/extra/generate_html/inst/private/get_texi_conf.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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 text = get_texi_conf (srcdir) - conf_texi = fullfile (srcdir, "doc", "conf.texi"); - fid = fopen (conf_texi, "r"); - text = char (fread (fid).'); - fclose (fid); -endfunction
--- a/extra/generate_html/inst/private/get_txi_files.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,56 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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 [file_list, file_pattern] = get_txi_files (srcdir) - txi_dir = fullfile (srcdir, "doc", "interpreter"); - octave_texi = fullfile (txi_dir, "octave.texi"); - file_pattern = fullfile (txi_dir, "*.txi"); - include = "@include"; - - fid = fopen (octave_texi, "r"); - file_list = {}; - while (true) - line = fgetl (fid); - if (line == -1) - break; - endif - - n = min (length (include), length (line)); - if (strcmp (line (1:n), include)) - fun = strtrim (line (n+1:end)); - if (strcmpi (fun, "conf.texi")) - continue; - endif - fun = strrep (fun, ".texi", ".txi"); - file_list {end+1} = fullfile (txi_dir, fun); - endif - endwhile - fclose (fid); -endfunction - -function [file_list, file_pattern] = old_get_txi_files (srcdir) - file_pattern = fullfile (txi_dir, "*.txi"); - fl = dir(file_pattern); - file_list = {}; - for k = 1:length (fl) - if (any (strcmpi (fl (k).name, {".", ".."}))) - continue; - endif - file_list {end+1} = fullfile (txi_dir, fl (k).name); - endfor -endfunction
--- a/extra/generate_html/inst/private/mk_chapter_dir.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,33 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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 location = mk_chapter_dir (outdir, options) - if (isfield (options, "chapter_dir")) - location = options.chapter_dir; - else - location = "chapter"; - endif - - location = fullfile (outdir, location); - - ## Create output directory if needed - if (!exist (location, "dir")) - mkdir (location); - endif - -endfunction
--- a/extra/generate_html/inst/private/mk_function_dir.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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
--- a/extra/generate_html/inst/private/mk_various_dir.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,33 +0,0 @@ -## Copyright (C) 2009 Soren Hauberg <soren@hauberg.org> -## -## 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 location = mk_various_dir (outdir, options) - if (isfield (options, "various_dir")) - location = options.various_dir; - else - location = "various"; - endif - - location = fullfile (outdir, location); - - ## Create output directory if needed - if (!exist (location, "dir")) - mkdir (location); - endif - -endfunction
--- a/extra/generate_html/inst/private/octave_forge_seealso.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,39 +0,0 @@ -## Copyright (C) 2009 Soren Hauberg <soren@hauberg.org> -## -## 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 expanded = octave_forge_seealso (root, arg) - header = "@html\n<div class=\"seealso\">\n<b>See also</b>: "; - footer = "\n</div>\n@end html\n"; - - ## XXX: Deal properly with the root directory - format = sprintf (" <a href=\"%sfind_function.php?fun=%%s\">%%s</a> ", root); - kw_format = sprintf (" <a href=\"%soperators.html#%%s\">%%s</a> ", root); - - keywords = __keywords__ (); - - help_list = ""; - for k = 1:length (arg) - f = arg {k}; - if (any (strcmp (f, keywords))) - elem = sprintf (kw_format, f, f); - else - elem = sprintf (format, f, f); - endif - help_list = strcat (help_list, elem); - endfor - - expanded = strcat (header, help_list, footer); -endfunction
--- a/extra/generate_html/inst/texi2html.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,99 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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} html_help_text (@var{name}, @var{outname}, @var{options}) -## Writes a function help text to disk formatted as @t{HTML}. -## -## The help text of the function @var{name} is written to the file @var{outname} -## formatted as @t{HTML}. The design of the generated @t{HTML} 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{HTML} header of the generated file. Through this -## things such as @t{CSS} style sheets can be set. -## @item footer -## This field contains the @t{HTML} footer of the generated file. This should -## match the @samp{header} field to ensure all opened tags get closed. -## @item title -## This field sets the title of the @t{HTML} page. This is enforced even if the -## @samp{header} field contains a title. -## @end table -## -## @var{options} structures for various projects can be with the @code{get_html_options} -## function. As a convenience, if @var{options} is a string, a structure will -## be generated by calling @code{get_html_options}. -## -## @seealso{get_html_options, generate_package_html} -## @end deftypefn - -function [header, text, footer] = texi2html (text, options = struct (), root = "") - ## If options is a string, call get_html_options - if (ischar (options)) - options = get_html_options (options); - endif - - ## 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 = options.seealso; - else - seealso = @(args) html_see_also_with_prefix (root, args {:}); - endif - - ## Run makeinfo - orig_text = text; - [text, status] = __makeinfo__ (text, "html", seealso); - if (status != 0) - txi_out = orig_text (1:min (100, length (orig_text))); - warning ("texi2html: couldn't parse texinfo: \n%s", txi_out); # XXX: make this an error - 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); - - ## Hack around 'makeinfo' bug that forgets to put <p>'s before function declarations - text = strrep (text, "—", "<p class=\"functionfile\">"); - - ## Read 'options' input argument - [header, title, footer] = get_header_title_and_footer (options, :, root); -endfunction - -function expanded = html_see_also_with_prefix (prefix, varargin) - header = "@html\n<div class=\"seealso\">\n<b>See also</b>: "; - footer = "\n</div>\n@end html\n"; - - format = sprintf (" <a href=\"%s%%s.html\">%%s</a> ", 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 -
--- a/extra/generate_html/inst/txi2index.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,126 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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{index} =} txi2index (@var{file_pattern}) -## Convert @code{.txi} files in the Octave source into an @t{INDEX} structure -## suitable for generating a functon reference. -## -## @var{file_pattern} must be a string containing either the name of a @code{.txi} -## file, or a pattern for globbing a set of files (e.g. @t{"*.txi"}). The resulting -## cell array @var{index} contains a set of structures corresponding to those -## generated by @code{pkg ("describe")}. These structures can then be given to -## @code{generate_package_html} to produce @t{HTML} content. -## -## As an example, if the Octave source code is located in @t{~/octave_code}, -## then this function can be called with -## -## @example -## octave_source_code = "~/octave_code"; -## index = txi2index (fullfile (octave_source_code, "doc/interpreter", "*.txi")); -## @end example -## @seealso{pkg, generate_package_html} -## @end deftypefn - -function all_index = txi2index (srcdir) - if (nargin == 0) - print_usage (); - endif - - if (!ischar (srcdir)) - error ("txi2index: input argument must be a string"); - endif - - [file_list, file_pattern] = get_txi_files (srcdir); - [global_dir, name, ext] = fileparts (file_pattern); - - all_index = cell (size (file_list)); - for k = 1:length (file_list) - filename = file_list{k}; - - [not_used, name, ext] = fileparts (filename); - index.filename = filename; - index.name = name; - index.description = ""; - index.provides = {}; - - CHAPTER = "@chapter "; - APPENDIX = "@appendix "; - SECTION = "@section "; - DOCSTRING = "@DOCSTRING"; - default_section = "General"; - - fid = fopen (filename, "r"); - if (fid < 0) - warning ("txi2index: couldn't open '%s' for reading", filename); - continue; - endif - - idx = 0; - txi_has_contents = false; - while (true) - line = fgetl (fid); - if (line == -1) - break; - endif - - if (strncmpi (CHAPTER, line, length (CHAPTER))) - index.name = strtrim (line (length (CHAPTER)+1:end)); - elseif (strncmpi (APPENDIX, line, length (APPENDIX))) - index.name = strtrim (line (length (APPENDIX)+1:end)); - elseif (strncmpi (SECTION, line, length (SECTION))) - section = strtrim (line (length (SECTION)+1:end)); - if (idx == 0 || !isempty (index.provides {idx}.functions)) - idx ++; - endif - - index.provides {idx} = struct (); - index.provides {idx}.category = section; - index.provides {idx}.functions = {}; - elseif (strncmpi (DOCSTRING, line, length (DOCSTRING))) - if (idx == 0) - idx ++; - - index.provides {idx} = struct (); - index.provides {idx}.category = default_section; - index.provides {idx}.functions = {}; - endif - - start = find (line == "(", 1); - stop = find (line == ")", 1); - if (isempty (start) || isempty (stop)) - warning ("txi2index: invalid @DOCSTRING: %s", line); - continue; - endif - - fun = strtrim (line (start+1:stop-1)); - index.provides {idx}.functions {end+1} = fun; - txi_has_contents = true; - endif - endwhile - fclose (fid); - - if (idx > 0 && isempty (index.provides {idx}.functions)) - index.provides = index.provides (1:idx-1); - endif - - if (txi_has_contents) - all_index {k} = index; - else - all_index {k} = []; - endif - endfor -endfunction
--- a/extra/generate_html/inst/txi2reference.m Wed Aug 13 23:46:20 2014 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,86 +0,0 @@ -## Copyright (C) 2008 Soren Hauberg <soren@hauberg.org> -## -## 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{reference} =} txi2reference (@var{file_pattern}) -## Convert @code{.txi} files in the Octave source into a functon reference. -## -## @var{file_pattern} must be a string containing either the name of a @code{.txi} -## file, or a pattern for globbing a set of files (e.g. @t{"*.txi"}). The resulting -## cell array @var{reference} contains a string for each @code{.txi} file. These -## strings can the be passed to @code{makeinfo} to create output in many formats. -## -## As an example, if the Octave source code is located in @t{~/octave_code}, -## then this function can be called with -## -## @example -## octave_source_code = "~/octave_code"; -## reference = txi2reference (fullfile (octave_source_code, "doc/interpreter", "*.txi")); -## @end example -## @seealso{makeinfo, txi2index} -## @end deftypefn - -function result = txi2reference (filename, docstring_handler = @default_docstring_handler) - ## Check input - if (nargin == 0) - print_usage (); - endif - - if (!ischar (filename)) - error ("txi2reference: first input argument must be a string"); - endif - - if (!isa (docstring_handler, "function_handle")) - error ("txi2reference: second input argument must be a function handle"); - endif - - ## Constants for string matching - DOCSTRING = "@DOCSTRING"; - DS_start = "("; - DS_stop = ")"; - - ## Open and read file - fid = fopen (filename, "r"); - if (fid < 0) - error ("txi2reference: couldn't open '%s' for reading", filename); - endif - - text = char (fread (fid).'); - fclose (fid); - - ## Search for @DOCSTRING - DOCSTRING_idx = strfind (text, DOCSTRING); - DS_start_idx = find (text == DS_start); - DS_stop_idx = find (text == DS_stop); - - ## Process search results - result = ""; - prev = 1; - for n = 1:length (DOCSTRING_idx) - idx = DOCSTRING_idx (n); - start = DS_start_idx (find (DS_start_idx > idx, 1)); - stop = DS_stop_idx (find (DS_stop_idx > idx, 1)); - fun = text (start+1:stop-1); - fun_text = docstring_handler (fun); - result = strcat (result, text (prev:idx-1), fun_text); - prev = stop + 1; - endfor - result = strcat (result, text (prev:end)); -endfunction - -function ds = default_docstring_handler (fun) - ds = sprintf ("See: @xref{%s}", fun); -endfunction