├── .gitignore ├── LICENSE ├── README.md ├── pic └── demo-show-selection.gif ├── roam-with-helm-v2.el └── roam-with-helm.el /.gitignore: -------------------------------------------------------------------------------- 1 | *.org 2 | *~ 3 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | # Installation 5 | 6 | Clone or download this repository (path of the folder is the used below). 7 | 8 | If using Org Roam v2, clone (or download) the [helm-org-walk](https://github.com/dustinlacewell/helm-org-walk) repository. 9 | 10 | In your `~/.emacs`, add the following two lines: 11 | 12 | (add-to-list 'load-path "") 13 | (require 'roam-with-helm) 14 | 15 | Or for version 2: 16 | 17 | (add-to-list 'load-path "") 18 | (add-to-list 'load-path "") 19 | (require 'roam-with-helm-v2) 20 | 21 | # Usage 22 | 23 | By press: \`M-x roam-with-helm-org-roam-find-file\` 24 | 25 | (define-key org-mode-map (kbd "C-c f") 'roam-with-helm-org-roam-find-file) 26 | 27 | Or for version-2 28 | 29 | (global-set-key (kbd "C-c f") 'helm-org-roam) 30 | 31 | ## Jump to the content 32 | 33 | After input the title, press `RET` to visit the file 34 | 35 | 36 | ## Preview the content 37 | 38 | In helm, press `C-c C-f`. When navigation, you can preview the 39 | content. 40 | 41 | 42 | ## Insert the contents as a transclusion link. 43 | 44 | This requires user to mark the candidates by pressing `C-SPC`. After 45 | the selection, press `RET` to insert the candidates as 46 | transclusions. 47 | 48 | 49 | # Issue 50 | 51 | It cannot insert a normal link as `org-roam-insert-immediate` on the 52 | fly depending on existence of notes. 53 | 54 | So, this function is tweaked as a separated function. You can use 55 | your favorite completing system as you used to. 56 | -------------------------------------------------------------------------------- /pic/demo-show-selection.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/randomwangran/roam-with-helm/c488043a160b3a1e2ddf9f4de6e059c744225c63/pic/demo-show-selection.gif -------------------------------------------------------------------------------- /roam-with-helm-v2.el: -------------------------------------------------------------------------------- 1 | ;;; roam-with-helm --- A source for navigation Org-roam -*- lexical-binding: nil; -*- 2 | 3 | ;; Copyright (C) 2022 Ran Wang 4 | 5 | ;; Author: Ran Wang 6 | ;; URL: https://github.com/randomwangran/roam-with-helm 7 | ;; Version: 0.0.3 8 | ;; Package-Requires: ((emacs "27.1") (org "9.4") (helm "3.6.2") (org-roam "2.2.1")) 9 | ;; Keywords: org-mode, navigation, writing, note-taking 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;; This program is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | ;;; Commentary: 27 | 28 | ;; 29 | 30 | ;;;; Installation 31 | 32 | ;;;;; MELPA 33 | 34 | ;; This package is not available on MELPA. Manual installation required. 35 | 36 | ;;;;; Manual 37 | 38 | ;; Install these required packages: 39 | 40 | ;; Then put this file in your load-path, and put this in your init 41 | ;; file: 42 | ;; (require 'roam-with-helm) 43 | 44 | 45 | (require 'helm-mode) 46 | (require 'org-roam) 47 | (require 'helm-org-walk) 48 | 49 | 50 | (setq previous-node-title nil) 51 | 52 | (defun chatgpt/add-slash-to-string (str) 53 | (concat (substring str 0 2) "/" (substring str 2))) 54 | 55 | ;;;; [Very Very Very important] 56 | ;; Walk around for dynamically capture a thoughts into a node. 57 | ;; Notice `(dynamic-node ,title-or-id), only works for Helm user. 58 | ;; 59 | (defun org-roam-capture--setup-target-location () 60 | "Initialize the buffer, and goto the location of the new capture. 61 | Return the ID of the location." 62 | (let (p new-file-p) 63 | (pcase (org-roam-capture--get-target) 64 | (`(file ,path) 65 | (setq path (org-roam-capture--target-truepath path) 66 | new-file-p (org-roam-capture--new-file-p path)) 67 | (when new-file-p (org-roam-capture--put :new-file path)) 68 | (set-buffer (org-capture-target-buffer path)) 69 | (widen) 70 | (setq p (goto-char (point-min)))) 71 | (`(file+olp ,path ,olp) 72 | (setq path (org-roam-capture--target-truepath path) 73 | new-file-p (org-roam-capture--new-file-p path)) 74 | (when new-file-p (org-roam-capture--put :new-file path)) 75 | (set-buffer (org-capture-target-buffer path)) 76 | (setq p (point-min)) 77 | (let ((m (org-roam-capture-find-or-create-olp olp))) 78 | (goto-char m)) 79 | (widen)) 80 | (`(file+head ,path ,head) 81 | (setq path (org-roam-capture--target-truepath path) 82 | new-file-p (org-roam-capture--new-file-p path)) 83 | (set-buffer (org-capture-target-buffer path)) 84 | (when new-file-p 85 | (org-roam-capture--put :new-file path) 86 | (insert (org-roam-capture--fill-template head 'ensure-newline))) 87 | (widen) 88 | (setq p (goto-char (point-min)))) 89 | (`(file+head+olp ,path ,head ,olp) 90 | (setq path (org-roam-capture--target-truepath path) 91 | new-file-p (org-roam-capture--new-file-p path)) 92 | (set-buffer (org-capture-target-buffer path)) 93 | (widen) 94 | (when new-file-p 95 | (org-roam-capture--put :new-file path) 96 | (insert (org-roam-capture--fill-template head 'ensure-newline))) 97 | (setq p (point-min)) 98 | (let ((m (org-roam-capture-find-or-create-olp olp))) 99 | (goto-char m))) 100 | (`(file+datetree ,path ,tree-type) 101 | (setq path (org-roam-capture--target-truepath path)) 102 | (require 'org-datetree) 103 | (widen) 104 | (set-buffer (org-capture-target-buffer path)) 105 | (unless (file-exists-p path) 106 | (org-roam-capture--put :new-file path)) 107 | (funcall 108 | (pcase tree-type 109 | (`week #'org-datetree-find-iso-week-create) 110 | (`month #'org-datetree-find-month-create) 111 | (_ #'org-datetree-find-date-create)) 112 | (calendar-gregorian-from-absolute 113 | (cond 114 | (org-overriding-default-time 115 | ;; Use the overriding default time. 116 | (time-to-days org-overriding-default-time)) 117 | ((org-capture-get :default-time) 118 | (time-to-days (org-capture-get :default-time))) 119 | ((org-capture-get :time-prompt) 120 | ;; Prompt for date. Bind `org-end-time-was-given' so 121 | ;; that `org-read-date-analyze' handles the time range 122 | ;; case and returns `prompt-time' with the start value. 123 | (let* ((org-time-was-given nil) 124 | (org-end-time-was-given nil) 125 | (prompt-time (org-read-date 126 | nil t nil "Date for tree entry:"))) 127 | (org-capture-put 128 | :default-time 129 | (if (or org-time-was-given 130 | (= (time-to-days prompt-time) (org-today))) 131 | prompt-time 132 | ;; Use 00:00 when no time is given for another 133 | ;; date than today? 134 | (apply #'encode-time 0 0 135 | org-extend-today-until 136 | (cl-cdddr (decode-time prompt-time))))) 137 | (time-to-days prompt-time))) 138 | (t 139 | ;; Current date, possibly corrected for late night 140 | ;; workers. 141 | (org-today))))) 142 | (setq p (point))) 143 | (`(node ,title-or-id) 144 | ;; first try to get ID, then try to get title/alias 145 | (let ((node (or (org-roam-node-from-id title-or-id) 146 | (org-roam-node-from-title-or-alias title-or-id) 147 | (user-error "No node with title or id \"%s\"" title-or-id)))) 148 | (set-buffer (org-capture-target-buffer (org-roam-node-file node))) 149 | (goto-char (org-roam-node-point node)) 150 | (setq p (org-roam-node-point node)))) 151 | (`(dynamic-node ,title-or-id) 152 | ;; (nth 0 canadidate) is a hack for helm user. 153 | (let ((node (or (org-roam-node-from-id (nth 0 canadidate)) 154 | (user-error "No node with title or id \"%s\"" title-or-id)))) 155 | (set-buffer (org-capture-target-buffer (org-roam-node-file node))) 156 | (goto-char (org-roam-node-point node)) 157 | (setq p (org-roam-node-point node)))) 158 | 159 | (`(dynamic-node-2nd ,title-or-id) 160 | ;; (nth 0 canadidate) is a hack for helm user. 161 | (let ((node (or (org-roam-node-from-id new-candidates) 162 | (user-error "No node with title or id \"%s\"" title-or-id)))) 163 | (set-buffer (org-capture-target-buffer (org-roam-node-file node))) 164 | (goto-char (org-roam-node-point node)) 165 | (setq p (org-roam-node-point node)))) 166 | ) 167 | ;; Setup `org-id' for the current capture target and return it back to the 168 | ;; caller. 169 | (save-excursion 170 | (goto-char p) 171 | (if-let ((id (org-entry-get p "ID"))) 172 | (setf (org-roam-node-id org-roam-capture--node) id) 173 | (org-entry-put p "ID" (org-roam-node-id org-roam-capture--node))) 174 | (prog1 175 | (org-id-get) 176 | (run-hooks 'org-roam-capture-new-node-hook))))) 177 | 178 | ;;;; 179 | (defun helm-org-roam-node-walk--subheadings-at-point () 180 | "Return a list of subheadings." 181 | (if (org-before-first-heading-p) 182 | (save-excursion 183 | (let ((pred (lambda () (if (org-id-get) 184 | (cons (org-entry-get nil "ITEM") 185 | (org-id-get)))))) 186 | (progn 187 | (org-show-subtree) 188 | (remq nil (cdr (cl-loop collect (funcall pred) 189 | until (let ((pos (point))) 190 | (null (org-forward-heading-same-level nil t)) 191 | (eq pos (point))))))))) 192 | (save-excursion 193 | (let ((pred (lambda () (if (org-id-get) 194 | (cons (org-entry-get nil "ITEM") 195 | (org-id-get)))))) 196 | (progn 197 | (org-back-to-heading t) 198 | (org-show-subtree) 199 | (remq nil (if (org-goto-first-child) 200 | (cl-loop collect (funcall pred) 201 | until (let ((pos (point))) 202 | (null (org-forward-heading-same-level nil t)) 203 | (eq pos (point))))))))))) 204 | 205 | (defun helm-org-roam-node-walk (my-id) 206 | "Process content of MY-ID. If it is a title, insert the whole 207 | file. Otherwise, just insert the content of the subtree." 208 | (interactive) 209 | (push my-id roam-walk-stack) 210 | (message "debug flag %s" my-id) 211 | ;; if a node does not have any child, then jump into the node; 212 | ;; otherwise, show the children. 213 | (if (nth 0 (nth 0 (if (= (org-roam-node-level (org-roam-node-from-id my-id)) 0) 214 | (progn 215 | (setq node-does-not-have-any-head-flag t) 216 | (with-temp-buffer 217 | (insert-file-contents (org-roam-node-file (org-roam-node-from-id my-id))) 218 | (org-mode) 219 | (setq my-new-candidates (helm-org-roam-node-walk--subheadings-at-point)))) 220 | (with-temp-buffer 221 | (insert-file-contents (org-roam-node-file (org-roam-node-from-id my-id))) 222 | (org-mode) 223 | (re-search-forward (concat ":ID: " my-id)) 224 | (setq my-new-candidates (helm-org-roam-node-walk--subheadings-at-point)))))) 225 | (helm 226 | :sources (list 227 | (helm-build-sync-source "We have some children?: " 228 | :candidates my-new-candidates 229 | :keymap helm-org-node-walk-map 230 | :action 231 | '(("Open" . (lambda (new-candidates) 232 | (message "does it call debug flag %s" new-candidates) 233 | (or (progn 234 | (org-id-goto new-candidates) 235 | (widen) 236 | (org-id-goto new-candidates)) 237 | (helm-org-roam-node-walk new-candidates) 238 | ))) 239 | 240 | ("Find File" . (lambda (canadidate) 241 | (setq roam-visit-immediately canadidate))) 242 | 243 | ("Capture as a child" . (lambda (new-candidates) 244 | (org-roam-capture- 245 | :templates '(("v" "Test before 1st head" entry 246 | "* %?\n:PROPERTIES:\n:ID: %(org-id-uuid)\n:END:\n" 247 | :target (dynamic-node-2nd title-or-id) 248 | )) 249 | :node (org-roam-node-from-id new-candidates) 250 | :props '(:immediate-finish nil)))) 251 | 252 | ("[C-c i ] Insert link" . (lambda (new-candidates) 253 | (let ((note-id (org-roam-node-from-id new-candidates))) 254 | (if default 255 | (progn 256 | (delete-region (region-beginning) (region-end)) 257 | (insert 258 | (format 259 | "[[id:%s][%s]]" 260 | (org-roam-node-id note-id) 261 | default))) 262 | (insert 263 | (format 264 | "[[id:%s][%s]]" 265 | (org-roam-node-id note-id) 266 | (org-roam-node-title note-id))))))) 267 | 268 | ("[C-c M-i] Insert links with transclusions" . (lambda (x) 269 | (let ((note (helm-marked-candidates))) 270 | (cl-loop for n in note 271 | do (--> n 272 | (let ((note-id (org-roam-node-from-id n))) 273 | (insert 274 | (format 275 | "#+transclude: [[id:%s][%s]] :only-contents\n\n" 276 | (org-roam-node-id note-id) 277 | (org-roam-node-title note-id))))))))) 278 | 279 | ("[C-c M-I] Insert as transclusion exclude headline" . (lambda (x) 280 | (let ((note (helm-marked-candidates))) 281 | (cl-loop for n in note 282 | do (--> n 283 | (let ((note-id (org-roam-node-from-id n))) 284 | (insert 285 | (format 286 | "#+transclude: [[id:%s][%s]] :only-contents :exclude-elements \"headline\"\n\n" 287 | (org-roam-node-id note-id) 288 | (org-roam-node-title note-id))))))))))))) 289 | 290 | (setq final-node-id (car roam-walk-stack))) 291 | 292 | (if my-new-candidates 293 | nil 294 | (org-id-goto final-node-id)) 295 | 296 | (if roam-visit-immediately 297 | (org-id-goto roam-visit-immediately)) 298 | 299 | (if (and node-does-not-have-any-head-flag 300 | (eq (length roam-walk-stack) 1)) 301 | (org-id-goto my-id))) 302 | 303 | (defun fast/org-roam-node-random () 304 | "Jump into a random node but very fast." 305 | (interactive) 306 | (org-roam-node-visit (org-roam-node-from-id 307 | (seq-random-elt 308 | (mapcar 'car (mapcar 'cdr (node-candidates))))) nil)) 309 | 310 | (defun node-candidates () 311 | "Returns candidates for the org-roam nodes." 312 | (cl-loop for cand in (org-roam-db-query 313 | "SELECT 314 | id, 315 | aliases as aliases, 316 | Null as Col2 317 | FROM 318 | ( 319 | SELECT 320 | nodes.id as id, 321 | aliases.alias as aliases 322 | FROM nodes 323 | LEFT JOIN aliases ON aliases.node_id = nodes.id 324 | GROUP BY nodes.id, aliases.alias 325 | ) 326 | UNION ALL 327 | SELECT 328 | id, 329 | title, 330 | '(' || group_concat(tags, ' ') || ')' as tags 331 | FROM 332 | ( 333 | SELECT 334 | id, 335 | title, 336 | tags 337 | FROM 338 | ( 339 | SELECT 340 | nodes.id as id, 341 | nodes.title as title, 342 | tags.tag as tags 343 | FROM nodes 344 | LEFT JOIN tags ON tags.node_id = nodes.id 345 | LEFT JOIN aliases ON aliases.node_id = nodes.id 346 | GROUP BY nodes.id, tags.tag ) 347 | GROUP BY id, tags ) 348 | GROUP BY id 349 | ") 350 | collect (cons (if (nth 2 cand) 351 | (format "%s #%s" 352 | (truncate-string-to-width (nth 1 cand) 80 nil ?\s "…") 353 | (mapconcat 'identity (nth 2 cand) " #")) 354 | (format "%s" 355 | (truncate-string-to-width (or (nth 1 cand) "") 80 nil ?\s "…"))) 356 | cand))) 357 | 358 | 359 | ;;;; tools 360 | (defun my-org-day-of-week () 361 | (org-day-of-week (nth 3 (decode-time)) 362 | (nth 4 (decode-time)) 363 | (nth 5 (decode-time)))) 364 | 365 | (defun wr/jump-into-workout-log (org-id) 366 | (interactive) 367 | (org-id-goto org-id) 368 | (org-narrow-to-subtree) 369 | (org-columns) 370 | (org-overview) 371 | (show-children) 372 | (move-beginning-of-line-or-indentation) 373 | (re-search-forward (concat "-D" (number-to-string (my-org-day-of-week))) nil t) 374 | (move-beginning-of-line-or-indentation) 375 | (org-show-entry)) 376 | 377 | ;;;; main functions 378 | (defun helm-org-roam (&optional default ini candidates) 379 | "Original see from a blog post by Andrea: 380 | 381 | 382 | The code was inspired by the code https://github.com/ag91/escalator. 383 | I add a function to insert multiply notes. Then, those notes can be 384 | transcluded into the current buffer. 385 | 386 | After using Org-Roam extensively, the speed for query is too 387 | slow. So, I had to do a customized work to use Org-Roam. 388 | 389 | The bottleneck is found to be `(org-roam-list-files)`. So I tested two things: 390 | 391 | 1. query the db using the default function 392 | 2. customized my own version, which is very basic information 393 | 394 | The details can be found in a GitHub issue discussion 395 | . The first one 396 | is the default query. I found the speed was too slow for just 397 | using it. The latter just queries the titles/alias/tags, so it is 398 | very fast. 399 | 400 | ;; → run time: 5.713161 seconds 401 | ;; → run time: 0.130336 seconds 402 | " 403 | (interactive) 404 | (let ((default (when (use-region-p) 405 | (buffer-substring-no-properties 406 | (region-beginning) (region-end))))) 407 | (setq roam-walk-stack nil) 408 | (setq roam-visit-immediately nil) 409 | (setq node-does-not-have-any-head-flag nil) 410 | (helm 411 | :input (or default ini) 412 | :sources (list 413 | (helm-build-sync-source "Roam: " 414 | :must-match nil 415 | :fuzzy-match nil 416 | :keymap roam-with-helm-map 417 | :candidates #'node-candidates 418 | :action 419 | '(("Helm-org-roam-node-walk" . (lambda (canadidate) 420 | (setq previous-node-title helm-pattern) 421 | (helm-org-roam-node-walk (nth 0 canadidate)))) 422 | 423 | ("Find File" . (lambda (canadidate) 424 | (org-roam-node-visit 425 | (org-roam-node-from-id 426 | (nth 0 canadidate)) 427 | nil))) 428 | 429 | ("Capture as a child" . (lambda (canadidate) 430 | (org-roam-capture- 431 | :templates '(("v" "Test before 1st head" entry 432 | "* %?\n:PROPERTIES:\n:ID: %(org-id-uuid)\n:END:\n" 433 | :target (dynamic-node title-or-id) 434 | )) 435 | :node (org-roam-node-from-id (nth 0 canadidate)) 436 | :props '(:immediate-finish nil)))) 437 | 438 | ("Add alias" . (lambda (canadidate) 439 | (let ((node (org-roam-node-from-id 440 | (nth 0 canadidate)))) 441 | (org-roam-node-visit node nil) 442 | (save-excursion 443 | (goto-char (org-roam-node-point node)) 444 | (let ((x)) 445 | (org-roam-property-add "ROAM_ALIASES" (read-from-minibuffer "What ALIAS?"))))))) 446 | 447 | ("[C-c i ] Insert link" . (lambda (canadidate) 448 | (let ((note-id (org-roam-node-from-id (nth 0 canadidate)))) 449 | (if default 450 | (progn 451 | (delete-region (region-beginning) (region-end)) 452 | (insert 453 | (format 454 | "[[id:%s][%s]]" 455 | (org-roam-node-id note-id) 456 | default))) 457 | (insert 458 | (format 459 | "[[id:%s][%s]]" 460 | (org-roam-node-id note-id) 461 | (org-roam-node-title note-id))))))) 462 | 463 | 464 | ("[C-c M-i] Insert links with transclusions" . (lambda (x) 465 | (let ((note (helm-marked-candidates))) 466 | (cl-loop for n in note 467 | do (--> n 468 | (let ((note-id (org-roam-node-from-id (nth 0 n)))) 469 | (insert 470 | (format 471 | "#+transclude: [[id:%s][%s]] :only-contents\n\n" 472 | (org-roam-node-id note-id) 473 | (org-roam-node-title note-id))))))))) 474 | 475 | ("[C-c M-I] Insert as transclusion exclude headline" . (lambda (x) 476 | (let ((note (helm-marked-candidates))) 477 | (cl-loop for n in note 478 | do (--> n 479 | (let ((note-id (org-roam-node-from-id (nth 0 n)))) 480 | (insert 481 | (format 482 | "#+transclude: [[id:%s][%s]] :only-contents :exclude-elements \"headline\"\n\n" 483 | (org-roam-node-id note-id) 484 | (org-roam-node-title note-id))))))))) 485 | 486 | ("[C-c C-o ] Open attachment" . (lambda (canadidate) 487 | (let* ((note-id (org-roam-node-from-id (nth 0 canadidate))) 488 | (attach-dir (expand-file-name 489 | (chatgpt/add-slash-to-string (org-roam-node-id note-id)) 490 | org-attach-directory))) 491 | (if (file-exists-p attach-dir) 492 | (dired attach-dir) 493 | (message "Attachment directory not found."))))) 494 | 495 | ("[NaN ] Insert link using ALIAS" . (lambda (canadidate) 496 | (let ((note-id (org-roam-node-from-id (nth 0 canadidate)))) 497 | (insert 498 | (format 499 | "[[id:%s][%s]]" 500 | (org-roam-node-id note-id) 501 | (nth 1 canadidate)))))) 502 | 503 | ("[No KBD ] Insert workout link" . (lambda (canadidate) 504 | (let ((note-id (org-roam-node-from-id (nth 0 canadidate)))) 505 | (insert 506 | (format 507 | "[[elisp:(wr/jump-into-workout-log \"%s\")][Training daily: %s]]" 508 | (org-roam-node-id note-id) 509 | (org-roam-node-title note-id)))))) 510 | 511 | 512 | ;; Thank Dustin Lacewell for inspiration. 513 | ("Helm-org-walk" . (lambda (canadidate) 514 | (save-excursion (helm-org-walk 515 | (org-roam-node-file (org-roam-node-from-id 516 | (nth 0 canadidate))))))))) 517 | 518 | (helm-build-dummy-source 519 | "Create note" 520 | :action '(("Capture note" . (lambda (candidate) 521 | (org-roam-capture- 522 | :node (org-roam-node-create :title candidate) 523 | :props '(:finalize find-file)))))) 524 | 525 | (helm-build-dummy-source 526 | "Search on Net" 527 | :action '(("Open" . (lambda (candidate) 528 | (browse-url (concat "https://encrypted.google.com/search?ie=UTF-8&oe=UTF-8&q=" candidate)))))) 529 | 530 | (helm-build-dummy-source 531 | "Search on G-scholar" 532 | :action '(("Open" . (lambda (candidate) 533 | (browse-url (concat "https://scholar.google.ca/scholar?hl=en&q=" candidate)))))))))) 534 | 535 | 536 | ;;;; recursion 537 | ;; 538 | (defun helm-org-node-walk--test () 539 | "It returns back to the intial query." 540 | (interactive) 541 | (helm-run-after-exit 542 | (lambda () (helm 543 | :input previous-node-title 544 | :sources (list 545 | (helm-build-sync-source "Roam: " 546 | :must-match nil 547 | :fuzzy-match nil 548 | :candidates #'node-candidates 549 | :keymap roam-with-helm-map 550 | :action 551 | '(("Helm-org-roam-node-walk" . (lambda (canadidate) 552 | (setq previous-node-title helm-pattern) 553 | (helm-org-roam-node-walk (nth 0 canadidate)))) 554 | 555 | ("Find File" . (lambda (canadidate) 556 | (org-roam-node-visit 557 | (org-roam-node-from-id 558 | (nth 0 canadidate)) 559 | nil))) 560 | 561 | ("Capture as a child" . (lambda (canadidate) 562 | (org-roam-capture- 563 | :templates '(("v" "Test before 1st head" entry 564 | "* %?\n:PROPERTIES:\n:ID: %(org-id-uuid)\n:END:\n" 565 | :target (dynamic-node title-or-id) 566 | )) 567 | :node (org-roam-node-from-id (nth 0 canadidate)) 568 | :props '(:immediate-finish nil)))) 569 | 570 | ("Add alias" . (lambda (canadidate) 571 | (let ((node (org-roam-node-from-id 572 | (nth 0 canadidate)))) 573 | (org-roam-node-visit node nil) 574 | (save-excursion 575 | (goto-char (org-roam-node-point node)) 576 | (let ((x)) 577 | (org-roam-property-add "ROAM_ALIASES" (read-from-minibuffer "What ALIAS?"))))))) 578 | 579 | ("[C-c i ] Insert link" . (lambda (canadidate) 580 | (let ((note-id (org-roam-node-from-id (nth 0 canadidate)))) 581 | (if default 582 | (progn 583 | (delete-region (region-beginning) (region-end)) 584 | (insert 585 | (format 586 | "[[id:%s][%s]]" 587 | (org-roam-node-id note-id) 588 | default))) 589 | (insert 590 | (format 591 | "[[id:%s][%s]]" 592 | (org-roam-node-id note-id) 593 | (org-roam-node-title note-id))))))) 594 | 595 | ("[C-c M-i] Insert links with transclusions" . (lambda (x) 596 | (let ((note (helm-marked-candidates))) 597 | (cl-loop for n in note 598 | do (--> n 599 | (let ((note-id (org-roam-node-from-id (nth 0 n)))) 600 | (insert 601 | (format 602 | "#+transclude: [[id:%s][%s]] :only-contents\n\n" 603 | (org-roam-node-id note-id) 604 | (org-roam-node-title note-id))))))))) 605 | 606 | ("[C-c M-I] Insert as transclusion exclude headline" . (lambda (x) 607 | (let ((note (helm-marked-candidates))) 608 | (cl-loop for n in note 609 | do (--> n 610 | (let ((note-id (org-roam-node-from-id (nth 0 n)))) 611 | (insert 612 | (format 613 | "#+transclude: [[id:%s][%s]] :only-contents :exclude-elements \"headline\"\n\n" 614 | (org-roam-node-id note-id) 615 | (org-roam-node-title note-id))))))))) 616 | 617 | ;; Thank Dustin Lacewell for inspiration. 618 | ("Helm-org-walk" . (lambda (canadidate) 619 | (save-excursion (helm-org-walk 620 | (org-roam-node-file (org-roam-node-from-id 621 | (nth 0 canadidate))))))))) 622 | 623 | (helm-build-dummy-source 624 | "Create note" 625 | :action '(("Capture note" . (lambda (candidate) 626 | (org-roam-capture- 627 | :node (org-roam-node-create :title candidate) 628 | :props '(:finalize find-file)))))) 629 | 630 | (helm-build-dummy-source 631 | "Search on Net" 632 | :action '(("Open" . (lambda (candidate) 633 | (browse-url (concat "https://encrypted.google.com/search?ie=UTF-8&oe=UTF-8&q=" candidate)))))) 634 | 635 | (helm-build-dummy-source 636 | "Search on G-scholar" 637 | :action '(("Open" . (lambda (candidate) 638 | (browse-url (concat "https://scholar.google.ca/scholar?hl=en&q=" candidate)))))) 639 | 640 | 641 | ))))) 642 | 643 | (defun helm-org-node-walk--new () 644 | "Function to process ." 645 | (interactive) 646 | (helm-run-after-exit 647 | (lambda () 648 | (helm 649 | :input (org-roam-node-title (org-roam-node-from-id (car roam-walk-stack))) 650 | :sources (list 651 | (helm-build-sync-source "Roam: " 652 | :must-match nil 653 | :fuzzy-match nil 654 | :keymap roam-with-helm-map 655 | :candidates #'node-candidates 656 | :action 657 | '(("Helm-org-roam-node-walk" . (lambda (canadidate) 658 | (setq previous-node-title helm-pattern) 659 | (helm-org-roam-node-walk (nth 0 canadidate)))) 660 | 661 | ("Find File" . (lambda (canadidate) 662 | (org-roam-node-visit 663 | (org-roam-node-from-id 664 | (nth 0 canadidate)) 665 | nil))) 666 | 667 | ("Capture as a child" . (lambda (canadidate) 668 | (org-roam-capture- 669 | :templates '(("v" "Test before 1st head" entry 670 | "* %?\n:PROPERTIES:\n:ID: %(org-id-uuid)\n:END:\n" 671 | :target (dynamic-node title-or-id) 672 | )) 673 | :node (org-roam-node-from-id (nth 0 canadidate)) 674 | :props '(:immediate-finish nil)))) 675 | 676 | ("Add alias" . (lambda (canadidate) 677 | (let ((node (org-roam-node-from-id 678 | (nth 0 canadidate)))) 679 | (org-roam-node-visit node nil) 680 | (save-excursion 681 | (goto-char (org-roam-node-point node)) 682 | (let ((x)) 683 | (org-roam-property-add "ROAM_ALIASES" (read-from-minibuffer "What ALIAS?"))))))) 684 | 685 | ("[C-c i ] Insert link" . (lambda (canadidate) 686 | (let ((note-id (org-roam-node-from-id (nth 0 canadidate)))) 687 | (if default 688 | (progn 689 | (delete-region (region-beginning) (region-end)) 690 | (insert 691 | (format 692 | "[[id:%s][%s]]" 693 | (org-roam-node-id note-id) 694 | default))) 695 | (insert 696 | (format 697 | "[[id:%s][%s]]" 698 | (org-roam-node-id note-id) 699 | (org-roam-node-title note-id))))))) 700 | 701 | ("[C-c M-i] Insert links with transclusions" . (lambda (x) 702 | (let ((note (helm-marked-candidates))) 703 | (cl-loop for n in note 704 | do (--> n 705 | (let ((note-id (org-roam-node-from-id (nth 0 n)))) 706 | (insert 707 | (format 708 | "#+transclude: [[id:%s][%s]] :only-contents\n\n" 709 | (org-roam-node-id note-id) 710 | (org-roam-node-title note-id))))))))) 711 | 712 | ("[C-c M-I] Insert as transclusion exclude headline" . (lambda (x) 713 | (let ((note (helm-marked-candidates))) 714 | (cl-loop for n in note 715 | do (--> n 716 | (let ((note-id (org-roam-node-from-id (nth 0 n)))) 717 | (insert 718 | (format 719 | "#+transclude: [[id:%s][%s]] :only-contents :exclude-elements \"headline\"\n\n" 720 | (org-roam-node-id note-id) 721 | (org-roam-node-title note-id))))))))) 722 | 723 | ;; Thank Dustin Lacewell for inspiration. 724 | ("Helm-org-walk" . (lambda (canadidate) 725 | (save-excursion (helm-org-walk 726 | (org-roam-node-file (org-roam-node-from-id 727 | (nth 0 canadidate))))))))) 728 | 729 | (helm-build-dummy-source 730 | "Create note" 731 | :action '(("Capture note" . (lambda (candidate) 732 | (org-roam-capture- 733 | :node (org-roam-node-create :title candidate) 734 | :props '(:finalize find-file)))))) 735 | 736 | (helm-build-dummy-source 737 | "Search on Net" 738 | :action '(("Open" . (lambda (candidate) 739 | (browse-url (concat "https://encrypted.google.com/search?ie=UTF-8&oe=UTF-8&q=" candidate)))))) 740 | 741 | (helm-build-dummy-source 742 | "Search on G-scholar" 743 | :action '(("Open" . (lambda (candidate) 744 | (browse-url (concat "https://scholar.google.ca/scholar?hl=en&q=" candidate))))))))))) 745 | 746 | 747 | (defun call-find-file () 748 | "Thanks to xuchunyang: 749 | " 750 | (interactive) 751 | (helm-select-nth-action 1)) 752 | 753 | (defun call-find-file-in-walking () 754 | "" 755 | (interactive) 756 | (helm-select-nth-action 1)) 757 | 758 | (defun call-add-as-link () 759 | "" 760 | (interactive) 761 | (helm-select-nth-action 4)) 762 | 763 | (defun call-add-as-transclusion () 764 | "" 765 | (interactive) 766 | (helm-select-nth-action 5)) 767 | 768 | (defun call-add-as-transclusion-only-head () 769 | "" 770 | (interactive) 771 | (helm-select-nth-action 6)) 772 | 773 | (defun call-open-attachment () 774 | "" 775 | (interactive) 776 | (helm-select-nth-action 7)) 777 | 778 | (defun call-add-as-link-in-walking () 779 | "" 780 | (interactive) 781 | (helm-select-nth-action 2)) 782 | 783 | (defun call-add-as-transclusion-in-walking () 784 | "" 785 | (interactive) 786 | (helm-select-nth-action 3)) 787 | 788 | (defun call-add-as-transclusion-only-head-in-walking () 789 | "" 790 | (interactive) 791 | (helm-select-nth-action 4)) 792 | 793 | 794 | ;;;; kbd 795 | (setq helm-org-node-walk-map 796 | (let ((map (make-sparse-keymap))) 797 | (set-keymap-parent map helm-map) 798 | (define-key map (kbd "C-") 'helm-org-node-walk--new) 799 | (define-key map (kbd "C-") 'call-find-file-in-walking) 800 | (define-key map (kbd "C-c i") 'call-add-as-link-in-walking) 801 | (define-key map (kbd "C-c M-i") 'call-add-as-transclusion-in-walking) 802 | (define-key map (kbd "C-c M-I") 'call-add-as-transclusion-only-head-in-walking) 803 | map)) 804 | 805 | (setq roam-with-helm-map 806 | (let ((map (make-sparse-keymap))) 807 | (set-keymap-parent map helm-map) 808 | (define-key map (kbd "C-") 'call-find-file) 809 | (define-key map (kbd "C-") 'helm-org-node-walk--test) 810 | (define-key map (kbd "C-c i") 'call-add-as-link) 811 | (define-key map (kbd "C-c o") 'call-add-as-link) 812 | (define-key map (kbd "C-c M-i") 'call-add-as-transclusion) 813 | (define-key map (kbd "C-c M-I") 'call-add-as-transclusion-only-head) 814 | (define-key map (kbd "C-c C-o") 'call-open-attachment) 815 | (define-key map (kbd "") 'helm-maybe-exit-minibuffer) 816 | map)) 817 | 818 | 819 | (provide 'roam-with-helm-v2) 820 | -------------------------------------------------------------------------------- /roam-with-helm.el: -------------------------------------------------------------------------------- 1 | (setq roam-with-helm-org-roam-completion-system 'helm+) 2 | 3 | (defun roam-with-helm-org-roam-find-file (&optional initial-prompt completions filter-fn no-confirm) 4 | (interactive) 5 | (unless org-roam-mode (org-roam-mode)) 6 | (let* ((completions (funcall (or filter-fn #'identity) 7 | (or completions (org-roam--get-title-path-completions)))) 8 | (title-with-tags (if no-confirm 9 | initial-prompt 10 | (+org-roam-completion--completing-read "File: " completions 11 | :initial-input initial-prompt))) 12 | (res (cdr (assoc title-with-tags completions))) 13 | (file-path (plist-get res :path))) 14 | (if file-path 15 | (org-roam--find-file file-path) 16 | (let ((org-roam-capture--info `((title . ,title-with-tags) 17 | (slug . ,(funcall org-roam-title-to-slug-function title-with-tags)))) 18 | (org-roam-capture--context 'title)) 19 | (setq org-roam-capture-additional-template-props (list :finalize 'find-file)) 20 | (org-roam-capture--capture))))) 21 | 22 | (cl-defun +org-roam-completion--completing-read (prompt choices &key 23 | require-match initial-input 24 | action) 25 | (let (res) 26 | (setq res 27 | (cond 28 | ((eq roam-with-helm-org-roam-completion-system 'helm+) 29 | (unless (and (fboundp 'helm) 30 | (fboundp 'helm-make-source)) 31 | (user-error "Please install helm from \ 32 | https://github.com/emacs-helm/helm")) 33 | (let ((source (helm-make-source prompt 'helm-source-sync 34 | :candidates (mapcar #'car choices) 35 | :action 36 | (lambda (_candidate) 37 | (let ((note (helm-marked-candidates :with-wildcard t))) 38 | (if (> (length note) 1) 39 | (cl-loop for n in note 40 | do (roam-with-helm--get-path-from-title n)) 41 | (org-roam-find-file _candidate nil nil t)))) 42 | :filtered-candidate-transformer 43 | (and (not require-match) 44 | #'org-roam-completion--helm-candidate-transformer))) 45 | (buf (concat "*org-roam " 46 | (s-downcase (s-chop-suffix ":" (s-trim prompt))) 47 | "*"))) 48 | (or (helm :sources source 49 | :prompt prompt 50 | :input initial-input 51 | :buffer buf) 52 | (keyboard-quit)))))) 53 | (if action 54 | (funcall action res) 55 | res))) 56 | 57 | (defun roam-with-helm--get-path-from-title (title) 58 | (cl-loop for ns in (mapcar #'cdr (org-roam--get-title-path-completions)) 59 | do (pcase ns 60 | (`(:path ,foo :title ,bar) (if (string-match title bar) 61 | (insert (format "#+transclude: t\n[[file:%s][%s]]\n\n" (roam-with-helm--return-path-relative-to-home foo) bar))))))) 62 | 63 | (defun roam-with-helm--return-path-relative-to-home (full-path) 64 | (concat "~/"(string-remove-prefix (file-truename "~/") full-path))) 65 | 66 | (provide 'roam-with-helm) 67 | --------------------------------------------------------------------------------