commit 9b9ea300e9908493b1b5425ccb5dacb691c32bbe Author: Marcel Kapfer Date: Mon Nov 1 20:28:35 2021 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8cb1220 --- /dev/null +++ b/.gitignore @@ -0,0 +1,71 @@ +# ---> Emacs +# -*- mode: gitignore; -*- +*~ +\#*\# +/.emacs.desktop +/.emacs.desktop.lock +*.elc +auto-save-list +tramp +.\#* + +# Org-mode +.org-id-locations +*_archive + +# flymake-mode +*_flymake.* + +# eshell files +/eshell/history +/eshell/lastdir + +# elpa packages +/elpa/ + +# reftex files +*.rel + +# AUCTeX auto folder +/auto/ + +# cask packages +.cask/ +dist/ + +# Flycheck +flycheck_*.el + +# server auth directory +/server/ + +# projectiles files +.projectile + +# directory configuration +.dir-locals.el + +# network security +/network-security.data + + +config.el +custom.el +history +transient/ +bookmarks +places +recentf +/.mc-lists.el +/config-mu4e.el +/config-elfeed.el +/url/ +/.lsp-session-v1 +/emms/scores +/emms/cache +/org-roam.db +/emojis/ +/.cache/ +projects +/eshell/ +/persist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e142a52 --- /dev/null +++ b/LICENSE @@ -0,0 +1,625 @@ +GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The GNU General Public License is a free, copyleft license for software and +other kinds of works. + +The licenses for most software and other practical works are designed to take +away your freedom to share and change the works. By contrast, the GNU General +Public License is intended to guarantee your freedom to share and change all +versions of a program--to make sure it remains free software for all its users. +We, the Free Software Foundation, use the GNU General Public License for most +of our software; it applies also to any other work released this way by its +authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for them if you wish), that +you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs, and that you know you +can do these things. + +To protect your rights, we need to prevent others from denying you these rights +or asking you to surrender the rights. Therefore, you have certain responsibilities +if you distribute copies of the software, or if you modify it: responsibilities +to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must pass on to the recipients the same freedoms that you received. +You must make sure that they, too, receive or can get the source code. And +you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert +copyright on the software, and (2) offer you this License giving you legal +permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that +there is no warranty for this free software. For both users' and authors' +sake, the GPL requires that modified versions be marked as changed, so that +their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. +This is fundamentally incompatible with the aim of protecting users' freedom +to change the software. The systematic pattern of such abuse occurs in the +area of products for individuals to use, which is precisely where it is most +unacceptable. Therefore, we have designed this version of the GPL to prohibit +the practice for those products. If such problems arise substantially in other +domains, we stand ready to extend this provision to those domains in future +versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that +patents applied to a free program could make it effectively proprietary. To +prevent this, the GPL assures that patents cannot be used to render the program +non-free. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of works, +such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this License. +Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals +or organizations. + +To "modify" a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact +copy. The resulting work is called a "modified version" of the earlier work +or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based on the +Program. + +To "propagate" a work means to do anything with it that, without permission, +would make you directly or secondarily liable for infringement under applicable +copyright law, except executing it on a computer or modifying a private copy. +Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as +well. + +To "convey" a work means any kind of propagation that enables other parties +to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" to the +extent that it includes a convenient and prominently visible feature that +(1) displays an appropriate copyright notice, and (2) tells the user that +there is no warranty for the work (except to the extent that warranties are +provided), that licensees may convey the work under this License, and how +to view a copy of this License. If the interface presents a list of user commands +or options, such as a menu, a prominent item in the list meets this criterion. + + 1. Source Code. + +The "source code" for a work means the preferred form of the work for making +modifications to it. "Object code" means any non-source form of a work. + +A "Standard Interface" means an interface that either is an official standard +defined by a recognized standards body, or, in the case of interfaces specified +for a particular programming language, one that is widely used among developers +working in that language. + +The "System Libraries" of an executable work include anything, other than +the work as a whole, that (a) is included in the normal form of packaging +a Major Component, but which is not part of that Major Component, and (b) +serves only to enable use of the work with that Major Component, or to implement +a Standard Interface for which an implementation is available to the public +in source code form. A "Major Component", in this context, means a major essential +component (kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to produce +the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all the source +code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. +However, it does not include the work's System Libraries, or general-purpose +tools or generally available free programs which are used unmodified in performing +those activities but which are not part of the work. For example, Corresponding +Source includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically linked +subprograms that the work is specifically designed to require, such as by +intimate data communication or control flow between those subprograms and +other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + + The Corresponding Source for a work in source code form is that same work. + + 2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright +on the Program, and are irrevocable provided the stated conditions are met. +This License explicitly affirms your unlimited permission to run the unmodified +Program. The output from running a covered work is covered by this License +only if the output, given its content, constitutes a covered work. This License +acknowledges your rights of fair use or other equivalent, as provided by copyright +law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey +covered works to others for the sole purpose of having them make modifications +exclusively for you, or provide you with facilities for running those works, +provided that you comply with the terms of this License in conveying all material +for which you do not control copyright. Those thus making or running the covered +works for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of your copyrighted +material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure +under any applicable law fulfilling obligations under article 11 of the WIPO +copyright treaty adopted on 20 December 1996, or similar laws prohibiting +or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention +of technological measures to the extent such circumvention is effected by +exercising rights under this License with respect to the covered work, and +you disclaim any intention to limit operation or modification of the work +as a means of enforcing, against the work's users, your or third parties' +legal rights to forbid circumvention of technological measures. + + 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive +it, in any medium, provided that you conspicuously and appropriately publish +on each copy an appropriate copyright notice; keep intact all notices stating +that this License and any non-permissive terms added in accord with section +7 apply to the code; keep intact all notices of the absence of any warranty; +and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you +may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce +it from the Program, in the form of source code under the terms of section +4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified it, and +giving a relevant date. + +b) The work must carry prominent notices stating that it is released under +this License and any conditions added under section 7. This requirement modifies +the requirement in section 4 to "keep intact all notices". + +c) You must license the entire work, as a whole, under this License to anyone +who comes into possession of a copy. This License will therefore apply, along +with any applicable section 7 additional terms, to the whole of the work, +and all its parts, regardless of how they are packaged. This License gives +no permission to license the work in any other way, but it does not invalidate +such permission if you have separately received it. + +d) If the work has interactive user interfaces, each must display Appropriate +Legal Notices; however, if the Program has interactive interfaces that do +not display Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, +which are not by their nature extensions of the covered work, and which are +not combined with it such as to form a larger program, in or on a volume of +a storage or distribution medium, is called an "aggregate" if the compilation +and its resulting copyright are not used to limit the access or legal rights +of the compilation's users beyond what the individual works permit. Inclusion +of a covered work in an aggregate does not cause this License to apply to +the other parts of the aggregate. + + 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections +4 and 5, provided that you also convey the machine-readable Corresponding +Source under the terms of this License, in one of these ways: + +a) Convey the object code in, or embodied in, a physical product (including +a physical distribution medium), accompanied by the Corresponding Source fixed +on a durable physical medium customarily used for software interchange. + +b) Convey the object code in, or embodied in, a physical product (including +a physical distribution medium), accompanied by a written offer, valid for +at least three years and valid for as long as you offer spare parts or customer +support for that product model, to give anyone who possesses the object code +either (1) a copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical medium customarily +used for software interchange, for a price no more than your reasonable cost +of physically performing this conveying of source, or (2) access to copy the +Corresponding Source from a network server at no charge. + +c) Convey individual copies of the object code with a copy of the written +offer to provide the Corresponding Source. This alternative is allowed only +occasionally and noncommercially, and only if you received the object code +with such an offer, in accord with subsection 6b. + +d) Convey the object code by offering access from a designated place (gratis +or for a charge), and offer equivalent access to the Corresponding Source +in the same way through the same place at no further charge. You need not +require recipients to copy the Corresponding Source along with the object +code. If the place to copy the object code is a network server, the Corresponding +Source may be on a different server (operated by you or a third party) that +supports equivalent copying facilities, provided you maintain clear directions +next to the object code saying where to find the Corresponding Source. Regardless +of what server hosts the Corresponding Source, you remain obligated to ensure +that it is available for as long as needed to satisfy these requirements. + +e) Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are +being offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from +the Corresponding Source as a System Library, need not be included in conveying +the object code work. + +A "User Product" is either (1) a "consumer product", which means any tangible +personal property which is normally used for personal, family, or household +purposes, or (2) anything designed or sold for incorporation into a dwelling. +In determining whether a product is a consumer product, doubtful cases shall +be resolved in favor of coverage. For a particular product received by a particular +user, "normally used" refers to a typical or common use of that class of product, +regardless of the status of the particular user or of the way in which the +particular user actually uses, or expects or is expected to use, the product. +A product is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent the +only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, procedures, +authorization keys, or other information required to install and execute modified +versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the +continued functioning of the modified object code is in no case prevented +or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically +for use in, a User Product, and the conveying occurs as part of a transaction +in which the right of possession and use of the User Product is transferred +to the recipient in perpetuity or for a fixed term (regardless of how the +transaction is characterized), the Corresponding Source conveyed under this +section must be accompanied by the Installation Information. But this requirement +does not apply if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has been installed +in ROM). + +The requirement to provide Installation Information does not include a requirement +to continue to provide support service, warranty, or updates for a work that +has been modified or installed by the recipient, or for the User Product in +which it has been modified or installed. Access to a network may be denied +when the modification itself materially and adversely affects the operation +of the network or violates the rules and protocols for communication across +the network. + +Corresponding Source conveyed, and Installation Information provided, in accord +with this section must be in a format that is publicly documented (and with +an implementation available to the public in source code form), and must require +no special password or key for unpacking, reading or copying. + + 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this License +by making exceptions from one or more of its conditions. Additional permissions +that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part +may be used separately under those permissions, but the entire Program remains +governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when +you modify the work.) You may place additional permissions on material, added +by you to a covered work, for which you have or can give appropriate copyright +permission. + +Notwithstanding any other provision of this License, for material you add +to a covered work, you may (if authorized by the copyright holders of that +material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or + +b) Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed +by works containing it; or + +c) Prohibiting misrepresentation of the origin of that material, or requiring +that modified versions of such material be marked in reasonable ways as different +from the original version; or + +d) Limiting the use for publicity purposes of names of licensors or authors +of the material; or + +e) Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or + +f) Requiring indemnification of licensors and authors of that material by +anyone who conveys the material (or modified versions of it) with contractual +assumptions of liability to the recipient, for any liability that these contractual +assumptions directly impose on those licensors and authors. + +All other non-permissive additional terms are considered "further restrictions" +within the meaning of section 10. If the Program as you received it, or any +part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. +If a license document contains a further restriction but permits relicensing +or conveying under this License, you may add to a covered work material governed +by the terms of that license document, provided that the further restriction +does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, +in the relevant source files, a statement of the additional terms that apply +to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form +of a separately written license, or stated as exceptions; the above requirements +apply either way. + + 8. Termination. + +You may not propagate or modify a covered work except as expressly provided +under this License. Any attempt otherwise to propagate or modify it is void, +and will automatically terminate your rights under this License (including +any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from +a particular copyright holder is reinstated (a) provisionally, unless and +until the copyright holder explicitly and finally terminates your license, +and (b) permanently, if the copyright holder fails to notify you of the violation +by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, +this is the first time you have received notice of violation of this License +(for any work) from that copyright holder, and you cure the violation prior +to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. +If your rights have been terminated and not permanently reinstated, you do +not qualify to receive new licenses for the same material under section 10. + + 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy +of the Program. Ancillary propagation of a covered work occurring solely as +a consequence of using peer-to-peer transmission to receive a copy likewise +does not require acceptance. However, nothing other than this License grants +you permission to propagate or modify any covered work. These actions infringe +copyright if you do not accept this License. Therefore, by modifying or propagating +a covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives +a license from the original licensors, to run, modify and propagate that work, +subject to this License. You are not responsible for enforcing compliance +by third parties with this License. + +An "entity transaction" is a transaction transferring control of an organization, +or substantially all assets of one, or subdividing an organization, or merging +organizations. If propagation of a covered work results from an entity transaction, +each party to that transaction who receives a copy of the work also receives +whatever licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the Corresponding +Source of the work from the predecessor in interest, if the predecessor has +it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights +granted or affirmed under this License. For example, you may not impose a +license fee, royalty, or other charge for exercise of rights granted under +this License, and you may not initiate litigation (including a cross-claim +or counterclaim in a lawsuit) alleging that any patent claim is infringed +by making, using, selling, offering for sale, or importing the Program or +any portion of it. + + 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this License +of the Program or a work on which the Program is based. The work thus licensed +is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned or controlled +by the contributor, whether already acquired or hereafter acquired, that would +be infringed by some manner, permitted by this License, of making, using, +or selling its contributor version, but do not include claims that would be +infringed only as a consequence of further modification of the contributor +version. For purposes of this definition, "control" includes the right to +grant patent sublicenses in a manner consistent with the requirements of this +License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent +license under the contributor's essential patent claims, to make, use, sell, +offer for sale, import and otherwise run, modify and propagate the contents +of its contributor version. + +In the following three paragraphs, a "patent license" is any express agreement +or commitment, however denominated, not to enforce a patent (such as an express +permission to practice a patent or covenant not to sue for patent infringement). +To "grant" such a patent license to a party means to make such an agreement +or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free +of charge and under the terms of this License, through a publicly available +network server or other readily accessible means, then you must either (1) +cause the Corresponding Source to be so available, or (2) arrange to deprive +yourself of the benefit of the patent license for this particular work, or +(3) arrange, in a manner consistent with the requirements of this License, +to extend the patent license to downstream recipients. "Knowingly relying" +means you have actual knowledge that, but for the patent license, your conveying +the covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that country +that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, +you convey, or propagate by procuring conveyance of, a covered work, and grant +a patent license to some of the parties receiving the covered work authorizing +them to use, propagate, modify or convey a specific copy of the covered work, +then the patent license you grant is automatically extended to all recipients +of the covered work and works based on it. + +A patent license is "discriminatory" if it does not include within the scope +of its coverage, prohibits the exercise of, or is conditioned on the non-exercise +of one or more of the rights that are specifically granted under this License. +You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which +you make payment to the third party based on the extent of your activity of +conveying the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by you +(or copies made from those copies), or (b) primarily for and in connection +with specific products or compilations that contain the covered work, unless +you entered into that arrangement, or that patent license was granted, prior +to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available +to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from +the conditions of this License. If you cannot convey a covered work so as +to satisfy simultaneously your obligations under this License and any other +pertinent obligations, then as a consequence you may not convey it at all. +For example, if you agree to terms that obligate you to collect a royalty +for further conveying from those to whom you convey the Program, the only +way you could satisfy both those terms and this License would be to refrain +entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have permission to +link or combine any covered work with a work licensed under version 3 of the +GNU Affero General Public License into a single combined work, and to convey +the resulting work. The terms of this License will continue to apply to the +part which is the covered work, but the special requirements of the GNU Affero +General Public License, section 13, concerning interaction through a network +will apply to the combination as such. + + 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the +GNU General Public License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies +that a certain numbered version of the GNU General Public License "or any +later version" applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published +by the Free Software Foundation. If the Program does not specify a version +number of the GNU General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of +the GNU General Public License can be used, that proxy's public statement +of acceptance of a version permanently authorizes you to choose that version +for the Program. + +Later license versions may give you additional or different permissions. However, +no additional obligations are imposed on any author or copyright holder as +a result of your choosing to follow a later version. + + 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE +LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM +PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + + 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM +AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO +USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE +PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot +be given local legal effect according to their terms, reviewing courts shall +apply local law that most closely approximates an absolute waiver of all civil +liability in connection with the Program, unless a warranty or assumption +of liability accompanies a copy of the Program in return for a fee. END OF +TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively state the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + + +Copyright (C) + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like +this when it starts in an interactive mode: + + Copyright (C) + +This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + +This is free software, and you are welcome to redistribute it under certain +conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands might +be different; for a GUI interface, you would use an "about box". + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. For +more information on this, and how to apply and follow the GNU GPL, see . + +The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General Public +License instead of this License. But first, please read . diff --git a/README.org b/README.org new file mode 100644 index 0000000..0411889 --- /dev/null +++ b/README.org @@ -0,0 +1,9 @@ +#+title: My Emacs Configuration + +*Welcome to my Emacs configuration! Feel free to browse, read, borrow and/or inspire yourself!* + +This Emacs configuration is written using [[https://orgmode.org/][Org Mode]] in =config.org= and compiled to Emacs Lisp on startup using the =init.el= file. It is licensed under the General Public License version 3 (GPLv3). + +The configuration is not as new as it seems. I [[https://git.mmk2410.org/mmk2410/dotfiles/commit/dce591e5cbfac5f270d0f2fcf1c4b82e923a2215][declared .emacs bankruptcy]] on 12 March 2020 and started writing a this new configuration back then which I continuously used. Nevertheless it took more than one and a half year to finally release it again to the public (mind the commit message of the bankruptcy: "Starting a new Emacs configuration in a new repository. Will be available soon."). Since then I made over 270 commit in a private repository since in the beginning I was not sure IF or HOW to handle private information in the configuration. Since I don't have any motivation to browse all these commit to perhaps find something I don't want to publish I decided to release the configuration to the public in a new repository. + +Next to the main host at git.mmk2410.org I also mirror the repository to GitLab and GitHub. All three feature a rudimentary display of org mode and so you can read the =config.org= directly in your browser. Although I recommend downloading it and viewing it in Emacs to get all the advantages of Org. diff --git a/authinfo.gpg b/authinfo.gpg new file mode 100644 index 0000000..69c0c4d Binary files /dev/null and b/authinfo.gpg differ diff --git a/config.org b/config.org new file mode 100644 index 0000000..c63df68 --- /dev/null +++ b/config.org @@ -0,0 +1,2195 @@ +#+TITLE: Emacs Configuration file +#+AUTHOR: Marcel Kapfer +#+EMAIL: opensource(at)mmk2410(dot)org +# Source: https://gitlab.com/mmk2410/dot-emacs +# License: This file is licensed under the GPL v3 +#+STARTUP: indent overview + +*Welcome!* You found my (Marcel Kapfer aka mmk2410) personal Emacs configuration file. Please feel free to read through it, use it or get inspiration! + +This file (=config.org=) is written in [[https://orgmode.org/][org-mode]] and converted as Emacs Lisp to =config.el= on startup. This is achieved on org-babel and tangle (see the =init.el= file). + +There are many people that I should thank for giving me the help needed to write this config. Two of them need to be mentioned here since many parts are either copied or heavily inspired by their configurations: + +- [[https://karl-voit.at/][Karl Voit]] especially for his [[https://karl-voit.at/2021/06/01/Thunderbird-to-Evolution][Evolution email workflow]] and this [[https://karl-voit.at/2017/06/03/emacs-org/][setup approach]] ([[https://github.com/novoid/dot-emacs/blob/master/config.org][his Emacs config]]) +- [[https://daviwil.com/][David Wilson]] and his [[https://www.youtube.com/c/SystemCrafters][System Crafters]] YouTube channel for his [[https://www.youtube.com/c/SystemCrafters/videos][Emacs videos]] ([[https://config.daviwil.com/emacs][his Emacs config]]) + +/Note: Elisp blocks which are marked as =:tangle no= are not evaluated./ + +* A few words on setup + +Writing the initial "stable" version of this configuration took nearly two years. I used it constantly during this time after I declared Emacs bankruptcy with [[https://git.mmk2410.org/mmk2410/dotfiles/src/commit/f6d220554ab0946a1a4efb7e3400194139a99550/emacs/emacs.el][my old configuration]]. During this time many things happened and changed Back in March 2019 when I started I never imaged using this configuration on a native Microsoft® Windows® installation of Emacs. But in 2021 when I started using some creative tools that are only available on Windows® I first did and only later switched completely to the Windows Subsystem for Linux. Therefore /some/ parts are compatible with a native installation of Emacs on Windows®. + +For Microsoft(R) Windows(R) users it is highly adviced to set the =HOME= environment variable to the users home directory. This can be done by opening the file explorer =WIN+e=, right clicking on "This PC" and choosing "Properties". In the opening window it is possible to open "Advanced system settings" in the sidebar. In the then appearing dialg ther is a button labeled "Environment Variables...". Using the "New..." button in the "User variables" section of the "Environment Variables" dialog it is possible to add a new one. Enter as name =HOME= and use the "Browse Directory.." button for choosing your user home directory. Accept all the changes by clicking on "OK" until there are no more open dialogs left. + +* General settings + +Settings for Emacs in general as well as for my personal setup. + +** Personal Information + +#+begin_src emacs-lisp +(setq user-full-name "Marcel Kapfer" + user-mail-address "opensource@mmk2410.org") +#+end_src + +** Date & Time + +Set the first day of the week to Mondays. + +#+begin_src emacs-lisp +(setq calendar-week-start-day 1) +#+end_src + +Automatically create and save UIDs when exporting an iCalendar using Org. + +#+begin_src emacs-lisp +(setq org-icalendar-store-UID t) +#+end_src + +Set timezone for Org iCalendar export. + +#+begin_src emacs-lisp +(setq org-icalendar-timezone "Europe/Berlin") +#+end_src + +Use 24h time display including day and date. + +#+begin_src emacs-lisp +(setq display-time-24hr-format t + display-time-day-and-date t) +#+end_src + +Use a sane date style. + +#+begin_src emacs-lisp +(setq calendar-date-style 'european) +#+end_src + +** Turn off backup files + +#+begin_src emacs-lisp +(setq-default backup-inhibited t) +#+end_src + +** Disable adding double spaces after periods + +Source: [[http://www.reddit.com/r/emacs/comments/2l5gtz/real_sentence_in_emacs/][Real sentence in Emacs : emacs]] + +#+begin_src emacs-lisp +(setq-default sentence-end-double-space nil) +#+end_src + +** Enable truncate lines mode + +Sources: +- https://www.emacswiki.org/emacs/TruncateLines +- [[http://stackoverflow.com/questions/7577614/emacs-truncate-lines-in-all-buffers][elisp - Emacs truncate lines in all buffers - Stack Overflow]] + +#+begin_src emacs-lisp +(setq-default truncate-lines t) +(setq-default global-visual-line-mode t) +(add-hook 'org-mode-hook 'visual-line-mode) +#+end_src + +** Delete trailing white-space + +Source: [[https://www.emacswiki.org/emacs/DeletingWhitespace][EmacsWiki: Deleting Whitespace]] + +#+begin_src emacs-lisp +(add-hook 'before-save-hook 'delete-trailing-whitespace) +#+end_src + +** Require final newline + +#+begin_src emacs-lisp +(setq require-final-newline t) +#+end_src + +** Keep Emacs custom settings in a seperate file + +This includes creating the file if not existent. + +#+begin_src emacs-lisp +(setq custom-file (expand-file-name "custom.el" user-emacs-directory)) +(unless (file-exists-p custom-file) + (with-temp-buffer (write-file custom-file))) +(load custom-file) +#+end_src + +** Always follow VCS symlinks + +#+begin_src emacs-lisp +(setq vc-follow-symlink t) +#+end_src + +** Indent using spaces, not tabs + +#+begin_src emacs-lisp +(setq-default indent-tabs-mode nil) +#+end_src + +** Save minibuffer histroy + +#+begin_src emacs-lisp +(savehist-mode 1) +#+end_src + +** Auto-revert externally changed files + +#+begin_src emacs-lisp +(global-auto-revert-mode t) +(setq global-auto-revert-non-file-buffers t) +#+end_src + +** Save cursor place in file for next visit + +#+begin_src emacs-lisp +(save-place-mode t) +#+end_src + +** Spell checking + +Enable aspell. Options set according to [[https://www.emacswiki.org/emacs/FlySpell][Emacswiki: FlySpell]] + +#+begin_src emacs-lisp +(setq-default ispell-program-name "aspell") +(setq ispell-list-command "--list") +#+end_src + +For using spell checking on Microsoft(R) Windows(R) a little bit more work is apparently needed. First of all some spell checking program is needed and when trying to install either ispell, aspell or hunspell I run into the problem that all three of them are primarily developed for Linux systems. + +For installing aspell and the required dictionaries I decided to use [[https://www.msys2.org/][MSYS2]]. After installing this and following the initial setup guide on their website I installed aspell using =pacman -S mingw-w64-x86_64-aspell= in an MSYS2 terminal (for the next steps it was also necessary to install the =make= program with =pacman -S make=). The installation itself does not make the program available to my Emacs installation (see [[*A few words on setup][A few words on setup]]) but I needed to add the =C:\msys64\mingw64\bin= directory to the Windows =Path= variable. Therefore I opened an explorer (=WIN+e=), right-clicked "This PC" and then properties. In the appearing window I continued by clicking "Advanced system settings" in the sidebar. In the now appearing window I continued by clicking the "Environment Variables..." button. There I edited the =Path= *system* variable. By clicking on "New" first and then clicking on "Browse..." I was able to add the previously named directory to the path. Afterwards it is possible to check weather this was successful by either opening a PowerShell or CMD prompt and executing =aspell --version=. + +While Emacs now finds aspell (at least after a restart of Emacs) it does not find any dictionaries and therefore not work. This is quite understandable since by default non are installed. Apparently compared to some Linux distributions MSYS2 does not provide any dictionaries through their repositories. So I downloaded the ones I needed from the [[https://ftp.gnu.org/gnu/aspell/dict/0index.html][aspell dictionaries website]]. Using the *MSYS2 MinGW 64-bit* terminal (this is important, the MSYS MSYS2 one does not work for this) I could extract them with =tar xjf aspell6-en-2020.12.07-0.tar.bz2= and switch to the extracted directory. Following the provided README I first run =./configure= and the executed =make=. Since the =make install= step fails by default I needed to adjust the Makefile by deleting the *two* lines that change the directory and execute =chmod 664= in the =install= rule. Afterwards running =make install= succeeded without any errors. + +After re-visiting the current file or opening another one spell checking in Emacs works! + +** scratch-buffer + +I prefer that the mode of my scratch buffer is org and don't want any initial lines. + +#+begin_src emacs-lisp +(setq initial-scratch-message nil) +(setq initial-major-mode 'org-mode) +#+end_src + +** doc-view + +Set doc-view resolution to 300 for sharp PDFs. + +#+begin_src emacs-lisp +(setq doc-view-resolution 300) +#+end_src + +** Raise emacsclient frame on open + +Raise new ~emacsclient~ frames when created. + +Source: [[https://gitlab.com/bkhl/dotfiles/-/blob/master/.emacs.d/configuration.org][bkhl's dotfiles]] + +#+begin_src emacs-lisp +(defun mmk2410/focus-frame () + (select-frame-set-input-focus (selected-frame))) +(add-hook 'server-switch-hook 'mmk2410/focus-frame) +(add-hook 'server-after-make-frame-hook 'mmk2410/focus-frame) +#+end_src + +** Enable electric pair mode + +=electric-pair-mode= enables adding closing parenthesis & co when opening one. + +#+begin_src emacs-lisp +(electric-pair-mode 1) +#+end_src + +** camel-case words as separate words + +In many programming languages writing camel-case is often used. So I would like to tread them as separate words. + +#+begin_src emacs-lisp +(add-hook 'prog-mode-hook 'subword-mode) +#+end_src + +** Make scripts executable when saving + +Files that start with =#!= should be made executable on save. + +#+begin_src emacs-lisp +(add-hook 'after-save-hook + 'executable-make-buffer-file-executable-if-script-p) +#+end_src + +** Follow symlinks automatically + +When visiting a symlink, follow it automatically. + +#+begin_src emacs-lisp +(setq vc-follow-symlinks t) +#+end_src + +** Dired customizations + +Show filesize human readable. + +#+begin_src emacs-lisp +(setq-default dired-listing-switches "-alh") +#+end_src + +* Package configuration +** General configuration + +Add relevant archives. + +#+begin_src emacs-lisp +(add-to-list 'package-archives '("nongnu" . "https://elpa.nongnu.org/nongnu/") t) +(add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t) +#+end_src + +Configure the package manager to prefer newer packages and to not load packages automatically on startup. + +#+begin_src emacs-lisp +(setq-default load-prefer-newer t) +(setq-default package-enable-at-startup nil) +#+end_src + +** use-package + +Install/enable use-package. + +#+begin_src emacs-lisp +(unless (package-installed-p 'use-package) + (package-refresh-contents) + (package-install 'use-package)) +(require 'use-package) +#+end_src + +Configure use-package to load packages by default. + +#+begin_src emacs-lisp +(setq use-package-always-ensure t) +#+end_src + +* Visual appearance + +I don't agree with some visual defaults, so I redefine them. + +** Short yes/no questions + +#+begin_src emacs-lisp +(defalias 'yes-or-no-p 'y-or-n-p) +#+end_src + +** Confirm before closing emacs + +#+begin_src emacs-lisp +(setq confirm-kill-emacs #'y-or-n-p) +#+end_src + +** Disable the startup screen + +Source: [[https://stackoverflow.com/a/744681][Stack Overflow: Unable to hide welcome screen in Emacs]] + +#+begin_src emacs-lisp +(setq inhibit-startup-screen t) +#+end_src + +** Replace BEEP by visual-bell + +#+begin_src emacs-lisp +(setq visible-bell 1) +#+end_src + +** Disable cursor blinking + +#+begin_src emacs-lisp +(blink-cursor-mode -1) +#+end_src + +** Highlight current line + +#+begin_src emacs-lisp +(add-hook 'text-mode-hook #'hl-line-mode) +#+end_src + +** Show line numbers + +#+begin_src emacs-lisp +(add-hook 'text-mode-hook #'display-line-numbers-mode) +(add-hook 'prog-mode-hook #'display-line-numbers-mode) +#+end_src + +And disable this for some modes. + +#+begin_src emacs-lisp +(add-hook 'elfeed-show-mode-hook (lambda () (display-line-numbers-mode -1))) +(add-hook 'eshell-mode-hook (lambda () (display-line-numbers-mode -1))) +(add-hook 'pdf-view-mode-hook (lambda () (display-line-numbers-mode -1))) +(add-hook 'shell-mode-hook (lambda () (display-line-numbers-mode -1))) +(add-hook 'eww-mode-hook (lambda () (display-line-numbers-mode -1))) +#+end_src + +** Replace selected text by typing + +#+begin_src emacs-lisp +(delete-selection-mode t) +#+end_src + +** Vertical bar as cursor + +#+begin_src emacs-lisp +(setq-default cursor-type 'bar) +#+end_src + +** Hide tool bar, menu bar and scroll bar + +I get scroll bars when using Emacs with emacsclient. So I disable the =scroll-bar-mode= explicitly when creating a new frame, but only on graphical systems. The same fix is also applied for the typeface. + +#+begin_src emacs-lisp +(when (fboundp 'tool-bar-mode) + (tool-bar-mode -1)) +(when (fboundp 'menu-bar-mode) + (menu-bar-mode -1)) +(when (fboundp 'scroll-bar-mode) + (scroll-bar-mode -1)) +#+end_src + +** Highlight matching parenthesis + +#+begin_src emacs-lisp +(show-paren-mode 1) +#+end_src + +** Fix wrong Emacs size in some window managers + +I have the problem in BSPWM that Emacs always starts floating and does not obey my rule to start in tiling mode. + +Setting =frame-resize-pixelwise= to non-nil (as described in [[https://github.com/baskerville/bspwm/issues/551][GitHub: baskerville/bspwm #551]]) solves this problem. + +#+begin_src emacs-lisp +(setq frame-resize-pixelwise t) +#+end_src + +** Set typeface + +My typeface is not loading when using emacsclient. So I set it explicitly when creating a frame. The same fix is applied for the scroll bars. + +#+begin_src emacs-lisp +(setq my-font "Jetbrains Mono 11") + +(set-frame-font my-font nil t) + +(add-hook 'after-make-frame-functions + #'(lambda (frame) + (set-frame-font my-font nil t))) + +(set-face-attribute 'default nil :font "Jetbrains Mono" :height 110 :weight 'regular) +(set-face-attribute 'variable-pitch nil :font "Open Sans" :height 130 :weight 'regular) +(set-face-attribute 'fixed-pitch nil :font "Jetbrains Mono" :height 110 :weight 'regular) +#+end_src + +** Set theme + +Installing and enabling Gruvbox light theme. /Disabled in favor of the Doom themes./ + +Source: [[https://github.com/greduan/emacs-theme-gruvbox][Github: greduan/emacs-theme-gruvbox]] + +#+begin_src emacs-lisp +(use-package gruvbox-theme + :disabled t + :config + (load-theme 'gruvbox-light-medium t)) +#+end_src + +Installing and enabling Modus themes. /Disabled in favor of the Doom themes./ + +#+begin_src emacs-lisp +(use-package modus-themes + :disabled t + :init + (modus-themes-load-themes) + (setq modus-themes-bold-constructs t) + (setq modus-themes-syntax 'alt-syntax) + (setq modus-themes-slanted-constructs t) + (setq modus-themes-org-blocks 'grayscale) + (setq modus-themes-variable-pitch-headings t) + :config + (modus-themes-load-operandi)) +#+end_src + +Installing and enabling Doom themes. + +#+begin_src emacs-lisp +(use-package doom-themes + :config + (setq doom-themes-enable-bold t + doom-themes-enable-italic t) + (load-theme 'doom-one-light t) + (doom-themes-visual-bell-config) + (doom-themes-org-config)) +#+end_src + +Add a slight transparency to the frames. Code provided by David Wilson / System Crafters [[https://github.com/daviwil/emacs-from-scratch/blob/master/Emacs.org][Emacs from Scratch]] video series. + +#+begin_src emacs-lisp +(setq mmk2410/frame-transparency '(95 . 95)) + +(set-frame-parameter (selected-frame) 'alpha mmk2410/frame-transparency) +(add-to-list 'default-frame-alist `(alpha . ,mmk2410/frame-transparency)) +#+end_src + +** Switch theme + +During the last weeks I got used to using a light theme during daytime and a dark theme during nighttime. Luckily the themes based on Atom One are to my liking and the doom package provides a dark and light variant. One thing that was difficult with Emacs was actually switching theme since it involved disabling all current ones (for some reason on one machine there are two enabled while on the other machine its only one) and then loading the correct one. These functions try to make that process easier, at least for now. The long-term goal is to automatically change the theme based on the current system-wide setting. + +#+begin_src emacs-lisp +(setq mmk2410/theme-night 'doom-one) +(setq mmk2410/theme-day 'doom-one-light) + +(defun mmk2410/switch-theme (theme) + (mapcar 'disable-theme custom-enabled-themes) + (load-theme theme t)) + +(defun mmk2410/switch-theme-night () + (interactive) + (mmk2410/switch-theme mmk2410/theme-night)) + +(defun mmk2410/switch-theme-day () + (interactive) + (mmk2410/switch-theme mmk2410/theme-day)) +#+end_src + +** Customize modeline + +I'd like to use telephone line as a mode line. + +#+begin_src emacs-lisp +(use-package telephone-line + :disabled t + :init (telephone-line-mode t)) +#+end_src + +I'm currently trying doom-modeline instead of telephone-line. + +#+begin_src emacs-lisp +(use-package doom-modeline + :init (doom-modeline-mode 1) + :config (setq doom-modeline-icon t)) +#+end_src + +Additionally to that I also like to know, in which column I am. + +#+begin_src emacs-lisp +(column-number-mode 1) +#+end_src + +** Customize tab-bar + +Since version 27 Emacs has a new tab-bar feature for keeping multiple window configurations open in different tabs. By default each tab has a close button and the tab bar includes an add button. I prefer not having either one. + +#+begin_src emacs-lisp +(setq tab-bar-close-button-show nil + tab-bar-new-button-show nil) +#+end_src + +** Emojis + +Minor mode for displaying emojis in Emacs. + +Source: [[https://github.com/iqbalansari/emacs-emojify][iqbalansari/emacs-emojify]] + +#+begin_src emacs-lisp +(use-package emojify + :ensure t + :hook (erc-mode . emojify-mode) + :commands emojify-mode) +#+end_src + +* Keybinding + +List of own custom keybindings + +** Emacs Lisp related + +#+begin_src emacs-lisp +(global-set-key (kbd "C-c x") 'eval-region) +#+end_src + +** Ibuffer as default + +#+begin_src emacs-lisp +(global-set-key (kbd "C-x C-b") 'ibuffer) +#+end_src + +** Disable =C-z= + +=C-z= by default (as known from terminal applications) suspends the current frame. Since I use Emacs as GUI and not in terminal I do not want this behavior. + +#+begin_src emacs-lisp +(unbind-key "C-z") +#+end_src + +** The evil side + +I currently try out =evil-mode= for evaluating if it is any better for my hand. + +Source: [[https://github.com/emacs-evil/evil][GitHub: emacs-evil/evil]] + +#+begin_src emacs-lisp +(use-package evil + :init + (setq evil-want-integration t) + (setq evil-want-keybinding nil) + :config + (evil-mode 1) + (define-key evil-insert-state-map (kbd "C-g") 'evil-normal-state) + (define-key evil-insert-state-map (kbd "C-h") 'evil-delete-backward-char-and-join) + (evil-global-set-key 'motion "j" 'evil-next-visual-line) + (evil-global-set-key 'motion "k" 'evil-previous-visual-line)) +#+end_src + +An even better integration may be achieved when additionall using the [[https://github.com/emacs-evil/evil-collection][evil-collection]] package. + +#+begin_src emacs-lisp +(use-package evil-collection + :after evil + :config (evil-collection-init)) +#+end_src + +* General packages +** diminish-mode + +Diminished modes are minor modes with no modeline display + +Source: [[https://github.com/myrjola/diminish.el][GitHub: myrjola/diminish.el]] + +#+begin_src emacs-lisp +(use-package diminish + :init + (diminish 'abbrev-mode)) +#+end_src + +** crux + +A Collection of Ridiculously Useful eXtensions for Emacs. + +Used especially for =crux-delete-file-and-buffer= and =crux-rename-file-and-buffer= + +Source: [[https://github.com/bbatsov/crux][GitHub: bbatsov/crux]] + +#+begin_src emacs-lisp +(use-package crux) +#+end_src + +** which-key + +Emacs package that displays available keybindings in popup + +Source: [[https://github.com/justbur/emacs-which-key][GitHub: justbur/emacs-which-key]] + +#+begin_src emacs-lisp +(use-package which-key + :diminish which-key-mode + :init (which-key-mode) + :config (setq which-key-idle-delay 0.5)) +#+end_src + +** multiple-cursors + +Multiple cursors for emacs. + +Source: [[https://github.com/magnars/multiple-cursors.el][GitHub: magnars/multiple-cursors]] + +#+begin_src emacs-lisp +(use-package multiple-cursors + :bind + (("C->" . mc/mark-next-like-this) + ("C-<" . mc/mark-previous-like-this) + ("C-*" . mc/mark-all-like-this) + ("C-;" . mc/edit-lines))) +#+end_src + +** magit + +A Git Porcelain inside Emacs + +Source: [[https://magit.vc/][magit.vc]] + +#+begin_src emacs-lisp +(use-package magit + :bind + ("C-x g" . magit-status)) +#+end_src + +** diff-hl + +Emacs package for highlighting uncommitted changes + +Source: [[https://github.com/dgutov/diff-hl][Github: dgutov/diff-hl]] + +#+begin_src emacs-lisp +(use-package diff-hl + :config (global-diff-hl-mode t) + :hook (magit-post-refresh-hook . diff-hl-magit-post-refresh)) +#+end_src + +** project.el + +Load the included =project= package. + +#+begin_src emacs-lisp +(use-package project) +#+end_src + +** treemacs + +Treemacs is a package for displaying a directory tree in a (side) buffer. While browsing a project using =project.el= is also possible and perhaps fast, I think that the tree approach especially helps discovering a new project. + +Source: [[https://github.com/Alexander-Miller/treemacs][Alexander-Miller/treemacs]] + +#+begin_src emacs-lisp +(use-package treemacs + :defer t + :config + (setq treemacs-litter-directories '("/node_modules" "/.venv" "/.cask" "/vendor") + treemacs-indent-guide-style 'line) + (treemacs-follow-mode t) + (treemacs-git-mode 'deferred) + (treemacs-indent-guide-mode t) + :bind (:map global-map + ("M-0" . treemacs-select-window) + ("C-c b 1" . treemacs-delete-other-windows) + ("C-c b b" . treemacs) + ("C-c b B" . treemacs-bookmark) + ("C-c b C-f" . treemacs-find-file) + ("C-c b M-f" . treemacs-find-tag))) + +(use-package treemacs-evil + :after (treemacs evil)) +#+end_src + +** counsel, ivy and swiper + +Emacs package collection (ivy, swiper and counsel) of flexible, simple tools for minibuffer completion. + +Source: [[https://github.com/abo-abo/swiper][GitHub: abo-abo/swiper]] + +#+begin_src emacs-lisp +(use-package counsel + :bind ("M-x" . counsel-M-x)) + +(use-package ivy + :after (counsel) + :diminish (ivy-mode) + :config + (ivy-mode t) + (setq ivy-use-virtual-buffers t) + (setq ivy-count-format "(%d/%d) ") + :bind + (("C-c g" . counsel-git) + ("C-s" . swiper) + ("C-r" . swiper))) +#+end_src + +** ivy-rich + +ivy-rich enhances M-x and similar even more by giving more information directly in the minibuffer. + +Source: [[https://github.com/Yevgnen/ivy-rich][GitHub: Yevgnen/ivy-rich]] + +#+begin_src emacs-lisp +(use-package ivy-rich + :init (ivy-rich-mode 1)) +#+end_src + +** avy + +Jump to things in Emacs tree-style + +Source: [[https://github.com/abo-abo/avy][GitHub: abo-abo/avy]] + +#+begin_src emacs-lisp +(use-package avy + :bind + (("C-:" . avy-goto-char) + ("C-M-:" . avy-goto-char-2))) +#+end_src + +** yasnippet + +YASnippet is a template system for Emacs. + +Snippets can be put in the ~yas-snippet-dirs~, e.g. =~/.emacs.d/snippets=. + +Source: [[https://github.com/joaotavora/yasnippet][GitHub: joaotavora/yasnippet]] + +#+begin_src emacs-lisp +(use-package yasnippet + :config (yas-global-mode 1)) +#+end_src + +** pdf-tools + +An advanced Emacs support library for PDF files. + +Source: [[https://github.com/politza/pdf-tools][GitHub: politza/pdf-tools]] + +#+begin_src emacs-lisp +(use-package pdf-tools + :if (not (eq system-type 'windows-nt)) + :config + (pdf-loader-install) + ;; open pdfs scaled to fit page + (setq-default pdf-view-display-size 'fit-page) + ;; more fine-grained zooming + (setq pdf-view-resize-factor 1.1) + ;; use normal isearch + (define-key pdf-view-mode-map (kbd "C-s") 'isearch-forward) + (define-key pdf-view-mode-map (kbd "C-r") 'isearch-backward) + ;; keyboard shortcuts + (define-key pdf-view-mode-map (kbd "h") 'pdf-annot-add-highlight-markup-annotation) + (define-key pdf-view-mode-map (kbd "t") 'pdf-annot-add-text-annotation) + (define-key pdf-view-mode-map (kbd "D") 'pdf-annot-delete)) +#+end_src + +** deft + +Deft is a nice tool for searching for files (in my case my notes). Since it searches not only through the title of files but also through the contents it may be useful for me. + +#+begin_src emacs-lisp +(use-package deft + :bind ("C-c d" . deft) + :commands (deft) + :config (setq deft-directory "~/org" + deft-extensions '("org") + deft-recursive t)) +#+end_src + +** ace-window + +Quickly switch windows in Emacs + +Source: [[https://github.com/abo-abo/ace-window][GitHub: abo-abo/ace-window]] + +#+begin_src emacs-lisp +(use-package ace-window + :bind (("M-o" . 'ace-window))) +#+end_src + +* Org mode configuration + +This is my personal org-mode configuration. + +** Org modules + +#+begin_src emacs-lisp +(use-package org + :pin gnu) +(add-to-list 'org-modules 'org-habit) +(require 'org-protocol) +#+end_src + +** General settings + +Follow links when pressing enter on them. + +#+begin_src emacs-lisp +(setq org-return-follows-link t) +#+end_src + +Disable extra indent in src-blocks. + +#+begin_src emacs-lisp +(setq org-edit-src-content-indentation 0) +#+end_src + +Prevent accidental edits in invisible regions. + +#+begin_src emacs-lisp +(setq org-catch-invisible-edits 'error) +#+end_src + +Replace the three dots for collapsed stuff with a nicer symbol. + +#+begin_src emacs-lisp +(setq org-ellipsis " ▼") +#+end_src + +Hide emphasis markers. While this sometimes is very distracting it mostly looks absolutely beautiful. + +#+begin_src emacs-lisp +(setq org-hide-emphasis-markers t) +#+end_src + +** Org font adjustments + +I like to have larger headlines in Org for better identifying them. The configuration of [[https://config.daviwil.com/emacs#fonts-and-bullets][David Wilson]] was a large help in this regard. + +#+begin_src emacs-lisp +(with-eval-after-load 'org + (dolist (face '((org-level-1 . 1.4) + (org-level-2 . 1.3) + (org-level-3 . 1.2) + (org-level-4 . 1.15) + (org-level-5 . 1.1) + (org-level-6 . 1.1) + (org-level-7 . 1.1) + (org-level-8 . 1.1))) + (set-face-attribute (car face) nil :font "Open Sans" :weight 'bold :height (cdr face)))) + +#+end_src + +When using a variable-pitch font this also applies to stuff like code blocks. The following block resets this change for these unwanted faces. + +#+begin_src emacs-lisp +(with-eval-after-load 'org + (org-indent-mode) + (set-face-attribute 'org-block nil :foreground nil :inherit 'fixed-pitch) + (set-face-attribute 'org-code nil :inherit '(shadow fixed-pitch)) + (set-face-attribute 'org-indent nil :inherit '(org-hide fixed-pitch)) + (set-face-attribute 'org-verbatim nil :inherit '(shadow fixed-pitch)) + (set-face-attribute 'org-special-keyword nil :inherit '(font-lock-comment-face fixed-pitch)) + (set-face-attribute 'org-meta-line nil :inherit '(font-lock-comment-face fixed-pitch)) + (set-face-attribute 'org-checkbox nil :inherit 'fixed-pitch)) +#+end_src + +** Org Superstar Mode + +=org-superstar-mode= is a nice package for enriching the display of heading stars as well as list items. + +#+begin_src emacs-lisp +(with-eval-after-load 'org + (use-package org-superstar + :hook (org-mode . org-superstar-mode))) +#+end_src + +** LaTeX-related settings + +Add =scratcl= KOMA-Script class as available LaTeX class. + +#+begin_src emacs-lisp +(with-eval-after-load 'ox-latex + (add-to-list 'org-latex-classes + '("scrartcl" + "\\documentclass{scrartcl}" + ("\\section{%s}" . "\\section*{%s}") + ("\\subsection{%s}" . "\\subsection*{%s}") + ("\\subsubsection{%s}" . "\\subsubsection*{%s}") + ("\\paragraph{%s}" . "\\paragraph*{%s}") + ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))) +#+end_src + +Set the scrartcl class as default. + +#+begin_src emacs-lisp +(setq org-latex-default-class "scrartcl") +#+end_src + +Us LuaLaTeX as default LaTeX compiler. + +#+begin_src emacs-lisp +(setq org-latex-compiler "lualatex") +#+end_src + +Customize LaTeX packages and configurations. + +#+begin_src emacs-lisp +(setq org-latex-packages-alist + '( + ("" "booktabs" t) + ("" "amsmath" t) + ("AUTO" "polyglossia" t) + ("colorlinks" "hyperref" t) + "\\setmainfont{Linux Libertine O}" + "\\setsansfont{Linux Biolinum O}" + "\\setmonofont[Scale=0.9]{JetBrainsMono}")) +#+end_src + +Configure minted source code listings for LaTeX export. For actually using the configuration it is necessary to set =org-latex-listings= to ='minted= using a local variable and to add the =minted= and =xcolor= package to =org-latex-packages-alist=. This is not done by default since I don't need it for all files and it requires =--shell-escape= for the LaTeX compile process. + +#+begin_src emacs-lisp +(setq org-latex-minted-options + '(("baselinestretch" "1.2") + ("breaklines" "true") + ("fontsize" "\\footnotesize") + ("frame" "single") + ("framesep" "2mm") + ("linenos" "true") + ("style" "pastie"))) +#+end_src + +Removed unused default packages. + +#+begin_src emacs-lisp +(unless (boundp 'org-latex-default-packages-alist) + (setq org-latex-default-packages-alist nil)) +(setq + org-latex-default-packages-alist (remove '("AUTO" "inputenc" t) org-latex-default-packages-alist) + org-latex-default-packages-alist (remove '("" "fixltx2e" nil) org-latex-default-packages-alist) + org-latex-default-packages-alist (remove '("" "hyperref" nil) org-latex-default-packages-alist) + org-latex-default-packages-alist (remove '"\\tolerance=1000" org-latex-default-packages-alist)) +#+end_src + +Configure the org LaTeX preview to work with LuaLaTeX. + +#+begin_src emacs-lisp +(with-eval-after-load 'org + (add-to-list 'org-preview-latex-process-alist + '(luamagick :programs + ("lualatex" "convert") + :description "pdf > png" :message "you need to install the programs: lualatex and imagemagick." + :image-input-type "pdf" + :image-output-type "png" + :image-size-adjust (1.0 . 1.0) + :latex-compiler + ("lualatex --interaction=nonstopmode -output-directory=%o %f") + :image-converter + ("convert -density %D -trim -antialias %f -quality 100 %O")))) + +(setq org-preview-latex-default-process 'luamagick) +#+end_src + +Also adjust the LaTeX preview to be a little bit larger, since it is to small for me. + +#+begin_src emacs-lisp +(setq org-format-latex-options (plist-put org-format-latex-options :scale 1.5)) +#+end_src + +** ToDo-Management and Org Agenda + +Set TODO Keywords. + +#+begin_src emacs-lisp +(setq org-todo-keywords '((sequence + "TODO(t!)" "NEXT(n!)" "STARTED(a!)" "WAIT(w@/!)" "SOMEDAY(s)" + "|" "DONE(d!)" "CANCELLED(c@/!)"))) +#+end_src + +Set time tag when re-something on todos + +#+begin_src emacs-lisp +(setq org-log-done 'time + org-log-reschedule 'time + org-log-redeadline 'time + org-log-into-drawer t) +#+end_src + +Forbid closing of todos with open subtasks. + +#+begin_src emacs-lisp +(setq + org-enforce-todo-dependencies t + org-enforce-todo-checkbox-dependencies t) +#+end_src + +Set org agenda files. + +#+begin_src emacs-lisp +(setq org-agenda-files (list "~/org/") + org-agenda-text-search-extra-files (list "~/org/archive/" + "~/org/roam/" + "~/org/articles/")) +#+end_src + +Open org-agenda in current window. + +#+begin_src emacs-lisp +(setq org-agenda-window-setup (quote current-window)) +#+end_src + +Define org-capture templates. + +#+begin_src emacs-lisp +(setq org-capture-templates + '(("t" "Normal task" entry (file "~/org/inbox.org") + "* TODO %?\n :PROPERTIES:\n :CREATED: %U\n :END:") + ("e" "E-Mail needing a reply" entry (file "~/org/emails.org") + "* TODO Reply: %a\n :PROPERTIES:\n :CREATED: %U\n :END:" + :immediate-finish t) + ("p" "org-protocol-capture" entry (file "~/org/inbox.org") + "* TODO [[%:link][%:description]]\n :PROPERTIES:\n :CREATED: %U\n :END:\n\n %i" + :immediate-finish t) + ("s" "Event" entry (file "~/org/events.org") + "* SOMEDAY %? %^G\n SCHEDULED: %^T\n :PROPERTIES:\n :CREATED: %U\n :END:") + ("r" "Reading todo" entry (file "~/org/reading.org") + "* TODO %^L %^G\n :PROPERTIES:\n :CREATED: %U\n :END:\n"))) +#+end_src + +Configure refiling TODOs. + +- Show headline to refile to as path, also including the file name +- Don't select hierarchically, but show everything at once +- Enable the ability to create parent nodes when refiling +- Set refile targets to agenda files and only consider the first and second level + +#+begin_src emacs-lisp +(setq org-refile-use-outline-path 'file) +(setq org-outline-path-complete-in-steps nil) +(setq org-refile-allow-creating-parent-nodes 'confirm) +(setq org-refile-targets '((org-agenda-files :maxlevel . 1))) +#+end_src + +Warn me on deadlines in the next year. + +#+begin_src emacs-lisp +(setq org-deadline-warning-days 365) +#+end_src + +Org Agenda mode settings: + +- Set agenda span to one day +- Don't show entries twice (scheduled and deadline) +- Start week today and not on Monday. + +#+begin_src emacs-lisp +(setq org-agenda-span 'week) +(setq org-agenda-skip-scheduled-if-deadline-is-shown t) +(setq org-agenda-start-on-weekday nil) +#+end_src + +Make the column for categories wider. + +#+begin_src emacs-lisp +(setq org-agenda-prefix-format + '((agenda . " %i %-18:c%?-12t% s") + (todo . " %i %-18:c") + (tags . " %i %-18:c") + (search . " %i %-18:c"))) +#+end_src + +Finally define the org-agenda display using [[https://github.com/alphapapa/org-super-agenda][org-super-agenda]] by alphapapa. + +#+begin_src emacs-lisp +(use-package org-super-agenda + :after org + :init (org-super-agenda-mode) + :config + (setq org-agenda-block-separator nil + org-agenda-compact-blocks t) + (setq org-agenda-custom-commands + '(("c" "Complete Agenda with Todos" + ((agenda "" ((org-agenda-span 'week) + (org-deadline-warning-days 365) + (org-super-agenda-groups + '((:name "" :time-grid t :deadline future))))) + (alltodo "" ((org-agenda-overriding-header "") + (org-super-agenda-groups + '((:name "High Priority" :priority "A") + (:name "Inbox" :file-path ".*/org/inbox\\.org$") + (:name "Emails" :file-path ".*/org/emails\\.org$") + (:name "Next" :todo "NEXT") + (:name "Started" :todo "STARTED") + (:name "Bachelor Thesis" :category "BA") + (:name "Study" :and (:file-path ".*/org/study\\.org$" :not(:scheduled future))) + (:name "Öff-Ref" :tag "@oeffref") + (:name "FIN" :tag "@fin") + (:name "Reading" :file-path ".*/org/reading\\.org$") + (:name "Projects" :file-path ".*/org/projects\\.org$") + (:name "Habits" :habit t :order 100) + (:name "Someday" :todo "SOMEDAY" :scheduled future :order 101)))))))))) +#+end_src + +** Automatic UUID creation + +I am currently exploring the option in Org mode to export a file (or some entries) to an ics-file which I can then in turn import into my calendar. For reliably creating (and most importantly: updating) entries it is necessary that each one has an unique ID. To create a ID for the current entry I could just run =M-x org-id-get-create= and for an entire file execute the following Emacs Lisp ~(org-map-entries 'org-id-get-create)~. Of course this is not an ideal solution. But adding this s-expression to ~org-mode-hook~ would create IDs in all Org file I edit which I also don't like. Since the amount of files I do want the automatic creation is (currently) not that large it is OK for me to do some work on my own, at least if it is only a one time setup. + +The idea which I had to achieve this goal was to create a file-local variable (called ~mmk2410/org-create-uuids~) that I set to ~t~ in the buffers I need the automatic adding of IDs and adding a hook to ~org-mode-hook~ that in turn adds a hook to ~before-save-hook~ for calling the function ~mmk2410/org-create-all-uuids~ that executes the previously named s-expression to add a ID to each entry in the buffer. + +#+begin_src emacs-lisp +(setq mmk2410/org-create-uuids nil) + +(defun mmk2410/org-create-all-uuids () + "Create UUIDs for all entries in the current org-mode buffer." + (interactive) + (when mmk2410/org-create-uuids + (org-map-entries 'org-id-get-create))) + +(add-hook 'org-mode-hook + (lambda () (add-hook 'before-save-hook 'mmk2410/org-create-all-uuids nil t))) +#+end_src + +** Keybindings + +Fast org key bindings. + +- C-c l for =org-store-link= +- C-c c for =org-capture= +- C-c o for =org-switchb= +- C-c a for =org-agenda= + +#+begin_src emacs-lisp +(global-set-key (kbd "C-c l") 'org-store-link) +(global-set-key (kbd "C-c c") 'org-capture) +(global-set-key (kbd "C-c o") 'org-switchb) +(global-set-key (kbd "C-c a") 'org-agenda) +#+end_src + +** Nicer display for Org buffers + +From [[https://github.com/daviwil/emacs-from-scratch/blob/master/Emacs.org#center-org-buffers][System Crafters' Emacs from Scratch Config]]. + +#+begin_src emacs-lisp +(defun efs/org-mode-visual-fill () + (setq visual-fill-column-width 100 + visual-fill-column-center-text t) + (visual-fill-column-mode 1)) + +(use-package visual-fill-column + :hook (org-mode . efs/org-mode-visual-fill)) + +(add-hook 'org-mode-hook (lambda () + (display-line-numbers-mode -1) + (variable-pitch-mode))) +#+end_src + +** Hooks + +Enable =flyspell-mode= and disable line numbers in org-agenda. + +#+begin_src emacs-lisp +(add-hook 'org-mode-hook 'flyspell-mode) +(add-hook 'org-agenda-mode-hook (lambda () (display-line-numbers-mode -1))) +#+end_src + +** Org Journal + +Until now I did not thing that I needed to keep a (personal) journal. But since I is recommended to keep a journal of whom you met due to the corona pandemic I started thinking about setting up one. Further use cases came then to my mind and so I decided to give it a try. Therefore the configuration is still in a very early state and may change quite soon. + +#+begin_src emacs-lisp +(use-package org-journal + :config (setq org-journal-dir "~/org/journal" + org-journal-file-type 'monthly + org-journal-find-file 'find-file) + :bind (("C-c j j" . 'org-journal-new-entry) + ("C-c j s" . 'org-journal-new-scheduled-entry) + ("C-c j o" . 'org-journal-open-current-journal-file) + ("C-c j w" . 'mmk2410/org-journal-worktime))) +#+end_src + +Part of my workflow with org journal is in the meantime to clock the time I work in the different entries using =org-clock=. At the end of the day I like to create a summary for that. Currently the process for this includes a table with to formulas I created some time ago and copy every day from the previous one (while the first formula calculates the times the second is just there to clean the fields). While this is certainly improvable in many ways the only thing that really annoyed me was the calculation of the time. Since I try to follow the 52:17 methodology I have to add many numbers around 52 up to get the usual hour:minutes format. Although this is certainly a good brain training it has been shown that the calculation is very error-prone and calculating this twice does not make it more fun. + +Therefore I created a little interactive helper function to sum these times up. The function =mmk2410/org-journal-worktime= reads a list of space separated minute values (so the time 1:04 must be entered as 64) and returns it as an minibuffer message in the required format (hh:mm). + +#+begin_src emacs-lisp +(defun mmk2410/org-journal-worktime (workmins) + "Sum up the entered minutes and return it in hh:mm format." + (interactive "Show many minutes did you work today? ") + (let ((worksum (apply '+ (mapcar 'string-to-number (split-string workmins))))) + (message "Total work time: %d:%d" (/ worksum 60) (mod worksum 60)))) +#+end_src + +I am quite sure that the function can be improved in various ways. I am not a Lisp hacker and have not written very much in it. But at the moment it fits my needs (and I currently do not have more time to spare on this). + +** Org Drill + +org-drill is a package for spaced repetition in Emacs using org-mode files. + +Source: [[https://gitlab.com/phillord/org-drill/][GitLab: phillord/org-drill]] + +#+begin_src emacs-lisp +(use-package org-drill + :after org + :config + (setq org-drill-learn-fraction 0.4) + (setq org-drill-maximum-items-per-session 50)) +#+end_src + +* Org Research Assistant +** Org Roam + +Roam Research / Zettelkasten system using org-mode. + +Source: [[https://www.orgroam.com][orgroam.com]] + +#+begin_src emacs-lisp +(use-package org-roam + :commands (org-roam-node-insert org-roam-node-find org-roam-capture org-roam-buffer-toggle org-roam) + :init + (setq org-roam-v2-ack t) + :config + (setq org-roam-directory "~/org/roam") + (add-to-list 'display-buffer-alist + '("\\*org-roam\\*" + (display-buffer-in-direction) + (direction . right) + (window-width . 0.33) + (window-height . fit-window-to-buffer))) + (require 'org-roam-protocol) + (org-roam-db-autosync-mode) + :bind (("C-c r f" . org-roam-node-find) + ("C-c r i" . org-roam-node-insert) + ("C-c r b" . org-roam-buffer-toggle) + ("C-c r c" . org-roam-capture) + ("C-c r g" . org-roam-graph) + :map org-roam-mode-map + ("[mouse-1]" . #'org-roam-visit-thing))) +#+end_src + +** Org Roam Bibtex + +„Official“ connector between org-roam, BibTeX and org-ref. + +Source: [[https://github.com/org-roam/org-roam-bibtex][GitHub: org-roam/org-roam-bibtex]] + +#+begin_src emacs-lisp +(use-package org-roam-bibtex + :after org-roam + :hook (org-roam-mode . org-roam-bibtex-mode)) +#+end_src + +** Org Roam UI + +*Disabled since =org-roam-ui= is not yet released on Melpa.* And I currently have no time to setup or switch to =straight= (or to put it better: it is currently not important enough for me). + +A graphical frontend for exploring your org-roam Zettelkasten + +Source: [[https://github.com/org-roam/org-roam-ui][GitHub: org-roam/org-roam-ui]] + +#+begin_src emacs-lisp +(use-package websocket + :disabled t + :after org-roam) + +(use-package org-roam-ui + :disabled t + :after org-roam + :config + (setq org-roam-ui-sync-theme t + org-roam-ui-follow t + org-roam-ui-update-on-save t + org-roam-ui-open-on-start t)) +#+end_src + +** Helm Bibtex + +Search and manage bibliographies in Emacs. + +Source: [[https://github.com/tmalsburg/helm-bibtex][GitHub: tmalsburg/helm-bibtex]] + +#+begin_src emacs-lisp +(use-package ivy-bibtex + :after ivy + :config + (setq bibtex-completion-bibliography "~/org/bibliography.bib") + (setq bibtex-completion-library-path "~/papers") + (setq bibtex-completion-notes-path "~/org/roam") + (setq bibtex-completion-find-additional-pdfs t)) +#+end_src + +** Org Ref + +org-mode modules for citations, cross-references, bibliographies in org-mode and useful bibtex tools to go with it. + +Source: [[https://github.com/jkitchin/org-ref][Github: jkitchin/org-ref]] + +#+begin_src emacs-lisp +(use-package org-ref + :after org + :config + (setq org-ref-default-bibliography '("~/org/bibliography.bib")) + (setq org-ref-pdf-directory "~/papers/") + (setq org-ref-notes-directory "~/org/roam") + (setq reftex-default-bibliography org-ref-default-bibliography) + (setq bibtex-completion-bibliography org-ref-default-bibliography) + (setq bibtex-completion-library-path org-ref-pdf-directory) + (setq bibtex-completion-notes-path org-ref-notes-directory)) +#+end_src + +** Org Noter + +A synchronized, Org-mode, document annotator + +Source: [[https://github.com/weirdNox/org-noter][GitHub: weirdNorx/org-noter]] + +#+begin_src emacs-lisp +(use-package org-noter + :after (:any org pdf-tools) + :config + (setq org-noter-notes-search-path '("~/org/roam"))) +#+end_src + +* LaTeX configuration +** auctex + +For LaTeX typesetting in Emacs I like to use the great AUCTeX package. + +#+begin_src emacs-lisp +(use-package auctex + :defer t + :config + (setq TeX-auto-save t) + (setq TeX-parse-self t) + (setq TeX-engine 'luatex)C + (setq-default TeX-master nil)) +#+end_src + +** company-auctex + +I also like to turn on company completion for auctex. + +#+begin_src emacs-lisp +(use-package company-auctex + :after auctex + :config + (company-auctex-init)) +#+end_src + +** cdlatex + +Fast input methods to enter LaTeX environments and math. + +Source: [[https://github.com/cdominik/cdlatex][GitHub: cdominik/cdlatex]] + +#+begin_src emacs-lisp +(use-package cdlatex + :hook ((LaTeX-mode . turn-on-cdlatex) + (org-mode . turn-on-org-cdlatex))) +#+end_src + +* General Programming Packages +** rainbow-delimiters + +Lisp languages involve many parentheses and it might get hard to know which one are on the same “level”. The rainbow-delimiters package is here to help with this problem. + +Source: [[https://github.com/Fanael/rainbow-delimiters][GitHub: Fanael/rainbow-delimiters]] + +#+begin_src emacs-lisp +(use-package rainbow-delimiters + :hook (prog-mode . rainbow-delimiters-mode)) +#+end_src + +** highlight-indent-guides + +Minor mode for highlighting indentation. + +Source: [[https://github.com/DarthFennec/highlight-indent-guides][DarthFennec/highlight-indent-guides]] + +#+begin_src emacs-lisp +(use-package highlight-indent-guides + :config + (setq highlight-indent-guides-method 'character + highlight-indent-guides-responsive 'top) + :hook (prog-mode . highlight-indent-guides-mode)) +#+end_src + +** company + +Auto completion + +Source: [[https://github.com/company-mode/company-mode][GitHub: company-mode]] + +#+begin_src emacs-lisp +(use-package company + :diminish company-mode + :hook ((prog-mode . company-mode) + (latex-mode . company-mode)) + :init + (setq company-show-numbers t + company-minimum-prefix-length 1 + company-idle-delay 0.0 + company-dabbrev-downcase nil)) +#+end_src + +** lsp + +Language Server Protocoll capabilities for Emacs + +Source: [[https://github.com/emacs-lsp/lsp-mode][GitHub:emacs-lsp/lsp-mode]] + +#+begin_src emacs-lisp +(use-package lsp-mode + :hook ((python-mode . lsp-deferred) + (go-mode . lsp-deferred) + (php-mode . lsp-deferred) + (vue-mode . lsp-deferred) + (typescript-mode . lsp-deferred) + (js-mode . lsp-deferred) + (lsp-mode . lsp-enable-which-key-integration)) + :commands (lsp lsp-deferred) + :config + (setq lsp-keymap-prefix "C-s-l" + lsp-prefer-capf t)) + +(use-package lsp-ui + :commands lsp-ui-mode) + +(use-package lsp-ivy + :commands lsp-ivy-workspace-symbol) + +(use-package lsp-treemacs + :commands lsp-treemacs-errors-list) +#+end_src + +** editorconfig + +EditorConfig plugin for Emacs + +Source: [[https://github.com/editorconfig/editorconfig-emacs][GitHub: editorconfig/editorconfig-emacs]] + +#+begin_src emacs-lisp +(use-package editorconfig + :ensure t + :config + (editorconfig-mode 1)) +#+end_src + +* Language-Specific Programming Packages +** Go + +Emacs mode for the Go programming language + +Source: [[https://github.com/dominikh/go-mode.el][dominikh/go-mode.el]] + +#+begin_src emacs-lisp +(use-package go-mode + :mode "\\.go\\'") +#+end_src + +** PHP + +PHP major mode for Emacs. + +Source: [[https://github.com/emacs-php/php-mode][GitHub: emacs-php/php-mode]] + +#+begin_src emacs-lisp +(use-package php-mode + :mode "\\.php\\'") +#+end_src + +** TypeScript + +TypeScript-support for Emacs + +Source: [[https://github.com/emacs-typescript/typescript.el][GitHub: emacs-typescript/typescript.el]] + +#+begin_src emacs-lisp +(use-package typescript-mode + :mode "\\.ts\\'") +#+end_src + +** Web Mode + +web-mode.el is an autonomous emacs major-mode for editing web templates. + +Source: [[https://github.com/fxbois/web-mode][GitHub: fxbois/web-mode]] + +#+begin_src emacs-lisp +(use-package web-mode + :mode (("\\.phtml\\'" . web-mode) + ("\\.tpl\\.php\\'" . web-mode) + ("\\.[agj]sp\\'" . web-mode) + ("\\.as[cp]x\\'" . web-mode) + ("\\.erb\\'" . web-mode) + ("\\.mustache\\'" . web-mode) + ("\\.djhtml\\'" . web-mode) + ("\\.blade\\.php\\'" . web-mode))) +#+end_src + +** Vue Mode + +Emacs major mode for vue.js + +Source: [[https://github.com/AdamNiederer/vue-mode][GitHub: AdamNiederer/vue-mode]] + +#+begin_src emacs-lisp +(use-package vue-mode + :mode "\\.vue\\'") +#+end_src + +** TypoScript + +TypoScript major mode for Emacs. + +Source: [[https://github.com/ksjogo/typoscript-mode][GitHub: ksjogo/typoscript-mode]] + +#+begin_src emacs-lisp +(use-package typoscript-mode + :mode "\\.typoscript\\'") +#+end_src + +** YAML + +YAML major mode for Emacs. + +Source: [[https://github.com/yoshiki/yaml-mode][GitHub: yoshiki/yaml-mode]] + +#+begin_src emacs-lisp +(use-package yaml-mode + :mode (("\\.yaml\\'" . yaml-mode) + ("\\.yml\\'" . yaml-mode))) +#+end_src + +** MoinMoin + +MoinMoin mode for Emacs. + +Source: [[https://moinmo.in/action/raw/EmacsForMoinMoin/MoinMoinMode?action=raw][MoinMoin wiki: EmacsForMoinMoin]] + +#+begin_src emacs-lisp +(use-package moinmoin-mode + :load-path "lisp/moinmoin-mode/" + :mode "\\.wiki\\'" + :commands (moinmoin-mode)) +#+end_src + +* Emacs Multimedia System (EMMS) + +For notes, tasks, writing, and countless other things there is org-mode. + +For professional typesetting with TeX and LaTeX there is AucTeX. + +And for playing music in Emacs there is EMMS. + +#+begin_src emacs-lisp +(use-package emms + :init + (emms-all) + (emms-default-players) + :config + (setq emms-source-file-default-directory "~/Music")) +#+end_src + +* ERC (the Emacs IRC client) + +** The beast itself + +For joining IRC channels I use ERC. For connecting with the network (using my ZNC bouncer) I would like to just press a keybinding. Therefore I warp the call to =erc-tls= with the correct arguments in the following function (which is later bound to =C-c i j=). + +#+begin_src emacs-lisp +(defun mmk2410/erc-connect () + "Start a IRC session with ERC by connecting to my ZNC bouncer." + (interactive) + (erc-tls :server "znc.mmk2410.org" :port "6697" :nick "mmk2410" + :full-name "Marcel Kapfer")) +#+end_src + +Now the configuration for ERC. Some stuff I found in the deepest depths of the internet. Worth mentioning is the [[https://www.emacswiki.org/emacs/ERC][EmacsWiki]] and the following two videos by David Wilson on the [[https://www.youtube.com/c/SystemCrafters][System Crafters YouTube channel]]: [[https://www.youtube.com/watch?v=qWHTZIYTA4s][Chat Like the 90's in Emacs with ERC]] and [[https://www.youtube.com/watch?v=Qci8t_jpVGA][System Crafters Live! - Improving the IRC Experience in ERC]]. + +#+begin_src emacs-lisp +(use-package erc + :config + ;; Display styling + (setq erc-fill-column 100 + erc-fill-function 'erc-fill-static + erc-fill-static-center 20) + ;; Emacs behavior + (setq erc-rename-buffers t + erc-kill-buffer-on-part t + erc-kill-queries-on-quit t + erc-kill-server-buffer-on-quit t) + ;; IRC behavior + (setq erc-hide-list '("JOIN" "PART" "QUIT" "NICK" "MODE" "AWAY") + erc-join-buffer 'bury + erc-autojoin-timing 'ident + erc-track-exclude '("#guix") + erc-track-exclude-types '("JOIN" "NICK" "QUIT" "MODE" "AWAY" "PART") + erc-track-exclude-server-buffer t) + :bind ( + ("C-c i c" . 'mmk2410/erc-connect) + :map erc-mode-map + ("RET" . nil) + ("C-c " . 'erc-send-current-line))) +#+end_src + +** Additional packages + +Highlight nicknames in ERC. + +Source: [[https://github.com/leathekd/erc-hl-nicks][leathekd/erc-hl-nicks]] + +#+begin_src emacs-lisp +(use-package erc-hl-nicks + :after erc + :config + (add-to-list 'erc-modules 'hl-nicks)) +#+end_src + +Fetch and show received images in a ERC buffer + +Source: [[https://github.com/kidd/erc-image.el][kidd/erc-image.el]] + +#+begin_src emacs-lisp +(use-package erc-image + :after erc + :config + (setq erc-image-inline-rescale 600) + (add-to-list 'erc-modules 'image)) +#+end_src + +* Emacs Web Wowser (EWW) + +Normally I use Firefox for browsing the web, but when I am working with full focus in Emacs I sometimes prefer eww. For example while reading a paper and taking notes on it. In this case I don't want to lose my focus while switching to a web browser (and potentially see some open tabs from another project). + +In recent times I have gotten really bad search results on DuckDuckGo (either I can't search anymore or they really got worse). So I'm using Startpage at the moment. + +More important for me while reading a paper is looking up some things on Wikipedia. So I defined -- additionally to a simple keybinding for eww itself -- a function and a keybinding for searching on the English Wikipedia. + +#+begin_src emacs-lisp +(eval-and-compile + (defun eww-browse-wikipedia-en () + (interactive) + (let ((search (read-from-minibuffer "Wikipedia (EN) search: "))) + (eww-browse-url + (concat "https://en.wikipedia.org/w/index.php?search=" search))))) + +(eval-and-compile + (defun eww-browser-english-dict () + (interactive) + (let ((search (read-from-minibuffer "Dictionary (EN) search: "))) + (eww-browse-url + (concat "https://www.merriam-webster.com/dictionary/" search))))) + +(use-package eww + :config + (setq eww-search-prefix "https://startpage.com/search/?q=") + :bind (("C-c w b" . 'eww) + ("C-c w d" . 'eww-browser-english-dict) + ("C-c w w" . 'eww-browse-wikipedia-en))) +#+end_src + +* Terminals & Shells +** vterm + +A fully-fledged terminal emulator based on libvterm. + +Source: [[https://github.com/akermu/emacs-libvterm][GitHub: akermu/emacs-libvterm]] + +#+begin_src emacs-lisp +(use-package vterm + :if (not (eq system-type 'windows-nt)) + :bind (("C-c t" . 'vterm))) +#+end_src + +** eshell + +Let's try out eshell. + +#+begin_src emacs-lisp +(use-package eshell + :bind (("C-c s" . 'eshell))) +#+end_src + +* Elfeed + +Since now I used many different RSS feed solutions. I started with Feedly back in 2013/14, switched later to a self-hosted TinyTinyRSS and then to Nextcloud News. After some time using this solution, its many bugs annoyed me more and more and I finally switched to FreshRSS in early 2021. Since early October I'm trying Miniflux. Although I had no problems with FreshRSS the interface of Miniflux (especially on mobile) is IMO nicer (though a little bit more eye-candy would be nice). + +Mostly I use Miniflux through its web app---on mobile and on the desktop as well. But I have used and liked elfeed in the past and so I keep it configured properly. + +** elfeed package + +This is the elfeed program itself. + +As with email I prefer showing older entries first so I can catch-up with these first before getting to newer stuff. Other than the binding to =C-c e= there is nothing interesting left to see here. + +Source: [[https://github.com/skeeto/elfeed][GitHub: skeeto/elfeed]] + +#+begin_src emacs-lisp +(use-package elfeed + :demand t + :config (setq elfeed-sort-order 'ascending) + :bind (("C-c e" . elfeed))) +#+end_src + +** Storing articles + +*Currently I am not using this since I need the actual articles offline for reading in some situation and therefore currently rely on Pocket.* + +I like to call myself quite an avid org-mode user and so I also want to store RSS articles I read with Elfeed in a reading list. Since from time to time I prefer to use my tablet or smartphone to read instead of sitting at the computer and it is a little bit cumbersome to use Emacs with Elfeed using Termux I prefer using the fantastic Orgzly app. The problem is now that I cannot just =org-store-link= in the org-capture template for Elfeed entries since this would store a link to the corresponding Elfeed entry. While I can open such links at my desktop I cannot in Orgzly. And also on desktop I most likely will open the article in my web browser instead of viewing just the RSS entry. Therefore it would be very practical if the capture template would not store a Elfeed link but directly the web link. Additionally would also like to store the Feed title as part of the note. + +Therefore I need a org-capture template which fetches these functions. And since I can only get the Elfeed entry properties in the buffer with the entry I cannot just use the =%(EXP)= option alone but need a function that switches to the Elfeed buffer, gets the property and then inserts the value in the capture template. For this I wrote the following function which does exactly this (thanks to [[https://emacs.stackexchange.com/a/55268][RichieHH]] who put me on the right track). + +#+begin_src emacs-lisp +(defun mmk2410/org-capture-elfeed-entry-props (prop-function) + (save-window-excursion + (switch-to-buffer (org-capture-get :original-buffer)) + (funcall prop-function elfeed-show-entry))) +#+end_src + +Using this function I can now define a org-capture template for my purpose. + +#+begin_src emacs-lisp +(add-to-list 'org-capture-templates + '("a" "RSS Article" entry (file "~/org/reading.org") + "* TODO %(elfeed-feed-title (mmk2410/org-capture-elfeed-entry-props 'elfeed-entry-feed)): [[%(mmk2410/org-capture-elfeed-entry-props 'elfeed-entry-link)][%(mmk2410/org-capture-elfeed-entry-props 'elfeed-entry-title)]]\n :PROPERTIES:\n :CREATED: %U\n :END:\n" + :immediate-finish t)) +#+end_src + +** elfeed-protocol + +=elfeed-protocol= is a addition to Elfeed which enables the usage of some cloud RSS services (e.g. Nextcloud News, TT-RSS). + +I currently use it in combination with my Miniflux instance (previously I used it with Nextcloud News and FreshRSS). The reason why I not only use elfeed with a local feed list (managed for example by elfeed-org) is that a cloud service can check for new feed articles continuously and I can read articles on any device. + +Source: [[https://github.com/fasheng/elfeed-protocol][GitHub: fasheng/elfeed-protocol]] + +#+begin_src emacs-lisp +(use-package elfeed-protocol + :init + ;; FreshRSS (self-hosted) + ;; Disabled since I currently use Miniflux + ;; (setq elfeed-feeds '(("fever+https://mmk2410@rss.mmk2410.org" + ;; :api-url "https://rss.mmk2410.org/api/fever.php" + ;; :use-authinfo t))) + ;; Miniflux (self-hosted) + (setq elfeed-feeds '(("fever+https://mmk2410@miniflux.rss.mmk2410.org" + :api-url "https://miniflux.rss.mmk2410.org/fever/" + :use-authinfo t))) + (elfeed-protocol-enable)) +#+end_src + +* mu4e + +Managing e-mails is maybe one of the most critical tasks in my life. Over the last years I tried countless different clients, including the famous (neo)mutt, KMail, and Thunderbird. But it seems that I always go back to one specific: mu4e. Maybe because it is integrated in Emacs and Org-mode, maybe because I like using a keyboard-focused client and that's where I end. I don't now. But what I know is: I enjoy using it! + +Sadly since my workplace heavily uses Microsoft Office 365 including Outlook for mails I'm currently using Evolution, with a setup heavily inspired by [[https://karl-voit.at/2021/06/01/Thunderbird-to-Evolution/][Karl Voit]]. + +** Load mu4e + +Not all distributions that I use have a enough up-to-date package of mu/maildir-utils in their repositories. Therefore on some system I compile and install it myself which ends in =/usr/local= instead of just =/usr.= Therefore I have a small function that finds the correct load-path for the mu4e package. + +#+begin_src emacs-lisp +(eval-and-compile + (defun mmk2410/mu4e-load-path () + (let* ((mu4e-site-lisp-path "/share/emacs/site-lisp/mu4e") + (mu4e-load-path-usr (concat "/usr" mu4e-site-lisp-path)) + (mu4e-load-path-usr-local (concat "/usr/local" mu4e-site-lisp-path))) + (cond ((file-directory-p mu4e-load-path-usr) + mu4e-load-path-usr) + ((file-directory-p mu4e-load-path-usr-local) + mu4e-load-path-usr-local) + (t (error "mu4e not found!")))))) +#+end_src + +Using the determined load path I now load mu4e itself if the =mu= executable is in path (useful for my work machine where I currently only have Evolution installed but not mu/mu4e) and bind it to a handy keybinding. Since I don't close the parenthesis of the ~use-package~ everything that follows this source code blocks is part of the config section. + +#+begin_src emacs-lisp +(use-package mu4e + :if (executable-find "mu") + :load-path (lambda () (list (mmk2410/mu4e-load-path))) + :demand t + :bind ("C-c m" . mu4e) + :config ;; final closing parens at th end of the file +#+end_src + +Once it is loaded I'd like to set mu4e as my default mail program in Emacs. + +#+begin_src emacs-lisp +(setq mail-user-agent 'mu4e-user-agent) +#+end_src + +** Fetching new mail + +I use mbsync for synchronising my messages and prefer that I can trigger the refresh from mu4e. Normally I use a [[https://git.mmk2410.org/mmk2410/dotfiles/src/branch/main/systemd][SystemD user service and timer]] for running mbsync every five minutes. + +Apparently mbsync requires a filename change, when moving mails. + +#+begin_src emacs-lisp +(setq mu4e-get-mail-command "mbsync -a" + mu4e-change-filenames-when-moving t) +#+end_src + +** Header view customizations + +I'd like to use the IS-8601 date format. + +#+begin_src emacs-lisp +(setq mu4e-headers-date-format "%Y-%m-%d %H:%M") +#+end_src + +For settings my header fields, I want to define a custom header field, which shows just an excerpt of my maildir path. My paths -- created by mbsync -- begin with the account name, which I want to shorten to just one letter. Since I archive my mail but let mu4e show me related mails, I want also to shorten the "Archive" path to "A". So the maildir path my be a short as e.g "m/INBOX" or "m/A". + +#+begin_src emacs-lisp +(add-to-list 'mu4e-header-info-custom + '(:mdir . + ( :name "Shortend Maildir path" + :shortname "Maildir" + :help "Shows a collapsed maildir path" + :function (lambda (msg) + (let ((maildir (or (mu4e-message-field msg :maildir) ""))) + (cond ((string-match-p "Archives/" maildir) + (replace-regexp-in-string "^/\\(.\\).*/\\(.\\).*/\\(.*\\)" "\\1/\\2/\\3" maildir)) + ((string-match-p "Archives" maildir) + (replace-regexp-in-string "^/\\(.\\).*/\\(.\\).*" "\\1/\\2" maildir)) + (t + (replace-regexp-in-string "^/\\(.\\).*/\\(.*\\)" "\\1/\\2" maildir)))))))) + +#+end_src + +I want to use the IMO improved =:from-or-to= header field instead of only a =:from=. Next to that I prefer to show the subject in a thread only once for a cleaner overview. + +#+begin_src emacs-lisp +(setq mu4e-headers-fields + '((:human-date . 16) + (:flags . 4) + (:mdir . 12) + (:mailing-list . 10) + (:from-or-to . 22) + (:thread-subject))) +#+end_src + +Additionally I prefer to change the sorting directory so that older messages are displayed on top. Since I try to keep an empty inbox and either reply to mails instantly or create a todo from them handling "old" mails should one the one hand be rare and on the other hand much more urgent. Actually I want them to distract and annoy me so that I handle them sooner than later. + +#+begin_src emacs-lisp +(setq mu4e-headers-sort-direction 'ascending) +#+end_src + +As already said, I like to archive my mail and have as few mailboxes as possible. Since I get some mails over different addresses and in different mailboxes mu4e displays only one and doesn't show the duplicate. So when I mark the message I see for archiving and refresh the list while applying the mark the then hidden duplicate is now shown and I have to mark that again for archiving. Since the mailbox is shown I also can tell which one to archive if necessary. That is why I disable the skipping of duplicates: + +#+begin_src emacs-lisp +(setq mu4e-headers-skip-duplicates nil) +#+end_src + +** Message view customizations + +By default mu4e jumps to the next message when pressing =SPC= at the end of a message. I explicitly do not want that behavior. + +#+begin_src emacs-lisp +(setq mu4e-view-scroll-to-next nil) +#+end_src + +I like to keep my Downloads folder quite empy and also download everything that I don't intent to keep to =/tmp=. + +#+begin_src emacs-lisp +(setq mu4e-attachment-dir "/tmp") +#+end_src + +The mu4e manual says, that viewing inline images may be not always correct. Let's try it anyway and find out how bad it really is. Additionally it is recommended, that =imagemagick-register-types= is called. + +#+begin_src emacs-lisp +(setq mu4e-view-show-images t) +(when (fboundp 'imagemagick-register-types) + (imagemagick-register-types)) +#+end_src + +I like to see the complete addresses and not just the name. + +#+begin_src emacs-lisp +(setq mu4e-view-show-addresses t) +#+end_src + +** Compose messages + +I prefer to BCC myself in mail so I now that a message was handled by the mail server and thereby I can also put all mails of a thread in the same folder which makes searching a bit easier. So I let mu4e automatically set the BCC header when I start to compose a message. + +#+begin_src emacs-lisp +(add-hook 'mu4e-compose-mode-hook + (lambda () + (save-excursion + (message-add-header (concat "Bcc: " user-mail-address "\n"))))) +#+end_src + +Since I get the emails via the BCC it is useless to also put them in a send folder. + +#+begin_src emacs-lisp +(setq mu4e-sent-messages-behavior 'delete) +#+end_src + +Don't keep "zombie" buffers around after sending a mail. + +#+begin_src emacs-lisp +(setq message-kill-buffer-on-exit t) +#+end_src + +Also don't reply to myself in case a "reply to all". + +#+begin_src emacs-lisp +(setq mu4e-compose-dont-reply-to-self t) +#+end_src + +I'd like to send my messages as flowed format. + +#+begin_src emacs-lisp +(setq mu4e-compose-format-flowed t) +#+end_src + +I like a "special" citation line... + +#+begin_src emacs-lisp +(setq message-citation-line-format "%f @ %Y-%m-%d %T %Z:\n" + message-citation-line-function 'message-insert-formatted-citation-line) +#+end_src + +** Sending mail + +Since I already have a msmtp client configured and would also use it in case I would use mutt, I want to use it also in mu4e. Setting msmtp as default SMTP client is quite easy but is it a little bit harder to set the account that should be used for sending. Therefore I wrote a lambda function that chooses the account and passes it as extra arguments based on the senders email address. + +#+begin_src emacs-lisp +(setq message-send-mail-function 'message-send-mail-with-sendmail + sendmail-program "msmtp" + message-sendmail-envelope-from 'header) +(add-hook 'message-send-mail-hook + (lambda () + (save-excursion + (let* ((from (save-restriction + (message-narrow-to-headers) + (message-fetch-field "from"))) + (account (cond + ((string-match "@uni-ulm.de" from) "uniulm") + (t "mailbox")))) + (setq message-sendmail-extra-arguments (list '"-a" account)))))) +#+end_src + +** Define custom bookmarks + +I don't really like the default bookmarks that mu4e sets. Thats why I overwrite the =mu4e-bookmarks= variable completely instead of just appending new bookmarks. + +#+begin_src emacs-lisp +(setq mu4e-bookmarks + '(( :name "Unread messages" + :key ?u + :query "flag:unread or m:/university/inbox or m:/university/uulmhack or m:/mailbox/inbox" ) + ( :name "Unread university messages" + :key ?e + :query "(flag:unread and m:/university/*) or m:/university/inbox or m:/university/uulmhack" ) + ( :name "Unread private messages" + :key ?p + :query "(flag:unread and m:/mailbox/*) or m:/mailbox/inbox" ))) +#+end_src + +** Define some shortcuts + +I like to get to some maildir quite fast and with a shortcut. + +#+begin_src emacs-lisp +(setq mu4e-maildir-shortcuts + '((:maildir "/university/inbox" :key ?e) + (:maildir "/mailbox/inbox" :key ?p))) +#+end_src + +** Org-Capture template and key bindings + +I use org-mode heavily and also manage my todos within it. Since my INBOX is not a todo list I like the idea of quickly add a mail as a todo. + +#+begin_src emacs-lisp +(add-to-list 'org-capture-templates + '("m" "mail" entry (file "~/org/inbox.org") + "* TODO %a%?\n :PROPERTIES:\n :CREATED: %U\n :END:\n")) +#+end_src + +** mu4e-contexts + +Multiple mail accounts in mu4e can be achieved by using so called contexts. + +First of all I like mu4e to only ask me, which content to use, if it can't figure it you. + +#+begin_src emacs-lisp +(setq mu4e-context-policy 'ask + mu4e-compose-context-policy 'ask) +#+end_src + +Now define the contexts. + +#+begin_src emacs-lisp +(setq mu4e-contexts + `( ,(make-mu4e-context + :name "Private" + :enter-func (lambda () (mu4e-message "Entering Private context")) + :match-func (lambda (msg) + (when msg + (string-prefix-p "/mailbox" (mu4e-message-field msg :maildir)))) + :vars '( ( user-mail-address . "me@mmk2410.org" ) + ( user-full-name . "Marcel Kapfer" ) + ( message-signature-file . nil) + ( mu4e-sent-folder . "/mailbox/Sent" ) + ( mu4e-drafts-folder . "/mailbox/Drafts" ) + ( mu4e-trash-folder . "/mailbox/Trash" ) + ( mu4e-refile-folder . "/mailbox/Archives" ))) + ,(make-mu4e-context + :name "uulmhack" + :enter-func (lambda () (mu4e-message "Entering uulmhack context")) + :match-func (lambda (msg) + (when msg + (or (string-prefix-p "/university/uulmhack" (mu4e-message-field msg :maildir)) + (string-prefix-p "/university/Archives/uulmhack" (mu4e-message-field msg :maildir))))) + :vars '( ( user-mail-address . "uulmhack@uni-ulm.de" ) + ( user-full-name . "uulmhack Orga-Team" ) + ( message-signature-file . "~/dotfiles/dotdotfiles/sig/uulmhack") + ( mu4e-sent-folder . "/university/Sent" ) + ( mu4e-drafts-folder . "/university/Drafts" ) + ( mu4e-trash-folder . "/university/Trash" ) + ( mu4e-refile-folder . "/university/Archives/uulmhack" ))) + ,(make-mu4e-context + :name "Education" + :enter-func (lambda () (mu4e-message "Entering education context")) + :match-func (lambda (msg) + (when msg + (string-prefix-p "/university" (mu4e-message-field msg :maildir)))) + :vars '( ( user-mail-address . "marcel.kapfer@uni-ulm.de" ) + ( user-full-name . "Marcel Kapfer" ) + ( message-signature-file . nil) + ( mu4e-sent-folder . "/university/Sent" ) + ( mu4e-drafts-folder . "/university/Drafts" ) + ( mu4e-trash-folder . "/university/Trash" ) + ( mu4e-refile-folder . "/university/Archives" ))))) +#+end_src + +** Other settings + +Mu4e displays a message in the minibuffer after refreshing. And since I run mbsync and mu index (through emacsclient) automatically every few minutes these messages can get quite distracting. Luckily mu4e provides an option to disable these index messages. + +#+begin_src emacs-lisp +(setq mu4e-hide-index-messages t) +#+end_src + +Mu4e show its current search in the modeline and as you may have already noticed, my default searches tend to be large. So I increase the shown characters from 30 to 60. + +#+begin_src emacs-lisp +(setq mu4e-modeline-max-width 60) +#+end_src + +It is maybe not surprising that I am subscribed to some mailing lists. Some of these have quite some long names and so I would like to use a some alias for the display of these names. Thanks god mu4e also provides a possibility for this! + +#+begin_src emacs-lisp +(setq mu4e-user-mailing-lists '(("debian-user.lists.debian.org" . "DebUsr") + ("debian-security-announce.lists.debian.org" . "DebSecAnn"))) +#+end_src + +Finally the mu4e configuration is done! So lets close the parenthesis left open since the ~use-package~ call. + +#+begin_src emacs-lisp +) ;; closing parens for (use-package mu4e +#+end_src + +* Email with Evolution + +Since my work place is using Microsoft Outlook for Email including its appointment features I sadly needed to switch away from mu4e to Evolution, as recommended by [[https://karl-voit.at/2021/06/01/Thunderbird-to-Evolution/][Karl Voit]]. Using [[https://github.com/novoid/dot-emacs/blob/master/config.org][his configuration]] as an inspiration and source I could setup the following workflow. + +I first define the path to my evolution binary. + +#+begin_src emacs-lisp +(setq mmk2410/evolution-path "/usr/bin/evolution") +#+end_src + +Then I copied and slightly adjusted Karl Voits function for handling =message-id= link in Org mode. + +#+begin_src emacs-lisp +(defun mmk2410/open-message-id-in-evolution (message-id) + (interactive) + (start-process + (concat "mid: " message-id) + nil + mmk2410/evolution-path + (concat "mid:<" message-id ">"))) + +(org-link-set-parameters "messageid" :follow #'mmk2410/open-message-id-in-evolution) +#+end_src + +The following function from him takes care of the other way: bringing a message as a link into Org mode. + +#+begin_src emacs-lisp +(defun mmk2410/convert-mail-header-to-org-link () + "Assumes an email header in the killring, parses it and returns an org mode link for it." + (interactive) + (with-temp-buffer + (save-match-data + (yank) + + (goto-char (point-min)) + (re-search-forward "^Message-Id:.+<\\(.+\\)>[ ]*$" nil nil 1) + (setq message-id (match-string 1)) + + (goto-char (point-min)) + (re-search-forward "^From:[ ]+\\(.+?\\)[ ]*$" nil nil 1) + (setq from (match-string 1)) + + (goto-char (point-min)) + (re-search-forward "^Subject:[ ]+\\(.+?\\)[ ]*$" nil nil 1) + (setq subject (match-string 1)) + + (goto-char (point-min)) + (re-search-forward "^Date:[ ]+\\(.+?\\)[ ]*$" nil nil 1) + (setq rawdate (match-string 1)) + (setq date + (let ((time (date-to-time rawdate))) + (set-time-zone-rule t) + (prog1 (format-time-string "%Y-%m-%d %H:%M" time) + (set-time-zone-rule nil)))))) + (insert (concat "[[messageid:" message-id "][" date " " from ": " subject "]]"))) + +(global-set-key (kbd "C-c M-m") 'mmk2410/convert-mail-header-to-org-link) +#+end_src + +* Helpers +** Tab Bar Setup + +Since version 27 Emacs features a tab bar. In contrast to e.g. a browser a tab does not display just one file/buffer/window but an Emacs tab features an entire window configuration. Since I use Emacs not just for programming but (perhaps even mainly) for personal information management (including mail, agenda, journal, IRC and RSS) I had the idea to have one Emacs frame open with different tabs for all these things. Therefore I wrote a ~mmk2410/tab-bar-setup~ function (bound to =C-c f C-f=) creating the following setup: + +- First tab: *Mail* with mu4e +- Second tab: *Agenda / Journal* with an Org agenda on the left and an Org journal on the right +- Third tab: *IRC* with ERC +- Fourth tab: *RSS* with elfeed + +This is accompanied with five helper functions to switch to the wished application in the correct tab and window. + +|------------+-----------------------------------+------------| +| *Applicaton* | *Command* | *Keybinding* | +| Mail | ~mmk2410/tab-bar-switch-to-mail~ | =C-c f m= | +| Agenda | ~mmk2410/tab-bar-switch-to-agenda~ | =C-c f a= | +| Journal | ~mmk2410/tab-bar-switch-to-journal~ | =C-c f j= | +| IRC | ~mmk2410/tab-bar-switch-to-irc~ | =C-c f i= | +| RSS | ~mmk2410/tab-bar-switch-to-rss~ | =C-c f r= | +|------------+-----------------------------------+------------| + +#+begin_src emacs-lisp +(defun mmk2410/tab-bar-setup () + "Enable tab bar and setup mu4e, Org Journal, Org Agenda and ERC." + (interactive) + (tab-bar-mode 1) + ;; Disabled since I'm currently not using mu4e that much (see Evolution Mail and mu4e setup). + ;; (tab-bar-rename-tab "Mail") + ;; (mu4e-context-switch :name "Private") + ;; (mu4e) + ;; (sit-for 1) + ;; (tab-bar-new-tab) + (tab-bar-rename-tab "Agenda / Journal") + (split-window-horizontally) + (org-agenda nil "c") + (sit-for 1) + (other-window 1) + (org-journal-open-current-journal-file) + (sit-for 1) + (tab-bar-new-tab) + (tab-bar-rename-tab "IRC") + (mmk2410/erc-connect) + (sit-for 1) + (switch-to-buffer "Libera.Chat") + (tab-bar-new-tab) + (tab-bar-rename-tab "RSS") + (elfeed)) + +(defun mmk2410/tab-bar-switch-to-mail () + "Switch to mail tab." + (interactive) + (tab-bar-switch-to-tab "Mail")) + +(defun mmk2410/tab-bar-switch-to-agenda () + "Switch to agenda/journal tab and there in the agenda window." + (interactive) + (tab-bar-switch-to-tab "Agenda / Journal") + (unless (string= (buffer-name) "*Org Agenda*") + (other-window 1))) + +(defun mmk2410/tab-bar-switch-to-journal () + "Switch to agenda/journal tab and there in the journal window." + (interactive) + (tab-bar-switch-to-tab "Agenda / Journal") + (if (string= (buffer-name) "*Org Agenda*") + (other-window 1))) + +(defun mmk2410/tab-bar-switch-to-irc () + "Switch to IRC tab." + (interactive) + (tab-bar-switch-to-tab "IRC")) + +(defun mmk2410/tab-bar-switch-to-rss () + "Switch to RSS tab." + (interactive) + (tab-bar-switch-to-tab "RSS")) + +(global-set-key (kbd "C-c f C-f") 'mmk2410/tab-bar-setup) +(global-set-key (kbd "C-c f m") 'mmk2410/tab-bar-switch-to-mail) +(global-set-key (kbd "C-c f a") 'mmk2410/tab-bar-switch-to-agenda) +(global-set-key (kbd "C-c f j") 'mmk2410/tab-bar-switch-to-journal) +(global-set-key (kbd "C-c f i") 'mmk2410/tab-bar-switch-to-irc) +(global-set-key (kbd "C-c f r") 'mmk2410/tab-bar-switch-to-rss) +#+end_src diff --git a/emms/streams.emms b/emms/streams.emms new file mode 100644 index 0000000..3fa7882 --- /dev/null +++ b/emms/streams.emms @@ -0,0 +1,13 @@ +;;; This is an EMMS playlist file Play it with M-x emms-play-playlist +((*track* (type . streamlist) (name . "https://streams.br.de/bayern1schw_2.m3u") (metadata "Bayern 1 (Schwaben)" "https://streams.br.de/bayern1schw_2.m3u" 1 streamlist) (last-played 24380 61095 420172 603000) (play-count . 1) (info-title . "Bayern 1 (Schwaben)")) + (*track* (type . streamlist) (name . "https://streams.br.de/bayern2sued_2.m3u") (metadata "Bayern 2 (Süd)" "https://streams.br.de/bayern2sued_2.m3u" 1 streamlist) (last-played 24380 61177 432455 757000) (play-count . 2) (info-title . "Bayern 2 (Süd)")) + (*track* (type . streamlist) (name . "https://streams.br.de/bayern3_2.m3u") (metadata "Bayern 3" "https://streams.br.de/bayern3_2.m3u" 1 streamlist) (info-title . "Bayern 3")) + (*track* (type . streamlist) (name . "https://streams.br.de/br-klassik_3.m3u") (metadata "BR Klassik" "https://streams.br.de/br-klassik_3.m3u" 1 streamlist) (info-title . "BR Klassik")) + (*track* (type . streamlist) (name . "https://streams.br.de/b5aktuell_2.m3u") (metadata "B5 aktuell" "https://streams.br.de/b5aktuell_2.m3u" 1 streamlist) (info-title . "B5 aktuell")) + (*track* (type . streamlist) (name . "http://mp3-live.swr.de/swr1bw_m.m3u") (metadata "SWR 1 (BW)" "http://mp3-live.swr.de/swr1bw_m.m3u" 1 streamlist) (info-title . "SWR 1 (BW) ") (last-played 24380 61277 832539 839000) (play-count . 1)) + (*track* (type . streamlist) (name . "http://mp3-live.swr.de/swr2_m.m3u") (metadata "SWR 2" "http://mp3-live.swr.de/swr2_m.m3u" 1 streamlist) (last-played 24380 61282 6595 340000) (play-count . 1) (info-title . "SWR 2")) + (*track* (type . streamlist) (name . "http://mp3-live.swr3.de/swr3_m.m3u") (metadata "SWR 3" "http://mp3-live.swr3.de/swr3_m.m3u" 1 streamlist) (last-played 24380 61302 252207 517000) (play-count . 1) (info-title . "SWR 3")) + (*track* (type . streamlist) (name . "http://mp3-live.swr.de/swraktuell_m.m3u") (metadata "SWR 3" "http://mp3-live.swr.de/swraktuell_m.m3u" 1 streamlist) (last-played 24380 61312 907185 480000) (play-count . 1) (info-title . "SWR Aktuell")) + (*track* (type . streamlist) (name . "https://www.deutschlandradio.de/streaming/dlf.m3u") (metadata "Deutschlandfunk" "https://www.deutschlandradio.de/streaming/dlf.m3u" 1 streamlist) (last-played 24380 61323 853051 82000) (play-count . 1) (info-title . "Deutschlandfunk")) + (*track* (type . streamlist) (name . "https://www.deutschlandradio.de/streaming/dkultur.m3u") (metadata "Deutschlandfunk Kultur" "https://www.deutschlandradio.de/streaming/dkultur.m3u" 1 streamlist) (info-title . "Deutschlandfunk Kultur")) + (*track* (type . streamlist) (name . "https://st03.sslstream.dlf.de/dlf/03/128/mp3/stream.mp3") (metadata "Deutschlandfunk Nova" "https://st03.sslstream.dlf.de/dlf/03/128/mp3/stream.mp3" 1 streamlist) (info-title . "Deutschlandfunk Nova"))) diff --git a/init.el b/init.el new file mode 100644 index 0000000..ff6904d --- /dev/null +++ b/init.el @@ -0,0 +1,47 @@ +;;; init.el --- My personal Emacs configuration + +;; Source: https://gitlab.com/mmk2410/dot-emacs +;; Authors: Marcel Kapfer +;; Created: 2020-02-03 19:26 +;; License: This file is licensed under the GPLv3 License + +;; This file only loads and evaluates my Emacs configuration +;; kept in config.org using Org Babel. +;; And it counts startup time. + +;; Little welcome message +(message "Welcome to Emacs, starting now up.") + +;; Save the time when init.el was started. +(defvar mmk2410/init-el-start-time (current-time)) + +;; Enable package management. +(package-initialize) + +;; First add the required package archives and initialize it. +(add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t) + +;; Configure package management basics. +;; Prefer newer packages. +(setq-default load-prefer-newer t) +;; Don't load packages automatically on startup. +(setq-default package-enable-at-startup nil) + +;; Install / enable use-package for handling following dependencies. +(unless (package-installed-p 'use-package) + (package-refresh-contents) + (package-install 'use-package)) +(require 'use-package) + +;; Always ensure that packages are installed on the current system. +(setq use-package-always-ensure t) + +;; Use/load latest Org mode +(use-package org + :pin gnu) + +;; Load config.org file with org-babel +(org-babel-load-file (expand-file-name "config.org" user-emacs-directory)) + +;; Message the total startup time +(message "Total init.el load time: %.2fs" (float-time (time-subtract (current-time) mmk2410/init-el-start-time))) diff --git a/lisp/moinmoin-mode/moinmoin-mode.el b/lisp/moinmoin-mode/moinmoin-mode.el new file mode 100644 index 0000000..acea6c6 --- /dev/null +++ b/lisp/moinmoin-mode/moinmoin-mode.el @@ -0,0 +1,589 @@ +;;; Use raw text to fetch this code, see EmacsForMoinMoin for tutorial and discussion. + +;;; Download link: http://moinmo.in/EmacsForMoinMoin/MoinMoinMode?action=raw + +;;; moinmoin-mode.el --- a major mode to edit MoinMoin wiki pages + +;; Written by ASK, distributed under GPL + +;; Filename: moinmoin-mode.el +;; Keywords: moinmoin, wiki +;; Description: a major mode to edit MoinMoin wiki pages +;; Compatibility: GNU Emacs 22.0.50.1 (probably others) +;; Last modified: 2006-04-15 + +;; This file is NOT part of GNU Emacs. + +;;; Definition of font faces +(defgroup moinmoin nil + "Major mode for MoinMoin wiki pages" + :prefix "moinmoin-") + +(defface moinmoin-h5 '((t (:foreground "tan3" :slant italic))) + "Face name to use for 5-level headings in moinmoin" + :group 'moinmoin) +(defface moinmoin-h4 '((t (:inherit moinmoin-h5 :slant normal :foreground "tan4"))) + "Face name to use for 4-level headings in moinmoin" + :group 'moinmoin) +(defface moinmoin-h3 '((t (:inherit moinmoin-h4 :weight bold))) + "Face name to use for 3-level headings in moinmoin" + :group 'moinmoin) +(defface moinmoin-h2 '((t (:inherit moinmoin-h3 :height 1.2))) + "Face name to use for 3-level headings in moinmoin" + :group 'moinmoin) +(defface moinmoin-h1 '((t (:inherit moinmoin-h2 :height 1.4))) + "Face name to use for 3-level headings in moinmoin" + :group 'moinmoin) + +(defface moinmoin-smiley '((t (:foreground "green4" :weight bold))) + "Face name to use smileys in moinmoin" + :group 'moinmoin) + +(defface moinmoin-table-separator '((t (:foreground "salmon" :weight bold))) + "Face name to use for separation of columns in tables of moinmoin" + :group 'moinmoin) +(defface moinmoin-table-pi '((t (:foreground "plum3"))) + "Face name to use for processing instructions in tables of moinmoin" + :group 'moinmoin) + +(defface moinmoin-anchor '((t (:foreground "tan3" :height 0.8))) + "Face name to use for anchors (targets) in moinmoin" + :group 'moinmoin) +(defface moinmoin-anchor-ref-id '((t (:foreground "blue2" :height 0.8 :underline t))) + "Face name to use for id in anchor reference in moinmoin" + :group 'moinmoin) +(defface moinmoin-anchor-ref-title '((t (:foreground "blue4" :underline t))) + "Face name to use for title in anchors reference in moinmoin" + :group 'moinmoin) + +(defface moinmoin-macro-name '((t (:foreground "plum3"))) + "Face name to use for names of macros in moinmoin" + :group 'moinmoin) +(defface moinmoin-macro-parameters '((t (:foreground "plum4"))) + "Face name to use for parameters of macros in moinmoin" + :group 'moinmoin) + +(defface moinmoin-item '((t (:foreground "brown" :weight bold))) + "Face name to use for items in lists in moinmoin" + :group 'moinmoin) +(defface moinmoin-item-2 '((t (:foreground "brown"))) + "Face name to use for second-level items in moinmoin" + :group 'moinmoin) +(defface moinmoin-blockquote-indent '((t (:background "aquamarine1"))) + "Face name to use for blockquote indentation in moinmoin" + :group 'moinmoin) +(defface moinmoin-blockquote-text '((t (:foreground "aquamarine4"))) + "Face name to use for blockquote text in moinmoin" + :group 'moinmoin) + +(defface moinmoin-code '((t (:foreground "purple4"))) + "Face name to use for code inside braces in moinmoin" + :group 'moinmoin) +(defface moinmoin-code-braces '((t (:foreground "plum3"))) + "Face name to use for baces which delimit code inside braces in moinmoin" + :group 'moinmoin) + +(defface moinmoin-pi '((t (:foreground "plum3" :weight bold))) + "Face name to use for processing instructions in moinmoin" + :group 'moinmoin) +(defface moinmoin-comment '((t (:foreground "maroon3"))) + "Face name to use for comments in moinmoin" + :group 'moinmoin) +(defface moinmoin-rule '((t (:foreground "tomato2" :weight bold))) + "Face name to use for rules in moinmoin" + :group 'moinmoin) +(defface moinmoin-ss '((t (:foreground "grey" ))) ;; try also :height 0.1 + "Face name to use for syntactic sugar in moinmoin" + :group 'moinmoin) +(defface moinmoin-tt '((t (:foreground "cyan4"))) + "Face name to use for typewriter text in moinmoin" + :group 'moinmoin) +(defface moinmoin-entity '((t (:foreground "grey"))) + "Face name to use for HTML entities in moinmoin" + :group 'moinmoin) +(defface moinmoin-email '((t (:foreground "blue2"))) + "Face name to use for emails in moinmoin" + :group 'moinmoin) +(defface moinmoin-url '((t (:foreground "blue2" :height 0.8))) + "Face name to use for URLs in moinmoin" + :group 'moinmoin) +(defface moinmoin-url-title '((t (:foreground "blue4" :underline t))) + "Face name to use for title of URL in moinmoin" + :group 'moinmoin) +(defface moinmoin-wiki-link '((t (:foreground "blue4" :weight bold))) + "Face name to use for CamelCase links in moinmoin" + :group 'moinmoin) +(defface moinmoin-inter-wiki-link '((t (:foreground "blue3" :weight bold))) + "Face name to use for inter wiki links in moinmoin" + :group 'moinmoin) +(defface moinmoin-bold '((t (:weight bold))) + "Face name to use for bold text in moinmoin" + :group 'moinmoin) +(defface moinmoin-italic '((t (:slant italic))) + "Face name to use for italic text in moinmoin" + :group 'moinmoin) +(defface moinmoin-underline '((t (:underline t))) + "Face name to use for underlined text in moinmoin" + :group 'moinmoin) +(defface moinmoin-stroke '((t (:strike-through t))) + "Face name to use for stroked text in moinmoin" + :group 'moinmoin) +(defface moinmoin-subscript '((t (:height 0.8))) + "Face name to use for subscripts in moinmoin" + :group 'moinmoin) +(defface moinmoin-superscript '((t (:height 0.8))) + "Face name to use for superscripts in moinmoin" + :group 'moinmoin) + + + +;;; Font lock setup +(defconst moinmoin-url-prefix + "\\(?:http\\|https\\|ftp\\|nntp\\|news\\|mailto\\|telnet\\|wiki\\|file\\|irc\\|attachment\\|inline\\|drawing\\)" + "Bracketed regexp matching URL prefixes in moinmoin") +(defconst moinmoin-url-punctuation + "]\"'}|:,.)?!" ; start with ] + "Punctuation in URLs of moinmoin") +(defconst moinmoin-pi-re + "^#\\(?:format\\|refresh\\|redirect\\|deprecated\\|pragma\\|form\\|acl\\|language\\).*$" + "Regexp for processing instructions in moinmoin") +(defconst moinmoin-smiley-re + "\\(?:<:(\\|X-(\\|:)\\|:-))\\|:(\\|/!\\\\\\|{X}\\|{OK}\\|B-)\\|{2}\\|>:>\\|;-)\\|\\|:o\\||-)\\|;)\\||)\\|(!)\\|:-(\\|:-)\\|{o}\\|:D\\|(./)\\|B)\\|{*}\\|:\\\|:-?\\|{i}\\|{3}\\|{1}\\|:)\\)" + "Regexp for smileys in moinmoin") + +(defun moinmoin-formatted-code-matcher (bound) + "Search for formatted code +This is supposed to be bug-to-bug compatible with moinmoin-1.5.2" + (catch 'match + (while (< (point) bound) + (unless (search-forward-regexp "{{{" bound t) + (throw 'match nil)) + (let ((start-brace-begin (match-beginning 0)) + (start-brace-end (match-end 0)) + pi-begin pi-end + code-begin code-end + end-brace-begin end-brace-end) + (unless (get-text-property start-brace-begin 'moinmoin-verbatim) + (goto-char start-brace-end) + (if (looking-at "#!.*\n") + (setq pi-begin (match-beginning 0) + pi-end (match-end 0) + code-begin (match-end 0)) + (setq code-begin start-brace-end)) + (goto-char code-begin) + (let ((not-first-line)) + (while (looking-at + "\\(?:##.*\\|`.*?`\\|{{{.*?}}}\\|.\\)*?\\(?:\\(}}}\\)\\|\n\\)") + (goto-char (match-end 0)) + (when (and (match-beginning 1) ; non-paired `}}}' + not-first-line) + (setq code-end (match-beginning 1) + end-brace-begin (match-beginning 1) + end-brace-end (match-end 1)) + (set-match-data (list start-brace-begin end-brace-end + start-brace-begin start-brace-end + pi-begin pi-end + code-begin code-end + end-brace-begin end-brace-end)) + (throw 'match t)) + (setq not-first-line t))) + (throw 'match nil)))))) + + +(defun moinmoin-bracketed-url-matcher (bound) + "Search for bracketed URLs" + (catch 'match + (while (< (point) bound) + (unless (search-forward-regexp + (concat "\\(\\[\\)" + "\\(" moinmoin-url-prefix "?:.*?\\) +" + "\\(.*?\\)?" + "\\(\\]\\)") bound t) + (throw 'match nil)) + (unless (get-text-property (match-beginning 0) 'moinmoin-verbatim) + (throw 'match t))))) + +(defun moinmoin-setup-font-lock () + (setq font-lock-beginning-of-syntax-function '(lambda () (goto-char 1))) + (setq font-lock-multiline t) + (make-local-variable 'font-lock-extra-managed-props) + (add-to-list 'font-lock-extra-managed-props 'moinmoin-verbatim) ; Not Comment Start + (add-to-list 'font-lock-extra-managed-props 'display) + (font-lock-add-keywords nil `( + ("\\(?:^\\|[^|]\\)\\(\\(?:||\\)+\\)\\(<.*?>\\)?" + (1 'moinmoin-table-separator) + (2 'moinmoin-table-pi t t)) + ("'''\\(.*?\\)'''" (1 'moinmoin-bold prepend)) + ("\\(?:[^']\\|^\\)''\\([^'].*?[^']\\)''[^']" (1 'moinmoin-italic prepend)) + ("\\(__\\)\\(.*?\\)\\(__\\)" + (1 'moinmoin-ss t) (2 'moinmoin-underline prepend) (3 'moinmoin-ss t)) + ("\\(--(\\)\\(.*?\\)\\()--\\)" + (1 'moinmoin-ss t) (2 'moinmoin-stroke prepend) (3 'moinmoin-ss t)) + ("\\(,,\\)\\(.*?\\)\\(,,\\)" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-subscript 'display '(raise -0.3)) prepend) + (3 'moinmoin-ss t)) + ("\\(\\^\\)\\(.*?\\)\\(\\^\\)" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-superscript 'display '(raise 0.3)) prepend) + (3 'moinmoin-ss t)) + ("''+" (0 'moinmoin-ss t)) + ("^ +\\(?:\\*\\|.*?::\\|\\(?:[0-9]+\\|[aAiI]\\)\\.\\) " + (0 'moinmoin-item-2)) + ("^ \\(?:\\*\\|.*?::\\|\\(?:[0-9]+\\|[aAiI]\\)\\.\\) " + (0 'moinmoin-item)) + ("^\\( +\\)\\(.*\\)" + (1 'moinmoin-blockquote-indent) + (2 'moinmoin-blockquote-text)) + ("&[A-Za-z0-9]*;" (0 'moinmoin-entity prepend)) + (,(concat "\\(?:^\\| \\)\\(" moinmoin-smiley-re "\\)[[:space:]]") + (1 'moinmoin-smiley t)) + ("\\(?:^\\|[^A-Za-z!]\\)\\(\\(?:\\.\\./\\)?/?[A-Z][a-z]+[A-Z][a-z][A-Za-z]*\\(?:/[A-Z][a-z]+[A-Z][a-z][A-Za-z]*\\)?\\)" + (1 'moinmoin-wiki-link t)) + (,(concat "[A-Z][A-Za-z]+:" + "[^[:space:]'\":<|]" + "\\(?:[^" moinmoin-url-punctuation "[:space:]]\\|" + "[" moinmoin-url-punctuation "]" + "[^" moinmoin-url-punctuation "[:space:]]\\)+") + (0 'moinmoin-inter-wiki-link t)) + ("\\(\\[\"\\)\\(?:\\(.*?:.*\\)\\|\\(.*?\\)\\)\\(\"\\]\\)" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-inter-wiki-link 'moinmoin-verbatim t) t t) + (3 (list 'face 'moinmoin-wiki-link 'moinmoin-verbatim t) t t) + (4 'moinmoin-ss t)) + ;;ur'%(url_guard)s(%(url)s)\:([^\s\<%(punct)s]|([%(punct)s][^\s\<%(punct)s]))+' + (,(concat "\\<" moinmoin-url-prefix ":" + "\\(?:[^" moinmoin-url-punctuation "<[:space:]]\\|" + "[" moinmoin-url-punctuation "]" + "[^" moinmoin-url-punctuation "<[:space:]]\\)+") + (0 'moinmoin-url t)) + ("[A-Za-z0-9_+-]+@[A-Za-z0-9_-]+\\(?:\\.[A-Za-z0-9_-]+\\)+" + (0 'moinmoin-email t)) + ("-\\{4,\\}" (0 'moinmoin-rule t)) + ;; macros + ("\\(\\[\\[\\)\\([A-Za-z0-9]+\\)\\(?:\\((\\)\\(.*?\\)\\()\\)\\)?\\(\\]\\]\\)" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-macro-name 'moinmoin-verbatim t) t) + (3 'moinmoin-ss t t) + (4 (list 'face 'moinmoin-macro-parameters 'moinmoin-verbatim t) t t) + (5 'moinmoin-ss t t) + (6 'moinmoin-ss t)) + ("\\(\\[\\[Anchor(\\)\\(.*?\\)\\()\\]\\]\\)" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-anchor 'moinmoin-verbatim t) t) + (3 'moinmoin-ss t)) + ("\\(\\[#\\)\\(.*?\\) +\\(.*?\\)?\\(\\]\\)" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-anchor-ref-id 'moinmoin-verbatim t) t) + (3 (list 'face 'moinmoin-anchor-ref-title 'moinmoin-verbatim t) t t) + (4 (list 'face 'moinmoin-ss 'moinmoin-verbatim t) t)) + ;; typewriter (tt) overrides the above + ("\\({{{\\)\\(.*?\\)\\(}}}\\)" + (1 (list 'face 'moinmoin-ss 'moinmoin-verbatim t) keep) + (2 (list 'face 'moinmoin-tt 'moinmoin-verbatim t) t) + (3 (list 'face 'moinmoin-ss 'moinmoin-verbatim t) keep)) + ("\\(`\\)\\(.*?\\)\\(`\\)" + (1 'moinmoin-ss keep) ; cannot match `{{{' thus no need for ncs + (2 (list 'face 'moinmoin-tt 'moinmoin-verbatim t) t) + (3 'moinmoin-ss keep)) + ;; headers overrides tt and biu + ("^\\(= \\)\\(.*\\)\\( =\\)$" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-h1 'moinmoin-verbatim t) t) + (3 'moinmoin-ss t)) + ("^\\(== \\)\\(.*\\)\\( ==\\)$" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-h2 'moinmoin-verbatim t) t) + (3 'moinmoin-ss t)) + ("^\\(=== \\)\\(.*\\)\\( ===\\)$" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-h3 'moinmoin-verbatim t) t) + (3 'moinmoin-ss t)) + ("^\\(==== \\)\\(.*\\)\\( ====\\)$" + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-h4 'moinmoin-verbatim t) t) + (3 'moinmoin-ss t)) + ("^\\(=====\\(=*\\) \\)\\(.*\\)\\( \\2=====\\)$" ; 5th and all others + (1 'moinmoin-ss t) + (3 (list 'face 'moinmoin-h5 'moinmoin-verbatim t) t) + (4 'moinmoin-ss t)) + ;; comments and pi + ("^##.*$" + (0 (list 'face 'moinmoin-comment 'moinmoin-verbatim t) t)) + (,moinmoin-pi-re + (0 (list 'face 'moinmoin-pi 'moinmoin-verbatim t) t)) + (moinmoin-bracketed-url-matcher + (1 'moinmoin-ss t) + (2 (list 'face 'moinmoin-url 'moinmoin-verbatim t) t) + (3 (list 'face 'moinmoin-url-title 'moinmoin-verbatim t) t t) + (4 (list 'face 'moinmoin-ss 'moinmoin-verbatim t) t)) + (moinmoin-formatted-code-matcher + (1 (list 'face 'moinmoin-code-braces 'moinmoin-verbatim t) t) + (2 (list 'face 'moinmoin-pi 'moinmoin-verbatim t) t t) + (3 (list 'face 'moinmoin-code 'moinmoin-verbatim t) t) + (4 (list 'face 'moinmoin-code-braces 'moinmoin-verbatim t) t)) + ) 'set)) + + + +;;; Automagic typing helpers +(defun moinmoin-insert-quote () + "Convert double quote to HTML entity (“ or ”)" + (interactive) + (cond + ((or (get-text-property (point) 'moinmoin-verbatim) + (looking-back "\\[\\|= *\\|^\\(?:[^\"]*\"[^\"]*\"\\)*[^\"]*\"[^\"]*")) + (insert "\"")) + ((or (looking-back "[[:space:]]") (eq (point) 1)) + (insert "“")) + (t (insert "”")))) + +(defun moinmoin-insert-dash () + "Insert different types of dashes. +`----' and `-' stays unchanged +`--' is converted to `–' +`---' is converted to `—' +`)--' is not changed' +`<-' is converted to `←'" + (interactive) + (cond + ((get-text-property (point) 'moinmoin-verbatim) + (insert "-")) + ((looking-back "---\\|—") + (replace-match "----" t t)) + ((looking-back "--\\|–") + (replace-match "—" t t)) + ((looking-back ")-") + (replace-match ")--" t t)) + ((looking-back "<") + (replace-match "←" t t)) + ((looking-back "-") + (replace-match "–" t t)) + (t (insert "-")))) + +(defun moinmoin-insert-lparen () + "–( to --(" + (interactive) + (cond + ((get-text-property (point) 'moinmoin-verbatim) + (insert "(")) + ((looking-back "–") + (replace-match "--(" t t)) + (t (insert "(")))) + +(defun moinmoin-insert-greater-than () + "-> to →" + (interactive) + (cond + ((get-text-property (point) 'moinmoin-verbatim) + (insert ">")) + ((looking-back "-") + (replace-match "→" t t)) + (t (insert ">")))) + +(defun moinmoin-insert-item () + "Start new item or row +If current line starts with item prefix insert newline and the same +prefix in front of the rest of line. +If it is table then finish the line and add the new one" + (interactive) + (when (bolp) (backward-char)) + (cond + ((looking-back "^\\( *||\\).*") ; in a table + (let ((prefix (match-string 1))) + (end-of-line) + (looking-back "[^|]\\(|*\\)") + (replace-match "||" t t nil 1) + (insert "\n" prefix))) + ((looking-back "^\\( +\\(?:\\* \\|\\(?:[0-9]+\\|[aAiI]\\)\\. \\|\\)\\).*") + (let ((prefix (match-string 1))) + (insert "\n") + (insert prefix))))) + + + +;;; Header manipulation helpers +(defun moinmoin-is-header () + "Is point in a header line? +If yes the title is in \\1" + (save-excursion + (beginning-of-line) + (looking-at "=+ \\(.*\\) =+$"))) + +(defun moinmoin-increase-header-level () + "Add `=' in the beginning and end of current line" + (save-excursion + (beginning-of-line) (insert "=") + (end-of-line) (insert "="))) + +(defun moinmoin-decrease-header-level () + "Decrease level of the header +Warns if point in a top-level header or not in a header" + (save-excursion + (beginning-of-line) + (if (looking-at "=\\(=+ .* =+\\)=$") + (replace-match "\\1" t) + (warn "cannot decrease level")) + )) + +(defun moinmoin-change-header-level (increment) + "Increase or decrease level of header according to INCREMENT" + (interactive "r") + (if (eq increment 1) + (moinmoin-increase-header-level) + (moinmoin-decrease-header-level))) + +(defun moinmoin-change-header-levels-in-region (increment start end) + "Increase or decrease level of all headers in the region according to INCREMENT" + (interactive "p\nr") + (save-excursion + (goto-char start) + (while (progn + (when (moinmoin-is-header) + (moinmoin-change-header-level increment)) + (and (zerop (forward-line)) (< (point) end)))) + )) + +(defun moinmoin-insert-equal (increment) + "Do-what-I-mean with header level or insert `='. +With active region increase or decrease level of all headers in region. +On an empty line starts new header. +On a header line increase or decrease level. +Otherwise just insert `='" + (interactive "p") + (if mark-active + (progn + (moinmoin-change-header-levels-in-region + increment (region-beginning) (region-end)) + (setq deactivate-mark nil)) + (cond + ((looking-at "^$") + (insert "= =") + (backward-char 2)) + ((moinmoin-is-header) + (moinmoin-change-header-level increment)) + (t (insert "="))))) + + + +;;; Anchor insertion and navigation +(defun moinmoin-list-anchors () + "List anchors in the current buffer" + (let ((lst)) + (save-excursion + (goto-char 1) + (while (search-forward-regexp "\\[\\[Anchor(\\([^])\n]*\\))\\]\\]" nil t) + (setq lst (cons (match-string-no-properties 1) lst)))) + lst)) + +(defvar moinmoin-anchor-history "Minibuffer history of anchors") +(defun moinmoin-completing-read-anchor (prompt &optional require-match) + "Read non-empty anchor using complition of all the anchors in the current buffer" + (let ((anchor + (completing-read "Anchor: " (moinmoin-list-anchors) + nil require-match + nil moinmoin-anchor-history))) + (when (string-equal anchor "") + (error "Empty anchor")) + anchor)) + +(defun moinmoin-insert-number-sign (&optional no-title) + (interactive "P") + "After `[' insert a reference to anchor inputed using completition, +If no argument given also insert the title of the section which contains +the anchor." + (cond + ((and (looking-back "\\[") + (not (get-text-property (point) 'moinmoin-verbatim))) + (let* ((anchor (moinmoin-completing-read-anchor "Anchor: ")) + (title + (unless no-title + (condition-case nil + (moinmoin-get-anchored-header anchor) + (error (message "No header for anchor %s" anchor) nil))))) + (insert "#" anchor " ") + (if title + (insert title "]") + (insert "]") (backward-char)))) + (t ; not after "[" + (insert "#")))) + +(defun moinmoin-insert-anchor () + "Insert anchor (using the title if point is in a header)" + (interactive) + (cond + ((moinmoin-is-header) + (let ((anchor-name + (replace-regexp-in-string ; remove non-anchor symbols + "[^A-Za-z0-9]+" "-" + (match-string-no-properties 1) t t))) + (forward-line) + (insert "[[Anchor(" anchor-name ")]]\n"))) + (t + (insert "[[Anchor()]]") (backward-char 3)))) + +(defun moinmoin-anchor-read-or-ask (&optional prompt) + "DWIM to get anchor: read [#... ] on current line (before point) or ask user." + (cond + ((and + (search-backward + "[#" (save-excursion (beginning-of-line) (point)) t) + (looking-at "\\[#\\([^]\n ]+\\)")) + (match-string-no-properties 1)) + (t + (moinmoin-completing-read-anchor (or prompt "Anchor: ") t)))) + +(defun moinmoin-goto-anchor (&optional anchor) + "Go to anchor +If ANCHOR is nil (e.g., if called interactively) read reference +to it from the current line or ask user. So if there is an +anchor on the current line but you want to jump to something +different go to the beginning of the line first." + (interactive) + (unless anchor + (setq anchor (moinmoin-anchor-read-or-ask))) + (goto-char 1) + (search-forward (concat "[[Anchor(" anchor ")]]"))) + +(defun moinmoin-get-anchored-header (anchor) + "Get title of the section which contains ANCHOR" + (save-excursion + (moinmoin-goto-anchor anchor) + (search-backward-regexp "^=+ \\(.*\\) =+$" nil) + (match-string-no-properties 1))) + +(defun moinmoin-insert-anchored-header (&optional to-kill-ring) + "Insert title of the section which contains anchor, with prefix save it to kill-ring" + (interactive "P") + (let ((header (moinmoin-get-anchored-header nil))) + (if to-kill-ring + (kill-new header) + (insert header)))) + + + +;;; Setup +(define-derived-mode moinmoin-mode outline-mode "MoinMoin" + "Set major mode for editing MoinMoin pages" + (make-local-variable 'outline-regexp) + (setq outline-regexp "=+") + (make-local-variable 'outline-heading-end-regexp) + (setq outline-heading-end-regexp " =+\n") + (local-set-key "\"" 'moinmoin-insert-quote) + (local-set-key "-" 'moinmoin-insert-dash) + (local-set-key "(" 'moinmoin-insert-lparen) + (local-set-key ">" 'moinmoin-insert-greater-than) + (local-set-key "=" 'moinmoin-insert-equal) + (local-set-key "#" 'moinmoin-insert-number-sign) + (local-set-key (kbd "M-RET") 'moinmoin-insert-item) + (local-set-key (kbd "C-c a") 'moinmoin-insert-anchor) + (local-set-key (kbd "C-c g") 'moinmoin-goto-anchor) + (toggle-truncate-lines 0) ; do not truncate + (moinmoin-setup-font-lock) + (abbrev-mode 1) + (set-fill-column 65000) + (auto-fill-mode 0)) + +(add-to-list 'auto-mode-alist '("\\.wiki$" . moinmoin-mode)) + +(provide 'moinmoin-mode) diff --git a/org-protocol.desktop b/org-protocol.desktop new file mode 100644 index 0000000..9091c28 --- /dev/null +++ b/org-protocol.desktop @@ -0,0 +1,7 @@ +[Desktop Entry] +Name=org-protocol +Exec=emacsclient %u +Type=Application +Terminal=false +Categories=System; +MimeType=x-scheme-handler/org-protocol;