Repository: theodorewiles/org-mind-map Branch: master Commit: 95347b2f9291 Files: 17 Total size: 79.2 KB Directory structure: gitextract_s1gnjvgp/ ├── .gitignore ├── LICENSE ├── README.md ├── example-1.org ├── example-2.org ├── example-3.org ├── example-4.org ├── example-5.org ├── example-7.org ├── examples/ │ ├── example-1.org │ ├── example-2.org │ ├── example-3.org │ ├── example-4.org │ ├── example-5.org │ ├── example-7.org │ └── example-8.org └── org-mind-map.el ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitignore ================================================ org-mind-map.el~ *~ ================================================ FILE: LICENSE ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU 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 . 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: {project} Copyright (C) {year} {fullname} 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 . 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 . ================================================ FILE: README.md ================================================ # org-mind-map This is an emacs package that creates graphviz directed graphs from org-mode files. This project is currently unmaintained! If anyone would like to take this over an fix up my (very messy) code, please let me know. # Requirements This package relies on the [Graphviz](http://graphviz.org/) suite of graphical diagramming tools. ## windows (the default option), these tools are available via [cygwin](http://cygwin.com/). ## linux these tools are available through any of the popular package managers. ## mac binarys are at the graphviz site, but for recent versions like El Capitan, Sierra and High Sierra, macports or homebrew are recommended. ```bash brew install graphviz ``` This package also relies on the org-mode and dash libraries, available from melpa (M-x list-packages). # Installation and usage To install, add this code to your .emacs: ```elisp (load "INSTALLPATH/org-mind-map.el") ``` or if you're using use-package: ```elisp ;; This is an Emacs package that creates graphviz directed graphs from ;; the headings of an org file (use-package org-mind-map :init (require 'ox-org) :ensure t ;; Uncomment the below if 'ensure-system-packages` is installed ;;:ensure-system-package (gvgen . graphviz) :config (setq org-mind-map-engine "dot") ; Default. Directed Graph ;; (setq org-mind-map-engine "neato") ; Undirected Spring Graph ;; (setq org-mind-map-engine "twopi") ; Radial Layout ;; (setq org-mind-map-engine "fdp") ; Undirected Spring Force-Directed ;; (setq org-mind-map-engine "sfdp") ; Multiscale version of fdp for the layout of large graphs ;; (setq org-mind-map-engine "twopi") ; Radial layouts ;; (setq org-mind-map-engine "circo") ; Circular Layout ) ``` Then, run `M-x org-mind-map-write` within the org-mode file you would like to make a mind-map for. If all works as expected, a PDF file will be generated in the same directory as the org file. # Examples - [Basic concept](#basic-concept) - [Tags](#tags) - [Selective Colors](#selective-colors) - [Links](#links) - [Including text](#including-text) - [Including images (BETA)](#including-images-beta) - [Selective Export](#selective-export) ## Basic concept Here is an example org-mode tree that demonstrates the basic concept: ```Org * This is an example org-mode tree The content of the node doesn't matter. ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D ``` and the result is shown below: ![examples/example-1.org.pdf](examples/example-1.org.png) ## Tags You can also add tags, as in this org-mode file: ```Org * This is an org-mode tree with tags ** Branch A :TagA: *** Sub-Branch 1 :TagA: *** Sub-Branch 2 :TagA: *** Sub-Branch 3 :TagA:TagB: ** Branch B :TagB: ** Branch C ** Branch D ``` These are randomly color-coded into pastel tags: ![examples/example-2.org.pdf](examples/example-2.org.png) ## Selective Colors If you would like a node to show up as a specific color, you can add the `:OMM-COLOR:` and `:OMM-LEGEND:` properties to a node. The node will be colored in, and a legend entry item will be added, as shown below: ```Org * This is an org-mode tree with tags :PROPERTIES: :OMM-COLOR: GREEN :OMM-LEGEND: Legend entry :END: ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D * This is an org-mode tree that interleaves :TagOne: ** Branch E *** Sub-Branch 3 :TagTwo: *** Sub-Branch 3 :TagOne: ** Branch B ** Branch C ``` this results in this file: ![examples/example-4.org.png](examples/example-4.org.png) ## Links You can also draw edges between nodes by including links to headlines in your Org mode files. Links will be drawn from the parent heading to the heading of the destination link. This works as shown below: ```Org * This is an org-mode tree with tags :PROPERTIES: :OMM-COLOR: GREEN :OMM-LEGEND: Legend entry :END: ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D * Here is another tree ** Branch One ** Branch Two [[Branch C]] ** Branch Three [[Branch One][Another link]] [[Sub-Branch 1][Yet Another Link]] ``` this results in this file: ![examples/example-5.org.png](examples/example-5.org.png) ## Including text You can also control the display of text within each heading with the `org-mind-map-include-text` option. When set to `t`, this displays all of the paragraph text underneath a given headline. For example, ```Org * Branch One ** Branch Two Here is some interesting text... ** Branch Three *** Example - Plain lists show up as additional paragraphs [[http://www.google.com/][But links don't show up at all]] #+BEGIN_SRC Nor do source code blocks. #+END_SRC ``` this results in this file: ![examples/example-7.png](examples/example-7.png) ## Including images BETA You can also now include PNG files. These will be included as sub-headings. The images are currently scaled to a rectangle of 100px by 100px. This may be updated in the future. For example, ```Org * Node A ** Node B Example paragraph [[Node C]] [[./Lena.png]] ** Node C More details ** Node D [[Node A]] ``` Results in this file: ![examples/example-8.png](examples/example-8.png) # Thanks! http://pages.sachachua.com/evil-plans/ # Other Options Customize the `org-mind-map-engine` variable to specify additional layout options (e.g. radial layouts where root nodes are in the center of the graph), and customize `org-mind-map-rankdir` to specify if the chart is going up-and-down or left-to-right. ## Selective Export Use the command `org-mind-map-write-current-tree` to just create a map from the current tree. ================================================ FILE: example-1.org ================================================ * This is an example org-mode tree The content of the node doesn't matter. ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D ================================================ FILE: example-2.org ================================================ * This is an org-mode tree with tags ** Branch A :TagA: *** Sub-Branch 1 :TagA: *** Sub-Branch 2 :TagA: *** Sub-Branch 3 :TagA:TagB: ** Branch B :TagB: ** Branch C ** Branch D ================================================ FILE: example-3.org ================================================ * This is an org-mode tree with tags ** Branch A :TagA: *** Sub-Branch 1 :TagA: *** Sub-Branch 2 :TagA: *** Sub-Branch 3 :TagA:TagB: ** Branch B :TagB: ** Branch C ** Branch D * This is an org-mode tree that interleaves ** Branch E *** Sub-Branch 3 *** Sub-Branch 3 :TagA:TagB: ** Branch B ================================================ FILE: example-4.org ================================================ * This is an org-mode tree with tags :PROPERTIES: :OMM-COLOR: GREEN :OMM-LEGEND: Legend entry :END: ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D * This is an org-mode tree that interleaves :TagOne: ** Branch E *** Sub-Branch 3 :TagTwo: *** Sub-Branch 3 :TagOne: ** Branch B ** Branch C ================================================ FILE: example-5.org ================================================ * This is an org-mode tree with tags :PROPERTIES: :OMM-COLOR: GREEN :OMM-LEGEND: Legend entry :END: ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D * Here is another tree ** Branch One ** Branch Two [[Branch C]] ** Branch Three [[Branch One][Another link]] [[Sub-Branch 1][Yet Another Link]] ================================================ FILE: example-7.org ================================================ * Branch One ** Branch Two Here is some interesting text... ** Branch Three *** Example - Plain lists show up as additional paragraphs [[http://www.google.com/][But links don't show up at all]] #+BEGIN_SRC Nor do source code blocks. #+END_SRC ================================================ FILE: examples/example-1.org ================================================ * This is an example org-mode tree The content of the node doesn't matter. ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D ================================================ FILE: examples/example-2.org ================================================ * This is an org-mode tree with tags ** Branch A :TagA: *** Sub-Branch 1 :TagA: *** Sub-Branch 2 :TagA: *** Sub-Branch 3 :TagA:TagB: ** Branch B :TagB: ** Branch C ** Branch D ================================================ FILE: examples/example-3.org ================================================ * This is an org-mode tree with tags ** Branch A :TagA: *** Sub-Branch 1 :TagA: *** Sub-Branch 2 :TagA: *** Sub-Branch 3 :TagA:TagB: ** Branch B :TagB: ** Branch C ** Branch D * This is an org-mode tree that interleaves ** Branch E *** Sub-Branch 3 *** Sub-Branch 3 :TagA:TagB: ** Branch B ================================================ FILE: examples/example-4.org ================================================ * This is an org-mode tree with tags :PROPERTIES: :OMM-COLOR: GREEN :OMM-LEGEND: Legend entry :END: ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D * This is an org-mode tree that interleaves :TagOne: ** Branch E *** Sub-Branch 3 :TagTwo: *** Sub-Branch 3 :TagOne: ** Branch B ** Branch C ================================================ FILE: examples/example-5.org ================================================ * This is an org-mode tree with tags :PROPERTIES: :OMM-COLOR: GREEN :OMM-LEGEND: Legend entry :END: ** Branch A *** Sub-Branch 1 *** Sub-Branch 2 *** Sub-Branch 3 ** Branch B ** Branch C ** Branch D * Here is another tree ** Branch One ** Branch Two [[Branch C]] ** Branch Three [[Branch One][Another link]] [[Sub-Branch 1][Yet Another Link]] ================================================ FILE: examples/example-7.org ================================================ * Branch One ** Branch Two Here is some interesting text... ** Branch Three *** Example - Plain lists show up as additional paragraphs [[http://www.google.com/][But links don't show up at all]] #+BEGIN_SRC Nor do source code blocks. #+END_SRC ================================================ FILE: examples/example-8.org ================================================ * Node A ** Node B Example paragraph [[Node C]] [[./Lena.png]] ** Node C More details ** Node D [[Node A]] ================================================ FILE: org-mind-map.el ================================================ ;;; org-mind-map.el --- Creates a directed graph from org-mode files ;; Author: Ted Wiles ;; Keywords: orgmode, extensions, graphviz, dot ;; Version: 0.4 ;; URL: https://github.com/theodorewiles/org-mind-map ;; Package-Requires: ((emacs "24") (dash "1.8.0") (org "8.2.10")) ;; This file is NOT part of GNU Emacs. ;; 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, 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 GNU Emacs; see the file LICENSE. If not, write to the ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, ;; Boston, MA 02110-1301, USA. ;;; Commentary: ;; This package takes an org-mode tree and converts it into a ;; file that can be read into graphviz in order to visually show the ;; tree as a directed graph. Mail to to discuss ;; features and additions. All suggestions are more than welcome. ;;; Commands: ;; ;; Below is a complete list of commands: ;; ;; `org-mind-map-write' ;; Create a digraph based on all org trees in the current buffer. ;; Keybinding: M-x org-mind-map-write ;; `org-mind-map-write-current-branch' ;; Create a directed graph output based on just the current org tree branch. ;; Keybinding: M-x org-mind-map-write-current-branch ;; `org-mind-map-write-current-tree' ;; Create a directed graph output based on the whole current org tree. ;; Keybinding: M-x org-mind-map-write-current-tree ;; ;;; Customizable Options: ;; ;; Below is a list of customizable options: ;; ;; `org-mind-map-wrap-line-length' ;; Line length within graphviz nodes. ;; default = 30 ;; `org-mind-map-wrap-legend-line-length' ;; Line length of the graphviz legend. ;; default = 45 ;; `org-mind-map-unflatten-command' ;; Shell executable command for running the UNFLATTEN command. ;; default = "unflatten -l3" ;; `org-mind-map-dot-command' ;; Shell executable command for running the DOT command. ;; default = "dot" ;; `org-mind-map-dot-output' ;; Format of the DOT output. Defaults to PDF. ;; default = "pdf" ;; `org-mind-map-engine' ;; Sets the layout engine used in your graphs. ;; default = "dot" ;; `org-mind-map-default-node-attribs' ;; Alist of default node attributes and values. ;; default = '(("shape" . "plaintext")) ;; `org-mind-map-default-edge-attribs' ;; Alist of default edge attributes and values. ;; default = nil ;; `org-mind-map-default-graph-attribs' ;; Alist of default graph attributes and values. ;; default = '(("autosize" . "false") ("size" . "9,12") ("resolution" . "100") ...)) ;; `org-mind-map-node-formats' ;; Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-NODE-FMT property ;; See also `org-mind-map-make-node-fn' ;; default = nil ;; `org-mind-map-edge-formats' ;; Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-EDGE-FMT property ;; See also `org-mind-map-make-edge-fn' ;; default = nil ;; `org-mind-map-edge-format-default' ;; Default format string for graph edges, e.g. "[style=dotted]". ;; default = "" ;; `org-mind-map-reserved-colors' ;; List of colors that will not be used for coloring tags. ;; default = nil ;; `org-mind-map-tag-colors' ;; An alist of (TAG . COLOR) pairs for choosing colors for tags. ;; default = nil ;; `org-mind-map-include-text' ;; A boolean indicating whether our not to include paragraph text in body of nodes. ;; default = t ;; `org-mind-map-include-images' ;; A boolean indicating whether our not to include images in body of nodes. ;; default = t ;; The headings of the org-mode file are treated as node text in the resulting tree. ;; Org-mode heading tags are included in the resulting tree as additional cells ;; within the node. ;; The tags are color-coded to be consistent across the tree. ;; Tree interleaving is also possible by naming multiple org-mode headings ;; with the same heading. ;; NOTE: this requires the GRAPHVIZ software. This is installable on ;; windows using cygwin. ;; To install, add this code to your .emacs: ;; (load "org-mind-map.el") ;; If on linux, customize the values of `org-mind-map-unflatten-command' ;; and `org-mind-map-dot-command' to have the values corresponding to ;; the executables in your system. ;; Then, run "M-x org-mind-map-write" to create a graph of all trees in the current buffer, ;; You can customize the style of the graph by adding :OMM-NODE-FMT and :OMM-EDGE-FMT properties ;; to the headlines in the tree. ;; The latest version is available at: ;; ;; https://github.com/theodorewiles/org-mind-map ;; ;;; Code: (require 'dash) (require 'org) (require 'subr-x) (defconst org-mind-map-version "0.4") (defgroup org-mind-map nil "Convert org-mode tree into a graphviz directed graph" :group 'org) (defcustom org-mind-map-wrap-line-length 30 "Line length within graphviz nodes." :type 'integer :group 'org-mind-map) (defcustom org-mind-map-wrap-text-length 60 "Line length within graphviz nodes that have longer text." :type 'integer :group 'org-mind-map) (defcustom org-mind-map-wrap-legend-line-length 45 "Line length of the graphviz legend." :type 'integer :group 'org-mind-map) (defcustom org-mind-map-unflatten-command "unflatten -l3" "Shell executable command for running the UNFLATTEN command." :type 'string :group 'org-mind-map) (defcustom org-mind-map-dot-command "dot" "Shell executable command for running the DOT command." :type 'string :group 'org-mind-map) (defcustom org-mind-map-dot-output '("pdf" "png" "jpeg" "svg" "eps" "gif" "tiff") "List of formats for the DOT output file. If more than one are specified then the user will be prompted to choose one. To find a list of available formats, on the command line enter: dot -T?" :type '(repeat (string :tag "File type")) :group 'org-mind-map) (defcustom org-mind-map-display nil "How the results should be displayed: nil = don't display results current = display results in current window window = display results in new window frame = display results in new frame" :type '(choice (const :tag "Don't display" nil) (const :tag "Display in current window" current) (const :tag "Display in new window" window) (const :tag "Display in new frame" frame)) :group 'org-mind-map) (defcustom org-mind-map-engine "dot" "Sets the layout engine used in your graphs. See the graphviz user manual for description of these options." :type '(choice (const :tag "Directed Graph" "dot") (const :tag "Undirected Spring Graph" "neato") (const :tag "Radial Layout" "twopi") (const :tag "Circular Layout" "circo") (const :tag "Undirected Spring Force-Directed" "fdp")) :group 'org-mind-map) (defcustom org-mind-map-default-node-attribs '(("shape" . "plaintext")) "Alist of default node attributes and values. Each item in the alist should be a cons cell of the form (ATTRIB . VALUE) where ATTRIB and VALUE are strings. For a list of value attributes, see here: https://graphviz.gitlab.io/_pages/doc/info/attrs.html" :type '(alist :key-type (string :tag "Attribute") :value-type (string :tag " Value")) :group 'org-mind-map) (defcustom org-mind-map-default-edge-attribs nil "Alist of default edge attributes and values. Each item in the alist should be a cons cell of the form (ATTRIB . VALUE) where ATTRIB and VALUE are strings. For a list of value attributes, see here: https://graphviz.gitlab.io/_pages/doc/info/attrs.html" :type '(alist :key-type (string :tag "Attribute") :value-type (string :tag " Value")) :group 'org-mind-map) (defcustom org-mind-map-default-graph-attribs '(("autosize" . "false") ("size" . "9,12") ("resolution" . "100") ("nodesep" . "0.75") ("overlap" . "false") ("spline" . "true") ("rankdir" . "LR")) "Alist of default graph attributes and values. Each item in the alist should be a cons cell of the form (ATTRIB . VALUE) where ATTRIB and VALUE are strings. For a list of value attributes, see here: https://graphviz.gitlab.io/_pages/doc/info/attrs.html" :type '(alist :key-type (string :tag "Attribute") :value-type (string :tag " Value")) :group 'org-mind-map) (defcustom org-mind-map-node-formats nil "Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-NODE-FMT property of a node/headline, and FN is a function which outputs a format string to be placed after the node name (e.g. \"[label='Node1',color='red']\"). The function FN should take the following 5 arguments which can be used to construct the format: TITLE = the label string for the node TAGS = a list of org tags for the current node COLOR = the contents of the OMM-COLOR property for the current node HM = a hash map of colors EL = an org element obtained from `org-element-map' Note: the :OMM-NODE-FMT property is inherited by children of the node/headline where it is defined." :type '(alist :key-type (string :tag " Name") :value-type (function :tag "Format function")) :group 'org-mind-map) (defcustom org-mind-map-edge-formats nil "Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-EDGE-FMT property of a node/headline, and FN is a function which outputs a format string to be placed after an edge (e.g. \"[style=dotted]\"). The function FN should take the following 2 arguments which can be used to construct the format: HM = a hash map of colors EL = an org element obtained from `org-element-map' Note: the :OMM-EDGE-FMT property affects edges leading to the node at which it is defined, and is inherited by children of that node/headline." :type '(alist :key-type (string :tag " Name") :value-type (function :tag "Format function")) :group 'org-mind-map) (defcustom org-mind-map-edge-format-default "" "Default format string for graph edges, e.g. \"[style=dotted]\"." :type 'string :group 'org-mind-map) (defcustom org-mind-map-reserved-colors nil "List of colors that will not be used for coloring tags. These colors will be excluded when random tag colors are chosen by `org-mind-map-rgb' so that you can use them for other things. Each color should be in hexadecimal form, e.g: \"#e3cfbc\", where the consecutive pairs of hexdigits indicate levels of red, green and blue respectively. It is not necessary to include any colors with levels below 7d, as these are not used for creating random tag colors." :type '(repeat string) :group 'org-mind-map) (defcustom org-mind-map-tag-colors nil "An alist of (TAG . COLOR) pairs for choosing colors for tags. Any tags not listed here will be colored with randomly selected colors that dont clash with those in `org-mind-map-reserved-colors'. Each color should be in hexadecimal form, e.g: \"#e3cfbc\", where the consecutive pairs of hexdigits indicate levels of red, green and blue respectively. Note: you can also set tag colors by altering the hashmap passed as an argument to functions defined in `org-mind-map-node-formats'." :type '(alist :key-type (string :tag " Tag") :value-type (string :tag "Color")) :group 'org-mind-map) (defcustom org-mind-map-include-text t "A boolean indicating whether our not to include paragraph text in body of nodes. default = t" :type 'boolean :group 'org-mind-map ) (defcustom org-mind-map-include-images t "A boolean indicating whether our not to include paragraph text in body of nodes. default = t" :type 'boolean :group 'org-mind-map ) (defun org-mind-map-do-wrap (words width) "Create lines of maximum width WIDTH (in characters) from word list WORDS." (let (lines line) (while words (setq line (pop words)) (while (and words (< (+ (length line) (length (car words))) width)) (setq line (concat line " " (pop words)))) (setq lines (push line lines))) (nreverse lines))) (defun org-mind-map-wrap (s l) (let* ((s2 (org-mind-map-do-wrap (split-string s " ") l))) (mapconcat 'identity s2 "

"))) (defun org-mind-map-wrap-lines (s) "Wraps a string S so that it can never be more than ORG-MIND-MAP-WRAP-LINE-LENGTH characters long." (org-mind-map-wrap s org-mind-map-wrap-line-length)) (defun org-mind-map-wrap-text (s) "Wraps a string S so that it can never be more than ORG-MIND-MAP-WRAP-TEXT-LENGTH characters long." (org-mind-map-wrap s org-mind-map-wrap-text-length)) (defun org-mind-map-wrap-legend-lines (s) "Wraps a string S so that it can never be more than ORG-MIND-MAP-WRAP-LEGEND-LINE-LENGTH characters long." (let* ((s2 (org-mind-map-do-wrap (split-string s " ") org-mind-map-wrap-legend-line-length))) (mapconcat 'identity s2 "

"))) (defun org-mind-map-dot-node-name (s) "Make string S formatted to be usable within dot node names." (concat "\"" (replace-regexp-in-string "]*>" "" (replace-regexp-in-string "label=\\(\"[^\"]+\"\\|[^,]+\\).*" "\\1" s)) "\"")) (defun org-mind-map-add-color (hm tag &optional colspan) "Create data element containing TAG with associated color found in hashmap HM." (let* ((color (gethash tag hm))) (concat "" tag ""))) (defun org-mind-map-write-tags-default (title tags color hm el &optional content images) "Default function for writing nodes. Label node with TITLE and background COLOR, and write TAGS (a list of tag names) into boxes underneath, using associated colors in hashmap HM. The EL argument is not used, but is needed for compatibility." (concat "[label=<" (if (> (length tags) 0) (concat "" (if (> (length tags) 0) (concat "" (mapconcat (-partial 'org-mind-map-add-color hm) tags "") "")) (if (> (length content) 0) (concat "") ) (if (> (length images) 0) images "" ) "
" title "
" content "
>];")) (defun org-mind-map-get-property (prop el &optional inheritp) "Get property PROP from an org element EL, using inheritance if INHERITP is non-nil. PROP can be either the property symbol (beginning with :), or the name of the property (with or without :). If there is a column summary value for the property that has recently be calculated it will be used." (let* ((node el) (propstr (if (stringp prop) (upcase (if (string-match "^:" prop) (substring prop 1) prop)) (substring (symbol-name prop) 1))) (prop (if (stringp prop) (intern (concat ":" propstr)) prop)) (val (or (cdr (cl-find propstr (get-text-property (org-element-property :begin el) 'org-summaries) :test (lambda (x y) (equal (caar y) x)))) (org-element-property prop el)))) (while (and inheritp (not val) (not (eq (org-element-type node) 'org-data))) (setq node (org-element-property :parent node) val (org-element-property prop node))) val)) (defun org-mind-map-narrow-to-heading-content (b) "Narrow to the region until the next headline, if applicable" (let* ((new-end (org-element-map (org-element-parse-buffer 'object 'true) 'headline (lambda (x) (if (not (= (org-element-property :begin x) b)) b nil)) nil 'true))) (if new-end (progn (widen) (narrow-to-region b new-end))))) (defun org-mind-map-write-tags (hm el &optional edgep) "Use HM as the hash-map of colors and takes an element EL and extracts the title and tags. Then, formats the titles and tags so as to be usable within DOT's graphviz language." (let* ((ts (org-element-property :title el)) (wrapped-title (org-mind-map-wrap-lines (if (listp ts) (first ts) ts))) (title (replace-regexp-in-string "&" "&" wrapped-title nil t)) (color (org-element-property :OMM-COLOR el)) (tags (org-element-property :tags el)) (fmt (org-mind-map-get-property (if edgep :OMM-EDGE-FMT :OMM-NODE-FMT) el)) (b (org-element-property :begin el)) (e (org-element-property :end el)) (images (if org-mind-map-include-images (save-restriction (narrow-to-region b e) (org-mind-map-narrow-to-heading-content b) (mapconcat 'identity (org-element-map (org-element-parse-buffer 'object 'true) '(link) (lambda (x) (message "Inline image: %s" (org-export-inline-image-p x)) (if (org-export-inline-image-p x) (concat "" "" "") ""))) "")))) (content (if org-mind-map-include-text (save-restriction (narrow-to-region b e) (org-mind-map-narrow-to-heading-content b) (mapconcat 'identity (org-element-map (org-element-parse-buffer 'object 'true) '(paragraph) (lambda (x) (org-mind-map-wrap-text (string-trim (substring-no-properties (car (org-element-contents x))))))) "



")) nil)) ) (if edgep (funcall (or (cdr (assoc fmt org-mind-map-edge-formats)) (lambda (a b) org-mind-map-edge-format-default)) hm el) (funcall (or (cdr (assoc fmt org-mind-map-node-formats)) 'org-mind-map-write-tags-default) title tags color hm el content images)))) (defun org-mind-map-first-headline (e) "Figure out the first headline within element E." (let* ((parent (org-element-property :parent e))) (if parent (if (eq (org-element-type parent) 'headline) parent (org-mind-map-first-headline parent)) nil))) (defun org-mind-map-valid-link? (e) "Is E at a valid link?" (condition-case ex (let* ((org-link-search-inhibit-query t) (type (org-element-property :type e)) (l (org-element-property :path e))) (if (string= type "fuzzy") (save-excursion (org-link-search l) t) nil)) ('error nil))) (defun org-mind-map-destination-headline (e) "Figure out where the link in E is pointing to." (let* ((l (org-element-property :path e)) (org-link-search-inhibit-query t)) (save-excursion (org-open-link-from-string (concat "[[" l "]]")) (org-element-at-point)))) (defun org-mind-map-get-links (hm) "Make a list of links with the headline they are within and their destination. Pass hashmap arg HM mapping tags to colors in order to keep the tag colors consistent across calls." (org-element-map (org-element-parse-buffer 'object) 'link (lambda (l) (if (org-mind-map-valid-link? l) (let* ((origin (org-mind-map-write-tags hm (org-mind-map-first-headline l))) (h (org-mind-map-destination-headline l)) (destination (org-mind-map-write-tags hm h))) (list origin destination)))))) (defun org-mind-map-make-legend (h) "Make a legend using the hash-map HM." (let ((res '())) (maphash (lambda (k v) (push k res)) h) (if (> (length res) 0) (concat "{ Legend [shape=none, margin=0, label=< " (mapconcat 'identity (let* (result) (maphash (lambda (name color) (push (concat "") result)) h) (reverse result)) "") "
Legend
" (org-mind-map-wrap-legend-lines name) "    
>];}")))) (defun org-mind-map-rgb (&optional exceptions) "Make a random pastel-like RGB color. Dont return any of the colors listed in the optional arg EXCEPTIONS." (let* ((fn (lambda nil (concat "#" (format "%x" (+ 125 (random (- 255 125)))) (format "%x" (+ 125 (random (- 255 125)))) (format "%x" (+ 125 (random (- 255 125))))))) (color (funcall fn))) (while (member color exceptions) (setq color (funcall fn))) color)) (defun org-mind-map-tags (&optional exceptions) "Return a hash map of tags in the org file mapped to random colors. Dont return any of the colors listed in the optional arg EXCEPTIONS." (let* ((hm (make-hash-table :test 'equal))) (org-element-map (org-element-parse-buffer 'headline) 'headline (lambda (hl) (let ((tags (mapcar 'substring-no-properties (org-element-property :tags hl))) (legend (org-element-property :OMM-LEGEND hl)) (color (org-element-property :OMM-COLOR hl))) (if legend (puthash legend color hm)) (if tags (mapcar (lambda (x) (puthash x (--if-let (assoc x org-mind-map-tag-colors) (cdr it) (org-mind-map-rgb (append exceptions (mapcar 'cdr org-mind-map-tag-colors)))) hm)) tags))))) hm)) (defun org-mind-map-data (&optional linksp) "Create graph & tag legend of all directed pairs of headlines for constructing the digraph. If LINKSP is non-nil include graph edges for org links." (let* ((hm (org-mind-map-tags org-mind-map-reserved-colors)) (output (org-element-map (org-element-parse-buffer 'headline) 'headline (lambda (hl) (let ((parent (org-element-property :parent hl))) (and (eq (org-element-type parent) 'headline) (list (org-mind-map-write-tags hm parent) (org-mind-map-write-tags hm hl) (org-mind-map-write-tags hm hl t)))))))) (list (append output (if linksp (org-mind-map-get-links hm))) hm))) (defun org-mind-map-make-dot (data) "Create the dot file from DATA." (let ((table (nth 0 data)) (legend (nth 1 data))) (concat "digraph structs {\n // DEFAULT OPTIONS\n" (if org-mind-map-default-graph-attribs (concat " graph [" (mapconcat #'(lambda (x) (concat (car x) "=\"" (cdr x) "\"")) org-mind-map-default-graph-attribs ", ") "];\n")) (if org-mind-map-default-node-attribs (concat " node [" (mapconcat #'(lambda (x) (concat (car x) "=\"" (cdr x) "\"")) org-mind-map-default-node-attribs ", ") "];\n")) (if org-mind-map-default-edge-attribs (concat " edge [" (mapconcat #'(lambda (x) (concat (car x) "=\"" (cdr x) "\"")) org-mind-map-default-edge-attribs ", ") "];\n")) " // NODES\n" (mapconcat #'(lambda (x) (concat " " (org-mind-map-dot-node-name x) " " x)) (-distinct (-flatten (mapcar (lambda (x) (list (nth 0 x) (nth 1 x))) table))) "\n") "\n // EDGES\n" (mapconcat #'(lambda (x) (format " %s -> %s;" (org-mind-map-dot-node-name (nth 0 x)) (org-mind-map-dot-node-name (nth 1 x)) (nth 2 x))) table "\n") (org-mind-map-make-legend legend) "}"))) (defun org-mind-map-command (name outputtype) "Return the shell script that will create the correct file NAME of type OUTPUTTYPE. The output file will be in the same location as the org file." (concat org-mind-map-unflatten-command " | " org-mind-map-dot-command " -T" (shell-quote-argument outputtype) " -K" (shell-quote-argument org-mind-map-engine) " -o" (shell-quote-argument (concat name "." outputtype "")))) (defun org-mind-map-update-message (filename process event) "Write an update message on the output of running org-mind-map based on PROCESS and EVENT. Open FILENAME according to value of `org-mind-map-display'." (let* ((e (with-current-buffer "*org-mind-map-errors*" (buffer-string)))) (if (string= e "") (princ (format "Org mind map %s" event)) (princ (format "Org mind map %sErrors: %s" event e))) (if (string= event "finished\n") (progn (cl-case org-mind-map-display (nil nil) (current (find-file filename)) (window (find-file-other-window filename)) (frame (switch-to-buffer-other-frame (find-file-noselect filename)))) (cl-case major-mode (pdf-view-mode (pdf-view-fit-page-to-window)) (doc-view-mode (doc-view-fit-page-to-window))))))) (defun org-mind-map-write-named (name &optional debug linksp) "Create a directed graph output based on the org tree in the current buffer, with name NAME. To customize, see the org-mind-map group. If DEBUG is non-nil, then print the dot command to the *Messages* buffer, and print the dotfile to the *Messages* buffer or to a file if DEBUG is a filename. If LINKSP is non-nil include graph edges for org links." (let ((dot (org-mind-map-make-dot (org-mind-map-data linksp))) a (outputtype (if (> (length org-mind-map-dot-output) 1) (completing-read "Output file type: " org-mind-map-dot-output) (car org-mind-map-dot-output)))) (if debug (progn (message (org-mind-map-command name outputtype)) (if (stringp debug) (with-temp-file debug (insert dot)) (message dot "%s")))) (if (get-buffer "*org-mind-map-errors*") (kill-buffer "*org-mind-map-errors*")) (let* ((p (start-process-shell-command "org-mind-map-s" "*org-mind-map-errors*" (org-mind-map-command name outputtype))) (filename (concat name "." outputtype ""))) (process-send-string p dot) (process-send-string p "\n") (process-send-eof p) (set-process-sentinel p (-partial 'org-mind-map-update-message filename)) filename))) ;;;###autoload (defun org-mind-map-write-with-prompt nil "Prompt for an output FILENAME (without extension) to write your output and .dot files." (let ((filename (read-file-name "What is the file name you would like to save to?"))) (org-mind-map-write-named filename (concat filename ".dot") (y-or-n-p "Include org links? ")))) (defun org-mind-map-default-filename (treenamep) "Return a default filename for saving the tree diagram. If TREENAMEP is non-nil include in the filename the name of the top level header of the tree." (concat (file-name-sans-extension (buffer-name)) "_diagram" (if treenamep (concat "-" (replace-regexp-in-string " +" "_" (nth 4 (org-heading-components))))))) ;;;###autoload (defun org-mind-map-write (&optional promptp) "Create a digraph based on all org trees in the current buffer. The digraph will be named the same name as the current buffer. To customize, see the org-mind-map group. If called with prefix arg (or PROMPTP is non-nil), then call `org-mind-map-write-with-prompt'." (interactive "P") (if promptp (org-mind-map-write-with-prompt) (org-mind-map-write-named (org-mind-map-default-filename nil)))) ;;;###autoload (defun org-mind-map-write-current-branch (&optional promptp) "Create a directed graph output based on just the current org tree branch. To customize, see the org-mind-map group. If called with prefix arg (or PROMPTP is non-nil), then call `org-mind-map-write-with-prompt'." (interactive "P") (org-narrow-to-subtree) (let ((filename (if promptp (org-mind-map-write-with-prompt) (org-mind-map-write-named (org-mind-map-default-filename t))))) (widen) filename)) ;;;###autoload (defun org-mind-map-write-current-tree (&optional promptp) "Create a directed graph output based on the whole current org tree. If called with prefix arg (or PROMPTP is non-nil), then call `org-mind-map-write-with-prompt'." (interactive "P") (save-restriction (ignore-errors (outline-up-heading 100)) (org-mind-map-write-current-branch promptp))) ;;;###autoload (defmacro org-mind-map-make-node-fn (name doc props &optional shape color other) "Create a function org-mind-map-NAME-node for use with :OMM-NODE-FMT writing node properties. The created function should be added to `org-mind-map-node-formats' and the associated string can be used as the :OMM-NODE-FMT for a tree. Document the function with the DOC arg. PROPS is a list of either property & format string pairs, or individual property names, which will be placed in each node, e.g: ((\"PROB\" \"probability=%s\") \"COST\"). For property names with no format string, \"%s=%s\" will be used with the property name and value. The node shape and background color can be specified with the optional SHAPE and COLOR arguments, and any other attributes (e.g. \"fontsize=30\") can be specified with the OTHER argument. Each of these arguments can be either a string or a form which is evaluated for each node, and returns a string. Example: (org-mind-map-make-node-fn decisiontree \"Draw decision tree\" (\"COST\" (\"NOTES\" \"Notes: %s\")) nil (cond ((equal (org-mind-map-get-property :todo-keyword el) \"ACTION\") \"red\") ((equal (org-mind-map-get-property :todo-keyword el) \"STATE\") \"yellow\") ((equal (org-mind-map-get-property :todo-keyword el) \"DECISION\") \"green\"))) You could put this code in your emacs startup file (e.g. ~/.emacs) and then add to `org-mind-map-node-formats' the pair '(\"decisiontree\" . org-mind-map-decisiontree-node), and use \":OMM-NODE-FMT: decisiontree\" as a tree property." `(defun ,(intern (concat "org-mind-map-" (symbol-name name) "-node")) (title tags color hm el) ,doc (let* ((numtags (if tags (length tags))) (colspan (if tags (int-to-string numtags))) (propstxt (cl-remove nil (list ,@(mapcar (lambda (p) (cond ((stringp p) `(--if-let (org-mind-map-get-property ,p el) (concat ,(upcase p) "=" it))) ((consp p) `(--if-let (org-mind-map-get-property ,(car p) el) (format ,(nth 1 p) it))) (t (error "Invalid props value")))) props)))) (shape ,shape) (color (or color ,color)) (other ,other)) (concat "[label=<" (if numtags (concat "" title "" (mapconcat (lambda (p) (concat "" (org-mind-map-add-color hm p numtags) "")) propstxt "") (if numtags (concat "" (mapconcat (-partial 'org-mind-map-add-color hm) tags "") "")) ">" (if shape (concat ",shape=" shape (if color (concat ",style=filled,color=" color)))) (if other (concat "," other)) "];")))) ;;;###autoload (defmacro org-mind-map-make-edge-fn (name doc props &optional style color other) "Create a function org-mind-map-write-NAME for writing edge properties which can be used for :OMM-EDGE-FMT. Document the function with the DOC arg. PROPS is a list of either property & format string pairs, or individual property names, which will concatenated and used to label the edges, e.g: ((\"PROB\" \"probability=%s\") \"COST\"). For property names with no format string \"%s=%s\" will be used with the property name and value. The edge style and color can be specified with the optional STYLE and COLOR arguments, and any other attributes (e.g. \"fontsize=30\") can be specified with the OTHER argument. Each of these arguments can be either a string or a form which is evaluated for each node, and returns a string. Example: (org-mind-map-make-edge-fn decisiontree \"Draw decision tree\" (\"PROB\")) You could put this code in your emacs startup file (e.g. ~/.emacs) and then add to `org-mind-map-edge-formats' the pair '(\"decisiontree\" . org-mind-map-decisiontree-edge), and use \":OMM-EDGE-FMT: decisiontree\" as a tree property." `(defun ,(intern (concat "org-mind-map-" (symbol-name name) "-edge")) (hm el) ,doc (let* ((propstxt (cl-remove nil (list ,@(mapcar (lambda (p) (cond ((stringp p) `(--if-let (org-mind-map-get-property ,p el) (concat ,(upcase p) "=" it))) ((consp p) `(--if-let (org-mind-map-get-property ,(car p) el) (format ,(nth 1 p) it))) (t (error "Invalid props value")))) props)))) (style ,style) (color ,color) (other ,other)) (concat "[label=\"" (mapconcat 'identity propstxt ",") "\"" (if color (concat ",color=\"" color "\" ")) (if style (concat ",style=\"" style "\"")) (if other (concat "," other)) "]")))) (defun ox-graphviz-export (&optional async subtreep visible-only body-only info) "Export the current buffer to a graphviz diagram. Optional argument ASYNC to asynchronously export. Optional argument SUBTREEP to export current subtree. Optional argument VISIBLE-ONLY to only export visible content. Optional argument BODY-ONLY export only the body. Optional argument INFO is a plist of options." (let ((org-mind-map-display nil)) (if subtreep (org-mind-map-write-current-branch) (org-mind-map-write)))) (defun ox-graphviz-export-and-open (&optional async subtreep visible-only body-only info) "Export the current buffer to a graphviz diagram, and open the output file. Optional argument ASYNC to asynchronously export. Optional argument SUBTREEP to export current subtree. Optional argument VISIBLE-ONLY to only export visible content. Optional argument BODY-ONLY export only the body. Optional argument INFO is a plist of options." (let ((org-mind-map-display (or org-mind-map-display 'current))) (if subtreep (org-mind-map-write-current-branch) (org-mind-map-write)))) (defun ox-graphviz-export-dot (&optional async subtreep visible-only body-only info) "Export the current buffer to a graphviz diagram, and create and open a dot file. Optional argument ASYNC to asynchronously export. Optional argument SUBTREEP to export current subtree. Optional argument VISIBLE-ONLY to only export visible content. Optional argument BODY-ONLY export only the body. Optional argument INFO is a plist of options." (let ((org-mind-map-display nil) (filename (org-mind-map-default-filename subtreep)) (linksp (y-or-n-p "Include org links? "))) (if subtreep (org-narrow-to-subtree)) (org-mind-map-write-named filename (concat filename ".dot") linksp) (widen))) (defun ox-graphviz-export-dot-and-open (&optional async subtreep visible-only body-only info) "Export the current buffer to a graphviz diagram and a dot file, and open the output file. Optional argument ASYNC to asynchronously export. Optional argument SUBTREEP to export current subtree. Optional argument VISIBLE-ONLY to only export visible content. Optional argument BODY-ONLY export only the body. Optional argument INFO is a plist of options." (let ((org-mind-map-display (or org-mind-map-display 'current)) (filename (org-mind-map-default-filename subtreep)) (linksp (y-or-n-p "Include org links? "))) (if subtreep (org-narrow-to-subtree)) (org-mind-map-write-named filename (concat filename ".dot") linksp) (widen))) (defun org-mind-map-export-message nil "Message string for `org-export-dispatch' buffer." (if (> (length org-mind-map-dot-output) 1) "Select output file format" (concat "As " (car org-mind-map-dot-output) " file"))) (org-export-define-derived-backend 'graphviz 'org :menu-entry '(?g "Export to graphviz diagram" ((?f "Create graph" ox-graphviz-export) (?o "Create graph and open" ox-graphviz-export-and-open) (?d "Create graph & dot file" ox-graphviz-export-dot) (?O "Create graph & dot file, and open graph" ox-graphviz-export-dot-and-open)))) ;; Add a tool bar icon ;; (define-key org-mode-map [tool-bar org-button] ;; '(menu-item "Write the org-mode file mind map to disk." org-mind-map-write-with-prompt ;; :image (image :type xpm :file "info.xpm") ;; )) ;; Add menu items ;; (define-key org-mode-map [menu-bar Org Diagram] ;; (cons "Graphviz diagram" (make-sparse-keymap "Graphviz diagram"))) ;; (define-key org-mode-map [menu-bar Org Diagram all] ;; '("Diagram of whole buffer" . org-mind-map-write)) ;; (define-key org-mode-map [menu-bar Org Diagram current] ;; '("Diagram of current tree" . org-mind-map-write-current-tree)) ;; (define-key org-mode-map [menu-bar Org Diagram branch] ;; '("Diagram of current branch" . org-mind-map-write-current-branch)) ;; (global-set-key (kbd "") 'org-mind-map-write) (provide 'org-mind-map) ;;; org-mind-map.el ends here