├── LICENSE ├── README.md ├── README.org ├── img ├── source.png ├── tangle.png └── weave.png ├── makefile ├── org-tangle ├── org-tangle.md ├── org-tangle.org ├── org-weave ├── org-weave.md └── org-weave.org /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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | > Humanity is The Big Story, which, in turn, is broken down into very many sub-Stories. We're Story-oriented. Code so far is not. Code is like networks of tunnels where, for all intents and purposes, most of the tunneling has already collapsed, the tunnel paths mostly unknowable. 2 | > 3 | > What makes me so excited about org mode is that it's the first time I've seen literate programming move a tick up into the realm of actually creating a tellable Story. 4 | > 5 | > – [Lawrence Bottorff, Feb 2014](https://lists.gnu.org/archive/html/emacs-orgmode/2014-02/msg01022.html) 6 | 7 | # What is it ? 8 | 9 | `org-noweb` is a couple of programs who make [literate programming](http://en.wikipedia.org/wiki/Literate_programming) with [Org](http://orgmode.org) easier. 10 | 11 | - [org-tangle](./org-tangle.md) takes one or several org files as arguments and produces programs 12 | - [org-weave](./org-weave) takes an org file as an argument and produces, on standard output, source code for typeset documentation. 13 | 14 | Org already comes "batteries included" with (some) literate programming abilities, thanks to Eric Schulte and Dan Davison ; but these features are meant for interactive use, with a running Emacs instance. 15 | 16 | `org-noweb` brings these features to the command line, allowing code and documentation to be generated non-interactively. If you care about build automation, that's just what you want. 17 | 18 | `org-tangle` and `org-weave` themselves are written in literate Org documents, and this repository is managed using these GNU Makefile rules: 19 | 20 | - **org-tangle:** [program](./org-tangle) | [documentation](./org-tangle.md) | [source document](./org-tangle.md) 21 | - **org-weave:** [program](./org-weave) | [documentation](./org-weave.md) | [source document](./org-weave.md) 22 | 23 | ## What is Literate Programming ? Why should I care ? 24 | 25 | I'd personnaly recommend these two resources: 26 | 27 | - [Literate Programming in the Large](http://daly.axiom-developer.org/TimothyDaly_files/publications/DocConf/LiterateSoftwareTalk.html), a talk presented by [Timothy Daly](http://daly.axiom-developer.org/) at Write The Docs conference (April 2013) ([slides](http://daly.axiom-developer.org/TimothyDaly_files/publications/DocConf/LiterateSoftwareTalk.pdf)) 28 | - [A nice introductory page](https://github.com/limist/literate-programming-examples) by Kai Wu (March 2014), packed with a collection of literate programming examples using Org. 29 | 30 | # How does it work ? 31 | 32 | Consider an Org document (`source.org`) containing source code interleaved with documentation: 33 | 34 | Source code 35 | 36 | Running `org-tangle source.org` will extract the source code blocks according to the `:tangle` directives within the `source.org` and generate, for instance: 37 | 38 | Tangled code 39 | 40 | Then, running `org-weave -f gfm source.org > source.md` will generate documentation in GitHub flavored Markdown. 41 | 42 | Generated documentation 43 | 44 | # How to install it ? 45 | 46 | 1. Clone this repository 47 | 48 | ```sh 49 | git clone https://github.com/ngirard/org-noweb 50 | ``` 51 | 2. Install `org-tangle` `org-weave` in a directory belonging to your `$PATH` 52 | 53 | ```sh 54 | cd org-noweb 55 | install -m 755 org-tangle org-weave /dest/dir 56 | ``` 57 | 58 | `org-weave` currently does nothing else than exporting to GitHub flavored Markdown ; it needs the `ox-gfm` package that was contributed by Lars Tveito. `ox-gfm` [currently doesn't belong](http://permalink.gmane.org/gmane.emacs.orgmode/87366) to the `org` / `org-plus-contrib` packages yet; so until then you'll need to 59 | 60 | - [grab it from Gmane](http://cache.gmane.org//gmane/emacs/orgmode/84702-001.bin) into a directory `dir`; 61 | - run `org-weave` using 62 | 63 | ```sh 64 | org-weave -f gfm -O '-Q --batch -L dir' file.org > file.md 65 | ``` 66 | 67 | # The Makefile used 68 | 69 | 70 | 71 | This is the Makefile file I'm using on my system to manage this repository. 72 | 73 | 74 | ```makefile 75 | PROGRAMS=org-tangle org-weave 76 | TARGETS=$(PROGRAMS) README.md org-tangle.md org-weave.md 77 | 78 | all: $(TARGETS) 79 | 80 | %: %.org 81 | org-tangle -l emacs-lisp,org $< 82 | 83 | %.md: %.org 84 | org-weave -f gfm -O '-Q --batch -L ~/.emacs.d/local-packages' $< > $@ 85 | 86 | DESTDIR=/home/soft/bin 87 | install: all 88 | install -m 755 $(PROGRAMS) $(DESTDIR) 89 | ``` 90 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+title: 2 | #+OPTIONS: H:2 num:nil toc:nil 3 | 4 | #+BEGIN_QUOTE 5 | Humanity is The Big Story, which, in turn, is broken down into very many sub-Stories. We're Story-oriented. Code so far is not. Code is like networks of tunnels where, for all intents and purposes, most of the tunneling has already collapsed, the tunnel paths mostly unknowable. 6 | 7 | What makes me so excited about org mode is that it's the first time I've seen literate programming move a tick up into the realm of actually creating a tellable Story. 8 | 9 | -- [[https://lists.gnu.org/archive/html/emacs-orgmode/2014-02/msg01022.html][Lawrence Bottorff, Feb 2014]] 10 | #+END_QUOTE 11 | 12 | * What is it ? 13 | =org-noweb= is a couple of programs who make [[http://en.wikipedia.org/wiki/Literate_programming][literate programming]] with [[http://orgmode.org][Org]] easier. 14 | # 15 | - [[./org-tangle.md][org-tangle]] takes one or several org files as arguments and produces programs 16 | - [[./org-weave][org-weave]] takes an org file as an argument and produces, on standard output, source code for typeset documentation. 17 | 18 | Org already comes "batteries included" with (some) literate programming abilities, thanks to Eric Schulte and Dan Davison ; but these features are meant for interactive use, with a running Emacs instance. 19 | 20 | =org-noweb= brings these features to the command line, allowing code and documentation to be generated non-interactively. If you care about build automation, that's just what you want. 21 | 22 | =org-tangle= and =org-weave= themselves are written in literate Org documents, and this repository is managed using these GNU Makefile rules: 23 | - org-tangle :: [[./org-tangle][program]] | [[./org-tangle.md][documentation]] | [[./org-tangle.org][source document]] 24 | - org-weave :: [[./org-weave][program]] | [[./org-weave.md][documentation]] | [[./org-weave.org][source document]] 25 | 26 | ** What is Literate Programming ? Why should I care ? 27 | 28 | I'd personnaly recommend these two resources: 29 | # 30 | - [[http://daly.axiom-developer.org/TimothyDaly_files/publications/DocConf/LiterateSoftwareTalk.html][Literate Programming in the Large]], a talk presented by [[http://daly.axiom-developer.org/][Timothy Daly]] at Write The Docs conference (April 2013) ([[http://daly.axiom-developer.org/TimothyDaly_files/publications/DocConf/LiterateSoftwareTalk.pdf][slides]]) 31 | - [[https://github.com/limist/literate-programming-examples][A nice introductory page]] by Kai Wu (March 2014), packed with a collection of literate programming examples using Org. 32 | 33 | * How does it work ? 34 | Consider an Org document (=source.org=) containing source code interleaved with documentation: 35 | 36 | Source code 37 | 38 | Running =org-tangle source.org= will extract the source code blocks according to the =:tangle= directives within the =source.org= and generate, for instance: 39 | 40 | Tangled code 41 | 42 | Then, running =org-weave -f gfm source.org > source.md= will generate documentation in GitHub flavored Markdown. 43 | 44 | Generated documentation 45 | 46 | * How to install it ? 47 | 1. Clone this repository 48 | #+begin_src sh 49 | git clone https://github.com/ngirard/org-noweb 50 | #+end_src 51 | 2. Install =org-tangle= =org-weave= in a directory belonging to your =$PATH= 52 | #+begin_src sh 53 | cd org-noweb 54 | install -m 755 org-tangle org-weave /dest/dir 55 | #+end_src 56 | 57 | =org-weave= currently does nothing else than exporting to GitHub flavored Markdown ; it needs the =ox-gfm= package that was contributed by Lars Tveito. =ox-gfm= [[http://permalink.gmane.org/gmane.emacs.orgmode/87366][currently doesn't belong]] to the =org= / =org-plus-contrib= packages yet; so until then you'll need to 58 | - [[http://cache.gmane.org//gmane/emacs/orgmode/84702-001.bin][grab it from Gmane]] into a directory =dir=; 59 | - run =org-weave= using 60 | #+begin_src sh 61 | org-weave -f gfm -O '-Q --batch -L dir' file.org > file.md 62 | #+end_src 63 | 64 | * The Makefile used 65 | 66 | 67 | This is the Makefile file I'm using on my system to manage this repository. 68 | 69 | # (setq org-src-preserve-indentation nil) 70 | #+begin_src makefile 71 | PROGRAMS=org-tangle org-weave 72 | TARGETS=$(PROGRAMS) README.md org-tangle.md org-weave.md 73 | 74 | all: $(TARGETS) 75 | 76 | %: %.org 77 | org-tangle -l emacs-lisp,org $< 78 | 79 | %.md: %.org 80 | org-weave -f gfm -O '-Q --batch -L ~/.emacs.d/local-packages' $< > $@ 81 | 82 | DESTDIR=/home/soft/bin 83 | install: all 84 | install -m 755 $(PROGRAMS) $(DESTDIR) 85 | #+end_src 86 | -------------------------------------------------------------------------------- /img/source.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ngirard/org-noweb/1579a976453fad0a6ce2d5ca21f505d89f9360f5/img/source.png -------------------------------------------------------------------------------- /img/tangle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ngirard/org-noweb/1579a976453fad0a6ce2d5ca21f505d89f9360f5/img/tangle.png -------------------------------------------------------------------------------- /img/weave.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ngirard/org-noweb/1579a976453fad0a6ce2d5ca21f505d89f9360f5/img/weave.png -------------------------------------------------------------------------------- /makefile: -------------------------------------------------------------------------------- 1 | PROGRAMS=org-tangle org-weave 2 | TARGETS=$(PROGRAMS) README.md org-tangle.md org-weave.md 3 | 4 | all: $(TARGETS) 5 | 6 | %: %.org 7 | ./org-tangle -l emacs-lisp,org $< 8 | 9 | %.md: %.org 10 | ./org-weave -f gfm -O '-Q --batch -L ~/.emacs.d/local-packages' $< > $@ 11 | 12 | DESTDIR=/home/soft/bin 13 | install: all 14 | install -m 755 $(PROGRAMS) $(DESTDIR) 15 | -------------------------------------------------------------------------------- /org-tangle: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | DIR=`pwd` 4 | FILES="" 5 | ORGDIR="/path/to/alternate/org-mode" 6 | QUICK_EXPANSION=nil 7 | EMACS=emacs 8 | EMACS_OPTS="-Q --batch" 9 | VERSION=0.1 10 | 11 | read -d '' help_string <<"EOF" 12 | Usage: org-tangle [options] file1.org [file2.org ...] 13 | 14 | -E EMACS Specify the Emacs executable. Default value is 'emacs24-nox' 15 | -O OPTIONS Specify the options to pass to Emacs. Default value is '-Q --batch' 16 | -q Enable quick expansion of noweb references 17 | (see variable org-babel-use-quick-and-dirty-noweb-expansion). 18 | -L ORGDIR Specify an alternate directory for Org libs. 19 | -l lang1,lang2 List of languages which can be evaluated in Org buffers. 20 | By default, only emacs-lisp is loaded 21 | (see variable org-babel-load-languages) 22 | -V Show version and exit 23 | EOF 24 | 25 | help () { 26 | echo -ne "$help_string\n" 27 | } 28 | 29 | while getopts "hE:O:L:l:qV" option "$@"; do 30 | case $option in 31 | h) help && exit 0 ;; 32 | E) EMACS="$OPTARG" ;; 33 | O) EMACS_OPTS="$OPTARG" ;; 34 | q) QUICK_EXPANSION=t ;; 35 | l) LANGUAGES="$OPTARG" ;; 36 | L) ORGDIR="$OPTARG" ;; 37 | V) echo "$(basename $0) $VERSION" && exit 0 ;; 38 | esac 39 | done ; shift $((OPTIND -1)) 40 | 41 | [ "$1" ] || { help && exit 1; } 42 | 43 | for i in $@; do 44 | FILES="$FILES \"$i\"" 45 | done 46 | 47 | out=$(tempfile) 48 | 49 | $EMACS ${EMACS_OPTS} --eval "(progn 50 | (package-initialize) 51 | (when (file-accessible-directory-p \"$ORGDIR\") 52 | (add-to-list 'load-path (expand-file-name \"$ORGDIR/lisp/\")) 53 | (add-to-list 'load-path (expand-file-name \"$ORGDIR/contrib/lisp/\" t))) 54 | (require 'org) 55 | (require 'ob) 56 | (require 'ob-tangle) 57 | (setq org-babel-use-quick-and-dirty-noweb-expansion ${QUICK_EXPANSION}) 58 | (setq org-confirm-babel-evaluate nil) 59 | (unless (equal \"$LANGUAGES\" \"\") 60 | (org-babel-do-load-languages 61 | 'org-babel-load-languages 62 | (mapcar 63 | (lambda (str) (cons (make-symbol str) t)) 64 | (split-string \"$LANGUAGES\" \",\")))) 65 | (mapc (lambda (file) 66 | (find-file (expand-file-name file \"$DIR\")) 67 | (org-babel-tangle) 68 | (kill-buffer)) '($FILES)))" >${out} 2>&1 69 | 70 | ret=$? 71 | if [ ${ret} -eq 0 ]; then 72 | grep -i tangled ${out} 73 | else 74 | cat ${out} 75 | fi 76 | 77 | exit ${ret} 78 | -------------------------------------------------------------------------------- /org-tangle.md: -------------------------------------------------------------------------------- 1 | `org-tangle` takes one or several [Org](http://orgmode.org) files as arguments and produces programs 2 | 3 | # Usage 4 | 5 | ```sh 6 | org-tangle [options] file1.org [file2.org ...] 7 | ``` 8 | 9 | Options: 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
-E EMACSSpecify the Emacs executable. Default value is 'emacs24-nox'
-O OPTIONSSpecify the options to pass to Emacs. Default value is '-Q –batch'
-qEnable quick expansion of noweb references
 (see variable org-babel-use-quick-and-dirty-noweb-expansion).
-L ORGDIRSpecify an alternate directory for Org libs.
-l lang1,lang2List of languages which can be evaluated in Org buffers.
 By default, only emacs-lisp is loaded
 (see variable org-babel-load-languages)
-VShow version and exit
74 | 75 | # Source code 76 | 77 | ## Shell code 78 | 79 | 80 | 81 | - Initial variables 82 | 83 | ```sh 84 | DIR=`pwd` 85 | FILES="" 86 | ORGDIR="/path/to/alternate/org-mode" 87 | QUICK_EXPANSION=nil 88 | EMACS=<> 89 | EMACS_OPTS="-Q --batch" 90 | VERSION=0.1 91 | ``` 92 | 93 | `<>` = 94 | 95 | ```sh 96 | emacs24-nox 97 | ``` 98 | 99 | - Help function 100 | 101 | ```sh 102 | read -d '' help_string <<"EOF" 103 | Usage: <> 104 | 105 | <> 106 | EOF 107 | 108 | help () { 109 | echo -ne "$help_string\n" 110 | } 111 | ``` 112 | 113 | - Main part 114 | 115 | Let's deal with command line options 116 | 117 | ```sh 118 | while getopts "hE:O:L:l:qV" option "$@"; do 119 | case $option in 120 | h) help && exit 0 ;; 121 | E) EMACS="$OPTARG" ;; 122 | O) EMACS_OPTS="$OPTARG" ;; 123 | q) QUICK_EXPANSION=t ;; 124 | l) LANGUAGES="$OPTARG" ;; 125 | L) ORGDIR="$OPTARG" ;; 126 | V) echo "$(basename $0) $VERSION" && exit 0 ;; 127 | esac 128 | done ; shift $((OPTIND -1)) 129 | ``` 130 | 131 | We need at least one file as an argument 132 | 133 | ```sh 134 | [ "$1" ] || { help && exit 1; } 135 | ``` 136 | 137 | Wrap each argument in the code required to call tangle on it 138 | 139 | ```sh 140 | for i in $@; do 141 | FILES="$FILES \"$i\"" 142 | done 143 | ``` 144 | 145 | Create a temporary file 146 | 147 | ```sh 148 | out=$(mktemp) 149 | ``` 150 | 151 | Now, execute emacs… 152 | 153 | ```sh 154 | $EMACS ${EMACS_OPTS} --eval "(progn 155 | <>)" 156 | ``` 157 | 158 | …saving its output to a temporary file… 159 | 160 | ```sh 161 | >${out} 2>&1 162 | ``` 163 | 164 | …and its return value. 165 | 166 | ```sh 167 | ret=$? 168 | ``` 169 | 170 | If things went fine, display the number of tangled blocs 171 | 172 | ```sh 173 | if [ ${ret} -eq 0 ]; then 174 | grep -i tangled ${out} 175 | ``` 176 | 177 | Otherwise, display the whole output for the user to further investigate 178 | 179 | ```sh 180 | else 181 | cat ${out} 182 | fi 183 | ``` 184 | 185 | Finally, exit with the same value as Emacs 186 | 187 | ```sh 188 | exit ${ret} 189 | ``` 190 | 191 | ## Elisp code 192 | 193 | When `ORGDIR` actually exists, load Org libraries from this directory. Otherwise, we'll use the ones that ship with Emacs or were installed using `package.el` 194 | 195 | ```lisp 196 | (package-initialize) 197 | (when (file-accessible-directory-p "$ORGDIR") 198 | (add-to-list 'load-path (expand-file-name "$ORGDIR/lisp/")) 199 | (add-to-list 'load-path (expand-file-name "$ORGDIR/contrib/lisp/" t))) 200 | ``` 201 | 202 | Require Org libs 203 | 204 | ```lisp 205 | (require 'org) 206 | (require 'ob) 207 | (require 'ob-tangle) 208 | ``` 209 | 210 | Set `org-babel-use-quick-and-dirty-noweb-expansion` to the value of `QUICK_EXPANSION` 211 | 212 | ```lisp 213 | (setq org-babel-use-quick-and-dirty-noweb-expansion ${QUICK_EXPANSION}) 214 | ``` 215 | 216 | Do not require confirmation before evaluating code blocks 217 | 218 | ```lisp 219 | (setq org-confirm-babel-evaluate nil) 220 | ``` 221 | 222 | Load the languages specified via the `-l` option, if any 223 | 224 | ```lisp 225 | (unless (equal "$LANGUAGES" "") 226 | (org-babel-do-load-languages 227 | 'org-babel-load-languages 228 | (mapcar 229 | (lambda (str) (cons (make-symbol str) t)) 230 | (split-string "$LANGUAGES" ",")))) 231 | ``` 232 | 233 | For each file in `FILES`… 234 | 235 | ```lisp 236 | (mapc (lambda (file) 237 | <>) '($FILES)) 238 | ``` 239 | - open it within Emacs; 240 | 241 | ```lisp 242 | (find-file (expand-file-name file "$DIR")) 243 | ``` 244 | - tangle it; 245 | 246 | ```lisp 247 | (org-babel-tangle) 248 | ``` 249 | - then close it. 250 | 251 | ```lisp 252 | (kill-buffer) 253 | ``` 254 | 255 | ## Utility functions 256 | 257 | `<>` = 258 | 259 | ```lisp 260 | (save-match-data 261 | (replace-regexp-in-string "\"" "\\\\\"" str-val)) 262 | ``` 263 | 264 | Used to escape the quotes within the elisp code before embedding it into the shell code, in order to preserve readability. 265 | 266 | `<>` = 267 | 268 | ```lisp 269 | (mapconcat 270 | (lambda (row) 271 | (format fmt (car row) (cadr row))) table "\n") 272 | ``` 273 | 274 | Used to format the options table. 275 | -------------------------------------------------------------------------------- /org-tangle.org: -------------------------------------------------------------------------------- 1 | #+title: org-tangle 2 | #+author: Nicolas Girard 3 | #+email: nicolas dot girard at gmail dot com 4 | #+OPTIONS: H:2 num:nil toc:nil 5 | 6 | 7 | =org-tangle= takes one or several [[http://orgmode.org][Org]] files as arguments and produces programs 8 | 9 | * Usage 10 | #+name: usage 11 | #+begin_src sh 12 | org-tangle [options] file1.org [file2.org ...] 13 | #+end_src 14 | 15 | Options: 16 | #+tblname: toptions 17 | | -E EMACS | Specify the Emacs executable. Default value is 'emacs24-nox' | 18 | | -O OPTIONS | Specify the options to pass to Emacs. Default value is '-Q --batch' | 19 | | -q | Enable quick expansion of noweb references | 20 | | | (see variable org-babel-use-quick-and-dirty-noweb-expansion). | 21 | | -L ORGDIR | Specify an alternate directory for Org libs. | 22 | | -l lang1,lang2 | List of languages which can be evaluated in Org buffers. | 23 | | | By default, only emacs-lisp is loaded | 24 | | | (see variable org-babel-load-languages) | 25 | | -V | Show version and exit | 26 | 27 | * Source code 28 | #+header: :shebang "#!/usr/bin/env bash" 29 | #+begin_src sh :noweb tangle :tangle org-tangle :exports none 30 | <> 31 | #+end_src 32 | 33 | ** Shell code 34 | :PROPERTIES: 35 | :noweb-sep: "\n\n" 36 | :END: 37 | *** Initial variables 38 | #+name: src 39 | #+begin_src sh 40 | DIR=`pwd` 41 | FILES="" 42 | ORGDIR="/path/to/alternate/org-mode" 43 | QUICK_EXPANSION=nil 44 | EMACS=<> 45 | EMACS_OPTS="-Q --batch" 46 | VERSION=0.1 47 | #+end_src 48 | 49 | =<>= = 50 | #+name: emacs 51 | #+begin_src sh 52 | emacs 53 | #+end_src 54 | 55 | *** Help function 56 | #+name: src 57 | #+begin_src sh 58 | read -d '' help_string <<"EOF" 59 | Usage: <> 60 | 61 | <> 62 | EOF 63 | 64 | help () { 65 | echo -ne "$help_string\n" 66 | } 67 | #+end_src 68 | *** Main part 69 | Let's deal with command line options 70 | #+name: src 71 | #+begin_src sh 72 | while getopts "hE:O:L:l:qV" option "$@"; do 73 | case $option in 74 | h) help && exit 0 ;; 75 | E) EMACS="$OPTARG" ;; 76 | O) EMACS_OPTS="$OPTARG" ;; 77 | q) QUICK_EXPANSION=t ;; 78 | l) LANGUAGES="$OPTARG" ;; 79 | L) ORGDIR="$OPTARG" ;; 80 | V) echo "$(basename $0) $VERSION" && exit 0 ;; 81 | esac 82 | done ; shift $((OPTIND -1)) 83 | #+end_src 84 | 85 | We need at least one file as an argument 86 | #+name: src 87 | #+begin_src sh 88 | [ "$1" ] || { help && exit 1; } 89 | #+end_src 90 | 91 | Wrap each argument in the code required to call tangle on it 92 | #+name: src 93 | #+begin_src sh 94 | for i in $@; do 95 | FILES="$FILES \"$i\"" 96 | done 97 | #+end_src 98 | 99 | Create a temporary file 100 | #+name: src 101 | #+begin_src sh 102 | out=$(mktemp) 103 | #+end_src 104 | 105 | Now, execute emacs... 106 | #+begin_src sh :noweb-ref src :noweb-sep " " 107 | $EMACS ${EMACS_OPTS} --eval "(progn 108 | <>)" 109 | #+end_src 110 | 111 | ...saving its output to a temporary file... 112 | #+begin_src sh :noweb-ref src :noweb-sep "\n\n" 113 | >${out} 2>&1 114 | #+end_src 115 | 116 | ...and its return value. 117 | #+begin_src sh :noweb-ref src :noweb-sep "\n" 118 | ret=$? 119 | #+end_src 120 | 121 | If things went fine, display the number of tangled blocs 122 | #+begin_src sh :noweb-ref src :noweb-sep "\n" 123 | if [ ${ret} -eq 0 ]; then 124 | grep -i tangled ${out} 125 | #+end_src 126 | 127 | Otherwise, display the whole output for the user to further investigate 128 | #+name: src 129 | #+begin_src sh 130 | else 131 | cat ${out} 132 | fi 133 | #+end_src 134 | 135 | Finally, exit with the same value as Emacs 136 | #+name: src 137 | #+begin_src sh 138 | exit ${ret} 139 | #+end_src 140 | ** Elisp code 141 | #+name: elisp-code 142 | #+begin_src org :noweb yes :exports none 143 | <> 144 | #+end_src 145 | 146 | When =ORGDIR= actually exists, load Org libraries from this directory. Otherwise, we'll use the ones that ship with Emacs or were installed using =package.el= 147 | 148 | #+name: elisp 149 | #+begin_src emacs-lisp 150 | (package-initialize) 151 | (when (file-accessible-directory-p "$ORGDIR") 152 | (add-to-list 'load-path (expand-file-name "$ORGDIR/lisp/")) 153 | (add-to-list 'load-path (expand-file-name "$ORGDIR/contrib/lisp/" t))) 154 | #+end_src 155 | 156 | Require Org libs 157 | #+name: elisp 158 | #+begin_src emacs-lisp 159 | (require 'org) 160 | (require 'ob) 161 | (require 'ob-tangle) 162 | #+end_src 163 | 164 | Set =org-babel-use-quick-and-dirty-noweb-expansion= to the value of =QUICK_EXPANSION= 165 | #+name: elisp 166 | #+begin_src emacs-lisp 167 | (setq org-babel-use-quick-and-dirty-noweb-expansion ${QUICK_EXPANSION}) 168 | #+end_src 169 | 170 | Do not require confirmation before evaluating code blocks 171 | #+name: elisp 172 | #+begin_src emacs-lisp 173 | (setq org-confirm-babel-evaluate nil) 174 | #+end_src 175 | 176 | Load the languages specified via the =-l= option, if any 177 | #+name: elisp 178 | #+begin_src emacs-lisp 179 | (unless (equal "$LANGUAGES" "") 180 | (org-babel-do-load-languages 181 | 'org-babel-load-languages 182 | (mapcar 183 | (lambda (str) (cons (make-symbol str) t)) 184 | (split-string "$LANGUAGES" ",")))) 185 | #+end_src 186 | 187 | For each file in =FILES=... 188 | #+name: elisp 189 | #+begin_src emacs-lisp 190 | (mapc (lambda (file) 191 | <>) '($FILES)) 192 | #+end_src 193 | 194 | - open it within Emacs; 195 | #+name: elisp-func 196 | #+begin_src emacs-lisp 197 | (find-file (expand-file-name file "$DIR")) 198 | #+end_src 199 | - tangle it; 200 | #+name: elisp-func 201 | #+begin_src emacs-lisp 202 | (org-babel-tangle) 203 | #+end_src 204 | - then close it. 205 | #+name: elisp-func 206 | #+begin_src emacs-lisp 207 | (kill-buffer) 208 | #+end_src 209 | ** Utility functions 210 | =<>= = 211 | #+name: escape-quotes 212 | #+begin_src emacs-lisp :var str-val="" 213 | (save-match-data 214 | (replace-regexp-in-string "\"" "\\\\\"" str-val)) 215 | #+end_src 216 | Used to escape the quotes within the elisp code before embedding it into the shell code, in order to preserve readability. 217 | 218 | =<>= = 219 | #+name: format-options 220 | #+begin_src emacs-lisp :var table="" :var fmt="%s%s" :results value 221 | (mapconcat 222 | (lambda (row) 223 | (format fmt (car row) (cadr row))) table "\n") 224 | #+end_src 225 | Used to format the options table. 226 | -------------------------------------------------------------------------------- /org-weave: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | DIR=`pwd` 4 | FILES="" 5 | ORGDIR="/path/to/alternate/org-mode" 6 | QUICK_EXPANSION=nil 7 | EMACS=emacs24-nox 8 | EMACS_OPTS="-Q --batch" 9 | FLAVOR=gfm 10 | VERSION=0.1 11 | 12 | read -d '' help_string <<"EOF" 13 | Usage: org-weave [options] file.org > document 14 | 15 | -E EMACS Specify the Emacs executable. Default value is 'emacs24-nox' 16 | -O OPTIONS Specify the options to pass to Emacs. Default value is '-Q --batch' 17 | -q Enable quick expansion of noweb references 18 | (see variable org-babel-use-quick-and-dirty-noweb-expansion). 19 | -L ORGDIR Specify an alternate directory for Org libs. 20 | -f FORMAT Specify the output format. 21 | Currently, only 'gfm' (GitHub flavored Mardown) is supported. 22 | -V Show version and exit 23 | EOF 24 | 25 | help () { 26 | echo -ne "$help_string\n" 27 | } 28 | 29 | while getopts "hE:O:L:f:qV" option "$@"; do 30 | case $option in 31 | h) help && exit 0 ;; 32 | E) EMACS="$OPTARG" ;; 33 | O) EMACS_OPTS="$OPTARG" ;; 34 | q) QUICK_EXPANSION=t ;; 35 | f) FLAVOR="$OPTARG" ;; 36 | L) ORGDIR="$OPTARG" ;; 37 | V) echo "$(basename $0) $VERSION" && exit 0 ;; 38 | esac 39 | done ; shift $((OPTIND -1)) 40 | 41 | [ "$1" ] || { help && exit 1; } 42 | file="$1" 43 | 44 | [ "$FLAVOR" = "gfm" ] || { help && exit 1; } 45 | 46 | out=$(mktemp) 47 | 48 | $EMACS ${EMACS_OPTS} --eval "(progn 49 | (package-initialize) 50 | (when (file-accessible-directory-p \"$ORGDIR\") 51 | (add-to-list 'load-path (expand-file-name \"$ORGDIR/lisp/\")) 52 | (add-to-list 'load-path (expand-file-name \"$ORGDIR/contrib/lisp/\" t))) 53 | (require 'ox-gfm) 54 | (setq org-babel-use-quick-and-dirty-noweb-expansion ${QUICK_EXPANSION}) 55 | (setq org-confirm-babel-evaluate nil) 56 | (find-file (expand-file-name \"$file\" \"$DIR\")) 57 | (princ (org-export-as 'gfm)))" 58 | -------------------------------------------------------------------------------- /org-weave.md: -------------------------------------------------------------------------------- 1 | `org-weave` takes an [Org](http://orgmode.org) file as an argument and produces, on standard output, source code for typeset documentation. 2 | 3 | Currently, the only format supported is `gfm` ([GitHub flavored Markdown](http://github.github.com/github-flavored-markdown/)). 4 | 5 | # Usage 6 | 7 | ```sh 8 | org-weave [options] file.org > document 9 | ``` 10 | 11 | Options: 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 |
-E EMACSSpecify the Emacs executable. Default value is 'emacs24-nox'
-O OPTIONSSpecify the options to pass to Emacs. Default value is '-Q –batch'
-qEnable quick expansion of noweb references
 (see variable org-babel-use-quick-and-dirty-noweb-expansion).
-L ORGDIRSpecify an alternate directory for Org libs.
-f FORMATSpecify the output format.
 Currently, only 'gfm' (GitHub flavored Mardown) is supported.
-VShow version and exit
70 | 71 | # Source code 72 | 73 | ## Shell code 74 | 75 | 76 | 77 | - Initial variables 78 | 79 | ```sh 80 | DIR=`pwd` 81 | FILES="" 82 | ORGDIR="/path/to/alternate/org-mode" 83 | QUICK_EXPANSION=nil 84 | EMACS=<> 85 | EMACS_OPTS="-Q --batch" 86 | FLAVOR=gfm 87 | VERSION=0.1 88 | ``` 89 | 90 | `<>` = 91 | 92 | ```sh 93 | emacs24-nox 94 | ``` 95 | 96 | - Help function 97 | 98 | ```sh 99 | read -d '' help_string <<"EOF" 100 | Usage: <> 101 | 102 | <> 103 | EOF 104 | 105 | help () { 106 | echo -ne "$help_string\n" 107 | } 108 | ``` 109 | 110 | - Main part 111 | 112 | Let's deal with command line options 113 | 114 | ```sh 115 | while getopts "hE:O:L:f:qV" option "$@"; do 116 | case $option in 117 | h) help && exit 0 ;; 118 | E) EMACS="$OPTARG" ;; 119 | O) EMACS_OPTS="$OPTARG" ;; 120 | q) QUICK_EXPANSION=t ;; 121 | f) FLAVOR="$OPTARG" ;; 122 | L) ORGDIR="$OPTARG" ;; 123 | V) echo "$(basename $0) $VERSION" && exit 0 ;; 124 | esac 125 | done ; shift $((OPTIND -1)) 126 | ``` 127 | 128 | We need a file as an argument 129 | 130 | ```sh 131 | [ "$1" ] || { help && exit 1; } 132 | file="$1" 133 | ``` 134 | 135 | For now, only gfm is supported 136 | 137 | ```sh 138 | [ "$FLAVOR" = "gfm" ] || { help && exit 1; } 139 | ``` 140 | 141 | Create a temporary file 142 | 143 | ```sh 144 | out=$(mktemp) 145 | ``` 146 | 147 | Now, execute emacs… 148 | 149 | ```sh 150 | $EMACS ${EMACS_OPTS} --eval "(progn 151 | <>)" 152 | ``` 153 | 154 | ## Elisp code 155 | 156 | When `ORGDIR` actually exists, load Org libraries from this directory. Otherwise, we'll use the ones that ship with Emacs or were installed using `package.el` 157 | 158 | ```lisp 159 | (package-initialize) 160 | (when (file-accessible-directory-p "$ORGDIR") 161 | (add-to-list 'load-path (expand-file-name "$ORGDIR/lisp/")) 162 | (add-to-list 'load-path (expand-file-name "$ORGDIR/contrib/lisp/" t))) 163 | ``` 164 | 165 | Require the necessary libs (only `ox-gfm` for now) 166 | 167 | ```lisp 168 | (require 'ox-gfm) 169 | ``` 170 | 171 | Set `org-babel-use-quick-and-dirty-noweb-expansion` to the value of `QUICK_EXPANSION` 172 | 173 | ```lisp 174 | (setq org-babel-use-quick-and-dirty-noweb-expansion ${QUICK_EXPANSION}) 175 | ``` 176 | 177 | Do not require confirmation before evaluating code blocks 178 | 179 | ```lisp 180 | (setq org-confirm-babel-evaluate nil) 181 | ``` 182 | 183 | Open the file within emacs; 184 | 185 | ```lisp 186 | (find-file (expand-file-name "$file" "$DIR")) 187 | ``` 188 | 189 | export it 190 | 191 | ```lisp 192 | (princ (org-export-as 'gfm)) 193 | ``` 194 | 195 | ## Utility functions 196 | 197 | `<>` = 198 | 199 | ```lisp 200 | (save-match-data 201 | (replace-regexp-in-string "\"" "\\\\\"" str-val)) 202 | ``` 203 | 204 | Used to escape the quotes within the elisp code before embedding it into the shell code, in order to preserve readability. 205 | 206 | `<>` = 207 | 208 | ```lisp 209 | (mapconcat 210 | (lambda (row) 211 | (format fmt (car row) (cadr row))) table "\n") 212 | ``` 213 | 214 | Used to format the options table. 215 | -------------------------------------------------------------------------------- /org-weave.org: -------------------------------------------------------------------------------- 1 | #+title: org-weave 2 | #+author: Nicolas Girard 3 | #+email: nicolas dot girard at gmail dot com 4 | #+OPTIONS: H:2 num:nil toc:nil 5 | 6 | 7 | =org-weave= takes an [[http://orgmode.org][Org]] file as an argument and produces, on standard output, source code for typeset documentation. 8 | 9 | Currently, the only format supported is =gfm= ([[http://github.github.com/github-flavored-markdown/][GitHub flavored Markdown]]). 10 | 11 | * Usage 12 | #+name: usage 13 | #+begin_src sh 14 | org-weave [options] file.org > document 15 | #+end_src 16 | 17 | Options: 18 | #+tblname: toptions 19 | | -E EMACS | Specify the Emacs executable. Default value is 'emacs24-nox' | 20 | | -O OPTIONS | Specify the options to pass to Emacs. Default value is '-Q --batch' | 21 | | -q | Enable quick expansion of noweb references | 22 | | | (see variable org-babel-use-quick-and-dirty-noweb-expansion). | 23 | | -L ORGDIR | Specify an alternate directory for Org libs. | 24 | | -f FORMAT | Specify the output format. | 25 | | | Currently, only 'gfm' (GitHub flavored Mardown) is supported. | 26 | | -V | Show version and exit | 27 | 28 | 29 | 30 | * Source code 31 | #+header: :shebang "#!/usr/bin/env bash" 32 | #+begin_src sh :noweb tangle :tangle org-weave :exports none 33 | <> 34 | #+end_src 35 | 36 | ** Shell code 37 | :PROPERTIES: 38 | :noweb-sep: "\n\n" 39 | :END: 40 | *** Initial variables 41 | #+name: src 42 | #+begin_src sh 43 | DIR=`pwd` 44 | FILES="" 45 | ORGDIR="/path/to/alternate/org-mode" 46 | QUICK_EXPANSION=nil 47 | EMACS=<> 48 | EMACS_OPTS="-Q --batch" 49 | FLAVOR=gfm 50 | VERSION=0.1 51 | #+end_src 52 | 53 | =<>= = 54 | #+name: emacs 55 | #+begin_src sh 56 | emacs24-nox 57 | #+end_src 58 | 59 | *** Help function 60 | #+name: src 61 | #+begin_src sh 62 | read -d '' help_string <<"EOF" 63 | Usage: <> 64 | 65 | <> 66 | EOF 67 | 68 | help () { 69 | echo -ne "$help_string\n" 70 | } 71 | #+end_src 72 | *** Main part 73 | Let's deal with command line options 74 | #+name: src 75 | #+begin_src sh 76 | while getopts "hE:O:L:f:qV" option "$@"; do 77 | case $option in 78 | h) help && exit 0 ;; 79 | E) EMACS="$OPTARG" ;; 80 | O) EMACS_OPTS="$OPTARG" ;; 81 | q) QUICK_EXPANSION=t ;; 82 | f) FLAVOR="$OPTARG" ;; 83 | L) ORGDIR="$OPTARG" ;; 84 | V) echo "$(basename $0) $VERSION" && exit 0 ;; 85 | esac 86 | done ; shift $((OPTIND -1)) 87 | #+end_src 88 | 89 | We need a file as an argument 90 | #+name: src 91 | #+begin_src sh 92 | [ "$1" ] || { help && exit 1; } 93 | file="$1" 94 | #+end_src 95 | 96 | For now, only gfm is supported 97 | #+name: src 98 | #+begin_src sh 99 | [ "$FLAVOR" = "gfm" ] || { help && exit 1; } 100 | #+end_src 101 | 102 | Create a temporary file 103 | #+name: src 104 | #+begin_src sh 105 | out=$(mktemp) 106 | #+end_src 107 | 108 | Now, execute emacs... 109 | #+begin_src sh :noweb-ref src :noweb-sep " " 110 | $EMACS ${EMACS_OPTS} --eval "(progn 111 | <>)" 112 | #+end_src 113 | 114 | ** Elisp code 115 | #+name: elisp-code 116 | #+begin_src org :noweb yes :exports none 117 | <> 118 | #+end_src 119 | 120 | When =ORGDIR= actually exists, load Org libraries from this directory. Otherwise, we'll use the ones that ship with Emacs or were installed using =package.el= 121 | 122 | #+name: elisp 123 | #+begin_src emacs-lisp 124 | (package-initialize) 125 | (when (file-accessible-directory-p "$ORGDIR") 126 | (add-to-list 'load-path (expand-file-name "$ORGDIR/lisp/")) 127 | (add-to-list 'load-path (expand-file-name "$ORGDIR/contrib/lisp/" t))) 128 | #+end_src 129 | 130 | Require the necessary libs (only =ox-gfm= for now) 131 | #+name: elisp 132 | #+begin_src emacs-lisp 133 | (require 'ox-gfm) 134 | #+end_src 135 | 136 | Set =org-babel-use-quick-and-dirty-noweb-expansion= to the value of =QUICK_EXPANSION= 137 | #+name: elisp 138 | #+begin_src emacs-lisp 139 | (setq org-babel-use-quick-and-dirty-noweb-expansion ${QUICK_EXPANSION}) 140 | #+end_src 141 | 142 | Do not require confirmation before evaluating code blocks 143 | #+name: elisp 144 | #+begin_src emacs-lisp 145 | (setq org-confirm-babel-evaluate nil) 146 | #+end_src 147 | 148 | Open the file within emacs; 149 | #+name: elisp 150 | #+begin_src emacs-lisp 151 | (find-file (expand-file-name "$file" "$DIR")) 152 | #+end_src 153 | 154 | export it 155 | #+name: elisp 156 | #+begin_src emacs-lisp 157 | (princ (org-export-as 'gfm)) 158 | #+end_src 159 | 160 | ** Utility functions 161 | =<>= = 162 | #+name: escape-quotes 163 | #+begin_src emacs-lisp :var str-val="" 164 | (save-match-data 165 | (replace-regexp-in-string "\"" "\\\\\"" str-val)) 166 | #+end_src 167 | Used to escape the quotes within the elisp code before embedding it into the shell code, in order to preserve readability. 168 | 169 | =<>= = 170 | #+name: format-options 171 | #+begin_src emacs-lisp :var table="" :var fmt="%s%s" :results value 172 | (mapconcat 173 | (lambda (row) 174 | (format fmt (car row) (cadr row))) table "\n") 175 | #+end_src 176 | Used to format the options table. 177 | --------------------------------------------------------------------------------