├── LICENSE ├── README.md ├── scripts ├── Makefile ├── add_ids.sh ├── fix_by_id.sh ├── graph.pl └── rename.sh └── zettel-mode.el /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | GNU GENERAL PUBLIC LICENSE 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for 12 | software and other kinds of works. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | the GNU General Public License is intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. We, the Free Software Foundation, use the 19 | GNU General Public License for most of our software; it applies also to 20 | any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you 31 | these rights or asking you to surrender the rights. Therefore, you have 32 | certain responsibilities if you distribute copies of the software, or if 33 | you modify it: responsibilities to respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must pass on to the recipients the same 37 | freedoms that you received. You must make sure that they, too, receive 38 | or can get the source code. And you must show them these terms so they 39 | know their rights. 40 | 41 | Developers that use the GNU GPL protect your rights with two steps: 42 | (1) assert copyright on the software, and (2) offer you this License 43 | giving you legal permission to copy, distribute and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains 46 | that there is no warranty for this free software. For both users' and 47 | authors' sake, the GPL requires that modified versions be marked as 48 | changed, so that their problems will not be attributed erroneously to 49 | authors of previous versions. 50 | 51 | Some devices are designed to deny users access to install or run 52 | modified versions of the software inside them, although the manufacturer 53 | can do so. This is fundamentally incompatible with the aim of 54 | protecting users' freedom to change the software. The systematic 55 | pattern of such abuse occurs in the area of products for individuals to 56 | use, which is precisely where it is most unacceptable. Therefore, we 57 | have designed this version of the GPL to prohibit the practice for those 58 | products. If such problems arise substantially in other domains, we 59 | stand ready to extend this provision to those domains in future versions 60 | of the GPL, as needed to protect the freedom of users. 61 | 62 | Finally, every program is threatened constantly by software patents. 63 | States should not allow patents to restrict development and use of 64 | software on general-purpose computers, but in those that do, we wish to 65 | avoid the special danger that patents applied to a free program could 66 | make it effectively proprietary. To prevent this, the GPL assures that 67 | patents cannot be used to render the program non-free. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Use with the GNU Affero General Public License. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU Affero General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the special requirements of the GNU Affero General Public License, 561 | section 13, concerning interaction through a network will apply to the 562 | combination as such. 563 | 564 | 14. Revised Versions of this License. 565 | 566 | The Free Software Foundation may publish revised and/or new versions of 567 | the GNU General Public License from time to time. Such new versions will 568 | be similar in spirit to the present version, but may differ in detail to 569 | address new problems or concerns. 570 | 571 | Each version is given a distinguishing version number. If the 572 | Program specifies that a certain numbered version of the GNU General 573 | Public License "or any later version" applies to it, you have the 574 | option of following the terms and conditions either of that numbered 575 | version or of any later version published by the Free Software 576 | Foundation. If the Program does not specify a version number of the 577 | GNU General Public License, you may choose any version ever published 578 | by the Free Software Foundation. 579 | 580 | If the Program specifies that a proxy can decide which future 581 | versions of the GNU General Public License can be used, that proxy's 582 | public statement of acceptance of a version permanently authorizes you 583 | to choose that version for the Program. 584 | 585 | Later license versions may give you additional or different 586 | permissions. However, no additional obligations are imposed on any 587 | author or copyright holder as a result of your choosing to follow a 588 | later version. 589 | 590 | 15. Disclaimer of Warranty. 591 | 592 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 593 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 594 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 595 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 596 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 597 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 598 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 599 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 600 | 601 | 16. Limitation of Liability. 602 | 603 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 604 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 605 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 606 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 607 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 608 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 609 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 610 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 611 | SUCH DAMAGES. 612 | 613 | 17. Interpretation of Sections 15 and 16. 614 | 615 | If the disclaimer of warranty and limitation of liability provided 616 | above cannot be given local legal effect according to their terms, 617 | reviewing courts shall apply local law that most closely approximates 618 | an absolute waiver of all civil liability in connection with the 619 | Program, unless a warranty or assumption of liability accompanies a 620 | copy of the Program in return for a fee. 621 | 622 | END OF TERMS AND CONDITIONS 623 | 624 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | zettel-mode [name subject to change] 2 | ==================================== 3 | 4 | Note: Mostly superseded by 5 | [zettel2](https://github.com/vifon/zettel2). Left as a separate 6 | project because the featureset is very different. 7 | 8 | An opinionated Emacs mode for [Zettelkasten][1]-style note-taking. 9 | Heavily inspired by [org-roam][2], striving to be simpler, less 10 | dependent on the external state (like the auxiliary database of 11 | `org-roam`) and local only to the affected files (i.e. no global minor 12 | modes). 13 | 14 | ASSUMPTIONS 15 | ----------- 16 | 17 | Traditionally uses [Deft][3] as its "entry point" and was initially 18 | developed under an assumption the `Deft` files reside in `~/.deft/`. 19 | It should work with any `deft-directory` but you'll need to customize 20 | `auto-mode-alist` accordingly. Using subdirectories isn't supported. 21 | 22 | It's possible to have secondary Zettelkastens outside of `~/.deft/`, 23 | or ignore Deft whatsoever by handling `auto-mode-alist` manually, for example: 24 | 25 | ```elisp 26 | ;;; Any .org file inside a zettel/ or zettels/ directory. 27 | (add-to-list 'auto-mode-alist '("/zettels?/[^/]+\\.org\\'" . zettel-mode)) 28 | 29 | (add-to-list 'auto-mode-alist '("/home/USER/my-zettelkasten/[^/]+\\.org\\'" . zettel-mode)) 30 | ``` 31 | 32 | To prevent `zettel-mode` from associating with the Deft files, eval 33 | `(setq zettel-mode-no-deft t)` before loading `zettel-mode`. 34 | 35 | [1]: https://zettelkasten.de/ 36 | [2]: https://github.com/org-roam/org-roam 37 | [3]: https://github.com/jrblevin/deft 38 | 39 | FEATURES 40 | -------- 41 | 42 | - Quick new note creation: select some text and press C-c C-l. 43 | - A sidebar with lists of references to and from the current file. 44 | - A fully optional reference and backreference cache (rebuilt with `make(1)`). 45 | 46 | For the settings see the provided [Customize][4] menus. 47 | 48 | [4]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html 49 | 50 | SCRIPTS 51 | ------- 52 | 53 | In the `scripts/` directory reside some helper scripts for common 54 | maintenance tasks for the notes. In general they work but they 55 | probably don't handle all the corner cases (like filenames with 56 | special characters). Each script has a brief description included as 57 | a comment. 58 | 59 | FAQ 60 | --- 61 | 62 | Q: Why it's not on MELPA? 63 | 64 | A: I don't want to hoard such a generic name as `zettel-mode` and for 65 | now I don't have a better name for it either. 66 | 67 | COPYRIGHT 68 | --------- 69 | 70 | Copyright (C) 2020 Wojciech Siewierski 71 | 72 | This program is free software: you can redistribute it and/or modify 73 | it under the terms of the GNU General Public License as published by 74 | the Free Software Foundation, either version 3 of the License, or 75 | (at your option) any later version. 76 | 77 | This program is distributed in the hope that it will be useful, 78 | but WITHOUT ANY WARRANTY; without even the implied warranty of 79 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 80 | GNU General Public License for more details. 81 | 82 | You should have received a copy of the GNU General Public License 83 | along with this program. If not, see . 84 | -------------------------------------------------------------------------------- /scripts/Makefile: -------------------------------------------------------------------------------- 1 | CACHES = .cache/backrefs.el .cache/refs.el 2 | 3 | .PHONY: all 4 | all: $(CACHES) 5 | 6 | .PHONY: clean 7 | clean: 8 | $(RM) $(CACHES) 9 | 10 | .cache/backrefs.el: $(wildcard *.org) | .cache 11 | emacsclient --eval "(progn (require 'zettel-mode) (zettel-get-all #'zettel-get-backrefs))" > $@ 12 | 13 | .cache/refs.el: $(wildcard *.org) | .cache 14 | emacsclient --eval "(progn (require 'zettel-mode) (zettel-get-all #'zettel-get-refs))" > $@ 15 | 16 | .cache: 17 | mkdir -p .cache 18 | -------------------------------------------------------------------------------- /scripts/add_ids.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -o errexit -o nounset -o pipefail 4 | 5 | # Fix the links after adding an ID prefix to a given file. The rest 6 | # of the filename must not have changed. 7 | 8 | 9 | for f in "$@"; do 10 | perl -pi'*.bak' -E 'BEGIN { 11 | $new = shift; 12 | $old = $new =~ s/^\d+_//r; 13 | } 14 | 15 | s/\Qfile:$old\E/file:$new/g; 16 | ' "$f" *.org 17 | done 18 | 19 | for f in *.org; do 20 | touch --no-create --reference "$f.bak" "$f" 21 | done 22 | -------------------------------------------------------------------------------- /scripts/fix_by_id.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -o errexit -o nounset -o pipefail 4 | 5 | # Fix the links after renaming a file while keeping the old ID. 6 | 7 | 8 | for f in "$@"; do 9 | perl -pi'*.bak' -E 'BEGIN { 10 | ($id, $new) = shift =~ /^(\d+)_(.*)\.org$/; 11 | } 12 | 13 | s/\Qfile:${id}_\E.*?\.org/file:${id}_$new.org/g; 14 | ' "$f" *.org 15 | done 16 | 17 | for f in *.org; do 18 | touch --no-create --reference "$f.bak" "$f" 19 | done 20 | -------------------------------------------------------------------------------- /scripts/graph.pl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env perl 2 | 3 | =head1 zettel-graph.pl 4 | 5 | Generate the input for Graphviz C to generate the graph of notes 6 | in the current directory and the links between them. 7 | 8 | =head2 USAGE 9 | 10 | cd ~/.deft 11 | .../graph.pl | dot -Tx11 12 | 13 | or 14 | 15 | .../graph.pl | dot -Tpdf -o graph.pdf 16 | 17 | =cut 18 | 19 | use warnings; 20 | use strict; 21 | use 5.010; 22 | use autodie; 23 | 24 | sub title (_) { 25 | my $filename = shift; 26 | 27 | my $title; 28 | open(my $f, '<', $filename); 29 | while (<$f>) { 30 | $title = $1 and last if /^#\+TITLE:\s*(.*)/ 31 | } 32 | close $f; 33 | $_ = $title // $filename =~ s/\.org$//r; 34 | } 35 | 36 | say 'digraph org {'; 37 | for my $file (<*.org>) { 38 | my $file_title = title $file; 39 | 40 | my @links = `grep -l -F "[file:$file]" *.org`; 41 | print ' {'; 42 | print join " ", map {chomp; title; qq("$_")} @links; 43 | say qq(} -> "$file_title"); 44 | say qq( "$file_title" [URL="$file"]); 45 | } 46 | say '}'; 47 | -------------------------------------------------------------------------------- /scripts/rename.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -o errexit -o nounset -o pipefail 4 | 5 | # Rename a file and fix the links to it. 6 | 7 | 8 | mv "$1" "$2" 9 | 10 | perl -pi'*.bak' -E 'BEGIN { 11 | $old = shift; 12 | $new = shift; 13 | } 14 | 15 | s/\Qfile:$old\E/file:$new/g; 16 | ' "$1" "$2" *.org 17 | 18 | for f in *.org; do 19 | touch --no-create --reference "$f.bak" "$f" 20 | done 21 | -------------------------------------------------------------------------------- /zettel-mode.el: -------------------------------------------------------------------------------- 1 | ;;; zettel-mode.el --- A Zettelkasten-style note-taking helper -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2020 Wojciech Siewierski 4 | 5 | ;; Author: Wojciech Siewierski 6 | ;; Keywords: outlines, org-mode, convenience 7 | ;; Version: 1.0 8 | ;; Package-Requires: ((emacs "26.1") (org "9.3") (deft "0.8")) 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 of the License, or 13 | ;; (at your option) 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 this program. If not, see . 22 | 23 | ;;; Commentary: 24 | 25 | ;; An Emacs mode for Zettelkasten-style note-taking. 26 | ;; Heavily inspired by org-roam. 27 | 28 | ;;; Code: 29 | 30 | (require 'cl-lib) 31 | (require 'deft) 32 | (require 'subr-x) 33 | (require 'org) 34 | 35 | (defgroup zettel-mode nil 36 | "A mode for Zettelkasten-style note-taking." 37 | :group 'outlines) 38 | 39 | (defcustom zettel-link-text-prefix "§ " 40 | "A prefix for titles of links between notes." 41 | :type 'string) 42 | 43 | (defcustom zettel-sidebar-max-depth 0 44 | "Maximum depth of the references lists in the sidebar." 45 | :type 'integer) 46 | 47 | (defcustom zettel-sidebar-update-delay 0.5 48 | "The time in seconds to wait before updating the sidebar on current buffer change." 49 | :type 'float) 50 | 51 | (defcustom zettel-slug-format "%Y%m%d%H%M%S_" 52 | "The prefix used for the filenames of created files." 53 | :type 'string) 54 | 55 | 56 | (defun zettel-get-files () 57 | (directory-files default-directory nil "\\.org\\'")) 58 | 59 | (defun zettel-absolute-filename (name) 60 | (concat (file-name-as-directory default-directory) 61 | (downcase 62 | (replace-regexp-in-string "[[:space:]/]+" "-" name)) 63 | ".org")) 64 | 65 | (defun zettel-get-backrefs (target-file) 66 | "Get the links to other files referencing TARGET-FILE." 67 | (sort 68 | (mapcan 69 | (lambda (file) 70 | (with-current-buffer (find-file-noselect file) 71 | (when-let ((link (org-element-map 72 | (org-element-parse-buffer) 'link 73 | ;; Find the first link to target-file. 74 | (lambda (link) 75 | (equal target-file 76 | (org-element-property :path link))) 77 | nil t))) 78 | ;; If this file links to the target-file, return its name 79 | ;; and title. `zettel-get-org-title' cannot be called in 80 | ;; the lambda above as `org-element-map' doesn't operate in 81 | ;; the context of the whole file, that's why we do it here. 82 | (let ((org-title (zettel-get-org-title))) 83 | (list (list file 84 | org-title)))))) 85 | (zettel-get-files)) 86 | (lambda (x y) (string< (car x) 87 | (car y))))) 88 | 89 | (defun zettel-get-refs (target-file) 90 | "Get the links to other files referenced from TARGET-FILE." 91 | (with-current-buffer (find-file-noselect target-file) 92 | (sort 93 | (mapcar 94 | (lambda (file) 95 | (list file (zettel-get-org-title file))) 96 | (cl-intersection 97 | (zettel-get-files) 98 | (delete-dups 99 | (org-element-map (org-element-parse-buffer) 'link 100 | (lambda (link) 101 | (let ((path (org-element-property :path link)) 102 | (type (org-element-property :type link))) 103 | (when (equal type "file") 104 | path))))) 105 | :test #'equal)) 106 | (lambda (x y) (string< (cadr x) 107 | (cadr y)))))) 108 | 109 | (defun zettel-get-external-refs (target-file) 110 | "Get the external links referenced from TARGET-FILE. 111 | 112 | Return all the links other than the ones to the other files." 113 | (with-current-buffer (find-file-noselect target-file) 114 | (mapcar 115 | (lambda (link) 116 | (list (plist-get link :raw) 117 | (plist-get link :text))) 118 | (sort 119 | (cl-set-difference 120 | (delete-dups 121 | (org-element-map (org-element-parse-buffer) 'link 122 | (lambda (link) 123 | (let ((path (org-element-property :path link)) 124 | (type (org-element-property :type link)) 125 | (raw (org-element-property :raw-link link)) 126 | (text (org-element-contents link))) 127 | (list :raw raw 128 | :text (if text 129 | (substring-no-properties 130 | (car text)) 131 | raw) 132 | :path (when (equal type "file") 133 | path)))))) 134 | (zettel-get-files) 135 | :test (lambda (a b) (equal (plist-get a :path) 136 | b))) 137 | (lambda (a b) 138 | (string< (plist-get a :text) 139 | (plist-get b :text))))))) 140 | 141 | (defun zettel-get-org-title (&optional file) 142 | "Get the `org-mode' title of FILE or the current file if FILE is nil." 143 | (with-current-buffer (if file 144 | (find-file-noselect file) 145 | (current-buffer)) 146 | (when-let ((title-prop (plist-get 147 | (org-export-get-environment) 148 | :title))) 149 | (substring-no-properties (car title-prop))))) 150 | 151 | (defun zettel-insert-refs-using (ref-function target-file depth &optional listed) 152 | "Insert a sidebar section. 153 | 154 | Insert the `org-mode' links found using REF-FUNCTION on 155 | TARGET-FILE recursively until `zettel-sidebar-max-depth' is 156 | reached. DEPTH is used to track the current recursion level, 157 | initially 0. LISTED holds the files already listed in a given 158 | subtree to avoid duplicates and cycles." 159 | (dolist (file-data 160 | (cl-nset-difference (funcall ref-function target-file) 161 | listed 162 | :test (lambda (x y) (equal (car x) y)))) 163 | (insert (make-string (* 2 depth) 164 | ?\ ) 165 | "- ") 166 | (let ((link (concat "file:" (car file-data))) 167 | (title (file-name-base (cadr file-data)))) 168 | (org-insert-link nil link title)) 169 | (insert "\n") 170 | (when (< depth zettel-sidebar-max-depth) 171 | (zettel-insert-refs-using ref-function 172 | (car file-data) 173 | (1+ depth) 174 | (cons target-file listed))))) 175 | 176 | (defun zettel-get-all (ref-func) 177 | "Compute an alist of all files' references using a given REF-FUNC. 178 | 179 | REF-FUNC should be a function such as `zettel-get-backrefs' or 180 | `zettel-get-refs', accepting a target-file as its argument, 181 | target-file being a member of `zettel-get-files'." 182 | (mapcar 183 | (lambda (target-file) 184 | (cons target-file 185 | (funcall ref-func target-file))) 186 | (zettel-get-files))) 187 | 188 | (defun zettel-cached (func cache-name) 189 | "Either call FUNC or retrieve its result from cache associated with the CACHE-NAME symbol. 190 | 191 | FUNC should be a function such as `zettel-get-backrefs' or 192 | `zettel-get-refs', accepting a target-file." 193 | (lambda (target-file) 194 | (if-let ((cache-file (concat (file-name-as-directory default-directory) 195 | ".cache/" 196 | (symbol-name cache-name) 197 | ".el")) 198 | (backref-cache (with-temp-buffer 199 | (when (file-exists-p cache-file) 200 | (insert-file-contents cache-file) 201 | (goto-char (point-min)) 202 | (read (current-buffer))))) 203 | (cached (assoc target-file backref-cache))) 204 | (cdr cached) 205 | (funcall func target-file)))) 206 | 207 | (defun zettel-insert-backrefs (target-file) 208 | (insert "* Backrefs\n\n") 209 | (zettel-insert-refs-using 210 | (zettel-cached #'zettel-get-backrefs 'backrefs) 211 | target-file 0)) 212 | 213 | (defun zettel-insert-refs (target-file) 214 | (insert "\n* References\n\n") 215 | (zettel-insert-refs-using 216 | (zettel-cached #'zettel-get-refs 'refs) 217 | target-file 0)) 218 | 219 | (defun zettel-insert-external-refs (target-file) 220 | (when-let ((links (zettel-get-external-refs target-file))) 221 | (insert "\n* External\n\n") 222 | (dolist (link links) 223 | (insert "- ") 224 | (let ((link (car link)) 225 | (title (cadr link))) 226 | (org-insert-link nil link title)) 227 | (insert "\n")))) 228 | 229 | 230 | (defvar zettel-sidebar-buffer "*zettel-sidebar*") 231 | 232 | (defun zettel-sidebar (&optional depth) 233 | "Show or refresh the sidebar with the lists of references. 234 | 235 | DEPTH overrides `zettel-sidebar-max-depth' temporarily." 236 | (interactive "P") 237 | (let* ((zettel-sidebar-max-depth (or depth 238 | zettel-sidebar-max-depth)) 239 | (target-file (file-name-nondirectory (buffer-file-name))) 240 | (zettel-directory default-directory) 241 | (buffer (get-buffer-create zettel-sidebar-buffer))) 242 | (display-buffer-in-side-window buffer 243 | '((side . right))) 244 | (with-current-buffer buffer 245 | (setq default-directory zettel-directory) 246 | (read-only-mode 1) 247 | (let ((inhibit-read-only t)) 248 | (erase-buffer) 249 | (zettel-sidebar-mode) 250 | (insert 251 | (with-temp-buffer 252 | (zettel-insert-backrefs target-file) 253 | (zettel-insert-refs target-file) 254 | (zettel-insert-external-refs target-file) 255 | (buffer-string))) 256 | (goto-char (point-min)))))) 257 | 258 | (defvar zettel--last-buffer nil 259 | "The last buffer the sidebar was generated for. 260 | 261 | Used to detect the change of buffer.") 262 | 263 | (defun zettel-update-hook () 264 | (let ((current-buffer (current-buffer))) 265 | (unless (and (eq zettel--last-buffer current-buffer) 266 | (get-buffer-window zettel-sidebar-buffer)) 267 | (run-at-time (when (get-buffer-window zettel-sidebar-buffer) 268 | zettel-sidebar-update-delay) 269 | nil 270 | (lambda () 271 | (when (eq current-buffer (current-buffer)) 272 | (zettel-sidebar) 273 | (setq zettel--last-buffer current-buffer))))))) 274 | 275 | 276 | (defun zettel-unique-name (name) 277 | "Add a unique ID to NAME." 278 | (concat (format-time-string zettel-slug-format) 279 | name)) 280 | 281 | (defun zettel-insert-note (text title file-name) 282 | "Insert a link to another org file, possibly creating a new file. 283 | 284 | If FILE-NAME doesn't exist, create it and use TITLE as its 285 | title (\"#+TITLE\"). Afterwards the file is displayed in the 286 | other window. Regardless of the file's previous existence a link 287 | to FILE-NAME with TEXT as its description is left at the 288 | original point. 289 | 290 | In interactive uses, if the region is active, use the selected 291 | text. Otherwise interactively ask for a file to link to." 292 | (interactive 293 | (if (region-active-p) 294 | (let* ((text (buffer-substring-no-properties 295 | (point) (mark))) 296 | (title (file-name-sans-extension 297 | (completing-read "File title: " 298 | (zettel-get-files) 299 | nil nil 300 | text))) 301 | (file-name (zettel-absolute-filename title))) 302 | (list text title file-name)) 303 | (let* ((title (file-name-sans-extension 304 | (completing-read "File title: " 305 | (zettel-get-files)))) 306 | (file-name (zettel-absolute-filename title)) 307 | (text (read-from-minibuffer "Description: " 308 | (when (file-exists-p file-name) 309 | (zettel-get-org-title file-name))))) 310 | (list text title file-name)))) 311 | (let* ((file-name (if (file-exists-p file-name) 312 | file-name 313 | (zettel-absolute-filename 314 | (zettel-unique-name 315 | (file-name-nondirectory 316 | (file-name-sans-extension 317 | file-name)))))) 318 | (link (concat "file:" file-name))) 319 | (org-insert-link nil 320 | link 321 | (concat zettel-link-text-prefix 322 | text)) 323 | (unless (file-exists-p file-name) 324 | (find-file-other-window file-name) 325 | (with-current-buffer (get-file-buffer file-name) 326 | (insert "#+TITLE: " title "\n\n") 327 | (goto-char (point-max))) 328 | (deft-cache-update-file file-name) 329 | (deft-refresh-filter)) 330 | (zettel-sidebar))) 331 | 332 | (defun zettel-insert-link (&optional arg) 333 | "Call `zettel-insert-note' if region is active, otherwise call `org-insert-link'. 334 | 335 | With a prefix ARG this behavior is inverted." 336 | (interactive "P") 337 | (if (or (and (region-active-p) 338 | (not arg)) 339 | (and (not (region-active-p)) 340 | arg)) 341 | (call-interactively #'zettel-insert-note) 342 | (let ((current-prefix-arg nil)) 343 | (call-interactively #'org-insert-link)))) 344 | 345 | 346 | (defvar zettel-mode-map 347 | (let ((map (make-sparse-keymap))) 348 | (define-key map [remap org-insert-link] #'zettel-insert-link) 349 | (define-key map (kbd "M-n") #'org-next-link) 350 | (define-key map (kbd "M-p") #'org-previous-link) 351 | (define-key map (kbd "C-c C-M-g") #'zettel-sidebar) 352 | map)) 353 | 354 | (define-derived-mode zettel-mode org-mode "Zettel" 355 | "A mode for Zettelkasten-style note-taking based on `org-mode'. 356 | 357 | Provides a quicker to use version of `org-insert-link' and 358 | a sidebar outlining the file's relationship with other files." 359 | (add-hook 'post-command-hook #'zettel-update-hook nil t)) 360 | 361 | (unless (bound-and-true-p zettel-mode-no-deft) 362 | (add-to-list 'auto-mode-alist '("/\\.deft/[^/]+\\.org\\'" . zettel-mode))) 363 | 364 | 365 | (defvar zettel-sidebar-mode-map 366 | (let ((map (make-sparse-keymap))) 367 | (define-key map (kbd "n") #'org-next-link) 368 | (define-key map (kbd "p") #'org-previous-link) 369 | (define-key map (kbd "g") (lambda (arg) 370 | (interactive "P") 371 | (with-current-buffer zettel--last-buffer 372 | (zettel-sidebar arg)))) 373 | map)) 374 | 375 | (define-derived-mode zettel-sidebar-mode org-mode "Zettel-sidebar" 376 | "A specialized mode for the `zettel-mode' sidebar with lists of references." 377 | (setq-local org-return-follows-link t) 378 | (setq-local org-cycle-include-plain-lists 'integrate)) 379 | 380 | 381 | (provide 'zettel-mode) 382 | ;;; zettel-mode.el ends here 383 | --------------------------------------------------------------------------------