├── .gitignore ├── examples ├── Lena.png ├── example-7.png ├── example-8.png ├── example-1.org.png ├── example-2.org.png ├── example-3.org.png ├── example-4.org.png ├── example-5.org.png ├── example-2.org ├── example-8.org ├── example-1.org ├── example-7.org ├── example-3.org ├── example-4.org └── example-5.org ├── org-mind-map.el.pdf ├── example-2.org ├── example-1.org ├── example-7.org ├── example-3.org ├── example-4.org ├── example-5.org ├── README.md ├── LICENSE └── org-mind-map.el /.gitignore: -------------------------------------------------------------------------------- 1 | org-mind-map.el~ 2 | *~ -------------------------------------------------------------------------------- /examples/Lena.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/Lena.png -------------------------------------------------------------------------------- /org-mind-map.el.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/org-mind-map.el.pdf -------------------------------------------------------------------------------- /examples/example-7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-7.png -------------------------------------------------------------------------------- /examples/example-8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-8.png -------------------------------------------------------------------------------- /examples/example-1.org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-1.org.png -------------------------------------------------------------------------------- /examples/example-2.org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-2.org.png -------------------------------------------------------------------------------- /examples/example-3.org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-3.org.png -------------------------------------------------------------------------------- /examples/example-4.org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-4.org.png -------------------------------------------------------------------------------- /examples/example-5.org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-ted/org-mind-map/HEAD/examples/example-5.org.png -------------------------------------------------------------------------------- /example-2.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | ** Branch A :TagA: 3 | *** Sub-Branch 1 :TagA: 4 | *** Sub-Branch 2 :TagA: 5 | *** Sub-Branch 3 :TagA:TagB: 6 | ** Branch B :TagB: 7 | ** Branch C 8 | ** Branch D 9 | -------------------------------------------------------------------------------- /examples/example-2.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | ** Branch A :TagA: 3 | *** Sub-Branch 1 :TagA: 4 | *** Sub-Branch 2 :TagA: 5 | *** Sub-Branch 3 :TagA:TagB: 6 | ** Branch B :TagB: 7 | ** Branch C 8 | ** Branch D 9 | -------------------------------------------------------------------------------- /example-1.org: -------------------------------------------------------------------------------- 1 | * This is an example org-mode tree 2 | The content of the node doesn't matter. 3 | ** Branch A 4 | *** Sub-Branch 1 5 | *** Sub-Branch 2 6 | *** Sub-Branch 3 7 | ** Branch B 8 | ** Branch C 9 | ** Branch D 10 | 11 | -------------------------------------------------------------------------------- /examples/example-8.org: -------------------------------------------------------------------------------- 1 | * Node A 2 | 3 | ** Node B 4 | 5 | Example paragraph 6 | 7 | [[Node C]] 8 | 9 | [[./Lena.png]] 10 | 11 | ** Node C 12 | 13 | More details 14 | 15 | ** Node D 16 | 17 | [[Node A]] 18 | -------------------------------------------------------------------------------- /examples/example-1.org: -------------------------------------------------------------------------------- 1 | * This is an example org-mode tree 2 | The content of the node doesn't matter. 3 | ** Branch A 4 | *** Sub-Branch 1 5 | *** Sub-Branch 2 6 | *** Sub-Branch 3 7 | ** Branch B 8 | ** Branch C 9 | ** Branch D 10 | 11 | -------------------------------------------------------------------------------- /example-7.org: -------------------------------------------------------------------------------- 1 | * Branch One 2 | ** Branch Two 3 | Here is some interesting text... 4 | 5 | ** Branch Three 6 | *** Example 7 | - Plain lists show up as additional paragraphs 8 | 9 | [[http://www.google.com/][But links don't show up at all]] 10 | 11 | #+BEGIN_SRC 12 | Nor do source code blocks. 13 | #+END_SRC 14 | -------------------------------------------------------------------------------- /examples/example-7.org: -------------------------------------------------------------------------------- 1 | * Branch One 2 | ** Branch Two 3 | Here is some interesting text... 4 | 5 | ** Branch Three 6 | *** Example 7 | - Plain lists show up as additional paragraphs 8 | 9 | [[http://www.google.com/][But links don't show up at all]] 10 | 11 | #+BEGIN_SRC 12 | Nor do source code blocks. 13 | #+END_SRC 14 | -------------------------------------------------------------------------------- /example-3.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | ** Branch A :TagA: 3 | *** Sub-Branch 1 :TagA: 4 | *** Sub-Branch 2 :TagA: 5 | *** Sub-Branch 3 :TagA:TagB: 6 | ** Branch B :TagB: 7 | ** Branch C 8 | ** Branch D 9 | * This is an org-mode tree that interleaves 10 | ** Branch E 11 | *** Sub-Branch 3 12 | *** Sub-Branch 3 :TagA:TagB: 13 | ** Branch B 14 | 15 | 16 | -------------------------------------------------------------------------------- /examples/example-3.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | ** Branch A :TagA: 3 | *** Sub-Branch 1 :TagA: 4 | *** Sub-Branch 2 :TagA: 5 | *** Sub-Branch 3 :TagA:TagB: 6 | ** Branch B :TagB: 7 | ** Branch C 8 | ** Branch D 9 | * This is an org-mode tree that interleaves 10 | ** Branch E 11 | *** Sub-Branch 3 12 | *** Sub-Branch 3 :TagA:TagB: 13 | ** Branch B 14 | 15 | 16 | -------------------------------------------------------------------------------- /example-4.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | :PROPERTIES: 3 | :OMM-COLOR: GREEN 4 | :OMM-LEGEND: Legend entry 5 | :END: 6 | 7 | ** Branch A 8 | *** Sub-Branch 1 9 | *** Sub-Branch 2 10 | *** Sub-Branch 3 11 | 12 | ** Branch B 13 | 14 | 15 | ** Branch C 16 | ** Branch D 17 | * This is an org-mode tree that interleaves :TagOne: 18 | ** Branch E 19 | *** Sub-Branch 3 :TagTwo: 20 | 21 | *** Sub-Branch 3 :TagOne: 22 | ** Branch B 23 | ** Branch C 24 | -------------------------------------------------------------------------------- /examples/example-4.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | :PROPERTIES: 3 | :OMM-COLOR: GREEN 4 | :OMM-LEGEND: Legend entry 5 | :END: 6 | 7 | ** Branch A 8 | *** Sub-Branch 1 9 | *** Sub-Branch 2 10 | *** Sub-Branch 3 11 | 12 | ** Branch B 13 | 14 | 15 | ** Branch C 16 | ** Branch D 17 | * This is an org-mode tree that interleaves :TagOne: 18 | ** Branch E 19 | *** Sub-Branch 3 :TagTwo: 20 | 21 | *** Sub-Branch 3 :TagOne: 22 | ** Branch B 23 | ** Branch C 24 | -------------------------------------------------------------------------------- /example-5.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | :PROPERTIES: 3 | :OMM-COLOR: GREEN 4 | :OMM-LEGEND: Legend entry 5 | :END: 6 | 7 | ** Branch A 8 | *** Sub-Branch 1 9 | *** Sub-Branch 2 10 | *** Sub-Branch 3 11 | 12 | ** Branch B 13 | 14 | 15 | ** Branch C 16 | ** Branch D 17 | * Here is another tree 18 | ** Branch One 19 | ** Branch Two 20 | [[Branch C]] 21 | ** Branch Three 22 | 23 | [[Branch One][Another link]] 24 | 25 | [[Sub-Branch 1][Yet Another Link]] 26 | 27 | 28 | -------------------------------------------------------------------------------- /examples/example-5.org: -------------------------------------------------------------------------------- 1 | * This is an org-mode tree with tags 2 | :PROPERTIES: 3 | :OMM-COLOR: GREEN 4 | :OMM-LEGEND: Legend entry 5 | :END: 6 | 7 | ** Branch A 8 | *** Sub-Branch 1 9 | *** Sub-Branch 2 10 | *** Sub-Branch 3 11 | 12 | ** Branch B 13 | 14 | 15 | ** Branch C 16 | ** Branch D 17 | * Here is another tree 18 | ** Branch One 19 | ** Branch Two 20 | [[Branch C]] 21 | ** Branch Three 22 | 23 | [[Branch One][Another link]] 24 | 25 | [[Sub-Branch 1][Yet Another Link]] 26 | 27 | 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # org-mind-map 2 | 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. 3 | 4 | # Requirements 5 | 6 | This package relies on the [Graphviz](http://graphviz.org/) suite of graphical diagramming tools. 7 | ## windows 8 | (the default option), these tools are available via [cygwin](http://cygwin.com/). 9 | ## linux 10 | these tools are available through any of the popular package managers. 11 | ## mac 12 | binarys are at the graphviz site, but for recent versions like El Capitan, Sierra and High Sierra, macports or 13 | homebrew are recommended. 14 | 15 | ```bash 16 | brew install graphviz 17 | ``` 18 | 19 | This package also relies on the org-mode and dash libraries, available from melpa (M-x list-packages). 20 | 21 | # Installation and usage 22 | 23 | To install, add this code to your .emacs: 24 | 25 | ```elisp 26 | (load "INSTALLPATH/org-mind-map.el") 27 | ``` 28 | 29 | or if you're using use-package: 30 | 31 | ```elisp 32 | ;; This is an Emacs package that creates graphviz directed graphs from 33 | ;; the headings of an org file 34 | (use-package org-mind-map 35 | :init 36 | (require 'ox-org) 37 | :ensure t 38 | ;; Uncomment the below if 'ensure-system-packages` is installed 39 | ;;:ensure-system-package (gvgen . graphviz) 40 | :config 41 | (setq org-mind-map-engine "dot") ; Default. Directed Graph 42 | ;; (setq org-mind-map-engine "neato") ; Undirected Spring Graph 43 | ;; (setq org-mind-map-engine "twopi") ; Radial Layout 44 | ;; (setq org-mind-map-engine "fdp") ; Undirected Spring Force-Directed 45 | ;; (setq org-mind-map-engine "sfdp") ; Multiscale version of fdp for the layout of large graphs 46 | ;; (setq org-mind-map-engine "twopi") ; Radial layouts 47 | ;; (setq org-mind-map-engine "circo") ; Circular Layout 48 | ) 49 | ``` 50 | 51 | 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. 52 | 53 | # Examples 54 | 55 | - [Basic concept](#basic-concept) 56 | - [Tags](#tags) 57 | - [Selective Colors](#selective-colors) 58 | - [Links](#links) 59 | - [Including text](#including-text) 60 | - [Including images (BETA)](#including-images-beta) 61 | - [Selective Export](#selective-export) 62 | 63 | ## Basic concept 64 | 65 | Here is an example org-mode tree that demonstrates the basic concept: 66 | 67 | ```Org 68 | * This is an example org-mode tree 69 | The content of the node doesn't matter. 70 | ** Branch A 71 | *** Sub-Branch 1 72 | *** Sub-Branch 2 73 | *** Sub-Branch 3 74 | ** Branch B 75 | ** Branch C 76 | ** Branch D 77 | ``` 78 | 79 | and the result is shown below: 80 | 81 | ![examples/example-1.org.pdf](examples/example-1.org.png) 82 | 83 | ## Tags 84 | 85 | You can also add tags, as in this org-mode file: 86 | 87 | ```Org 88 | * This is an org-mode tree with tags 89 | ** Branch A :TagA: 90 | *** Sub-Branch 1 :TagA: 91 | *** Sub-Branch 2 :TagA: 92 | *** Sub-Branch 3 :TagA:TagB: 93 | ** Branch B :TagB: 94 | ** Branch C 95 | ** Branch D 96 | ``` 97 | 98 | These are randomly color-coded into pastel tags: 99 | 100 | ![examples/example-2.org.pdf](examples/example-2.org.png) 101 | 102 | ## Selective Colors 103 | 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: 104 | 105 | ```Org 106 | * This is an org-mode tree with tags 107 | :PROPERTIES: 108 | :OMM-COLOR: GREEN 109 | :OMM-LEGEND: Legend entry 110 | :END: 111 | 112 | ** Branch A 113 | *** Sub-Branch 1 114 | *** Sub-Branch 2 115 | *** Sub-Branch 3 116 | 117 | ** Branch B 118 | 119 | 120 | ** Branch C 121 | ** Branch D 122 | * This is an org-mode tree that interleaves :TagOne: 123 | ** Branch E 124 | *** Sub-Branch 3 :TagTwo: 125 | 126 | *** Sub-Branch 3 :TagOne: 127 | ** Branch B 128 | ** Branch C 129 | ``` 130 | 131 | this results in this file: 132 | 133 | ![examples/example-4.org.png](examples/example-4.org.png) 134 | 135 | ## Links 136 | 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: 137 | 138 | ```Org 139 | * This is an org-mode tree with tags 140 | :PROPERTIES: 141 | :OMM-COLOR: GREEN 142 | :OMM-LEGEND: Legend entry 143 | :END: 144 | 145 | ** Branch A 146 | *** Sub-Branch 1 147 | *** Sub-Branch 2 148 | *** Sub-Branch 3 149 | 150 | ** Branch B 151 | 152 | 153 | ** Branch C 154 | ** Branch D 155 | * Here is another tree 156 | ** Branch One 157 | ** Branch Two 158 | [[Branch C]] 159 | ** Branch Three 160 | 161 | [[Branch One][Another link]] 162 | 163 | [[Sub-Branch 1][Yet Another Link]] 164 | ``` 165 | 166 | this results in this file: 167 | 168 | ![examples/example-5.org.png](examples/example-5.org.png) 169 | 170 | ## Including text 171 | 172 | You can also control the display of text within each heading with 173 | the `org-mind-map-include-text` option. When set to `t`, this 174 | displays all of the paragraph text underneath a given 175 | headline. 176 | 177 | For example, 178 | 179 | ```Org 180 | * Branch One 181 | ** Branch Two 182 | Here is some interesting text... 183 | 184 | ** Branch Three 185 | *** Example 186 | - Plain lists show up as additional paragraphs 187 | 188 | [[http://www.google.com/][But links don't show up at all]] 189 | 190 | #+BEGIN_SRC 191 | Nor do source code blocks. 192 | #+END_SRC 193 | ``` 194 | 195 | this results in this file: 196 | 197 | ![examples/example-7.png](examples/example-7.png) 198 | 199 | 200 | ## Including images BETA 201 | 202 | 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. 203 | 204 | For example, 205 | 206 | ```Org 207 | * Node A 208 | 209 | ** Node B 210 | 211 | Example paragraph 212 | 213 | [[Node C]] 214 | 215 | [[./Lena.png]] 216 | 217 | ** Node C 218 | 219 | More details 220 | 221 | ** Node D 222 | 223 | [[Node A]] 224 | ``` 225 | 226 | Results in this file: 227 | 228 | ![examples/example-8.png](examples/example-8.png) 229 | 230 | # Thanks! 231 | 232 | http://pages.sachachua.com/evil-plans/ 233 | 234 | # Other Options 235 | 236 | 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. 237 | 238 | ## Selective Export 239 | Use the command `org-mind-map-write-current-tree` to just create a map from the current tree. 240 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /org-mind-map.el: -------------------------------------------------------------------------------- 1 | ;;; org-mind-map.el --- Creates a directed graph from org-mode files 2 | ;; Author: Ted Wiles 3 | ;; Keywords: orgmode, extensions, graphviz, dot 4 | ;; Version: 0.4 5 | ;; URL: https://github.com/theodorewiles/org-mind-map 6 | ;; Package-Requires: ((emacs "24") (dash "1.8.0") (org "8.2.10")) 7 | 8 | ;; This file is NOT part of GNU Emacs. 9 | 10 | ;; This program is free software; you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation; either version 3, or (at your option) 13 | ;; any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with GNU Emacs; see the file LICENSE. If not, write to the 22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 23 | ;; Boston, MA 02110-1301, USA. 24 | 25 | ;;; Commentary: 26 | 27 | ;; This package takes an org-mode tree and converts it into a 28 | ;; file that can be read into graphviz in order to visually show the 29 | ;; tree as a directed graph. Mail to to discuss 30 | ;; features and additions. All suggestions are more than welcome. 31 | 32 | ;;; Commands: 33 | ;; 34 | ;; Below is a complete list of commands: 35 | ;; 36 | ;; `org-mind-map-write' 37 | ;; Create a digraph based on all org trees in the current buffer. 38 | ;; Keybinding: M-x org-mind-map-write 39 | ;; `org-mind-map-write-current-branch' 40 | ;; Create a directed graph output based on just the current org tree branch. 41 | ;; Keybinding: M-x org-mind-map-write-current-branch 42 | ;; `org-mind-map-write-current-tree' 43 | ;; Create a directed graph output based on the whole current org tree. 44 | ;; Keybinding: M-x org-mind-map-write-current-tree 45 | ;; 46 | ;;; Customizable Options: 47 | ;; 48 | ;; Below is a list of customizable options: 49 | ;; 50 | ;; `org-mind-map-wrap-line-length' 51 | ;; Line length within graphviz nodes. 52 | ;; default = 30 53 | ;; `org-mind-map-wrap-legend-line-length' 54 | ;; Line length of the graphviz legend. 55 | ;; default = 45 56 | ;; `org-mind-map-unflatten-command' 57 | ;; Shell executable command for running the UNFLATTEN command. 58 | ;; default = "unflatten -l3" 59 | ;; `org-mind-map-dot-command' 60 | ;; Shell executable command for running the DOT command. 61 | ;; default = "dot" 62 | ;; `org-mind-map-dot-output' 63 | ;; Format of the DOT output. Defaults to PDF. 64 | ;; default = "pdf" 65 | ;; `org-mind-map-engine' 66 | ;; Sets the layout engine used in your graphs. 67 | ;; default = "dot" 68 | ;; `org-mind-map-default-node-attribs' 69 | ;; Alist of default node attributes and values. 70 | ;; default = '(("shape" . "plaintext")) 71 | ;; `org-mind-map-default-edge-attribs' 72 | ;; Alist of default edge attributes and values. 73 | ;; default = nil 74 | ;; `org-mind-map-default-graph-attribs' 75 | ;; Alist of default graph attributes and values. 76 | ;; default = '(("autosize" . "false") ("size" . "9,12") ("resolution" . "100") ...)) 77 | ;; `org-mind-map-node-formats' 78 | ;; Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-NODE-FMT property 79 | ;; See also `org-mind-map-make-node-fn' 80 | ;; default = nil 81 | ;; `org-mind-map-edge-formats' 82 | ;; Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-EDGE-FMT property 83 | ;; See also `org-mind-map-make-edge-fn' 84 | ;; default = nil 85 | ;; `org-mind-map-edge-format-default' 86 | ;; Default format string for graph edges, e.g. "[style=dotted]". 87 | ;; default = "" 88 | ;; `org-mind-map-reserved-colors' 89 | ;; List of colors that will not be used for coloring tags. 90 | ;; default = nil 91 | ;; `org-mind-map-tag-colors' 92 | ;; An alist of (TAG . COLOR) pairs for choosing colors for tags. 93 | ;; default = nil 94 | ;; `org-mind-map-include-text' 95 | ;; A boolean indicating whether our not to include paragraph text in body of nodes. 96 | ;; default = t 97 | ;; `org-mind-map-include-images' 98 | ;; A boolean indicating whether our not to include images in body of nodes. 99 | ;; default = t 100 | 101 | 102 | ;; The headings of the org-mode file are treated as node text in the resulting tree. 103 | ;; Org-mode heading tags are included in the resulting tree as additional cells 104 | ;; within the node. 105 | 106 | ;; The tags are color-coded to be consistent across the tree. 107 | 108 | ;; Tree interleaving is also possible by naming multiple org-mode headings 109 | ;; with the same heading. 110 | 111 | ;; NOTE: this requires the GRAPHVIZ software. This is installable on 112 | ;; windows using cygwin. 113 | 114 | ;; To install, add this code to your .emacs: 115 | ;; (load "org-mind-map.el") 116 | 117 | ;; If on linux, customize the values of `org-mind-map-unflatten-command' 118 | ;; and `org-mind-map-dot-command' to have the values corresponding to 119 | ;; the executables in your system. 120 | 121 | ;; Then, run "M-x org-mind-map-write" to create a graph of all trees in the current buffer, 122 | 123 | ;; You can customize the style of the graph by adding :OMM-NODE-FMT and :OMM-EDGE-FMT properties 124 | ;; to the headlines in the tree. 125 | 126 | ;; The latest version is available at: 127 | ;; 128 | ;; https://github.com/theodorewiles/org-mind-map 129 | ;; 130 | 131 | ;;; Code: 132 | 133 | (require 'dash) 134 | (require 'org) 135 | (require 'subr-x) 136 | 137 | (defconst org-mind-map-version "0.4") 138 | 139 | (defgroup org-mind-map nil 140 | "Convert org-mode tree into a graphviz directed graph" 141 | :group 'org) 142 | 143 | (defcustom org-mind-map-wrap-line-length 30 144 | "Line length within graphviz nodes." 145 | :type 'integer 146 | :group 'org-mind-map) 147 | 148 | (defcustom org-mind-map-wrap-text-length 60 149 | "Line length within graphviz nodes that have longer text." 150 | :type 'integer 151 | :group 'org-mind-map) 152 | 153 | (defcustom org-mind-map-wrap-legend-line-length 45 154 | "Line length of the graphviz legend." 155 | :type 'integer 156 | :group 'org-mind-map) 157 | 158 | (defcustom org-mind-map-unflatten-command "unflatten -l3" 159 | "Shell executable command for running the UNFLATTEN command." 160 | :type 'string 161 | :group 'org-mind-map) 162 | 163 | (defcustom org-mind-map-dot-command "dot" 164 | "Shell executable command for running the DOT command." 165 | :type 'string 166 | :group 'org-mind-map) 167 | 168 | (defcustom org-mind-map-dot-output '("pdf" "png" "jpeg" "svg" "eps" "gif" "tiff") 169 | "List of formats for the DOT output file. 170 | If more than one are specified then the user will be prompted to choose one. 171 | To find a list of available formats, on the command line enter: dot -T?" 172 | :type '(repeat (string :tag "File type")) 173 | :group 'org-mind-map) 174 | 175 | (defcustom org-mind-map-display nil 176 | "How the results should be displayed: 177 | nil = don't display results 178 | current = display results in current window 179 | window = display results in new window 180 | frame = display results in new frame" 181 | :type '(choice (const :tag "Don't display" nil) 182 | (const :tag "Display in current window" current) 183 | (const :tag "Display in new window" window) 184 | (const :tag "Display in new frame" frame)) 185 | :group 'org-mind-map) 186 | 187 | (defcustom org-mind-map-engine "dot" 188 | "Sets the layout engine used in your graphs. 189 | See the graphviz user manual for description of these options." 190 | :type '(choice 191 | (const :tag "Directed Graph" "dot") 192 | (const :tag "Undirected Spring Graph" "neato") 193 | (const :tag "Radial Layout" "twopi") 194 | (const :tag "Circular Layout" "circo") 195 | (const :tag "Undirected Spring Force-Directed" "fdp")) 196 | :group 'org-mind-map) 197 | 198 | (defcustom org-mind-map-default-node-attribs '(("shape" . "plaintext")) 199 | "Alist of default node attributes and values. 200 | Each item in the alist should be a cons cell of the form (ATTRIB . VALUE) 201 | where ATTRIB and VALUE are strings. 202 | For a list of value attributes, see here: https://graphviz.gitlab.io/_pages/doc/info/attrs.html" 203 | :type '(alist :key-type (string :tag "Attribute") :value-type (string :tag " Value")) 204 | :group 'org-mind-map) 205 | 206 | (defcustom org-mind-map-default-edge-attribs nil 207 | "Alist of default edge attributes and values. 208 | Each item in the alist should be a cons cell of the form (ATTRIB . VALUE) 209 | where ATTRIB and VALUE are strings. 210 | For a list of value attributes, see here: https://graphviz.gitlab.io/_pages/doc/info/attrs.html" 211 | :type '(alist :key-type (string :tag "Attribute") :value-type (string :tag " Value")) 212 | :group 'org-mind-map) 213 | 214 | (defcustom org-mind-map-default-graph-attribs '(("autosize" . "false") 215 | ("size" . "9,12") 216 | ("resolution" . "100") 217 | ("nodesep" . "0.75") 218 | ("overlap" . "false") 219 | ("spline" . "true") 220 | ("rankdir" . "LR")) 221 | "Alist of default graph attributes and values. 222 | Each item in the alist should be a cons cell of the form (ATTRIB . VALUE) 223 | where ATTRIB and VALUE are strings. 224 | For a list of value attributes, see here: https://graphviz.gitlab.io/_pages/doc/info/attrs.html" 225 | :type '(alist :key-type (string :tag "Attribute") :value-type (string :tag " Value")) 226 | :group 'org-mind-map) 227 | 228 | (defcustom org-mind-map-node-formats nil 229 | "Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-NODE-FMT property 230 | of a node/headline, and FN is a function which outputs a format string to be placed after the 231 | node name (e.g. \"[label='Node1',color='red']\"). 232 | The function FN should take the following 5 arguments which can be used to construct the format: 233 | 234 | TITLE = the label string for the node 235 | TAGS = a list of org tags for the current node 236 | COLOR = the contents of the OMM-COLOR property for the current node 237 | HM = a hash map of colors 238 | EL = an org element obtained from `org-element-map' 239 | 240 | Note: the :OMM-NODE-FMT property is inherited by children of the node/headline where it is defined." 241 | :type '(alist :key-type (string :tag " Name") 242 | :value-type (function :tag "Format function")) 243 | :group 'org-mind-map) 244 | 245 | (defcustom org-mind-map-edge-formats nil 246 | "Assoc list of (NAME . FN) pairs where NAME is a value for the :OMM-EDGE-FMT property 247 | of a node/headline, and FN is a function which outputs a format string to be placed after an 248 | edge (e.g. \"[style=dotted]\"). 249 | The function FN should take the following 2 arguments which can be used to construct the format: 250 | 251 | HM = a hash map of colors 252 | EL = an org element obtained from `org-element-map' 253 | 254 | Note: the :OMM-EDGE-FMT property affects edges leading to the node at which it is defined, and 255 | is inherited by children of that node/headline." 256 | :type '(alist :key-type (string :tag " Name") 257 | :value-type (function :tag "Format function")) 258 | :group 'org-mind-map) 259 | 260 | (defcustom org-mind-map-edge-format-default "" 261 | "Default format string for graph edges, e.g. \"[style=dotted]\"." 262 | :type 'string 263 | :group 'org-mind-map) 264 | 265 | (defcustom org-mind-map-reserved-colors nil 266 | "List of colors that will not be used for coloring tags. 267 | These colors will be excluded when random tag colors are chosen by `org-mind-map-rgb' 268 | so that you can use them for other things. 269 | Each color should be in hexadecimal form, e.g: \"#e3cfbc\", where the consecutive pairs 270 | of hexdigits indicate levels of red, green and blue respectively. 271 | It is not necessary to include any colors with levels below 7d, as these are not used 272 | for creating random tag colors." 273 | :type '(repeat string) 274 | :group 'org-mind-map) 275 | 276 | (defcustom org-mind-map-tag-colors nil 277 | "An alist of (TAG . COLOR) pairs for choosing colors for tags. 278 | Any tags not listed here will be colored with randomly selected colors that dont 279 | clash with those in `org-mind-map-reserved-colors'. 280 | Each color should be in hexadecimal form, e.g: \"#e3cfbc\", where the consecutive pairs 281 | of hexdigits indicate levels of red, green and blue respectively. 282 | 283 | Note: you can also set tag colors by altering the hashmap passed as an argument to functions 284 | defined in `org-mind-map-node-formats'." 285 | :type '(alist :key-type (string :tag " Tag") :value-type (string :tag "Color")) 286 | :group 'org-mind-map) 287 | 288 | (defcustom org-mind-map-include-text t 289 | "A boolean indicating whether our not to include paragraph text in body of nodes. 290 | default = t" 291 | :type 'boolean 292 | :group 'org-mind-map 293 | ) 294 | 295 | (defcustom org-mind-map-include-images t 296 | "A boolean indicating whether our not to include paragraph text in body of nodes. 297 | default = t" 298 | :type 'boolean 299 | :group 'org-mind-map 300 | ) 301 | 302 | 303 | (defun org-mind-map-do-wrap (words width) 304 | "Create lines of maximum width WIDTH (in characters) from word list WORDS." 305 | (let (lines line) 306 | (while words 307 | (setq line (pop words)) 308 | (while (and words (< (+ (length line) (length (car words))) width)) 309 | (setq line (concat line " " (pop words)))) 310 | (setq lines (push line lines))) 311 | (nreverse lines))) 312 | 313 | (defun org-mind-map-wrap (s l) 314 | (let* ((s2 (org-mind-map-do-wrap (split-string s " ") l))) 315 | (mapconcat 'identity s2 "

"))) 316 | 317 | (defun org-mind-map-wrap-lines (s) 318 | "Wraps a string S so that it can never be more than ORG-MIND-MAP-WRAP-LINE-LENGTH characters long." 319 | (org-mind-map-wrap s org-mind-map-wrap-line-length)) 320 | 321 | (defun org-mind-map-wrap-text (s) 322 | "Wraps a string S so that it can never be more than ORG-MIND-MAP-WRAP-TEXT-LENGTH characters long." 323 | (org-mind-map-wrap s org-mind-map-wrap-text-length)) 324 | 325 | 326 | (defun org-mind-map-wrap-legend-lines (s) 327 | "Wraps a string S so that it can never be more than ORG-MIND-MAP-WRAP-LEGEND-LINE-LENGTH characters long." 328 | (let* ((s2 (org-mind-map-do-wrap (split-string s " ") org-mind-map-wrap-legend-line-length))) 329 | (mapconcat 'identity s2 "

"))) 330 | 331 | (defun org-mind-map-dot-node-name (s) 332 | "Make string S formatted to be usable within dot node names." 333 | (concat "\"" 334 | (replace-regexp-in-string 335 | "]*>" "" 336 | (replace-regexp-in-string "label=\\(\"[^\"]+\"\\|[^,]+\\).*" "\\1" s)) 337 | "\"")) 338 | 339 | (defun org-mind-map-add-color (hm tag &optional colspan) 340 | "Create data element containing TAG with associated color found in hashmap HM." 341 | (let* ((color (gethash tag hm))) 342 | (concat "" tag ""))) 345 | 346 | (defun org-mind-map-write-tags-default (title tags color hm el &optional content images) 347 | "Default function for writing nodes. 348 | Label node with TITLE and background COLOR, and write TAGS (a list of tag names) 349 | into boxes underneath, using associated colors in hashmap HM. 350 | The EL argument is not used, but is needed for compatibility." 351 | (concat "[label=<" 352 | (if (> (length tags) 0) 353 | (concat "" 357 | (if (> (length tags) 0) 358 | (concat 359 | "" (mapconcat (-partial 'org-mind-map-add-color hm) tags "") "")) 360 | (if (> (length content) 0) 361 | (concat 362 | "") 363 | ) 364 | 365 | (if (> (length images) 0) 366 | images "" 367 | ) 368 | "
" title "
" content "
>];")) 369 | 370 | (defun org-mind-map-get-property (prop el &optional inheritp) 371 | "Get property PROP from an org element EL, using inheritance if INHERITP is non-nil. 372 | PROP can be either the property symbol (beginning with :), or the name of the property (with or without :). 373 | If there is a column summary value for the property that has recently be calculated it will be used." 374 | (let* ((node el) 375 | (propstr (if (stringp prop) 376 | (upcase (if (string-match "^:" prop) 377 | (substring prop 1) 378 | prop)) 379 | (substring (symbol-name prop) 1))) 380 | (prop (if (stringp prop) (intern (concat ":" propstr)) prop)) 381 | (val (or (cdr (cl-find propstr (get-text-property 382 | (org-element-property :begin el) 383 | 'org-summaries) 384 | :test (lambda (x y) (equal (caar y) x)))) 385 | (org-element-property prop el)))) 386 | (while (and inheritp 387 | (not val) 388 | (not (eq (org-element-type node) 'org-data))) 389 | (setq node (org-element-property :parent node) 390 | val (org-element-property prop node))) 391 | val)) 392 | 393 | (defun org-mind-map-narrow-to-heading-content (b) 394 | "Narrow to the region until the next headline, if applicable" 395 | (let* ((new-end 396 | (org-element-map (org-element-parse-buffer 'object 'true) 397 | 'headline 398 | (lambda (x) 399 | (if (not 400 | (= (org-element-property :begin x) b)) 401 | b nil)) 402 | nil 'true))) 403 | (if new-end 404 | (progn 405 | (widen) 406 | (narrow-to-region b new-end))))) 407 | 408 | 409 | (defun org-mind-map-write-tags (hm el &optional edgep) 410 | "Use HM as the hash-map of colors and takes an element EL and extracts the title and tags. 411 | Then, formats the titles and tags so as to be usable within DOT's graphviz language." 412 | (let* ((ts (org-element-property :title el)) 413 | (wrapped-title (org-mind-map-wrap-lines (if (listp ts) (first ts) ts))) 414 | (title (replace-regexp-in-string "&" "&" wrapped-title nil t)) 415 | (color (org-element-property :OMM-COLOR el)) 416 | (tags (org-element-property :tags el)) 417 | (fmt (org-mind-map-get-property (if edgep :OMM-EDGE-FMT :OMM-NODE-FMT) el)) 418 | (b (org-element-property :begin el)) 419 | (e (org-element-property :end el)) 420 | (images 421 | (if org-mind-map-include-images 422 | (save-restriction 423 | (narrow-to-region b e) 424 | (org-mind-map-narrow-to-heading-content b) 425 | (mapconcat 'identity 426 | (org-element-map (org-element-parse-buffer 'object 'true) 427 | '(link) 428 | (lambda (x) 429 | (message "Inline image: %s" (org-export-inline-image-p x)) 430 | (if (org-export-inline-image-p x) 431 | (concat 432 | "" "" 435 | "") 436 | ""))) 437 | "")))) 438 | (content 439 | (if org-mind-map-include-text 440 | (save-restriction 441 | (narrow-to-region b e) 442 | (org-mind-map-narrow-to-heading-content b) 443 | (mapconcat 'identity 444 | (org-element-map (org-element-parse-buffer 'object 'true) 445 | '(paragraph) 446 | (lambda (x) 447 | (org-mind-map-wrap-text 448 | (string-trim 449 | (substring-no-properties 450 | (car (org-element-contents x))))))) 451 | "



")) 452 | nil)) 453 | ) 454 | (if edgep (funcall (or (cdr (assoc fmt org-mind-map-edge-formats)) 455 | (lambda (a b) org-mind-map-edge-format-default)) 456 | hm el) 457 | (funcall (or (cdr (assoc fmt org-mind-map-node-formats)) 458 | 'org-mind-map-write-tags-default) 459 | title tags color hm el content images)))) 460 | 461 | (defun org-mind-map-first-headline (e) 462 | "Figure out the first headline within element E." 463 | (let* ((parent (org-element-property :parent e))) 464 | (if parent 465 | (if (eq (org-element-type parent) 'headline) 466 | parent 467 | (org-mind-map-first-headline parent)) 468 | nil))) 469 | 470 | (defun org-mind-map-valid-link? (e) 471 | "Is E at a valid link?" 472 | (condition-case ex 473 | (let* ((org-link-search-inhibit-query t) 474 | (type (org-element-property :type e)) 475 | (l (org-element-property :path e))) 476 | (if (string= type "fuzzy") 477 | (save-excursion 478 | (org-link-search l) t) 479 | nil)) 480 | ('error nil))) 481 | 482 | (defun org-mind-map-destination-headline (e) 483 | "Figure out where the link in E is pointing to." 484 | (let* ((l (org-element-property :path e)) 485 | (org-link-search-inhibit-query t)) 486 | (save-excursion 487 | (org-open-link-from-string (concat "[[" l "]]")) 488 | (org-element-at-point)))) 489 | 490 | (defun org-mind-map-get-links (hm) 491 | "Make a list of links with the headline they are within and 492 | their destination. Pass hashmap arg HM mapping tags to colors 493 | in order to keep the tag colors consistent across calls." 494 | (org-element-map (org-element-parse-buffer 'object) 495 | 'link 496 | (lambda (l) 497 | (if (org-mind-map-valid-link? l) 498 | (let* ((origin 499 | (org-mind-map-write-tags hm 500 | (org-mind-map-first-headline l))) 501 | (h (org-mind-map-destination-headline l)) 502 | (destination 503 | (org-mind-map-write-tags hm h))) 504 | (list origin destination)))))) 505 | 506 | (defun org-mind-map-make-legend (h) 507 | "Make a legend using the hash-map HM." 508 | (let ((res '())) 509 | (maphash (lambda (k v) (push k res)) h) 510 | (if (> (length res) 0) 511 | (concat 512 | "{ 513 | Legend [shape=none, margin=0, label=< 514 | 515 | 516 | 517 | " 518 | (mapconcat 'identity 519 | (let* (result) 520 | (maphash 521 | (lambda (name color) 522 | (push (concat "") 524 | result)) 525 | h) 526 | (reverse result)) 527 | "") 528 | "
Legend
" (org-mind-map-wrap-legend-lines name) 523 | "    
>];}")))) 529 | 530 | (defun org-mind-map-rgb (&optional exceptions) 531 | "Make a random pastel-like RGB color. 532 | Dont return any of the colors listed in the optional arg EXCEPTIONS." 533 | (let* ((fn (lambda nil 534 | (concat "#" 535 | (format "%x" (+ 125 (random (- 255 125)))) 536 | (format "%x" (+ 125 (random (- 255 125)))) 537 | (format "%x" (+ 125 (random (- 255 125))))))) 538 | (color (funcall fn))) 539 | (while (member color exceptions) 540 | (setq color (funcall fn))) 541 | color)) 542 | 543 | (defun org-mind-map-tags (&optional exceptions) 544 | "Return a hash map of tags in the org file mapped to random colors. 545 | Dont return any of the colors listed in the optional arg EXCEPTIONS." 546 | (let* ((hm (make-hash-table :test 'equal))) 547 | (org-element-map (org-element-parse-buffer 'headline) 'headline 548 | (lambda (hl) 549 | (let ((tags (mapcar 'substring-no-properties (org-element-property :tags hl))) 550 | (legend (org-element-property :OMM-LEGEND hl)) 551 | (color (org-element-property :OMM-COLOR hl))) 552 | (if legend (puthash legend color hm)) 553 | (if tags (mapcar (lambda (x) 554 | (puthash x (--if-let (assoc x org-mind-map-tag-colors) 555 | (cdr it) 556 | (org-mind-map-rgb 557 | (append exceptions 558 | (mapcar 'cdr org-mind-map-tag-colors)))) 559 | hm)) 560 | tags))))) 561 | hm)) 562 | 563 | (defun org-mind-map-data (&optional linksp) 564 | "Create graph & tag legend of all directed pairs of headlines for constructing the digraph. 565 | If LINKSP is non-nil include graph edges for org links." 566 | (let* ((hm (org-mind-map-tags org-mind-map-reserved-colors)) 567 | (output 568 | (org-element-map (org-element-parse-buffer 'headline) 'headline 569 | (lambda (hl) 570 | (let ((parent (org-element-property :parent hl))) 571 | (and (eq (org-element-type parent) 'headline) 572 | (list (org-mind-map-write-tags hm parent) 573 | (org-mind-map-write-tags hm hl) 574 | (org-mind-map-write-tags hm hl t)))))))) 575 | (list (append output (if linksp (org-mind-map-get-links hm))) hm))) 576 | 577 | (defun org-mind-map-make-dot (data) 578 | "Create the dot file from DATA." 579 | (let ((table (nth 0 data)) 580 | (legend (nth 1 data))) 581 | (concat "digraph structs {\n // DEFAULT OPTIONS\n" 582 | (if org-mind-map-default-graph-attribs 583 | (concat " graph [" 584 | (mapconcat #'(lambda (x) (concat (car x) "=\"" (cdr x) "\"")) 585 | org-mind-map-default-graph-attribs ", ") 586 | "];\n")) 587 | (if org-mind-map-default-node-attribs 588 | (concat 589 | " node [" (mapconcat #'(lambda (x) (concat (car x) "=\"" (cdr x) "\"")) 590 | org-mind-map-default-node-attribs ", ") 591 | "];\n")) 592 | (if org-mind-map-default-edge-attribs 593 | (concat 594 | " edge [" (mapconcat #'(lambda (x) (concat (car x) "=\"" (cdr x) "\"")) 595 | org-mind-map-default-edge-attribs ", ") 596 | "];\n")) 597 | " // NODES\n" 598 | (mapconcat 599 | #'(lambda (x) (concat " " (org-mind-map-dot-node-name x) " " x)) 600 | (-distinct (-flatten (mapcar (lambda (x) (list (nth 0 x) (nth 1 x))) table))) 601 | "\n") 602 | "\n // EDGES\n" 603 | (mapconcat #'(lambda (x) (format " %s -> %s;" 604 | (org-mind-map-dot-node-name (nth 0 x)) 605 | (org-mind-map-dot-node-name (nth 1 x)) 606 | (nth 2 x))) 607 | table "\n") 608 | (org-mind-map-make-legend legend) 609 | "}"))) 610 | 611 | (defun org-mind-map-command (name outputtype) 612 | "Return the shell script that will create the correct file NAME of type OUTPUTTYPE. 613 | The output file will be in the same location as the org file." 614 | (concat org-mind-map-unflatten-command " | " 615 | org-mind-map-dot-command " -T" 616 | (shell-quote-argument outputtype) " -K" 617 | (shell-quote-argument org-mind-map-engine) " -o" 618 | (shell-quote-argument (concat name "." outputtype "")))) 619 | 620 | (defun org-mind-map-update-message (filename process event) 621 | "Write an update message on the output of running org-mind-map based on PROCESS and EVENT. 622 | Open FILENAME according to value of `org-mind-map-display'." 623 | (let* ((e (with-current-buffer "*org-mind-map-errors*" 624 | (buffer-string)))) 625 | (if (string= e "") 626 | (princ (format "Org mind map %s" event)) 627 | (princ (format "Org mind map %sErrors: %s" event e))) 628 | (if (string= event "finished\n") 629 | (progn 630 | (cl-case org-mind-map-display 631 | (nil nil) 632 | (current (find-file filename)) 633 | (window (find-file-other-window filename)) 634 | (frame (switch-to-buffer-other-frame (find-file-noselect filename)))) 635 | (cl-case major-mode 636 | (pdf-view-mode (pdf-view-fit-page-to-window)) 637 | (doc-view-mode (doc-view-fit-page-to-window))))))) 638 | 639 | (defun org-mind-map-write-named (name &optional debug linksp) 640 | "Create a directed graph output based on the org tree in the current buffer, with name NAME. 641 | To customize, see the org-mind-map group. 642 | If DEBUG is non-nil, then print the dot command to the *Messages* buffer, 643 | and print the dotfile to the *Messages* buffer or to a file if DEBUG is a filename. 644 | If LINKSP is non-nil include graph edges for org links." 645 | (let ((dot (org-mind-map-make-dot (org-mind-map-data linksp))) 646 | a (outputtype (if (> (length org-mind-map-dot-output) 1) 647 | (completing-read "Output file type: " org-mind-map-dot-output) 648 | (car org-mind-map-dot-output)))) 649 | (if debug 650 | (progn (message (org-mind-map-command name outputtype)) 651 | (if (stringp debug) 652 | (with-temp-file debug (insert dot)) 653 | (message dot "%s")))) 654 | (if (get-buffer "*org-mind-map-errors*") 655 | (kill-buffer "*org-mind-map-errors*")) 656 | (let* ((p (start-process-shell-command 657 | "org-mind-map-s" "*org-mind-map-errors*" 658 | (org-mind-map-command name outputtype))) 659 | (filename (concat name "." outputtype ""))) 660 | (process-send-string p dot) 661 | (process-send-string p "\n") 662 | (process-send-eof p) 663 | (set-process-sentinel p (-partial 'org-mind-map-update-message filename)) 664 | filename))) 665 | 666 | ;;;###autoload 667 | (defun org-mind-map-write-with-prompt nil 668 | "Prompt for an output FILENAME (without extension) to write your output and .dot files." 669 | (let ((filename (read-file-name "What is the file name you would like to save to?"))) 670 | (org-mind-map-write-named filename (concat filename ".dot") 671 | (y-or-n-p "Include org links? ")))) 672 | 673 | (defun org-mind-map-default-filename (treenamep) 674 | "Return a default filename for saving the tree diagram. 675 | If TREENAMEP is non-nil include in the filename the name of the top level header of the tree." 676 | (concat (file-name-sans-extension (buffer-name)) 677 | "_diagram" 678 | (if treenamep 679 | (concat "-" 680 | (replace-regexp-in-string " +" "_" (nth 4 (org-heading-components))))))) 681 | 682 | ;;;###autoload 683 | (defun org-mind-map-write (&optional promptp) 684 | "Create a digraph based on all org trees in the current buffer. 685 | The digraph will be named the same name as the current buffer. 686 | To customize, see the org-mind-map group. 687 | If called with prefix arg (or PROMPTP is non-nil), then call `org-mind-map-write-with-prompt'." 688 | (interactive "P") 689 | (if promptp (org-mind-map-write-with-prompt) 690 | (org-mind-map-write-named (org-mind-map-default-filename nil)))) 691 | 692 | ;;;###autoload 693 | (defun org-mind-map-write-current-branch (&optional promptp) 694 | "Create a directed graph output based on just the current org tree branch. 695 | To customize, see the org-mind-map group. 696 | If called with prefix arg (or PROMPTP is non-nil), then call `org-mind-map-write-with-prompt'." 697 | (interactive "P") 698 | (org-narrow-to-subtree) 699 | (let ((filename (if promptp (org-mind-map-write-with-prompt) 700 | (org-mind-map-write-named (org-mind-map-default-filename t))))) 701 | (widen) 702 | filename)) 703 | 704 | ;;;###autoload 705 | (defun org-mind-map-write-current-tree (&optional promptp) 706 | "Create a directed graph output based on the whole current org tree. 707 | If called with prefix arg (or PROMPTP is non-nil), then call `org-mind-map-write-with-prompt'." 708 | (interactive "P") 709 | (save-restriction 710 | (ignore-errors (outline-up-heading 100)) 711 | (org-mind-map-write-current-branch promptp))) 712 | 713 | ;;;###autoload 714 | (defmacro org-mind-map-make-node-fn (name doc props &optional shape color other) 715 | "Create a function org-mind-map-NAME-node for use with :OMM-NODE-FMT writing node properties. 716 | The created function should be added to `org-mind-map-node-formats' and the associated string 717 | can be used as the :OMM-NODE-FMT for a tree. 718 | Document the function with the DOC arg. 719 | PROPS is a list of either property & format string pairs, or individual property names, 720 | which will be placed in each node, e.g: ((\"PROB\" \"probability=%s\") \"COST\"). 721 | For property names with no format string, \"%s=%s\" will be used with the property name and value. 722 | 723 | The node shape and background color can be specified with the optional SHAPE and COLOR arguments, 724 | and any other attributes (e.g. \"fontsize=30\") can be specified with the OTHER argument. 725 | Each of these arguments can be either a string or a form which is evaluated for each node, 726 | and returns a string. 727 | 728 | Example: (org-mind-map-make-node-fn decisiontree \"Draw decision tree\" (\"COST\" (\"NOTES\" \"Notes: %s\")) nil 729 | (cond ((equal (org-mind-map-get-property :todo-keyword el) \"ACTION\") \"red\") 730 | ((equal (org-mind-map-get-property :todo-keyword el) \"STATE\") \"yellow\") 731 | ((equal (org-mind-map-get-property :todo-keyword el) \"DECISION\") \"green\"))) 732 | 733 | You could put this code in your emacs startup file (e.g. ~/.emacs) and then add to `org-mind-map-node-formats' 734 | the pair '(\"decisiontree\" . org-mind-map-decisiontree-node), and use \":OMM-NODE-FMT: decisiontree\" as a 735 | tree property." 736 | `(defun ,(intern (concat "org-mind-map-" (symbol-name name) "-node")) 737 | (title tags color hm el) 738 | ,doc 739 | (let* ((numtags (if tags (length tags))) 740 | (colspan (if tags (int-to-string numtags))) 741 | (propstxt 742 | (cl-remove 743 | nil (list ,@(mapcar 744 | (lambda (p) 745 | (cond ((stringp p) 746 | `(--if-let (org-mind-map-get-property ,p el) 747 | (concat ,(upcase p) "=" it))) 748 | ((consp p) 749 | `(--if-let (org-mind-map-get-property ,(car p) el) 750 | (format ,(nth 1 p) it))) 751 | (t (error "Invalid props value")))) 752 | props)))) 753 | (shape ,shape) 754 | (color (or color ,color)) 755 | (other ,other)) 756 | (concat "[label=<" 757 | (if numtags (concat "" title "" 760 | (mapconcat (lambda (p) 761 | (concat "" (org-mind-map-add-color hm p numtags) "")) 762 | propstxt "") 763 | (if numtags 764 | (concat "" 765 | (mapconcat (-partial 'org-mind-map-add-color hm) tags "") 766 | "")) 767 | ">" 768 | (if shape (concat ",shape=" shape (if color (concat ",style=filled,color=" color)))) 769 | (if other (concat "," other)) "];")))) 770 | 771 | ;;;###autoload 772 | (defmacro org-mind-map-make-edge-fn (name doc props &optional style color other) 773 | "Create a function org-mind-map-write-NAME for writing edge properties which can be used for :OMM-EDGE-FMT. 774 | Document the function with the DOC arg. 775 | PROPS is a list of either property & format string pairs, or individual property names, 776 | which will concatenated and used to label the edges, e.g: ((\"PROB\" \"probability=%s\") \"COST\"). 777 | For property names with no format string \"%s=%s\" will be used with the property name and value. 778 | 779 | The edge style and color can be specified with the optional STYLE and COLOR arguments, 780 | and any other attributes (e.g. \"fontsize=30\") can be specified with the OTHER argument. 781 | Each of these arguments can be either a string or a form which is evaluated for each node, 782 | and returns a string. 783 | 784 | Example: (org-mind-map-make-edge-fn decisiontree \"Draw decision tree\" (\"PROB\")) 785 | 786 | You could put this code in your emacs startup file (e.g. ~/.emacs) and then add to `org-mind-map-edge-formats' 787 | the pair '(\"decisiontree\" . org-mind-map-decisiontree-edge), and use \":OMM-EDGE-FMT: decisiontree\" as a 788 | tree property." 789 | `(defun ,(intern (concat "org-mind-map-" (symbol-name name) "-edge")) 790 | (hm el) 791 | ,doc 792 | (let* ((propstxt (cl-remove 793 | nil (list ,@(mapcar (lambda (p) 794 | (cond ((stringp p) 795 | `(--if-let (org-mind-map-get-property ,p el) 796 | (concat ,(upcase p) "=" it))) 797 | ((consp p) 798 | `(--if-let (org-mind-map-get-property ,(car p) el) 799 | (format ,(nth 1 p) it))) 800 | (t (error "Invalid props value")))) 801 | props)))) 802 | (style ,style) 803 | (color ,color) 804 | (other ,other)) 805 | (concat "[label=\"" (mapconcat 'identity propstxt ",") "\"" 806 | (if color (concat ",color=\"" color "\" ")) 807 | (if style (concat ",style=\"" style "\"")) 808 | (if other (concat "," other)) "]")))) 809 | 810 | (defun ox-graphviz-export (&optional async subtreep visible-only body-only info) 811 | "Export the current buffer to a graphviz diagram. 812 | Optional argument ASYNC to asynchronously export. 813 | Optional argument SUBTREEP to export current subtree. 814 | Optional argument VISIBLE-ONLY to only export visible content. 815 | Optional argument BODY-ONLY export only the body. 816 | Optional argument INFO is a plist of options." 817 | (let ((org-mind-map-display nil)) 818 | (if subtreep (org-mind-map-write-current-branch) 819 | (org-mind-map-write)))) 820 | 821 | (defun ox-graphviz-export-and-open (&optional async subtreep visible-only body-only info) 822 | "Export the current buffer to a graphviz diagram, and open the output file. 823 | Optional argument ASYNC to asynchronously export. 824 | Optional argument SUBTREEP to export current subtree. 825 | Optional argument VISIBLE-ONLY to only export visible content. 826 | Optional argument BODY-ONLY export only the body. 827 | Optional argument INFO is a plist of options." 828 | (let ((org-mind-map-display (or org-mind-map-display 'current))) 829 | (if subtreep (org-mind-map-write-current-branch) 830 | (org-mind-map-write)))) 831 | 832 | (defun ox-graphviz-export-dot (&optional async subtreep visible-only body-only info) 833 | "Export the current buffer to a graphviz diagram, and create and open a dot file. 834 | Optional argument ASYNC to asynchronously export. 835 | Optional argument SUBTREEP to export current subtree. 836 | Optional argument VISIBLE-ONLY to only export visible content. 837 | Optional argument BODY-ONLY export only the body. 838 | Optional argument INFO is a plist of options." 839 | (let ((org-mind-map-display nil) 840 | (filename (org-mind-map-default-filename subtreep)) 841 | (linksp (y-or-n-p "Include org links? "))) 842 | (if subtreep (org-narrow-to-subtree)) 843 | (org-mind-map-write-named filename (concat filename ".dot") linksp) 844 | (widen))) 845 | 846 | (defun ox-graphviz-export-dot-and-open (&optional async subtreep visible-only body-only info) 847 | "Export the current buffer to a graphviz diagram and a dot file, and open the output file. 848 | Optional argument ASYNC to asynchronously export. 849 | Optional argument SUBTREEP to export current subtree. 850 | Optional argument VISIBLE-ONLY to only export visible content. 851 | Optional argument BODY-ONLY export only the body. 852 | Optional argument INFO is a plist of options." 853 | (let ((org-mind-map-display (or org-mind-map-display 'current)) 854 | (filename (org-mind-map-default-filename subtreep)) 855 | (linksp (y-or-n-p "Include org links? "))) 856 | (if subtreep (org-narrow-to-subtree)) 857 | (org-mind-map-write-named filename (concat filename ".dot") linksp) 858 | (widen))) 859 | 860 | (defun org-mind-map-export-message nil 861 | "Message string for `org-export-dispatch' buffer." 862 | (if (> (length org-mind-map-dot-output) 1) 863 | "Select output file format" 864 | (concat "As " (car org-mind-map-dot-output) " file"))) 865 | 866 | (org-export-define-derived-backend 'graphviz 'org 867 | :menu-entry 868 | '(?g "Export to graphviz diagram" 869 | ((?f "Create graph" ox-graphviz-export) 870 | (?o "Create graph and open" ox-graphviz-export-and-open) 871 | (?d "Create graph & dot file" ox-graphviz-export-dot) 872 | (?O "Create graph & dot file, and open graph" ox-graphviz-export-dot-and-open)))) 873 | 874 | ;; Add a tool bar icon 875 | ;; (define-key org-mode-map [tool-bar org-button] 876 | ;; '(menu-item "Write the org-mode file mind map to disk." org-mind-map-write-with-prompt 877 | ;; :image (image :type xpm :file "info.xpm") 878 | ;; )) 879 | 880 | ;; Add menu items 881 | ;; (define-key org-mode-map [menu-bar Org Diagram] 882 | ;; (cons "Graphviz diagram" (make-sparse-keymap "Graphviz diagram"))) 883 | 884 | ;; (define-key org-mode-map [menu-bar Org Diagram all] 885 | ;; '("Diagram of whole buffer" . org-mind-map-write)) 886 | 887 | ;; (define-key org-mode-map [menu-bar Org Diagram current] 888 | ;; '("Diagram of current tree" . org-mind-map-write-current-tree)) 889 | 890 | ;; (define-key org-mode-map [menu-bar Org Diagram branch] 891 | ;; '("Diagram of current branch" . org-mind-map-write-current-branch)) 892 | 893 | ;; (global-set-key (kbd "") 'org-mind-map-write) 894 | 895 | (provide 'org-mind-map) 896 | ;;; org-mind-map.el ends here 897 | 898 | --------------------------------------------------------------------------------