#+PROPERTY: header-args :tangle "./.emacs.el" :results output silent #+OPTIONS: toc:3 # LocalWords: YASnippet UTF defun PlantUML LanguageTool HELP's Eshell showeverything #+STARTUP: showeverything * README :PROPERTIES: :ID: org_gcr_2017-05-12_mara:3DBC61FF-D790-471A-904F-DABFB0DABA1F :END: Configure EMACS to for everything defined within this monolithic system. Sysop is likely to use this constantly. Start EMACS with this command: #+BEGIN_EXAMPLE emacs --debug-init --no-init-file --no-splash --background-color white --foreground-color black --vertical-scroll-bars --eval '(switch-to-buffer "*Messages*")' --name HLP-TEST --title HLP-TEST --load ~/src/help/.emacs.el & #+END_EXAMPLE EMACS values dynamic-scoping for now and in the future. EMACS values lexical-scoping in the future. There are pecuilar interactions between [[https://yoo2080.wordpress.com/2011/12/31/lexical-scoping-and-dynamic-scoping-in-emacs-lisp/][lexically and dynamically scope closures]] and [[https://yoo2080.wordpress.com/2013/08/14/invasion-of-special-variables-in-emacs-lisp/][special variables]]. With the future in mind, make the switch now. It is enabled with a non-nil buffer-local variable ~lexical-binding~. The variable is inserted only here because it loads each of the child configurations. Web. Never compile this. #+NAME: org_gcr_2017-05-12_mara_881EF8A4-92D9-452C-AACC-2A966497ABF6 #+BEGIN_SRC emacs-lisp :comments no ;; -*- lexical-binding: t; no-byte-compile: t; -*- #+END_SRC #+NAME: org_gcr_2017-05-12_mara_EE00DAED-88BD-4271-9CFE-34BDCEE68932 #+BEGIN_SRC emacs-lisp ;; Added by Package.el. This must come before configurations of ;; installed packages. Don't delete this line. If you don't want it, ;; just comment it out by adding a semicolon to the start of the line. ;; You may delete these explanatory comments. ;;(package-initialize) (load-file "~/src/help/.org-mode-contribute.emacs.el") #+END_SRC ** HELP Enables Literate Programming :PROPERTIES: :ID: org_gcr_2017-05-12_mara:73599C3B-39B0-4979-86C2-E4AC068AAC79 :END: *Setup* 1) [[http://orgmode.org/][Clone Org-Mode]] to =~/src/= 2) Go there. #+BEGIN_EXAMPLE cd ~/src/org-mode #+END_EXAMPLE 3) Build it 1) Without =Make=: [[http://orgmode.org/worg/org-hacks.html][Generating autoloads and Compiling Org without make]] 1) As of <2016-01-19 Tue> this means doing this: #+BEGIN_EXAMPLE emacs -batch -Q -L lisp -l ../mk/org-fixup -f org-make-autoloads #+END_EXAMPLE 2) With ~Make~ use ~make~. 4) [[https://github.com/punchagan/org2blog][Clone Org2Blog]] to =~/src/=. 5) [[https://github.com/jwiegley/use-package][Clone Use-Package]] to =~/src/=. 6) Install supporting software adding their exectuable location to the =PATH=. 1) Install [[https://www.oracle.com/java/index.html][Oracle Java]]. 2) Install [[https://www.languagetool.org/][LanguageTool]] renaming it's folder to =LanguageTool=. 3) Install PlantUML. 4) Install Ditaa. 5) Install [[https://tug.org/mactex/][MacTeX]]. 7) Link: - The Eshell directory to HELP's. - =ln -s ~/src/help/eshell/ ~/.emacs.d/eshell= - The Initialization file to HELP's. - =ln -s ~/src/help/.emacs.el ~/.emacs.el= ** Style Guide :PROPERTIES: :ID: org_gcr_2017-05-12_mara:280391BE-63FC-4E2E-B734-AF18A449FA96 :END: - Appearance. - Never override theme colors. - When the theme doesn't configure a face then submit a patch. - Content - When importing update to conform with Style-Guide. - Keep tangled and weaved documents synchronized with their web. - Ask yourself: - Does it belong in this web? - Does it belong in this headline? - Dictionary - Exemple Complet Minimal (ECM) :: The minimal complete example of expected versus actual behavior. [[http://orgmode.org/worg/org-faq.html][Source]]. - Key-Bind :: A verb. The act of creating a Key Binding. - Literate Programming (LP) :: As Knuth intended. - Out of the Box (OOTB) :: The default configuration. - Sysop :: A proper noun. The System-Operator. The human operating this EMACS based Org-Mode enabled literate programming system. The reader. - Tangle :: A verb. Assemble a document for consumption by another program or machine. - Weave :: A verb. Prepare a document for consumption by a human. - Web :: A document contained Source-Block definitions that define a system. - Encoding - Prefer Unicode characters over ASCII equivalents. - Note eventual switch form PDFLaTeX to LuaTeX. - Consider Org-Mode automatic handling of ASCII to UTF-8 symbols. - File/Package Loading - Load every one with ~use-package~ whether it came with EMACS OOTB or ELPA. - ~ensure t~ tells the reader which one it came from. - Binding definitions often live in Piano Lessons. - Configurations aren't meant to be fully transplant-able because this system monolithic. In the interest of collaboration as much of the package configuration lives in the =use-package= block as possible. - Formatting - Code Snippet. - Key bindings - Programming language expressions - Variable names - Emacs mode function name, package name or Github name. This is the most technical name that you can and do use in scripts It is meant for computers. - ~org-mode~ - Class and Object names - Shell commands that are executable - Executable for programming language compilers and interpreters. To clarify these are either the executable names or the human names for example ~gcc versus ~C~. - ~gcc~ and ~python~ - ~bash~ and ~perl~ - ~scheme~ and ~java~ - =GCC= and =Python= - =Bash= and =Perl= - =Scheme= and =Java= - Anything that you would read program or text - Use ~code style~ of tildaes - Non-Code Snippet. - ALL PROPER NOUNS - File types - File names - Emacs mode name: THE HUMAN VERSION - Other stuff like function-name and package-name and Github name are not how humans write about them. Humans write about them like any other proper noun for example "Coca Cola" not "coca cola". - Org-Mode is the best example - Concepts like =Object Oriented Programming= or a =Immediately-invoked function expression= - Use =verbatim= style of equal sign - Package. - Same as Headline. - Dashes separate definition. - Acronyms are all upper case to distinguish from words for example "GNU" vs "Gnu". - Headline. - Be sure that every one has an =ID= property with a =UUID= value. - ~org-id-get-create~ does this. So does code in Hacking/Org Mode/Utility. - Capitalize: nouns, verbs, and adjectives. - Don't capitalize conjunctions unless they are starting the definition. - Sell this "chapter" to the reader. - Some headlines will be empty and significant; keep them. - Some modes don't require any configuration. The headline still needs to be present to remind the reader to keep it in her cognitive landscape. Configure other properties and modes taking it into account. - For every language under Hacking you should: - Only include it if it is valuable and you will invest adequate time to configure this well and use it well. When reading Org-Mode examples you will want to add Org-Mode language support because it is easy and fun and then you are left with an insufficiently configured environment. That is unacceptable. - Enable it in ~org-babel-load-languages~. - Read the user manual for it. - The =Prog-Mode= system configuration can result in Headlines that don't need any configuration. The Headline still communicates the mode's value to the reader even if it doesn't configure EMACS. - It is important to include headlines that are empty and that you may not even end up keeping. You need them to help you explore the cognitive landscape with them present. In this one case, premature optimization is /not/ the root of all evil. - Sometimes headlines might better be: - List items. - Stand-alone bold text without punctuation. - Hyperlink. - External. - Exclude those easily found with a search-engine unless you are willing to verify their existence frequently. - Include when they make the task at hand immensely easier. - Internal. - Minimize usage. - Literate Programming. - Comments. - Exclude from tangle-blocks and rely on source-block for traceability. - Noweb-Ref. - Same as Headline. - Replace spaces with dashes. - Probably the Heading name. - Keep depth shallow - Weaver and mode configurations are tightly bound. - Maintenance. - Frequently check spelling, grammar, and weasel-words. - Only keep working features in the system. - Macros - Rendered as written-text. - Don't contain source code. - Create for ideas expressed more than 2 times. - Expanded during weaving, not during tangling. - Plain List. - End single sentences with a period. - Programming Language. - Emacs-Lisp. - Almost always use ~defun~ instead of ~advice-add~. - Functions are more normal and predictable. - Advice can subtly break without you noticing. - Parameter. - ~nil~ for =FALSE=. - ~t~ for =TRUE=. - ~n~ for numerical values. - Never ~custom-set-variables~. - Always use relative file paths. - Byte-compile frequently to minimize System warnings. - Prefer to byte-compile all references by using ~function~. - Fail-fast: it is better to know immediately if there are resolution issues. - Prefer to declare anonymous functions with ~function~. - [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Using-Lexical-Binding.html#Using-Lexical-Binding][Quoted via]]. - If a non-special variable appears outside of a let form, the byte-compiler will warn about reference or assignment to a "free variable". An unused non-special variable binding within a let form provokes the byte-compiler will warn about an "unused lexical variable". The byte-compiler will also issue a warning if you use a special variable as a function argument. - Source Block - Be sure that every one has a =NAME= property with a =UUID= value. - YASnippet =sc= does this. So does code in Hacking/Org Mode/Utility. - Tell the story in speech, and then in code. - Communicate the intent in written language as one paragraph and realize that intent in the next paragraph as a source block. Separate the two paragraphs like you would any other paragraph. - The exporter will probably separate the two as you would expect whether you separate the two entities with a space or not - When contained within a list: - Indent begin/end blocks with list content; this makes it clear to Org-Mode to export it as a code block. - Tangle =:file= should have the same =NAME=. - Virtually never edit the contents within buffer-of-origin. - Out of buffer edits: - Fast when spoken language. - Risky when LISP. - While similar to Org-Macro, the =RESULT= formatting indicates to the reader that the value is the result of an evaluation. - Spelling - Place =LocalWords= at the beginning of the document. That way it won't get stomped on during development. - Synonyms. - Document and System and Web. - A Web defines a system. - This document is a Web. - Weave and Export. - Sysop and Reader. - Tangling. - When ordering matters, rely on block-reuse to enforce correct order. - Voice. - Provide answers; do not pose questions or observations. - Simple and detailed. - Pleasant conversation style. - Audience is Sysop; the author included. - Capture decisions that allow this system to move forward. - Weaving. - Strive to keep the weaving in synchronization with the tangling. - Word Choice. - Use Arabic numerals. - Instead of writing "tells EMACS", communicate the result. - "EMACS" refers to the EMACS software - "HELP" refers to the system configured by tangling this we. - Never describe something as "perfect" or "delightful". If it is part of this system then it is perfect and delightful. ** History :PROPERTIES: :ID: org_gcr_2017-06-25_mara:F917FFA6-077B-4A9A-B325-7E9A0CFF9720 :END: *** Version 1: Sufficient And Slipshod :PROPERTIES: :ID: org_gcr_2017-06-25_mara:2AE32991-F8DA-4205-822C-51A267EC81D6 :END: Emacs never grew on me the first few times I tried using it. The first was out of curiosity because a friend used ~jdee~. Five or ten years later I tried using it for ~clojure~ and lost interest first in ~clojure~ and then in Emacs. The third time was for ~ocaml~ and ~sml~. That worked pretty well but I didn't stick with ~sml~ so I didn't stick with Emacs either. At least five configuration files came out of this time all hand-coded Elisp and they are all either lost or hanging around in a SVN repository on a backup. I never had a sense of how Emacs worked, found any of it interesting or a problem solved by it. That is a reflection of what I did and what I brought to it. And I understand that. *** Version 2: How to design a file conservator (HTDFC) or The Care and Conservation of Computer Files (TC3F) :PROPERTIES: :ID: org_gcr_2017-06-25_mara:8BD93843-0D61-45FA-98F4-C3BBA0FFBB47 :END: The second time around, VIM got me hooked on Emacs. /Growing up/ with VIM I had returned to ~gvim~ and I was happy with plain old text files. For keeping todo lists, meeting minutes and working in LaTeX both worked great. That process of re-falling in love with plain old text files is what struck me. Once I heard the Org-Mode tag line "your life in plain text" I knew I had to take a look. And I did and it was delightful. And I was hooked. The line pulled me into pure exploration. Reading the manuals, blogs and other folks' configuration files was an boundless adventure. This was entirely about learning different libraries and configuration options. And it was pretty fun. It was still hand coded Elisp and probably went through ten iterations until I was happy with it. It meant so much to me that I started naming the configuration finally ending up with [[https://raw.githubusercontent.com/grettke/home/master/TC3F.txt][TC3F]]. *** Version 3: ALEC'S A LANGUAGE FOR EXPRESSING CREATIVITY (ALEC) :PROPERTIES: :ID: org_gcr_2017-06-25_mara:1D2B647B-DAEC-42FE-97C8-777CF8869C52 :END: ALEC is the Cambrian Explosion of my cognitive model of Emacs. Creativity abounded like never before. The technology reflected it, enabled and grew into the finest external tool that I had ever known. The passages elaborate on the technology, the thought processes and justification and go on much further into the nature of creativity, cognition and their grand intersection. That intersection was in the great plains, steaming jungles and snow capped mountain peaks. It was everywhere and I was everywhere. This was the point where I stopped pretending that it was written for anyone else other than me. Part of that admission was finally understanding what it means to learn about how we think and how we use that to craft, shape and hone our tools. Emacs is referred to in the singular but it is really a collection of hundreds of creative parts. The work here helped me start to narrow down what I was trying to do and to think. And I thought that I wanted to learn Literate Programming. So I did and I tried and it was a slow and confusing document because that is how it lived in my mind. There were hundreds and hundreds of commits until I was both happy enough with it and comfortable enough to share it. This was the first time that I started to feel like I had some clue about what I was doing. *** Version 4: HELP Enables Literate Programming :PROPERTIES: :ID: org_gcr_2017-06-25_mara:64CA819C-71AD-4E6E-9091-4FFCA95AAF08 :END: HELP was more than an attempt to create a recursive acronym. It /really was helpful/. Every good idea from ALEC got simplified and moved in here. Exploration of the tool and of creative processes were still part of it. But the bigger part was learning, studying and practicing Literate Programming (LP). Donald Knuth wrote a lot /about/ LP and /wrote/ a lot /in/ LP. That is revealing. To get the most about of LP you need to love programming. And you need to love writing. Really you need to love writing in whatever form that takes for you. And finally you need to love doing both together. Literate programmers are few and far between simply because the combination the three desires are uncommon. Despite that it is still fun to practice LP. And Org-Mode does LP so well. Org-Mode's LP tools are stunning and flawless. They shine so brightly that it can be difficult to take a look and see what is possible. HELP is my attempt to take the options that configure them building the perfect LP environment for me. Though HELP is still somewhat wild and unrefined the LP components are both precisely configured /and/ understood. Probably only to me and I am fine with that. Teaching LP with Org-Mode would be an entirely different task! Mark my words for they are sure to change here and probably be struck down by the idiom-zapper plugin that I've yet to write: this will be a stable version of my Emacs configuration for a long time. All of my original desires are satisfied. This fine tool, the infinite abacus, has sat in this hearth long enough. Now it is time to carry it out into the wilderness and far above and beyond the mountaintops to reveal the other side and the mysteries that they reveal. * Special Operating Procedure :PROPERTIES: :ID: org_gcr_2017-05-12_mara:A5B71AC0-1725-4416-AB50-86496180526A :END: The following code and packages are special to this configuration. They provide critical functionality for configuring the rest of the system. They provide ideas that make the entire system usable, productive, expressive, and fast. ** Benchmark :PROPERTIES: :ID: org_gcr_2018-09-21T18-57-01-05-00_cosmicality:32215650-08D5-448E-8EFE-885CA41A824A :END: Report startup benchmarks from here forward. #+name: org_gcr_2018-09-21T18-57-01-05-00_cosmicality_71EB64A3-523C-47F4-8FB5-1E29B102192B #+begin_src emacs-lisp (use-package benchmark-init :ensure t :config (defun help/benchmark-deactivate () (benchmark-init/deactivate) (benchmark-init/show-durations-tabulated) (benchmark-init/show-durations-tree)) (add-hook 'after-init-hook #'help/benchmark-deactivate)) #+end_src ** Customize :PROPERTIES: :ID: org_gcr_2017-05-12_mara:C8E7E545-E716-4ACE-9536-B7278F843632 :END: Easy Customization is great. Though most of the time I move the settings into hand-coded Elisp, I still love it. Store Customizations in another file. Avoids the [[https://www.reddit.com/r/emacs/comments/53zpv9/how_do_i_get_emacs_to_stop_adding_custom_fields/][package-selected-packages]] portability issue. #+NAME: org_gcr_2017-05-12_mara_289C017E-D5F0-4B8A-987F-A64696094359 #+BEGIN_SRC emacs-lisp (setq custom-file "~/src/help/custom.el") (load custom-file :noerror) #+END_SRC ** Display :PROPERTIES: :ID: org_gcr_2017-05-12_mara:AC7B6F6A-EB1C-49AA-89F3-0B5DAC8BD759 :END: Make it easy to conditionally evaluate code when running with a graphical display. #+NAME: org_gcr_2017-05-12_mara_0A242AFE-3101-4F88-A2CB-F230FA19AC64 #+BEGIN_SRC emacs-lisp (defmacro help/on-gui (statement &rest statements) "Evaluate the enclosed body only when run on GUI." `(when (display-graphic-p) ,statement ,@statements)) (defmacro help/not-on-gui (statement &rest statements) "Evaluate the enclosed body only when run on GUI." `(when (not (display-graphic-p)) ,statement ,@statements)) #+END_SRC ** Hydra :PROPERTIES: :ID: org_gcr_2017-05-12_mara:96FBC635-B614-479C-BFA4-E9AE3D70EB8B :END: #+NAME: org_gcr_2017-05-12_mara_D2A1FF8B-4A1A-4D25-A0CC-D86F3FFD7B28 #+BEGIN_SRC emacs-lisp (use-package hydra :ensure t) #+END_SRC ** Keyboard :PROPERTIES: :ID: org_gcr_2017-05-12_mara:63790E33-FB60-4C0E-A13E-907D5A175CEC :END: Key-Chord mode is amazing. Piano-Lessons shows you how. #+NAME: org_gcr_2017-05-12_mara_B25D3BDE-CB14-440D-8246-B833BD8F1C0B #+BEGIN_SRC emacs-lisp (use-package key-chord :ensure t :config (key-chord-mode t)) #+END_SRC Echo keystrokes immediately. #+NAME: org_gcr_2017-05-12_mara_6BB32DFA-105B-4712-BF6D-945A240C29E1 #+BEGIN_SRC emacs-lisp (setq echo-keystrokes 0.02) #+END_SRC ** Libraries :PROPERTIES: :ID: org_gcr_2017-05-12_mara:E1A8398D-E2F6-485B-83FB-CE52AE9A5D1B :END: Lists. #+NAME: org_gcr_2017-05-12_mara_12B73D47-AAFB-4271-92F2-98A18E19DC2A #+BEGIN_SRC emacs-lisp (use-package dash :ensure t :config (dash-enable-font-lock)) (use-package dash-functional :ensure t) #+END_SRC Files and directories. #+NAME: org_gcr_2017-05-12_mara_D99938CC-B521-4A2D-8DAA-F023FFB1E21E #+BEGIN_SRC emacs-lisp (use-package f :ensure t) #+END_SRC Strings. #+NAME: org_gcr_2017-05-12_mara_04215D1F-F7E8-46E2-A3BC-0D8DEE28B7E1 #+BEGIN_SRC emacs-lisp (use-package s :ensure t) #+END_SRC Hash-tables. #+NAME: org_gcr_2017-05-23_mara_5BAD0073-631D-4D4E-83CD-5B0CD0C7CAD6 #+BEGIN_SRC emacs-lisp (use-package ht :ensure t) #+END_SRC ALists. #+name: org_gcr_2019-03-02T18-08-48-06-00_cosmicality_C0DAC44D-EF0B-4203-A996-A27E65801233 #+begin_src emacs-lisp (require 'let-alist) (use-package a :ensure t) #+end_src Caching. #+NAME: org_gcr_2017-05-12_mara_C063F7CE-637E-43F8-8E16-AFBC68CA7618 #+BEGIN_SRC emacs-lisp (use-package persistent-soft :ensure t) #+END_SRC ~CL-LIB~. #+name: org_gcr_2018-07-18T20-32-35-05-00_mara_411E5B87-16D6-4ACA-8DF0-10DC5C92F934 #+begin_src emacs-lisp (require 'cl-lib) #+end_src ** Modeline :PROPERTIES: :ID: org_gcr_2017-05-12_mara:953129BC-045D-43B5-A194-904818E44FC7 :END: Reduce information about modes in the Modeline. #+NAME: org_gcr_2017-05-12_mara_2FD3C2CA-508B-453E-A619-76D6EA4AAF71 #+BEGIN_SRC emacs-lisp (use-package diminish) #+END_SRC Show the file size. #+NAME: org_gcr_2017-05-12_mara_555EE82E-410B-4189-BE53-D33346F3F3BE #+BEGIN_SRC emacs-lisp (size-indication-mode) #+END_SRC Show the column number. #+NAME: org_gcr_2017-05-12_mara_BC16CA62-6474-4848-880C-F1EDE2BB5616 #+BEGIN_SRC emacs-lisp (column-number-mode t) #+END_SRC Configuration uses active theme. #+NAME: org_gcr_2017-06-13_mara_7F117B6D-AFE7-479C-8313-3E9B6B4D967F #+BEGIN_SRC emacs-lisp (use-package smart-mode-line :ensure t) #+END_SRC Emacs mode for hiding the mode-line from [[https://emacs-doctor.com/emacs-hide-mode-line.html][Bastien]]. #+NAME: org_gcr_2017-11-15_mara_361908ED-32C9-4339-91AE-F02A2E017A87 #+BEGIN_SRC emacs-lisp (defvar-local hidden-mode-line-mode nil) (define-minor-mode hidden-mode-line-mode "Minor mode to hide the mode-line in the current buffer." :init-value nil :global t :variable hidden-mode-line-mode :group 'editing-basics (if hidden-mode-line-mode (setq hide-mode-line mode-line-format mode-line-format nil) (setq mode-line-format hide-mode-line hide-mode-line nil)) (force-mode-line-update) ;; Apparently force-mode-line-update is not always enough to ;; redisplay the mode-line (redraw-display) (when (and (called-interactively-p 'interactive) hidden-mode-line-mode) (run-with-idle-timer 0 nil 'message (concat "Hidden Mode Line Mode enabled. " "Use M-x hidden-mode-line-mode to make the mode-line appear.")))) #+END_SRC Fancy progress indicator. #+name: org_gcr_2018-06-06T22-01-54-05-00_mara_00E980AF-8BD1-4AFF-A815-303C78B85871 #+begin_src emacs-lisp (use-package unicode-progress-reporter :ensure t :config (unicode-progress-reporter-setup)) #+end_src ** macOS :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BC848D6F-7915-4151-8368-D473CA39E7C3 :END: Make it easy to evaluate code only when running on macOS #+NAME: org_gcr_2017-05-12_mara_FF670CDD-5374-49BA-897A-AE1A30B444D6 #+BEGIN_SRC emacs-lisp (defmacro help/on-mac-os (statement &rest statements) "Evaluate the enclosed body only when run on macOS." `(when (eq system-type 'darwin) ,statement ,@statements)) #+END_SRC Pull in the =ENVIRONMENT= variables because the GUI version of EMACS does not. #+NAME: org_gcr_2017-05-12_mara_375D2A3D-54B5-4DBC-B911-38CAB716286A #+BEGIN_SRC emacs-lisp (help/on-mac-os (use-package exec-path-from-shell :ensure t :config (setq exec-path-from-shell-check-startup-files nil) (setq exec-path-from-shell-debug 1) (exec-path-from-shell-initialize))) #+END_SRC Configure the meta keys. Use the macOS modifiers as Emacs meta keys. Don't pass them through to macOS. Easily allow option pass through for alternate input methods. #+NAME: org_gcr_2017-05-12_mara_F29E41A6-234D-4727-B9DF-75E5F5AC2AD3 #+BEGIN_SRC emacs-lisp (help/on-mac-os (load-file "~/src/help/.mac-os-keys.el")) #+END_SRC Run a bare Emacs instance on macOS like this: #+begin_example emacs --debug-init -no-init-file --load ~/src/help/.mac-os-keys.el& #+end_example EMACS dialogues don't work macOS. They lock up EMACS. This is a known issue. [[https://superuser.com/questions/125569/how-to-fix-emacs-popup-dialogs-on-mac-os-x][Here]] is the solution. #+NAME: org_gcr_2017-05-12_mara_82602D6E-30DB-49CF-A900-1FC9B733C347 #+BEGIN_SRC emacs-lisp (help/on-mac-os (defun help/yes-or-no-p (orig-fun &rest args) "Prevent yes-or-no-p from activating a dialog." (let ((use-dialog-box nil)) (apply orig-fun args))) (advice-add #'yes-or-no-p :around #'help/yes-or-no-p) (advice-add #'y-or-n-p :around #'help/yes-or-no-p)) #+END_SRC ** Windows :PROPERTIES: :ID: org_gcr_2017-05-12_mara:F59CD0F9-9B04-493E-AA9A-2471F2ED0A05 :END: Make it easy to evaluate code only when running on Windows. #+NAME: org_gcr_2017-05-12_mara_9C48F55A-19D7-4B5F-8779-11BFFF4AE514 #+BEGIN_SRC emacs-lisp (defmacro help/on-windows (statement &rest statements) "Evaluate the enclosed body only when run on Microsoft Windows." `(when (eq system-type 'windows-nt) ,statement ,@statements)) #+END_SRC Provide the proper shell. #+NAME: org_gcr_2017-05-12_mara_9CAED015-5B25-41BE-82A9-CBA4D07E8F3D #+BEGIN_SRC emacs-lisp (help/on-windows (setq shell-file-name "cmdproxy.exe")) #+END_SRC Enable the =super= key-space. #+NAME: org_gcr_2017-05-12_mara_7AFA0161-4DCA-4C54-8D3C-9EF3FD529BF4 #+BEGIN_SRC emacs-lisp (help/on-windows (setq w32-pass-lwindow-to-system nil) (defvar w32-lwindow-modifier 'super) (setq w32-pass-rwindow-to-system nil) (defvar w32-rwindow-modifier 'super)) #+END_SRC ** Linux :PROPERTIES: :ID: org_gcr_2017-07-23_mara:7D02C86B-CDBE-466B-9647-3EDA6DB016C6 :END: Make it easy to evaluate code only when running on . #+NAME: org_gcr_2017-07-23_mara_ED1CAC7D-4B9E-4316-8AB3-85ACDC06B3F4 #+BEGIN_SRC emacs-lisp (defmacro help/on-gnu/linux (statement &rest statements) "Evaluate the enclosed body only when run on GNU/Linux" `(when (eq system-type 'gnu/linux) ,statement ,@statements)) #+END_SRC * Standard Operating Procedure :PROPERTIES: :ID: org_gcr_2017-05-12_mara:205571BA-2DC4-4DCB-912C-65B9EC843574 :END: Configure EMACS to maximum utility. ** Helper Functions :PROPERTIES: :ID: org_gcr_2017-05-12_mara:1E88DD48-B992-46E1-B49F-EB8071E8EC37 :END: #+NAME: org_gcr_2017-05-12_mara_7D37FFE5-2D2B-4CF7-AF27-F3CB8616D81B #+BEGIN_SRC emacs-lisp (defun help/save-all-file-buffers () "Saves every buffer associated with a file." (interactive) (dolist (buf (buffer-list)) (with-current-buffer buf (when (and (buffer-file-name) (buffer-modified-p)) (save-buffer))))) (defun help/kill-other-buffers () "Kill all other buffers." (interactive) (mapc #'kill-buffer (delq (current-buffer) (buffer-list)))) (defvar help/delete-trailing-whitespace-p t "Should trailing whitespace be removed?") (defun help/delete-trailing-whitespace () "Delete trailing whitespace for everything but the current line. If `help/delete-trailing-whitespace-p' is non-nil, then delete the whitespace. This is useful for fringe cases where trailing whitespace is important." (interactive) (when help/delete-trailing-whitespace-p (let ((first-part-start (point-min)) (first-part-end (point-at-bol)) (second-part-start (point-at-eol)) (second-part-end (point-max))) (delete-trailing-whitespace first-part-start first-part-end) (delete-trailing-whitespace second-part-start second-part-end)))) (defun help/indent-curly-block (&rest _ignored) "Open a new brace or bracket expression, with relevant newlines and indent. URL: `https://github.com/Fuco1/smartparens/issues/80'" (interactive) (newline) (indent-according-to-mode) (forward-line -1) (indent-according-to-mode)) (defun beginning-of-line-dwim () "Toggles between moving point to the first non-whitespace character, and the start of the line. Src: http://www.wilfred.me.uk/" (interactive) (let ((start-position (point))) ;; see if going to the beginning of the line changes our position (move-beginning-of-line nil) (when (= (point) start-position) ;; we're already at the beginning of the line, so go to the ;; first non-whitespace character (back-to-indentation)))) (defun help/lazy-new-open-line () "Insert a new line without breaking the current line." (interactive) (beginning-of-line) (forward-line 1) (newline) (forward-line -1)) (defun help/smart-open-line () "Insert a new line, indent it, and move the cursor there. This behavior is different then the typical function bound to return which may be `open-line' or `newline-and-indent'. When you call with the cursor between ^ and $, the contents of the line to the right of it will be moved to the newly inserted line. This function will not do that. The current line is left alone, a new line is inserted, indented, and the cursor is moved there. Attribution: URL `http://emacsredux.com/blog/2013/03/26/smarter-open-line/'" (interactive) (move-end-of-line nil) (newline-and-indent)) (defun help/insert-ellipsis () "Insert an ellipsis into the current buffer." (interactive) (insert "\dots{}")) (defun help/insert-checkmark () "Insert a checkmark into the current buffer." (interactive) (insert "\checkmark{}")) (defun help/insert-noticeable-snip-comment-line () "Insert a noticeable snip comment line (NSCL)." (interactive) (if (not (bolp)) (message "I may only insert a NSCL at the beginning of a line.") (let ((ncl (make-string 70 ?✂))) (newline) (forward-line -1) (insert ncl) (comment-or-uncomment-region (line-beginning-position) (line-end-position))))) (progn (defvar my-read-expression-map (let ((map (make-sparse-keymap))) (set-keymap-parent map read-expression-map) (define-key map [(control ?g)] #'minibuffer-keyboard-quit) (define-key map [up] nil) (define-key map [down] nil) map)) (defun my-read--expression (prompt &optional initial-contents) (let ((minibuffer-completing-symbol t)) (minibuffer-with-setup-hook (lambda () (emacs-lisp-mode) (use-local-map my-read-expression-map) (setq font-lock-mode t) (funcall font-lock-function 1) (insert "()") (backward-char)) (read-from-minibuffer prompt initial-contents my-read-expression-map nil 'read-expression-history)))) (defun my-eval-expression (expression &optional arg) "Evaluate EXPRESSION adding the result to the kill-ring then either display it in a buffer or with a prefix argument ARG insert it into this buffer. Attribution: URL `https://lists.gnu.org/archive/html/help-gnu-emacs/2014-07/msg00135.html'." (interactive (list (read (my-read--expression "𝔼𝕍𝔸𝕃: ")) current-prefix-arg)) (let* ((it (eval expression lexical-binding)) (itstr (pp-to-string it))) (kill-new itstr) (if arg (insert itstr) (pp-display-expression it "*HELP Eval Output*"))))) (defun help/util-ielm () "HELP buffer setup for ielm. Creates enough space for one other permanent buffer beneath it." (interactive) (split-window-below -20) (help/safb-other-window) (ielm) (set-window-dedicated-p (selected-window) t)) (defun help/util-eshell () "HELP buffer setup for eshell. Depends upon `help/util-ielm' being run first." (interactive) (split-window-below -10) (help/safb-other-window) (eshell) (set-window-dedicated-p (selected-window) t)) (defvar help/util-state nil "Track whether the util buffers are displayed or not.") (defun help/util-state-toggle () "Toggle the util state." (interactive) (setq help/util-state (not help/util-state))) (defun help/util-start () "Perhaps utility buffers." (interactive) (help/util-ielm) (help/util-eshell) (help/util-state-toggle)) (defun help/util-stop () "Remove personal utility buffers." (interactive) (if (get-buffer "*ielm*") (kill-buffer "*ielm*")) (if (get-buffer "*eshell*") (kill-buffer "*eshell*")) (help/util-state-toggle)) (defun help/ielm-auto-complete () "Enables `auto-complete' support in \\[ielm]. Attribution: URL `http://www.masteringemacs.org/articles/2010/11/29/evaluating-elisp-emacs/'" (setq ac-sources '(ac-source-functions ac-source-variables ac-source-features ac-source-symbols ac-source-words-in-same-mode-buffers)) (add-to-list 'ac-modes #'inferior-emacs-lisp-mode) (auto-complete-mode 1)) (defun help/uuid () "Insert a UUID." (interactive) (let ((org-id-prefix nil)) (insert (org-id-new)))) (defun endless/sharp () "Insert #' unless in a string or comment. SRC: URL `http://endlessparentheses.com/get-in-the-habit-of-using-sharp-quote.html?source=rss'" (interactive) (call-interactively #'self-insert-command) (let ((ppss (syntax-ppss))) (unless (or (elt ppss 3) (elt ppss 4)) (insert "'")))) (defun help/chs () "Insert opening \"cut here start\" snippet." (interactive) (insert "--8<---------------cut here---------------start------------->8---")) (defun help/che () "Insert closing \"cut here end\" snippet." (interactive) (insert "--8<---------------cut here---------------end--------------->8---")) (defmacro help/measure-time (&rest body) "Measure the time it takes to evaluate BODY. Attribution Nikolaj Schumacher: URL `https://lists.gnu.org/archive/html/help-gnu-emacs/2008-06/msg00087.html'" `(let ((time (current-time))) ,@body (message "%.06f" (float-time (time-since time))))) (defun help/create-non-existent-directory () "Attribution URL: `https://iqbalansari.github.io/blog/2014/12/07/automatically-create-parent-directories-on-visiting-a-new-file-in-emacs/'" (let ((parent-directory (file-name-directory buffer-file-name))) (when (and (not (file-exists-p parent-directory)) (y-or-n-p (format "Directory `%s' does not exist. Create it?" parent-directory))) (make-directory parent-directory t)))) (defun help/occur-dwim () "Call `occur' with a mostly sane default. Attribution Oleh Krehel (abo-abo): URL `http://oremacs.com/2015/01/26/occur-dwim/'" (interactive) (push (if (region-active-p) (buffer-substring-no-properties (region-beginning) (region-end)) (let ((sym (thing-at-point 'symbol))) (when (stringp sym) (regexp-quote sym)))) regexp-history) (call-interactively 'occur) (other-window 1)) (defun help/util-cycle () "Display or hide the utility buffers." (interactive) (if help/util-state (help/util-stop) (help/util-start))) (defun sacha/unfill-paragraph (&optional region) "Takes a multi-line paragraph and makes it into a single line of text. Attribuation: URL https://github.com/sachac/.emacs.d/blob/gh-pages/Sacha.org#unfill-paragraph" (interactive (progn (barf-if-buffer-read-only) (list t))) (let ((fill-column (point-max))) (fill-paragraph nil region))) (defun help/text-scale-increase () "Increase font size" (interactive) (help/on-gui (setq help/font-size-current (+ help/font-size-current 1)) (help/update-font))) (defun help/text-scale-decrease () "Reduce font size." (interactive) (help/on-gui (when (> help/font-size-current 1) (setq help/font-size-current (- help/font-size-current 1)) (help/update-font))) (help/not-on-gui (message "Please resize the terminal emulator font."))) (defun help/org-weave-subtree-gfm (id file) "Export the subtree with ID to FILE in gfm." (interactive) (help/save-all-file-buffers) (save-excursion (let ((hidx (org-find-property "ID" id))) (when hidx (goto-char hidx) (org-export-to-file 'gfm file nil t nil))))) (defun help/org-weave-gfm (id) "Select an ID to export to the same name as Github Flavored Markdown.." (interactive "sEnter the ID to export: ") (help/org-weave-subtree-gfm id (s-prepend id ".md"))) (defun help/org-weave-readme () (interactive) (help/org-weave-subtree-gfm "orgmode:gcr:vela:README" "README.md")) (defun help/org-weave-style-guide () (interactive) (help/org-weave-subtree-gfm "orgmode:gcr:vela:STYLEGUIDE" "STYLEGUIDE.md")) (defun help/weave-everything-everywhere () "Export this entire document in configured weavers." (interactive) (save-excursion (org-ascii-export-to-ascii) (org-html-export-to-html) (org-gfm-export-to-markdown) (org-latex-export-to-pdf)) (help/org-weave-readme) (help/org-weave-style-guide)) (require 'thingatpt) (defun thing-at-point-goto-end-of-integer () "Go to end of integer at point. Attribution: URL `http://emacsredux.com/blog/2013/07/25/increment-and-decrement-integer-at-point/'" (let ((inhibit-changing-match-data t)) ;; Skip over optional sign (when (looking-at "[+-]") (forward-char 1)) ;; Skip over digits (skip-chars-forward "[[:digit:]]") ;; Check for at least one digit (unless (looking-back "[[:digit:]]") (error "No integer here")))) (put 'integer 'beginning-op 'thing-at-point-goto-end-of-integer) (defun thing-at-point-goto-beginning-of-integer () "Go to end of integer at point. Attribution: URL `http://emacsredux.com/blog/2013/07/25/increment-and-decrement-integer-at-point/'" (let ((inhibit-changing-match-data t)) ;; Skip backward over digits (skip-chars-backward "[[:digit:]]") ;; Check for digits and optional sign (unless (looking-at "[+-]?[[:digit:]]") (error "No integer here")) ;; Skip backward over optional sign (when (looking-back "[+-]") (backward-char 1)))) (put 'integer 'beginning-op 'thing-at-point-goto-beginning-of-integer) (defun thing-at-point-bounds-of-integer-at-point () "Get boundaries of integer at point. Attribution: URL `http://emacsredux.com/blog/2013/07/25/increment-and-decrement-integer-at-point/'" (save-excursion (let (beg end) (thing-at-point-goto-beginning-of-integer) (setq beg (point)) (thing-at-point-goto-end-of-integer) (setq end (point)) (cons beg end)))) (put 'integer 'bounds-of-thing-at-point 'thing-at-point-bounds-of-integer-at-point) (defun thing-at-point-integer-at-point () "Get integer at point. Attribution: URL `http://emacsredux.com/blog/2013/07/25/increment-and-decrement-integer-at-point/'" (let ((bounds (bounds-of-thing-at-point 'integer))) (string-to-number (buffer-substring (car bounds) (cdr bounds))))) (put 'integer 'thing-at-point 'thing-at-point-integer-at-point) (defun increment-integer-at-point (&optional inc) "Increment integer at point by one. With numeric prefix arg INC, increment the integer by INC amount. Attribution: URL `http://emacsredux.com/blog/2013/07/25/increment-and-decrement-integer-at-point/'" (interactive "p") (let ((inc (or inc 1)) (n (thing-at-point 'integer)) (bounds (bounds-of-thing-at-point 'integer))) (delete-region (car bounds) (cdr bounds)) (insert (int-to-string (+ n inc))))) (defun decrement-integer-at-point (&optional dec) "Decrement integer at point by one. With numeric prefix arg DEC, decrement the integer by DEC amount. Attribution: URL `http://emacsredux.com/blog/2013/07/25/increment-and-decrement-integer-at-point/'" (interactive "p") (increment-integer-at-point (- (or dec 1)))) (defun switch-to-previous-buffer () "Switch to most recent buffer. Repeated calls toggle back and forth between the most recent two buffers. Attribution: URL `http://pragmaticemacs.com/emacs/toggle-between-most-recent-buffers/' Attribution: URL `https://www.emacswiki.org/emacs/SwitchingBuffers#toc5'" (interactive) (switch-to-buffer (other-buffer (current-buffer) 1))) (defun help/dos2unix () "Not exactly but it's easier to remember. Attribution: URL `https://www.emacswiki.org/emacs/DosToUnix'" (interactive) (set-buffer-file-coding-system 'unix 't) ) (defun help/preview-buffer-file-in-marked-2 () "View buffer file in Marked 2. Attribution: URL `https://github.com/kotfu/marked-bonus-pack/blob/master/Emacs/dot.emacs.txt'" (interactive) (help/on-mac-os (shell-command (format "open -a 'Marked 2.app' %s" (shell-quote-argument (buffer-file-name)))))) (defun help/safb-flycheck-list-errors () "Save all file buffers and switch to flycheck error list" (interactive) (help/save-all-file-buffers) (flycheck-list-errors) (other-window 1)) (defun help/safb-kill-this-buffer () "Save all file buffers and maybe kill this buffer." (interactive) (help/save-all-file-buffers) (kill-this-buffer)) (defmacro help/profile-org (times &rest body) "Makes profiling Org-Mode easy by automatically instrumenting the desired functions, running the code you want to test, removing the instrumentation, and presenting the results. Attribution: Adam Porter " `(let (output) (dolist (p '("org-")) ; symbol prefixes to instrument (elp-instrument-package p)) (dotimes (x ,times) ,@body) (elp-results) (elp-restore-all) (point-min) (forward-line 20) (delete-region (point) (point-max)) (setq output (buffer-substring-no-properties (point-min) (point-max))) (kill-buffer) (delete-window) output)) (defun help/open-help () "Switch to the buffer backed by `help/help.org'." (interactive) (if (get-buffer "help/help.org") (switch-to-buffer "help/help.org"))) (defun help/open-projects () "Switch to the buffer backed by `bitbucket/projects.org'." (interactive) (if (get-buffer "bitbucket/projects.org") (switch-to-buffer "bitbucket/projects.org"))) (defun help/open-si-projects () "Switch to the buffer backed by `bitbucket-gcrstoneisle/projects.org'." (interactive) (if (get-buffer "bitbucket-gcrstoneisle/projects.org") (switch-to-buffer "bitbucket-gcrstoneisle/projects.org"))) (defun help/move-file (new-location) "Write this file to NEW-LOCATION, and delete the old one. Attribution: URL `http://zck.me/emacs-move-file'" (interactive (list (if buffer-file-name (read-file-name "Move file to: ") (read-file-name "Move file to: " default-directory (expand-file-name (file-name-nondirectory (buffer-name)) default-directory))))) (when (file-exists-p new-location) (delete-file new-location)) (let ((old-location (buffer-file-name))) (write-file new-location t) (when (and old-location (file-exists-p new-location) (not (string-equal old-location new-location))) (delete-file old-location)))) (defun help/rename-current-buffer-file () "Renames current buffer and file it is visiting. Attribution: `http://stackoverflow.com/a/25212377'" (interactive) (let ((name (buffer-name)) (filename (buffer-file-name))) (if (not (and filename (file-exists-p filename))) (error "Buffer '%s' is not visiting a file!" name) (let ((new-name (read-file-name "New name: " filename))) (if (get-buffer new-name) (error "A buffer named '%s' already exists!" new-name) (rename-file filename new-name 1) (rename-buffer new-name) (set-visited-file-name new-name) (set-buffer-modified-p nil) (message "File '%s' successfully renamed to '%s'" name (file-name-nondirectory new-name))))))) (defun help/sort-lines-ignore-case () "Sort lines ignoring case. Attribution: `https://stackoverflow.com/questions/20967818/emacs-function-to-case-insensitive-sort-lines'" (interactive) (let ((sort-fold-case t)) (call-interactively 'sort-lines))) (defun help/delete-this-buffer-and-file () "Deletes file connected to this buffer and kills this buffer. Attribution: URL `https://rejeep.github.io/emacs/elisp/2010/11/16/delete-file-and-buffer-in-emacs.html'" (interactive) (let ((filename (buffer-file-name)) (buffer (current-buffer)) (name (buffer-name))) (if (not (and filename (file-exists-p filename))) (error "Nothing to delete: '%s' is not visiting a file." name) (when (yes-or-no-p "Are you sure you want to delete this file? ") (delete-file filename) (kill-buffer buffer) (message "File '%s' successfully deleted." filename))))) (defun help/wih () (interactive) (when (use-region-p) (call-interactively 'kill-region)) (insert "#+CATEGORY: Article ,#+TAGS: Happiness, Health, philosophy, Yoga ,#+TITLE: (Happiness) ")) (defun help/wio () (interactive) (when (use-region-p) (call-interactively 'kill-region)) (insert "#+CATEGORY: Article ,#+TAGS: Babel, Emacs, Ide, Lisp, Literate Programming, Programming Language, Reproducible research, elisp, org-mode ,#+TITLE: (Emacs+Org-Mode) ")) (defun help/wip () (interactive) (when (use-region-p) (call-interactively 'kill-region)) (let ((name (read-string "Programming language name? "))) (insert (format "#+CATEGORY: Article ,#+TAGS: Programming Language, %s ,#+TITLE: (%s) " name name)))) (defconst help/buffalo "(🐃) Buffalo buffalo Buffalo buffalo buffalo buffalo Buffalo buffalo (🐃)" "URL: `https://en.wikipedia.org/wiki/Buffalo_buffalo_Buffalo_buffalo_buffalo_buffalo_Buffalo_buffalo'") (defun help/safb/compile () "Save all file buffers and call `compile'" (interactive) (help/save-all-file-buffers) (call-interactively 'compile)) (defun help/insert-formfeed () (interactive) (insert "\f")) (defun help/itwas () "Attribution: W<" (interactive) (insert-file-contents-literally "~/src/help/ascii/it-was-a-dark-and-stormy-night.asc")) (defun help/pie-blurb () "Insert PIE motto" (interactive) (insert-file-contents-literally "~/src/help/ascii/pie.asc")) (defun help/remove-vowel ($string &optional $from $to) "Remove the following letters: {a e i o u}. When called interactively, work on current paragraph or text selection. When called in lisp code, if ξstring is non-nil, returns a changed string. If ξstring nil, change the text in the region between positions ξfrom ξto. Attribution: URL `http://ergoemacs.org/emacs/elisp_command_working_on_string_or_region.html'" (interactive (if (use-region-p) (list nil (region-beginning) (region-end)) (let ((bds (bounds-of-thing-at-point 'paragraph)) ) (list nil (car bds) (cdr bds)) ) ) ) (let (workOnStringP inputStr outputStr) (setq workOnStringP (if $string t nil)) (setq inputStr (if workOnStringP $string (buffer-substring-no-properties $from $to))) (setq outputStr (let ((case-fold-search t)) (replace-regexp-in-string "a\\|e\\|i\\|o\\|u\\|" "" inputStr) ) ) (if workOnStringP outputStr (save-excursion (delete-region $from $to) (goto-char $from) (insert outputStr) )) ) ) (defun help/indent-buffer () "Indent the currently visited buffer. URL: `http://emacsredux.com/blog/2013/03/27/indent-region-or-buffer/'" (interactive) (indent-region (point-min) (point-max))) (defun help/indent-region-or-buffer () "Indent a region if selected, otherwise the whole buffer. URL: `http://emacsredux.com/blog/2013/03/27/indent-region-or-buffer/'" (interactive) (save-excursion (if (region-active-p) (progn (indent-region (region-beginning) (region-end)) (message "Indented selected region.")) (progn (help/indent-buffer) (message "Indented buffer."))))) (defun help/alist-set (key val alist &optional symbol) "Set property KEY to VAL in ALIST. Return new alist. This creates the association if it is missing, and otherwise sets the cdr of the first matching association in the list. It does not create duplicate associations. By default, key comparison is done with `equal'. However, if SYMBOL is non-nil, then `eq' is used instead. This method may mutate the original alist, but you still need to use the return value of this method instead of the original alist, to ensure correct results. Atribution: URL `https://emacs.stackexchange.com/a/33893/341'" (if-let ((pair (if symbol (assq key alist) (assoc key alist)))) (setcdr pair val) (push (cons key val) alist)) alist) (defun help/org-time-stamp-with-seconds-now () (interactive) (let ((current-prefix-arg '(16))) (call-interactively 'org-time-stamp))) (defun help/insert-log-entry () "Produces and inserts a compact datestamp with full year and maybe a log message." (interactive) (let* ((stamp (format-time-string "%Y%m%dT%H%M")) (msg (s-trim (read-string "Log message? (hit return to leave blank): "))) (str (or (and (s-blank? msg) stamp) (s-concat stamp "-" (s-replace " " "-" msg))))) (insert str))) (defun help/insert-datestamp-us () "Produces and inserts a US datestamp." (interactive) (insert (format-time-string "%m/%d/%y"))) (defun help/insert-datestamp-us-full-year-and-dashes () "Produces and inserts a US datestamp with full year and dashes." (interactive) (insert (format-time-string "%m-%d-%Y"))) (defun help/insert-datestamp-us-full-year () "Produces and inserts a US datestamp with full year." (interactive) (insert (format-time-string "%m/%d/%Y"))) (defun help/insert-datestamp-us-words () "Produces and inserts a US datestamp using words." (interactive) (insert (format-time-string "%A %B %d, %Y"))) (defun help/insert-hour-seconds () "Produces and inserts a Hour:Minute timestamp" (interactive) (insert (format-time-string "%H:%M"))) (defun help/insert-org-datestamp () "Produces and inserts an Org-Mode timestamp." (interactive) (insert (format "<%s>"(format-time-string "%F")))) (defun help/insert-jekyll-timestamp () "Insert Jekyll timestamp" (interactive) (insert (format-time-string "%Y-%m-%d %H:%M:%S %z"))) (defun help/org-count-words () "If region is active, count words in it; otherwise count words in current subtree." (interactive) (if (use-region-p) (funcall-interactively #'count-words-region (region-beginning) (region-end)) (org-with-wide-buffer (cl-loop for (lines words characters) in (org-map-entries (lambda () (help/org-forward-to-entry-content 'unsafe) (let ((end (org-entry-end-position))) (list (count-lines (point) end) (count-words (point) end) (- end (point))))) nil 'tree) sum lines into total-lines sum words into total-words sum characters into total-characters finally do (message "Subtree \"%s\" has %s lines, %s words, and %s characters." (org-get-heading t t) total-lines total-words total-characters))))) (defun help/org-forward-to-entry-content (&optional unsafe) "Skip headline, planning line, and all drawers in current entry. If UNSAFE is non-nil, assume point is on headline." (unless unsafe (org-back-to-heading)) (cl-loop for element = (org-element-at-point) for pos = (pcase element (`(headline . ,_) (org-element-property :contents-begin element)) (`(,(or 'planning 'property-drawer 'drawer) . ,_) (org-element-property :end element))) while pos do (goto-char pos))) (defvar help/most-used-words-count 10 "Default most used word count to show") (defun help/most-used-words-fn (&optional n) "Make a list of the N most used words in buffer, or use default. Attribution: Udyant Wig " (let ((n (or n help/most-used-words-count)) (counts (make-hash-table :test #'equal)) (words (split-string (buffer-string))) sorted-counts) (dolist (word words) (let ((count (gethash (downcase word) counts 0))) (puthash (downcase word) (1+ count) counts))) (cl-loop for word being the hash-keys of counts using (hash-values count) do (push (list word count) sorted-counts) finally (setf sorted-counts (cl-sort sorted-counts #'> :key #'cl-second))) (mapcar #'cl-first (cl-subseq sorted-counts 0 n)))) (defun help/most-used-words () "Report top N most used words in a new buffer, defaults to 1" (interactive) (let* ((input-raw (read-string "Report the top N most used words : " nil nil nil)) (input-num (floor (string-to-number (string-trim input-raw)))) (n (if (<= input-num 0) help/most-used-words-count input-num)) (words (help/most-used-words-fn n)) (name (format "TOP %s USED WORDS IN %s" n (buffer-name))) (underbar (make-string (length name) ?=)) (buf (get-buffer-create (format "*%s*"name)))) (switch-to-buffer buf) (insert (format "%s\n%s\n" name underbar)) (dolist (word words) (insert (format "%s\n" word))) (help-mode) (setq buffer-read-only t) (goto-char (point-min)))) (defun help/insert-it-then-real-space (char) "Insert CHAR followed by a space using a key event so modes can respond appropriately. I use this to automatically insert a space after punctuation characters. It might sound like a micro-optimization but I think of it more like making the keyboard work like it ought to work ;). When I first tried to set this up I bound the .-key to a function that inserted itself and then a space like this `(insert \". \")'. This inserts what you want but doesn't generate a key event for other modes to handle. For example `auto-fill-mode' won't break the line because it doesn't know that anything happened. When you do hit another key `auto-fill-mode' kicks in and breaks the line—I found that disturbing to my flow so I set this up instead. Does the \"right thing\" under `org-mode'." (cl-flet ((do-insert () (if (bound-and-true-p org-mode) (org-self-insert-command 1) (self-insert-command 1)))) (setq last-command-event char) (do-insert) (setq last-command-event ?\s) (do-insert))) (defun help/real-insert (char) (cl-flet ((do-insert () (if (bound-and-true-p org-mode) (org-self-insert-command 1) (self-insert-command 1)))) (setq last-command-event char) (do-insert))) (defun help/dot-space () (interactive) (help/insert-it-then-real-space ?\.)) (defun help/dot-real () (interactive) (help/real-insert ?\.)) (defun help/semicolon-space () (interactive) (help/insert-it-then-real-space ?\;)) (defun help/semicolon-real () (interactive) (help/real-insert ?\;)) (defun help/comma-space () (interactive) (help/insert-it-then-real-space ?\,)) (defun help/comma-real () (interactive) (help/real-insert ?\,)) #+END_SRC ** Typography :PROPERTIES: :ID: org_gcr_2017-05-12_mara:A5224E7E-EBAA-4970-951F-7405F04D4A26 :END: - Use 78 characters for a text document - Column 0 is the first possible character - Column 77 is the last possible character - Column 78 will always be empty - This is the fill column - This gives some spacing between the text body and the 80 column indicator - Column 79 will always be the fill column indicator - It *isn't* the fill column though - I want it to indicate 80 chars, typically the maximum number of columns for a line, to know how to size the window itself - Store this as the fill column because all supporting functions will do the right thing here #+NAME: org_gcr_2017-05-12_mara_7354096C-3F3A-408E-8F1C-79ABB054040F #+BEGIN_SRC emacs-lisp (defconst help/column-width 78) (setq-default fill-column help/column-width) #+END_SRC Two spaces follow a colon Two spaces after a semi-colon. One space after comma. #+NAME: org_gcr_2017-05-12_mara_38909B55-115D-44E4-B84F-70285016BF92 #+BEGIN_SRC emacs-lisp (setq colon-double-space nil) #+END_SRC Don't correct quotes in text until I make ispell handle it correctly. #+name: org_gcr_2018-09-29T16-11-05-05-00_cosmicality_3B4179ED-7D66-43AC-9DC5-5DE279747D6D #+begin_src emacs-lisp :tangle no (electric-quote-mode) #+end_src ** Buffer :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D4FC68F9-CEA3-455A-B718-EBDB113CFA71 :END: Maintain buffers across sessions. Desktop-Save-Mode persists every part of the buffer. If you upgrade a package that uses buffer-variables that have changed you may get unexpected behavior. Close all buffers and open them again after making such breaking changes. #+NAME: org_gcr_2017-05-12_mara_1986C8FB-6C8F-43F6-811D-D95577160064 #+BEGIN_SRC emacs-lisp (desktop-save-mode t) (setq desktop-restore-eager 5) #+END_SRC Provide expected "Undo" functionality. #+NAME: org_gcr_2017-05-12_mara_40A89EBE-247D-43B1-A606-896B172681D8 #+BEGIN_SRC emacs-lisp (use-package undo-tree :ensure t :config (global-undo-tree-mode 1) (global-set-key (kbd "M-/") #'undo-tree-redo) (global-set-key (kbd "C-M-/") #'undo-tree-visualize) :diminish undo-tree-mode) #+END_SRC Ever file must end with a [[https://robots.thoughtbot.com/no-newline-at-end-of-file][newline]]. #+NAME: org_gcr_2017-05-12_mara_B41C6C0B-AC1A-44A4-9D0F-471A781BCA81 #+BEGIN_SRC emacs-lisp (setq require-final-newline t) #+END_SRC If you are on the end of a line, and go up or down, then go to the end of line on that new line. Do not account for anything special about the character there. #+NAME: org_gcr_2017-05-12_mara_60C775FC-0ACD-47E3-8724-8F4C48980081 #+BEGIN_SRC emacs-lisp (setq track-eol t) (setq line-move-visual nil) #+END_SRC Take the cursor with scroll activities. #+NAME: org_gcr_2017-05-12_mara_6E2D611F-11F0-4703-AC88-AA11CEE56F8D #+BEGIN_SRC emacs-lisp (setq scroll-preserve-screen-position t) #+END_SRC Scroll text line-by-line as the cursor scrolls off of the screen. Nice to keep the document from jumping around. Not nice for scrolling when you want to quickly see the next ten or twenty lines. But ~recenter-top-bottom~ give you that so you can have both features easily. #+NAME: org_gcr_2017-05-12_mara_F6787724-7C59-4BD3-B436-0AB39E4F96E9 #+BEGIN_SRC emacs-lisp (setq scroll-conservatively 101) #+END_SRC More easily visualize tabular data. Considered to non-subjective. #+NAME: org_gcr_2017-05-12_mara_1BA609EB-C430-4CE0-BD33-9524EBB5A0AC #+BEGIN_SRC emacs-lisp (use-package stripe-buffer :ensure t) #+END_SRC End sentences with a single space. #+NAME: org_gcr_2017-05-12_mara_1710CA80-60CB-4E40-94E9-C38A2E0A0DE9 #+BEGIN_SRC emacs-lisp (setq sentence-end-double-space nil) #+END_SRC Ban white-space at end of lines, globally. #+NAME: org_gcr_2017-05-12_mara_A04E6B4A-EFC6-4AE3-946B-E08CF4E02DD9 #+BEGIN_SRC emacs-lisp (add-hook 'before-save-hook #'help/delete-trailing-whitespace) #+END_SRC Intelligently select the current char, then word, then object, then block, then document. #+NAME: org_gcr_2017-05-12_mara_14A9724E-F0E0-40CA-9FD8-142CB77B87BF #+BEGIN_SRC emacs-lisp (use-package expand-region :ensure t) #+END_SRC Configure Page-Break-Lines-Mode to visualize the formfeed character: ~C-q C-l~. #+NAME: org_gcr_2017-05-12_mara_11CC1DCC-05D6-4564-A40B-DE2AD0A7C46D #+BEGIN_SRC emacs-lisp (use-package page-break-lines :ensure t :diminish page-break-lines-mode) #+END_SRC Center the buffer after navigating pages. #+NAME: org_gcr_2017-05-12_mara_87233BFD-A241-48A6-9113-B383B30F9BC5 #+BEGIN_SRC emacs-lisp (advice-add #'backward-page :after #'recenter) (advice-add #'forward-page :after #'recenter) #+END_SRC Do the /right thing/ for getting to the start of the line. #+NAME: org_gcr_2017-05-12_mara_B8BDE36B-4B27-4580-BA34-35C047FBEA62 #+BEGIN_SRC emacs-lisp (use-package mwim :ensure t :config (global-set-key (kbd "C-a") 'mwim-beginning-of-code-or-line)) #+END_SRC Show text indentation guide lines. ~highlight-indentation~ is too difficult to see. #+NAME: org_gcr_2017-06-28_mara_EE77505E-5757-409C-9E87-2FA685145AB2 #+BEGIN_SRC emacs-lisp (use-package indent-guide :ensure t :diminish 'indent-guide-mode) #+END_SRC Management: - http://martinowen.net/blog/2010/02/03/tips-for-emacs-ibuffer.html - https://mytechrants.wordpress.com/2010/03/25/emacs-tip-of-the-day-start-using-ibuffer-asap/ - Group approach - See the world organized by? - File names - Buffer names - Mode types - Groups of files - [[https://github.com/purcell/ibuffer-projectile][Projectile project]] idea - Top up to .git dir - [[https://github.com/purcell/ibuffer-vc][Git]] working tree - This is how I see the world - [[https://github.com/abo-abo/hydra/wiki/Ibuffer][Hydra Helper]] #+NAME: org_gcr_2017-05-19_mara_845BEC94-54CC-46D3-B85F-7B537944E328 #+BEGIN_SRC emacs-lisp (defhydra hydra-ibuffer-main (:color pink :hint nil) " ^Navigation^ | ^Mark^ | ^Actions^ | ^View^ -^----------^-+-^----^--------+-^-------^--------+-^----^------- _k_: ʌ | _m_: mark | _D_: delete | _g_: refresh _RET_: visit | _u_: unmark | _S_: save | _s_: sort _j_: v | _*_: specific | _a_: all actions | _/_: filter -^----------^-+-^----^--------+-^-------^--------+-^----^------- " ("j" ibuffer-forward-line) ("RET" ibuffer-visit-buffer :color blue) ("k" ibuffer-backward-line) ("m" ibuffer-mark-forward) ("u" ibuffer-unmark-forward) ("*" hydra-ibuffer-mark/body :color blue) ("D" ibuffer-do-delete) ("S" ibuffer-do-save) ("a" hydra-ibuffer-action/body :color blue) ("g" ibuffer-update) ("s" hydra-ibuffer-sort/body :color blue) ("/" hydra-ibuffer-filter/body :color blue) ("o" ibuffer-visit-buffer-other-window "other window" :color blue) ("q" ibuffer-quit "quit ibuffer" :color blue) ("." nil "toggle hydra" :color blue)) (defhydra hydra-ibuffer-mark (:color teal :columns 5 :after-exit (hydra-ibuffer-main/body)) "Mark" ("*" ibuffer-unmark-all "unmark all") ("M" ibuffer-mark-by-mode "mode") ("m" ibuffer-mark-modified-buffers "modified") ("u" ibuffer-mark-unsaved-buffers "unsaved") ("s" ibuffer-mark-special-buffers "special") ("r" ibuffer-mark-read-only-buffers "read-only") ("/" ibuffer-mark-dired-buffers "dired") ("e" ibuffer-mark-dissociated-buffers "dissociated") ("h" ibuffer-mark-help-buffers "help") ("z" ibuffer-mark-compressed-file-buffers "compressed") ("b" hydra-ibuffer-main/body "back" :color blue)) (defhydra hydra-ibuffer-action (:color teal :columns 4 :after-exit (if (eq major-mode 'ibuffer-mode) (hydra-ibuffer-main/body))) "Action" ("A" ibuffer-do-view "view") ("E" ibuffer-do-eval "eval") ("F" ibuffer-do-shell-command-file "shell-command-file") ("I" ibuffer-do-query-replace-regexp "query-replace-regexp") ("H" ibuffer-do-view-other-frame "view-other-frame") ("N" ibuffer-do-shell-command-pipe-replace "shell-cmd-pipe-replace") ("M" ibuffer-do-toggle-modified "toggle-modified") ("O" ibuffer-do-occur "occur") ("P" ibuffer-do-print "print") ("Q" ibuffer-do-query-replace "query-replace") ("R" ibuffer-do-rename-uniquely "rename-uniquely") ("T" ibuffer-do-toggle-read-only "toggle-read-only") ("U" ibuffer-do-replace-regexp "replace-regexp") ("V" ibuffer-do-revert "revert") ("W" ibuffer-do-view-and-eval "view-and-eval") ("X" ibuffer-do-shell-command-pipe "shell-command-pipe") ("b" nil "back")) (defhydra hydra-ibuffer-sort (:color amaranth :columns 3) "Sort" ("i" ibuffer-invert-sorting "invert") ("a" ibuffer-do-sort-by-alphabetic "alphabetic") ("v" ibuffer-do-sort-by-recency "recently used") ("s" ibuffer-do-sort-by-size "size") ("f" ibuffer-do-sort-by-filename/process "filename") ("m" ibuffer-do-sort-by-major-mode "mode") ("b" hydra-ibuffer-main/body "back" :color blue)) (defhydra hydra-ibuffer-filter (:color amaranth :columns 4) "Filter" ("m" ibuffer-filter-by-used-mode "mode") ("M" ibuffer-filter-by-derived-mode "derived mode") ("n" ibuffer-filter-by-name "name") ("c" ibuffer-filter-by-content "content") ("e" ibuffer-filter-by-predicate "predicate") ("f" ibuffer-filter-by-filename "filename") (">" ibuffer-filter-by-size-gt "size") ("<" ibuffer-filter-by-size-lt "size") ("/" ibuffer-filter-disable "disable") ("b" hydra-ibuffer-main/body "back" :color blue)) (use-package ibuffer :config (key-chord-define ibuffer-mode-map "hh" #'hydra-ibuffer-main/body)) (use-package ibuffer-vc :ensure t) (defun help/ibuffer-hook-fn () "HELP customizations." (interactive) (setq ibuffer-expert t) (setq ibuffer-show-empty-filter-groups nil) (ibuffer-auto-mode t) (stripe-buffer-mode) (ibuffer-vc-set-filter-groups-by-vc-root) (unless (eq ibuffer-sorting-mode 'alphabetic) (ibuffer-do-sort-by-alphabetic))) (add-hook 'ibuffer-mode-hooks #'help/ibuffer-hook-fn) #+END_SRC This package for GNU APL. #+NAME: org_gcr_2017-07-20_mara_51310F49-2C54-43DC-AA11-CA3A4ABF1A5F #+BEGIN_SRC emacs-lisp (use-package face-remap :diminish 'buffer-face-mode) #+END_SRC Move region. #+NAME: org_gcr_2018-01-03_mara_F64F240D-3891-46C0-8989-6124AEF60518 #+BEGIN_SRC emacs-lisp (use-package smart-shift :ensure t :config (global-smart-shift-mode 1) (defhydra help/hydra/smart-shift (:color blue :hint nil) " Smart-Shift: (q to quit) ↑ _i_ ← _j_ _l_ → _k_ ↓ " ("j" smart-shift-left :exit nil) ("k" smart-shift-down :exit nil) ("i" smart-shift-up :exit nil) ("l" smart-shift-right :exit nil) ("q" nil))) #+END_SRC Unfilling #+name: org_gcr_2018-04-12T21-31-52-05-00_mara_4844006E-A8C3-4F45-BA6D-FFC6B3BFF7DC #+begin_src emacs-lisp (use-package unfill :ensure t) #+end_src ** Code Folding :PROPERTIES: :ID: org_gcr_2017-05-12_mara:94245A47-6A25-442A-B458-AD00A3DDA1A2 :END: #+NAME: org_gcr_2017-05-12_mara_611E83B9-E797-4512-95EE-643473026607 #+BEGIN_SRC emacs-lisp (use-package hideshow :config (setq hs-hide-comments-when-hiding-all t) (setq hs-isearch-open t) (defun display-code-line-counts (ov) "Displaying overlay content in echo area or tooltip" (when (eq 'code (overlay-get ov 'hs)) (overlay-put ov 'help-echo (buffer-substring (overlay-start ov) (overlay-end ov))))) (setq hs-set-up-overlay #'display-code-line-counts) (defun help/goto-line () "How do I get it to expand upon a goto-line? hideshow-expand affected block when using goto-line in a collapsed buffer." (call-interactively #'goto-line) (save-excursion (hs-show-block))) (defvar help/my-hs-hide nil "Current state of hideshow for toggling all.") (defun help/my-toggle-hideshow-all () "Toggle hideshow all." (interactive) (setq help/my-hs-hide (not help/my-hs-hide)) (if help/my-hs-hide (hs-hide-all) (hs-show-all))) :diminish hs-minor-mode) #+END_SRC ** Emacs Lisp Macros :PROPERTIES: :ID: org_gcr_2017-05-12_mara:6D4A22CE-EC84-4245-AD7E-2CCC0B35CBCA :END: Macro expander: - ~e~, ~=~, ~RET~ - expand the macro form following point one step - ~c~, ~u~, ~DEL~ - collapse the form following point - ~q~, ~C-c~ ~C-c~ - collapse all expanded forms and exit macrostep-mode - ~n~, ~TAB~ - jump to the next macro form in the expansion - ~p~, ~M-TAB~ - jump to the previous macro form in the expansion #+NAME: org_gcr_2017-05-12_mara_510C1AB4-A266-40A6-9DCF-25B827E60786 #+BEGIN_SRC emacs-lisp (use-package macrostep :ensure t) #+END_SRC ** Evaluation :PROPERTIES: :ID: org_gcr_2017-05-12_mara:C88E8819-35D2-40E0-BBAD-3AC799DA0A33 :END: #+NAME: org_gcr_2017-05-12_mara_CD327ED5-E83D-471F-9A30-B7A3FBB67486 #+BEGIN_SRC emacs-lisp (setq-default eval-expression-print-level nil) #+END_SRC Allow most commands. #+NAME: org_gcr_2017-05-12_mara_41240CBD-3217-466E-BD0F-5737D8BC68BF #+BEGIN_SRC emacs-lisp (put #'upcase-region 'disabled nil) (put #'downcase-region 'disabled nil) (put #'narrow-to-region 'disabled nil) #+END_SRC ** Encryption :PROPERTIES: :ID: org_gcr_2017-05-12_mara:DF56C626-A2CD-4011-9B2E-9863E72F0563 :END: Easy to use file-based AES encryption. #+NAME: org_gcr_2017-05-12_mara_A9233A74-18F8-4C65-AC14-1A6C41F69B80 #+BEGIN_SRC emacs-lisp (add-to-list 'load-path (getenv "CCRYPT")) (use-package ps-ccrypt) #+END_SRC ** Eshell :PROPERTIES: :ID: org_gcr_2017-05-12_mara:5FED47A4-C1F3-4866-AF87-86996BC999CA :END: Provide a cross-platform command line shell that is a first-class EMACS citizen. Commands input in eshell are delegated in order to an alias, a built in command, an Elisp function with the same name, and finally to a system call. Semicolons separate commands. =which= tells you what implementation will satisfy the call that you are going to make. The flag =eshell-prefer-lisp-functions= does what it says. =$$= is the result of the last command. Aliases live in =eshell-aliases-file=. History is maintained and expandable. =eshell-source-file= will run scripts. Since Eshell is not a terminal emulator, you need to configure it for any commands that need to run using a terminal emulator by adding it to to =eshell-visual-commands=. #+NAME: org_gcr_2017-05-12_mara_E5296E8A-C433-4FBF-97EE-8B95918B5A06 #+BEGIN_SRC emacs-lisp (setq eshell-prefer-lisp-functions nil eshell-cmpl-cycle-completions nil eshell-save-history-on-exit t eshell-cmpl-dir-ignore "\\`\\(\\.\\.?\\|CVS\\|\\.svn\\|\\.git\\)/\\'") (eval-after-load "esh-opt" '(progn (use-package em-cmpl) (use-package em-prompt) (use-package em-term) (setenv "PAGER" "cat") (add-to-list 'eshell-visual-commands "ssh") (add-to-list 'eshell-visual-commands "tail") (add-to-list 'eshell-command-completions-alist '("tar" "\\(\\.tar|\\.tgz\\|\\.tar\\.gz\\)\\'")))) #+END_SRC Configure a =PS1= like prompt. #+NAME: org_gcr_2017-05-12_mara_47F75687-F505-42B3-9E2B-EA832B41F7EC #+BEGIN_SRC emacs-lisp (setq eshell-prompt-regexp "^.+@.+:.+> ") (setq eshell-prompt-function (lambda () (concat (user-login-name) "@" (system-name) ":" (eshell/pwd) "⮞ "))) #+END_SRC Mode hook. #+name: org_gcr_2018-08-22T06-50-28-05-00_globigerina_EB364115-FC98-4798-ABD7-C7C7DE6A5BD3 #+begin_src emacs-lisp (defun help/eshell-mode-hook-fn () (message "Welcome to Eshell.") (setq pcomplete-cycle-completions nil)) (add-hook 'eshell-mode-hook #'help/eshell-mode-hook-fn) #+end_src ** File Based System :PROPERTIES: :ID: org_gcr_2017-05-12_mara:E57D0D2A-0BF5-4733-AE1B-7CEA95171316 :END: This system uses artifacts stored in files. It tries to persist file-stores every chance it gets without interrupting the user's flow. Flow is important. Don't create backup files. Instead Git for versioning Automatically back file-stores if no activity has occurred. #+NAME: org_gcr_2017-05-12_mara_11891C85-578F-417F-9956-FEBB52045CDC #+BEGIN_SRC emacs-lisp (setq auto-save-default t) (setq make-backup-files nil) (setq auto-save-visited-file-name t) (setq auto-save-interval 0) (setq auto-save-timeout (* 60 5)) #+END_SRC Backup file-stores when the frame loses focus. #+NAME: org_gcr_2017-05-12_mara_A02347F8-B3BB-4F43-8987-718530B6E053 #+BEGIN_SRC emacs-lisp (add-hook 'focus-out-hook #'help/save-all-file-buffers) #+END_SRC Always keep buffers in-sync with changes in-file. #+NAME: org_gcr_2017-05-12_mara_EE759660-2FB2-4BC1-AC4D-EFD21E5B02C0 #+BEGIN_SRC emacs-lisp (global-auto-revert-mode 1) (diminish 'auto-revert-mode) #+END_SRC Save all files before common activities. Functions are easier to use than advice. #+NAME: org_gcr_2017-05-12_mara_E2747C5E-DA22-4B22-9C0A-EB9DEED9A5F7 #+BEGIN_SRC emacs-lisp (defun help/safb-help/vc-next-action () (interactive) (help/save-all-file-buffers) (help/vc-next-action)) (defun help/safb-vc-ediff () (interactive) (help/save-all-file-buffers) (vc-ediff nil)) (defun help/safb-vc-diff () (interactive) (help/save-all-file-buffers) (vc-diff nil)) (defun help/safb-vc-revert () (interactive) (help/save-all-file-buffers) (vc-revert)) (defun help/safb-help/magit-status () (interactive) (help/save-all-file-buffers) (help/magit-status)) (defun help/safb-org-babel-tangle () (interactive) (help/save-all-file-buffers) (let ((start (current-time))) (message (concat "org-babel-tangle began at: " (help/get-timestamp))) (org-babel-tangle) (let* ((dur (float-time (time-since start))) (msg (format "Tangled for %s " (seconds-to-string dur)))) (message (concat "org-babel-tangle completed on: " (help/get-timestamp))) (message msg) (help/on-gui (alert msg :title "Org-Mode"))))) (defun help/safb-org-babel-detangle () (interactive) (help/save-all-file-buffers) (let ((start (current-time))) (message (concat "org-babel-detangle began at: " (help/get-timestamp) ">")) (org-babel-detangle) (let* ((dur (float-time (time-since start))) (msg (format "DE-Tangled for %s" (seconds-to-string dur)))) (message (concat "org-babel-detangle on: " (help/get-timestamp))) (message msg) (help/on-gui (alert msg :title "Org-Mode"))))) (defun help/safb-other-window () (interactive) (help/save-all-file-buffers) (other-window 1)) (defun help/ace-window () (interactive) (help/save-all-file-buffers) (call-interactively #'ace-window)) (defun help/safb-org-edit-src-code () (interactive) (help/save-all-file-buffers) (org-edit-src-code)) (defun help/safb-org-export-dispatch () (interactive) (help/save-all-file-buffers) (org-export-dispatch)) (defun help/safb-TeX-command-master (&optional arg) (interactive) (help/save-all-file-buffers) (TeX-command-master arg)) (defun help/safb-org-babel-execute-buffer () "Immediately save results." (interactive) (help/save-all-file-buffers) (org-babel-execute-buffer) (help/save-all-file-buffers)) (defun help/safb-org-babel-execute-subtree () "Immediately save results." (interactive) (help/save-all-file-buffers) (org-babel-execute-subtree) (help/save-all-file-buffers)) (defun help/safb-help/org-babel-demarcate-block () (interactive) (help/org-babel-demarcate-block) (help/save-all-file-buffers)) (defun help/safb-save-buffers-kill-terminal () "Partially redundant; kept for consistency among `SAFB' functions." (interactive) (help/save-all-file-buffers) (save-buffers-kill-terminal)) (defun help/safb-help/goto-line () (interactive) (help/save-all-file-buffers) (help/goto-line)) (defun help/safb-switch-to-previous-buffer () (interactive) (help/save-all-file-buffers) (switch-to-previous-buffer)) (defun help/safb-normal-mode () (interactive) (help/save-all-file-buffers) (call-interactively #'normal-mode) (help/save-all-file-buffers)) #+END_SRC Selection: - Don't perform on frequent keys like enter and line navigation. Future candidates: - avy jump - dired - eshell - eval-defun - eval-region - help/newline - goto-line - ielm - ispell - ispell-word - langtool-check-buffer - newline-and-indent - next-line - org-edit-src-exit - org-return - pop-to-mark-command - previous-line - sp-newline - with-current-buffer - writegood-mode Try to visit a non-existent file and get prompted to create its parent directories. #+NAME: org_gcr_2017-05-12_mara_CF605547-BD59-48FD-8CE1-47AD7F28D1B6 #+BEGIN_SRC emacs-lisp (add-to-list 'find-file-not-found-functions #'help/create-non-existent-directory) #+END_SRC Be aware of files larger than 2MiB. Turn off Aggressive-Indent and other expensive features in those buffers. NXML also seems to have a difficult time with large files. #+NAME: org_gcr_2017-05-12_mara_6F55AC0E-3877-4935-B93C-22A132C672AB #+BEGIN_SRC emacs-lisp (setq large-file-warning-threshold (* 1024 1024 2)) #+END_SRC - Always use /tmp for temporary files - Via the thread "[O] org-file using tramp + babel?" #+NAME: org_gcr_2017-05-12_mara_7102B5B4-168F-4E0E-87BD-EEA78DF6837A #+BEGIN_SRC emacs-lisp (setq temporary-file-directory "/tmp") #+END_SRC Probably never modify some files. #+NAME: org_gcr_2017-05-12_mara_F0004AA3-B2A6-4265-A9D5-13590DCBEE9A #+BEGIN_SRC emacs-lisp (use-package hardhat :ensure t :diminish global-hardhat-mode :config (global-hardhat-mode 1)) #+END_SRC Show real end of lines. #+name: org_gcr_2018-06-16T20-53-59-05-00_mara_FDBFB65D-7BF1-4C66-A322-4818B1EF04A9 #+begin_src emacs-lisp (setq inhibit-eol-conversion t) #+end_src Instead of Projectile Projects or other project packages use Filesets. #+name: org_gcr_2019-01-09T11-33-16-06-00_cosmicality_C82FE1F5-A3B3-4D4B-8949-DD8BEC8CCEA6 #+begin_src emacs-lisp (filesets-init) #+end_src ** IMenu :PROPERTIES: :ID: org_gcr_2017-05-12_mara:12791F68-A7B0-4F93-9648-386C65C09355 :END: Major productivity hack #+NAME: org_gcr_2017-05-12_mara_B746C905-E59E-4F33-88F9-5F6CD32C0DE2 #+BEGIN_SRC emacs-lisp (use-package imenu :config (setq imenu-sort-function #'imenu--sort-by-name)) (defun help/try-to-add-imenu () "Add Imenu to modes that have `font-lock-mode' activated. Attribution: URL http://www.emacswiki.org/emacs/ImenuMode" (condition-case nil (imenu-add-to-menubar "Imenu") (error nil))) (add-hook 'font-lock-mode-hook #'help/try-to-add-imenu) #+END_SRC Provide it in a buffer. #+NAME: org_gcr_2017-05-12_mara_E8A1EB03-CB72-4761-BC0A-555670C0D452 #+BEGIN_SRC emacs-lisp (use-package imenu-list :ensure t :config (setq imenu-list-focus-after-activation t) (setq imenu-list-auto-resize t) (setq imenu-list-position 'left) (setq imenu-list-size 40)) #+END_SRC ** Interactive User Interface Completion :PROPERTIES: :ID: org_gcr_2017-05-12_mara:29AAB820-5824-43F8-9E7F-7FD1CB6F4624 :END: ~ivy-use-virtual-buffers~ is a very nice feature but it shoots the cognitive way too high. #+name: org_gcr_2018-11-14T01-09-50-06-00_cosmicality_D0215545-09C4-4118-AA35-BC6FC634E6D1 #+begin_src emacs-lisp (use-package counsel :ensure t :config (use-package amx :ensure t) (use-package flx :ensure t) (ivy-mode 1) (diminish 'ivy-mode) (setq ivy-use-virtual-buffers nil) ;; intentional space before end of string (setq ivy-count-format "｟%d/%d｠ ") (setq ivy-initial-inputs-alist nil) (setq ivy-re-builders-alist '((t . ivy--regex-fuzzy))) (diminish 'ivy-mode) (use-package ivy-rich :ensure t :config (ivy-rich-mode 1) (setq ivy-format-function #'ivy-format-function-line) (setq ivy-rich-path-style 'abbrev))) #+end_src ** Font :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D12919AC-9D9B-4C40-9872-1E01C92FA493 :END: Activate font locking everywhere possible. #+NAME: org_gcr_2017-05-12_mara_ADAB043E-BF70-4AE0-BA60-CD08D82474FA #+BEGIN_SRC emacs-lisp (global-font-lock-mode t) #+END_SRC ** Going to Objects :PROPERTIES: :ID: org_gcr_2017-05-12_mara:8A73E509-A878-4E89-86DC-9BDA8C898F8C :END: Go to any object in the frame quickly. #+NAME: org_gcr_2017-05-12_mara_2B0564C9-2091-4364-8A28-E33A548284A2 #+BEGIN_SRC emacs-lisp (use-package avy :ensure t :config) #+END_SRC ** Grammar :PROPERTIES: :ID: org_gcr_2017-05-12_mara:2E0F4D9D-5AB6-407C-BBC6-BD0277ECA015 :END: Warn of poor grammar immediately interrupting flow with a visual indicator. #+NAME: org_gcr_2017-05-12_mara_9336B241-3511-4BB1-9CBA-30CA8BD4EFAB #+BEGIN_SRC emacs-lisp (use-package writegood-mode :ensure t :config (eval-after-load "writegood-mode" '(diminish 'writegood-mode))) #+END_SRC Integrate Langtool. #+NAME: org_gcr_2017-05-12_mara_1CB16C79-7EC3-4375-BAD3-FC612A1C0B9B #+BEGIN_SRC emacs-lisp (use-package langtool :ensure t :init (setq langtool-language-tool-jar (getenv "LANGTOOL")) (let ((lang "en-US")) (setq langtool-default-language lang) (setq langtool-mother-tongue lang)) (setq langtool-java-bin (concat (getenv "JAVA_HOME") "/bin/java")) (setq langtool-disabled-rules nil) (setq langtool-java-user-arguments '("-Dfile.encoding=UTF-8" )) (setq langtool-user-arguments nil) (setq langtool-disabled-rules '( "DASH_RULE" "WHITESPACE_RULE" "PUNCTUATION_PARAGRAPH_END" "EN_QUOTES" )) (defhydra help/hydra/both/langtool (:color blue :hint nil) " Langtool:^ ^|^ ^|^ -------------------^^+^-------------------^+^---------------------- _h_: check buffer | _j_: next error | _i_: brief message _y_: correct buffer | _k_: previous error | _o_: detailed message _n_: finished | _q_: quit | " ("h" langtool-check :exit nil) ("y" langtool-correct-buffer :exit nil) ("n" langtool-check-done) ("j" langtool-goto-next-error :exit nil) ("k" langtool-goto-previous-error :exit nil) ("i" langtool-show-brief-message-at-point :exit nil) ("o" langtool-show-message-at-point :exit nil) ("q" nil)) (key-chord-define-global "qk" #'help/hydra/both/langtool/body)) #+END_SRC Integrate Proselint. I wanted to load the executable location from =PROSELINT_HOME= but I haven't figured out how yet. ~flycheck-define-checker~ is a macro but I don't know how to expand the string for use in the macro. I tried quasiquote and that was wrong. #+NAME: org_gcr_2017-05-12_mara_A17A873C-5FC0-473F-842F-875CA99981D5 #+BEGIN_SRC emacs-lisp (with-eval-after-load "flycheck" (flycheck-define-checker proselint "A linter for prose." :command ("/Users/gcr/proselint/env/bin/proselint" source-inplace) :error-patterns ((warning line-start (file-name) ":" line ":" column ": " (id (one-or-more (not (any " ")))) (message (one-or-more not-newline) (zero-or-more "\n" (any " ") (one-or-more not-newline))) line-end)) :modes (text-mode org-mode markdown-mode gfm-mode)) (add-to-list 'flycheck-checkers 'proselint)) #+END_SRC ** Keyboard Macros :PROPERTIES: :ID: org_gcr_2017-05-12_mara:F2701D64-8484-4EB0-9FBD-692C98CA3C58 :END: Keep many keyboard macros. #+NAME: org_gcr_2017-05-12_mara_54E04F50-33B3-411D-B759-19408AE1DE48 #+BEGIN_SRC emacs-lisp (setq kmacro-ring-max 32) #+END_SRC Persist keyboard macros in Emacs Lisp alternative to ~insert-kbd-macro~. #+NAME: org_gcr_2017-05-12_mara_0BE407C6-354F-4E92-B7DC-66000217CCE6 #+BEGIN_SRC emacs-lisp (use-package elmacro :ensure t :diminish (elmacro-mode) :config (elmacro-mode)) #+END_SRC ** Word Completion :PROPERTIES: :ID: org_gcr_2017-05-12_mara:DE05FF62-53EA-491A-881B-650030210591 :END: #+NAME: org_gcr_2017-05-12_mara_909723A4-3234-40B4-B741-E59C3C9E3E0A #+BEGIN_SRC emacs-lisp (use-package fuzzy :ensure t) (use-package auto-complete :ensure t :config (use-package auto-complete-config) (setq ac-quick-help-prefer-pos-tip nil) (ac-config-default) (setq ac-auto-start nil) (help/on-gui (ac-set-trigger-key "")) :diminish auto-complete-mode) (use-package auto-complete-chunk :ensure t) #+END_SRC Auto-completion for =.=-separated words. #+NAME: org_gcr_2017-05-12_mara_0F225CED-24F2-4801-A3AF-7E45BF787E71 #+BEGIN_SRC emacs-lisp (use-package auto-complete-chunk :ensure t) #+END_SRC ** Mark, Kill and Region :PROPERTIES: :ID: org_gcr_2017-05-12_mara:432D3FDF-38B3-499D-94D3-338CFEF2957C :END: Easy kill ring access. #+NAME: org_gcr_2017-05-12_mara_DA93DCF6-E0AB-4B92-9708-4DE4781AA2ED #+BEGIN_SRC emacs-lisp (use-package browse-kill-ring :ensure t :config (browse-kill-ring-default-keybindings) (setq browse-kill-ring-highlight-current-entry t) (setq browse-kill-ring-highlight-inserted-item t) (setq browse-kill-ring-show-preview nil) (setq browse-kill-ring-separator "════════════════════════════════════════════════════════════════════════════════") (global-set-key (kbd "M-y") #'browse-kill-ring)) #+END_SRC When you start typing and text is selected, replace it with what you are typing, or pasting #+NAME: org_gcr_2017-05-12_mara_B696F088-B5EB-4507-8EBE-C719995EB5DA #+BEGIN_SRC emacs-lisp (delete-selection-mode t) #+END_SRC Automatically save data copied from the system clipboard into the kill ring before killing Emacs data. Via Ben Maughan: #+BEGIN_QUOTE ;; Save whatever's in the current (system) clipboard before ;; replacing it with the Emacs' text. ;; https://github.com/dakrone/eos/blob/master/eos.org #+END_QUOTE #+NAME: org_gcr_2017-05-12_mara_DDBFF500-4387-47FD-95BD-7F6F369AB0E8 #+BEGIN_SRC emacs-lisp (setq save-interprogram-paste-before-kill t) #+END_SRC [[http://pragmaticemacs.com/emacs/automatically-copy-text-selected-with-the-mouse/][Via]]: copy selected text to the clip board. #+NAME: org_gcr_2017-05-12_mara_087C8A85-9AC0-48C5-A19B-6C5E97F40572 #+BEGIN_SRC emacs-lisp (setq mouse-drag-copy-region t) #+END_SRC ** Minibuffer :PROPERTIES: :ID: org_gcr_2017-05-12_mara:FABF1013-0F88-4207-AB8E-982E7F4C250D :END: Make it easier to answer questions. #+NAME: org_gcr_2017-05-12_mara_F19234A5-0F40-46FE-946A-4B3F47C96424 #+BEGIN_SRC emacs-lisp (fset #'yes-or-no-p #'y-or-n-p) #+END_SRC Comfortably display information. #+NAME: org_gcr_2017-05-12_mara_2B089323-1D60-416F-83A7-792AEE290E67 #+BEGIN_SRC emacs-lisp (setq resize-mini-windows t) (setq max-mini-window-height 0.33) #+END_SRC Allow recursive commands-in-commands and highlight the levels of recursion. #+NAME: org_gcr_2017-05-12_mara_A0D0BC89-5180-4B18-BFDC-17650901FB7F #+BEGIN_SRC emacs-lisp (setq enable-recursive-minibuffers t) (minibuffer-depth-indicate-mode t) #+END_SRC Temporarily give it unlimited memory to speed it up. #+NAME: org_gcr_2017-07-29_mara_59F9B6F3-A62C-424A-AC57-D2677788FF1A #+BEGIN_SRC emacs-lisp (add-hook 'minibuffer-setup-hook #'help/double-gc-cons-threshold) (add-hook 'minibuffer-exit-hook #'help/set-gc-cons-threshold) #+END_SRC ** Mouse :PROPERTIES: :ID: org_gcr_2017-05-12_mara:6171A841-DFD0-44A7-AAA6-BB099B1922FE :END: Scroll pleasantly with the mouse wheel. A slow turn moves the buffer up and down one line at a time. So does a fast turn. Anything further than 5-10 lines deserves a fast navigation vehicle. #+NAME: org_gcr_2017-05-12_mara_4AA275B8-8C5E-498F-969E-28459D7E88E5 #+BEGIN_SRC emacs-lisp (setq mouse-wheel-scroll-amount '(1 ((shift) . 1))) (setq mouse-wheel-progressive-speed nil) (setq mouse-wheel-follow-mouse t) #+END_SRC ** Occur :PROPERTIES: :ID: org_gcr_2017-05-12_mara:54249478-0107-4838-8394-4A6A1850ED99 :END: - Alternate search result background color - Multiple Occur buffers - ~n~ and ~p~ navigate search results - Jump near buffer top #+NAME: org_gcr_2017-05-12_mara_0EB7874B-7C34-4879-97FA-C487115385EE #+BEGIN_SRC emacs-lisp (defun help/occur-mode-hook-fn () "HELP customizations." (interactive) (occur-rename-buffer t)) (add-hook 'occur-mode-hook #'help/occur-mode-hook-fn) (define-key occur-mode-map (kbd "n") #'next-logical-line) (define-key occur-mode-map (kbd "p") #'previous-logical-line) (add-hook 'occur-mode-find-occurrence-hook #'help/recenter-line-near-top-fn) #+END_SRC ** Popups :PROPERTIES: :ID: org_gcr_2017-05-12_mara:5EFCDB34-DC9E-4502-93AD-8E31363F8A5C :END: Provide popup notifications. #+NAME: org_gcr_2017-05-12_mara_66255B58-A96D-445E-83BF-F597E4BA4FB8 #+BEGIN_SRC emacs-lisp (use-package alert :ensure t :config (setq alert-fade-time 10) (setq alert-default-style 'message) (help/on-gui (help/on-mac-os (setq alert-default-style 'notifier))) (setq alert-reveal-idle-time 120)) #+END_SRC #+name: org_gcr_2018-06-12T21-48-52-05-00_mara_AD90D136-9CF3-46CE-8CDF-919A6E95AADD #+begin_src emacs-lisp (require 'popup) #+end_src ** Projects :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BEFE841E-58A8-43D6-84F0-5BA2EBCFE6B8 :END: Directories that have Git working copies are logically projects. Manage them with Projectile. #+NAME: org_gcr_2017-05-12_mara_814E8B43-89FD-4EC2-9C5A-EEE03D92A918 #+BEGIN_SRC emacs-lisp (use-package projectile :ensure t :config (projectile-global-mode t) (global-set-key (kbd "C-S-o") #'projectile-find-file) (help/on-windows (setq projectile-indexing-method 'alien)) (setq projectile-completion-system 'ivy) :diminish projectile-mode) #+END_SRC Notify Magit about every working copy that Projectile knows about. #+NAME: org_gcr_2017-05-12_mara_A3BF1E41-D15E-43FD-A379-E5283602BBB3 #+BEGIN_SRC emacs-lisp (eval-after-load "projectile" '(progn (setq magit-repository-directories (mapcar (lambda (dir) (substring dir 0 -1)) (remove-if-not (lambda (project) (file-directory-p (concat project "/.git/"))) (projectile-relevant-known-projects))) magit-repository-directories-depth 1))) #+END_SRC ** Printing :PROPERTIES: :ID: org_gcr_2017-05-12_mara:93730D86-E142-49E7-9325-0A48D23A8BE5 :END: #+NAME: org_gcr_2017-05-12_mara_22C5C379-532B-488C-A155-6212DB791ED6 #+BEGIN_SRC emacs-lisp (use-package pp :commands (pp-display-expression)) #+END_SRC ** Register :PROPERTIES: :ID: org_gcr_2017-05-12_mara:132C5084-FD72-45C5-BD32-DCE78A00ED34 :END: #+NAME: org_gcr_2017-05-12_mara_5418551F-1788-4236-B98B-B963BE0032F7 #+BEGIN_SRC emacs-lisp (setq register-preview-delay 2) (setq register-separator "\n\n") #+END_SRC ** Replacing :PROPERTIES: :ID: org_gcr_2017-05-12_mara:8DDCD1EC-C603-41D8-85A4-EA7C11C86207 :END: Display information about search-and-or-replace operation. #+NAME: org_gcr_2017-05-12_mara_82232186-B19E-402C-B9E7-6FD6839FD7F6 #+BEGIN_SRC emacs-lisp (use-package anzu :ensure t :config (global-anzu-mode t) (setq anzu-mode-lighter "") (setq anzu-deactivate-region t) (setq anzu-search-threshold 1000) (setq anzu-replace-to-string-separator " ⇒ ")) #+END_SRC ** Save and Restore Operating State :PROPERTIES: :ID: org_gcr_2017-05-12_mara:217B8635-CA69-4F58-A12D-124ED384EE22 :END: *** Mark :PROPERTIES: :ID: org_gcr_2017-05-12_mara:2CBAFE00-5B18-4798-AEF3-488D622374BE :END: When you re-open a file return the mark to its last position https://www.emacswiki.org/emacs/SavePlace #+NAME: org_gcr_2017-05-12_mara_9D56BD82-FDED-4326-9078-547457D593ED #+BEGIN_SRC emacs-lisp (save-place-mode 1) #+END_SRC *** Minibuffer :PROPERTIES: :ID: org_gcr_2017-05-12_mara:88B140F9-567E-47DA-8137-42EF4CE0904E :END: It is nice to have commands and their history saved so that every time you get back to work, you can just re-run stuff as you need it. https://www.emacswiki.org/emacs/SaveHist #+NAME: org_gcr_2017-05-12_mara_2C0AC56F-8956-4EC1-90A9-2FBCC4AA5AD1 #+BEGIN_SRC emacs-lisp (setq savehist-save-minibuffer-history t) (setq savehist-additional-variables '(kill-ring search-ring regexp-search-ring last-kbd-macro kmacro-ring shell-command-history)) (savehist-mode t) #+END_SRC Use the history as a lookup instead of a log. #+NAME: org_gcr_2017-05-12_mara_D92CB94A-5CDE-49D3-83AD-65242EACA752 #+BEGIN_SRC emacs-lisp (setq history-delete-duplicates t) #+END_SRC ** Searching :PROPERTIES: :ID: org_gcr_2017-05-12_mara:AA7F12B0-13E2-4B5A-A8BB-B42E1FCC6E55 :END: *** Internal :PROPERTIES: :ID: org_gcr_2017-05-12_mara:11DF2712-61B1-4E9F-9950-8BDB0E57E580 :END: It is *important* to understand how Emacs performs searching. Copied and pasted Emacs literature from - src_emacs-lisp{(info "(info) Searching Case")} - [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Search-Case.html][Searching and Case]] follows #+BEGIN_EXAMPLE Searches in Emacs normally ignore the case of the text they are searching through, if you specify the text in lower case. Thus, if you specify searching for 'foo', then 'Foo' and 'foo' also match. Regexps, and in particular character sets, behave likewise: '[ab]' matches 'a' or 'A' or 'b' or 'B'. An upper-case letter anywhere in the incremental search string makes the search case-sensitive. Thus, searching for 'Foo' does not find 'foo' or 'FOO'. This applies to regular expression search as well as to string search. The effect ceases if you delete the upper-case letter from the search string. If you set the variable case-fold-search to nil, then all letters must match exactly, including case. This is a per-buffer variable; altering the variable normally affects only the current buffer, unless you change its default value. See Locals. This variable applies to nonincremental searches also, including those performed by the replace commands (see Replace) and the minibuffer history matching commands (see Minibuffer History). Typing M-c within an incremental search toggles the case sensitivity of that search. The effect does not extend beyond the current incremental search to the next one, but it does override the effect of adding or removing an upper-case letter in the current search. #+END_EXAMPLE So let Emacs search how it was built to search instead of attempting to make it case-sensitive everywhere. Emacs already makes it easy to perform case-sensitive searches when you want. It is simple and predictable. When you don't want to do that interactively type M-c in the search input area to toggle case sensitivity. When you don't want to do that non-interactively then search for that command or activities toggling variable ~M-x apropos-variable RET case-fold-search RET~ and bind it during the search. Make ~isearch~ automatically search for Unicode homoglyphs of the search characters. #+NAME: org_gcr_2017-08-01_mara_98164910-DD0A-4AAE-A9B2-FAF864BCCE1C #+BEGIN_SRC emacs-lisp (setq search-default-mode #'char-fold-to-regexp) #+END_SRC Ditto for replace. #+NAME: org_gcr_2017-08-01_mara_1FA6AB2F-B0A9-491E-89D3-BFDFBD173EDD #+BEGIN_SRC emacs-lisp (setq replace-char-fold t) #+END_SRC *** External :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D55FB85E-A70E-4A56-AA5F-089B4FE52E7F :END: Writeable Grep integration. #+NAME: org_gcr_2017-05-12_mara_9F40A141-4464-4D4C-A062-54BEC12992FF #+BEGIN_SRC emacs-lisp (use-package wgrep :ensure t :config (setq wgrep-auto-save-buffer t)) #+END_SRC Ag integration. #+NAME: org_gcr_2017-05-12_mara_58F6AD1E-7E9B-4650-B859-F9C0540C74B6 #+BEGIN_SRC emacs-lisp (use-package ag :ensure t :config (setq ag-highlight-search t) (setq ag-reuse-window nil) (setq ag-reuse-buffers nil) (add-to-list 'ag-arguments "--hidden") (defun help/ag-mode-hook-fn () "HELP ag customizations." (interactive) (turn-on-stripe-buffer-mode)) (defun help/ag-mode-finished-hook-fn () "HELP ag finished hook function." (interactive) (let ((compilation-scroll-output 'first-error)) (pop-to-buffer next-error-last-buffer))) (add-hook 'ag-mode-hook #'help/ag-mode-hook-fn) (add-hook 'ag-search-finished-hook #'help/ag-mode-finished-hook-fn) (defhydra help/hydra/ag (:color blue :hint nil) " `ag', The Silver Searcher: Present in window: Search in folder: _j_ limit search by file type _k_ search in everything Search in project: _l_ limit search by file type _;_ search in everything Present in dired: Search in folder: _u_ limit search by file type _i_ search in everything Search in project: _o_ limit search by file type _p_ search in everything Other: _n_ close every other buffer _m_ close every buffer _q_ quit " ("u" ag-dired-regexp) ("i" ag-dired) ("o" ag-project-dired-regexp) ("p" ag-project-dired) ("j" ag-files) ("k" ag) ("l" ag-project-files) (";" ag-project) ("n" ag-kill-other-buffers) ("m" ag-kill-buffers) ("q" nil))) #+END_SRC Writeable Ag. #+NAME: org_gcr_2017-05-12_mara_E4E1E1A0-1353-4483-BE1C-746097F60CB6 #+BEGIN_SRC emacs-lisp (use-package wgrep-ag :ensure t :after ag) #+END_SRC ** Spell Checking :PROPERTIES: :ID: org_gcr_2017-05-12_mara:44909368-2D9A-40B9-A3F4-DF297A0EE570 :END: Ispell is simple and powerful. *** Org-Mode :PROPERTIES: :ID: org_gcr_2017-05-12_mara:4892BEB5-C0B5-4506-BBB3-40E41F9E25FF :END: Never ispell the following objects. Block regex helper. #+NAME: org_gcr_2017-05-12_mara_5EDEEFA9-7DED-41D9-AD9D-5C48BA580AC5 #+BEGIN_SRC emacs-lisp (defun help/block-regex (special) "Make an ispell skip-region alist for a SPECIAL block." (interactive) `(,(concat help/org-special-pre "BEGIN_" special) . ,(concat help/org-special-pre "END_" special))) #+END_SRC Source-Blocks. #+NAME: org_gcr_2017-05-12_mara_D15F7E3E-9D35-4AB3-A043-67154E3D588A #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist (help/block-regex "SRC")) #+END_SRC Example-Blocks. This system often uses Source-Blocks to edit content and Example-Blocks to make it easily renderable when it is not for running. #+NAME: org_gcr_2017-05-12_mara_EB14B834-8486-4750-96C5-E5E3CFB4C19B #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist (help/block-regex "EXAMPLE")) #+END_SRC Properties. #+NAME: org_gcr_2017-05-12_mara_F7E77F03-5A3E-4DC1-A345-4BE8E4C7FF11 #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist '("^\s*:PROPERTIES\:$" . "^\s*:END\:$")) #+END_SRC Footnotes. #+NAME: org_gcr_2017-05-12_mara_5459C549-E938-4899-827D-D03707983E52 #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist '("\\[fn:.+:" . "\\]")) #+END_SRC Footnotes with URLs that contain line-breaks. #+NAME: org_gcr_2017-05-12_mara_ECD4198B-7335-4141-8256-971748EE4D22 #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist '("^http" . "\\]")) #+END_SRC Bold text list items. #+NAME: org_gcr_2017-05-12_mara_1048E593-5E66-4F70-A591-B17A18634D8F #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist '("- \\*.+" . ".*\\*: ")) #+END_SRC Right arrows. #+NAME: org_gcr_2017-05-12_mara_5DB6D56D-1C05-4816-8BB6-8F3E936E5EFC #+BEGIN_SRC emacs-lisp (add-to-list 'ispell-skip-region-alist '("\\rarr")) #+END_SRC Check =SPECIAL LINE= definitions, ignoring their type. #+NAME: org_gcr_2017-05-12_mara_5C415ECB-91FC-44C2-9886-29704EF74836 #+BEGIN_SRC emacs-lisp (let () (--each '(("ATTR_LATEX" nil) ("AUTHOR" nil) ("BLOG" nil) ("CREATOR" nil) ("DATE" nil) ("DESCRIPTION" nil) ("EMAIL" nil) ("EXCLUDE_TAGS" nil) ("HTML_CONTAINER" nil) ("HTML_DOCTYPE" nil) ("HTML_HEAD" nil) ("HTML_HEAD_EXTRA" nil) ("HTML_LINK_HOME" nil) ("HTML_LINK_UP" nil) ("HTML_MATHJAX" nil) ("INFOJS_OPT" nil) ("KEYWORDS" nil) ("LANGUAGE" nil) ("LATEX_CLASS" nil) ("LATEX_CLASS_OPTIONS" nil) ("LATEX_HEADER" nil) ("LATEX_HEADER_EXTRA" nil) ("NAME" t) ("OPTIONS" t) ("POSTID" nil) ("RESULTS" t) ("SELECT_TAGS" nil) ("STARTUP" nil) ("TITLE" nil)) (add-to-list 'ispell-skip-region-alist (let ((special (concat "#[+]" (car it) ":"))) (if (cadr it) (cons special "$") (list special)))))) #+END_SRC ** Syntax Checking :PROPERTIES: :ID: org_gcr_2017-05-12_mara:DD506D5A-5F57-4939-B446-536437FDDC97 :END: Do not perform syntactic analysis on-demand. Something about my config makes global-mode puke and kill Emacs every so often. #+NAME: org_gcr_2017-05-12_mara_9931B79E-7900-4DE1-B097-45A8DE90CB44 #+BEGIN_SRC emacs-lisp (use-package flycheck :ensure t :diminish flycheck-mode) #+END_SRC ** TAB :PROPERTIES: :ID: org_gcr_2017-05-12_mara:C9ACAB8C-1D19-4CC2-ABE9-ACEBCDBCA9E6 :END: Most modes in this system will never use TAB stops. #+NAME: org_gcr_2017-05-12_mara_C23EBD24-B2DC-40CB-9F9E-CAEB03FF8EDC #+BEGIN_SRC emacs-lisp (setq-default indent-tabs-mode nil) #+END_SRC Functions to remove TAB It is at least unpleasant removing tabs that somebody wanted in the file, and for that alone it is worth removing untabification from the on save buffer file hook. Worst case it ruins files for example Makefiles or tab-delimited data files. #+NAME: org_gcr_2017-05-12_mara_3FFCD7B4-0055-4BE8-938F-EEA09D077343 #+BEGIN_SRC emacs-lisp (defun help/untabify-buffer-if-not-indent-tabs-mode () "Untabify buffer if `indent-tabs-mode' is false. Attribution: URL `http://www.emacswiki.org/emacs/UntabifyUponSave'" (interactive) (when (not indent-tabs-mode) (untabify (point-min) (point-max)))) (defun help/untabify-buffer-or-region-if-not-indent-tabs-mode () "Untabify a region if selected, otherwise the whole buffer. URL: `http://emacsredux.com/blog/2013/03/27/indent-region-or-buffer/'" (interactive) (save-excursion (if (region-active-p) (progn (untabify (region-beginning) (region-end)) (message "Untabified selected region.")) (progn (help/untabify-buffer-if-not-indent-tabs-mode) (message "Untabified buffer."))))) #+END_SRC JavaScript programmers set tabs to 2. C programmers set it to 8. Makefiles looks great at 4. 4 is the average and it looks good in exported LaTeX listings. #+NAME: org_gcr_2017-05-12_mara_5A73C4A8-C2AE-4F36-9D64-3FB6A4FF31E0 #+BEGIN_SRC emacs-lisp (setq-default tab-width 4) #+END_SRC ** Version Control :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BDC3035D-4F09-4A7B-8F14-1EE4604ACC0D :END: Use VC for single files and Magit for multiple files. #+NAME: org_gcr_2017-05-12_mara_3E77B825-E0A4-40EC-88DC-3F5C1E1445CE #+BEGIN_SRC emacs-lisp (use-package magit :ensure t :config (with-eval-after-load 'info (info-initialize) (add-to-list 'Info-directory-list ;; TODO remove this "~/src/magit/Documentation/")) (setq magit-completing-read-function 'ivy-completing-read) (use-package magit-filenotify :ensure t :config (add-hook 'magit-status-mode-hook 'magit-filenotify-mode))) #+END_SRC Close Magit-process related buffers when they become obselete. #+name: org_gcr_2018-02-24_mara_A2D8DA8E-CE8C-4F26-9DED-7E0AA2DD3CCA #+begin_src emacs-lisp (defun help/magit-kill-buffers () "Restore window configuration and kill all Magit buffers. Attribution: URL `https://manuel-uberti.github.io/emacs/2018/02/17/magit-bury-buffer/'" (interactive) (let ((buffers (magit-mode-get-buffers))) (magit-restore-window-configuration) (mapc #'kill-buffer buffers))) (bind-key "q" #'help/magit-kill-buffers magit-status-mode-map) #+end_src Leave the VC message template empty. #+NAME: org_gcr_2017-05-12_mara_A078BCD9-1559-412A-8D51-528CDDD4E402 #+BEGIN_SRC emacs-lisp (eval-after-load "log-edit" '(remove-hook 'log-edit-hook 'log-edit-insert-message-template)) #+END_SRC Change browsing. #+NAME: org_gcr_2017-05-12_mara_A696BECA-ED39-4A7A-911A-66C396E0925C #+BEGIN_SRC emacs-lisp (use-package git-timemachine :ensure t) #+END_SRC VC activity keybindings. #+NAME: org_gcr_2017-05-12_mara_A4E407FE-DD42-458A-BD83-2EFD71C1D728 #+BEGIN_SRC emacs-lisp (global-set-key (kbd "C-M-w") #'help/hydra/words/body) (global-set-key (kbd "H-e") #'help/safb-help/magit-status) (global-set-key (kbd "H-f") #'help/safb-help/vc-next-action) #+END_SRC Git ignore files are text files. #+NAME: org_gcr_2017-05-12_mara_C374930E-5AE3-478D-B3F1-E7791791D530 #+BEGIN_SRC emacs-lisp (add-to-list 'auto-mode-alist '(".gitignore$" . text-mode)) #+END_SRC Git config files. #+NAME: org_gcr_2017-05-12_mara_0183A8E0-5A59-4A4B-9260-FF5E8C5CAF2C #+BEGIN_SRC emacs-lisp (use-package gitignore-mode :ensure t) (use-package gitconfig-mode :ensure t) (use-package gitattributes-mode :ensure t) #+END_SRC Quick note about intent of the change. #+NAME: org_gcr_2017-12-22_mara_9F9E1F38-1FD7-474F-B2D9-4D9086316632 #+BEGIN_SRC emacs-lisp (defhydra help/hydra/commit-message (:color blue :hint nil) " Commit Message Descriptor (q to quit) _E_nhances: \"an increase or improvement in quality, value, or extent.\" _R_efines: \"the improvement or clarification of something by the making of small changes.\" _C_orrects: \"a change that rectifies an error or inaccuracy.\" C_l_oses | _F_ixes | Resol_v_es _A_rchives | Rest_o_res | Re_f_iles " ("E" (lambda () (interactive) (insert "(nhncs) "))) ("R" (lambda () (interactive) (insert "(rfns) "))) ("C" (lambda () (interactive) (insert "(crrcts) "))) ("l" (lambda () (interactive (insert "Closes #")))) ("F" (lambda () (interactive (insert "Fixes #")))) ("v" (lambda () (interactive (insert "Resolves #")))) ("A" (lambda () (interactive (insert "(rchvs) ")))) ("o" (lambda () (interactive (insert "(rstrs) ")))) ("f" (lambda () (interactive (insert "(rfls) ")))) ("q" nil)) #+END_SRC Commit message mode hook. #+NAME: org_gcr_2017-12-22_mara_93DCBFA6-1D9E-4126-ABA7-070A42297927 #+BEGIN_SRC emacs-lisp (defun help/commit-message-mode-hook-fn () "HELP Commit Message Mode Hook Function" (key-chord-define-local "hh" #'help/hydra/commit-message/body)) (add-hook 'vc-git-log-edit-mode-hook #'help/commit-message-mode-hook-fn) (add-hook 'git-commit-setup-hook #'help/commit-message-mode-hook-fn) #+END_SRC Smerge. #+NAME: org_gcr_2018-01-04_mara_3088E232-25CB-4DCA-8FA0-ADD739504E08 #+BEGIN_SRC emacs-lisp (diminish "smerge-mode") #+END_SRC ** Video :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BB0F7B20-AC2C-49DB-B6A2-07D3C5D7A197 :END: [[http://endlessparentheses.com/embedding-youtube-videos-with-org-mode-links.html][Embedding Youtube videos with org-mode links]]. #+NAME: org_gcr_2017-05-12_mara_BCF6CC3A-98AD-4845-BBE2-EB601E1A8550 #+BEGIN_SRC emacs-lisp (defvar yt-iframe-format ;; You may want to change your width and height. (concat "")) (org-add-link-type "yt" (lambda (handle) (browse-url (concat "https://www.youtube.com/embed/" handle))) (lambda (path desc backend) (cl-case backend (html (format yt-iframe-format path (or desc ""))) (latex (format "\href{%s}{%s}" path (or desc "video")))))) #+END_SRC ** Whitespace Management :PROPERTIES: :ID: org_gcr_2017-05-12_mara:9FBD1929-29C7-45CE-B9EC-DF0711778439 :END: - Visible Whitespace - Tabs #+NAME: org_gcr_2017-05-12_mara_081024E6-F582-40DF-A96F-7216725FDD00 #+BEGIN_SRC emacs-lisp (use-package whitespace :ensure t :config (setq whitespace-style '(tab-mark)) (setq whitespace-display-mappings '((tab-mark ?\t [?↹ ?\t] [?␉ ?\t] [?\t]))) (setq whitespace-line-column help/column-width) (global-whitespace-mode nil) (setq whitespace-global-modes '(not go-mode)) :diminish whitespace-mode global-whitespace-mode) #+END_SRC ** whoami :PROPERTIES: :ID: org_gcr_2018-06-17T11-45-33-05-00_mara:F4562648-EFF8-4C9A-8F2E-08F32E9D7473 :END: #+name: org_gcr_2018-06-17T11-45-33-05-00_mara_6EACD283-EEC3-4A5D-968D-85F37294C887 #+begin_src emacs-lisp (setq user-mail-address "gcr@wisdomandwonder.com") #+end_src ** Word Wrap :PROPERTIES: :ID: org_gcr_2017-05-12_mara:202157D8-58BB-4250-BDDD-98ADBF97F801 :END: #+NAME: org_gcr_2017-05-12_mara_BC6CD3BC-C736-40EE-84FD-33E2BB514A0C #+BEGIN_SRC emacs-lisp (diminish 'visual-line-mode) #+END_SRC How VLM works here: - At the end of visible line, which is where the wrap occurred, show a right curly arrow to draw your eye to the next line and back left to the beginning of it. - At the start of this new visible line, where the wrap continued, show a right straight arrow to draw your eye forward to continue the wrapped line where you came from. With these VLM settings, along with delete trailing whitespace on save, you don't need end of line indicators because every line is either: - An end of line with no trailing spaces between the last character and the newline - The line exceeds the maximum visible length desired so it has wrapped and you see arrows in the left and right fringe so you know that the isn't a newline in that visible line. You'll see a row that starts with a right arrow, and with nothing, and the line above that will have a right curly arrow. #+NAME: org_gcr_2017-05-12_mara_EA8B5E3D-0F0B-4BD8-A510-864EC04BABD7 #+BEGIN_SRC emacs-lisp (setq visual-line-fringe-indicators '(right-arrow right-curly-arrow)) #+END_SRC * Hacking :PROPERTIES: :ID: org_gcr_2017-05-12_mara:E900FBB2-2D32-4253-BFE6-36BC951384A2 :END: Emacs has [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Basic-Major-Modes.html#Basic-Major-Modes][three primal major modes that you must understand]]: - ~text-mode~ - ~prog-mode~ - ~special-mode~ ** Common Configurations :PROPERTIES: :ID: org_gcr_2017-05-12_mara:1864484F-237D-4443-BDD6-D429AAB7BD1A :END: This system configures ~text-mode~ and ~prog-mode~ very similarly: - EMACS *exists* to help you work with text. - EMACS' entire configuration helps you work with text whether it is in a specific mode or not. - Org-Mode's motto is "*Organize Your Life In Plain Text!*". - From an EMACS and a LP perspective ~text-mode~ *is a* programming mode. - In this system: *Text is the User-Interface*. This system does not rely on ~prog-mode~ inheritance to configure it's hacking modes: - The EMACS literature advises that modes extend ~text-mode~ or ~prog-mode~ - That /would/ make it easier to configure nearly everything using ~prog-mode-hook~. - In practice ~prog-mode~ is too new. - Not all programming modes inherit from it. Not even =IELM= is ready. With that in mind this system: - Defines common configuration here for reuse in every desired mode starting with =text-mode= and then all logical programming modes. - Explicitly utilizes it directly instead of using inheritance. - This system refers to this configuration of programming modes as =prog*-mode=. - The line between "configuring EMACS", "configuring ~text-mode~", and "configuring ~prog*-mode~" is often blurred and sometimes confusing. The lines become wavy and intertwined with mastery of EMACS and LP. Make sense of the current mode. #+NAME: org_gcr_2017-05-23_mara_9517CF5A-C95B-454E-A68F-1E4BA677C08C #+BEGIN_SRC emacs-lisp (use-package parent-mode :ensure t :config (defun help/parent-mode-display () "Display this buffer's mode hierarchy." (interactive) (let ((ls (parent-mode-list major-mode))) (princ ls)))) #+END_SRC *** Special Mode :PROPERTIES: :ID: org_gcr_2017-06-25_mara:7C9667D1-C881-40AC-9312-EB11A9F4F61E :END: Every special mode needs this. Which is nothing yet. *** Text-Mode :PROPERTIES: :ID: org_gcr_2017-05-12_mara:C3270DE0-55FD-4612-B3E3-226CAC5A8FDA :END: Auto-Capitalize text modes. #+NAME: org_gcr_2017-11-30_mara_75B00948-177E-487A-83A9-2F690611CA59 #+BEGIN_SRC emacs-lisp (add-to-list 'load-path "~/src/auto-capitalize") (eval-after-load "auto-capitalize" '(diminish "auto-capitalize-mode")) (require 'auto-capitalize) (diminish 'auto-capitalize-mode) (dolist (it '( "24B" "Emacs" "Fr" "God" "HTTP" "HTTPS" "I'll" "I'm" "Internet" "Mantra" "OK" "SI" "Sri" "StoneIsle" "Tantra" "Vidya" "VIM" "Yantra" "Yoga" )) (add-to-list 'auto-capitalize-words it)) (add-to-list 'desktop-minor-mode-handlers '(auto-capitalize . (lambda (desktop-buffer-locals)))) #+END_SRC Wrap Selection. #+NAME: org_gcr_2017-05-12_mara_CE6FE001-F609-4096-8807-9AB65010AD53 #+BEGIN_SRC emacs-lisp (use-package wrap-region :ensure t :config :diminish wrap-region-mode :config (wrap-region-add-wrapper "'" "'" nil 'text-mode) (wrap-region-add-wrapper "\"" "\"" nil 'text-mode) (wrap-region-add-wrapper "*" "*" nil 'text-mode) (wrap-region-add-wrapper "/" "/" nil 'text-mode) (wrap-region-add-wrapper "=" "=" nil 'text-mode) (wrap-region-add-wrapper "~" "~" nil 'text-mode) (wrap-region-add-wrapper "+" "+" nil 'text-mode)) #+END_SRC Every text editing buffer needs this. #+NAME: org_gcr_2017-05-12_mara_1FF81C16-BEB0-4B42-806A-D033566FC63F #+BEGIN_SRC emacs-lisp (defun help/text-mode-fn () "HELP's standard configuration for buffer's working with text, often for programming." (interactive) (auto-fill-mode) (diminish 'auto-fill-function) (visual-line-mode) (help/try-to-add-imenu) (turn-on-page-break-lines-mode) (turn-on-auto-capitalize-mode) (wrap-region-mode) (local-set-key (kbd ".") #'help/dot-space) (local-set-key (kbd "C-.") #'help/dot-real) (local-set-key (kbd ";") #'help/semicolon-space) (local-set-key (kbd "C-\;") #'help/semicolon-real) (local-set-key (kbd ",") #'help/comma-space) (local-set-key (kbd "C-,") #'help/comma-real) (local-set-key (kbd "C-n") #'next-logical-line) (local-set-key (kbd "C-p") #'previous-logical-line)) (add-hook 'text-mode-hook #'help/text-mode-fn) #+END_SRC Can use in source blocks. #+NAME: org_gcr_2017-11-17_mara_FCDC3DE5-3584-4431-A443-FFC8F9EA8253 #+BEGIN_SRC emacs-lisp (add-to-list 'org-babel-load-languages '(text . t)) #+END_SRC *** Prog-Mode Modes :PROPERTIES: :ID: org_gcr_2017-05-12_mara:E20FE37A-E10D-406C-B95D-545607F7A93C :END: - Mode inheritance is represented by list definition & indentation. - Some modes are so simple that inheritance isn't defined. - Hacking mode hooks. - Configurations common to every hacking vehicle. #+NAME: org_gcr_2017-05-12_mara_B9BA4FF5-62AC-4806-8E74-766E36C5148C #+BEGIN_SRC emacs-lisp (setq help/prog-modes '(makefile-mode-hook ruby-mode-hook sh-mode-hook plantuml-mode-hook tex-mode-hook R-mode-hook SAS-mode-hook graphviz-dot-mode-hook c-mode-common-hook php-mode-hook scad-mode-hook web-mode-hook js2-mode-hook json-mode-hook yaml-mode-hook crontab-mode-hook apache-mode-hook python-mode-hook gnu-apl-mode-hook geiser-mode-hook geiser-repl-mode-hook go-mode-hook TeX-mode-hook apples-mode-hook php-mode-hook)) #+END_SRC - LISP mode hooks. - Are hacking modes. #+NAME: org_gcr_2017-05-12_mara_F410CDAB-D4FE-42B8-BCB7-F37DC500CE86 #+BEGIN_SRC emacs-lisp (setq help/lisp-modes '(emacs-lisp-mode-hook ielm-mode-hook lisp-interaction-mode-hook scheme-mode-hook inferior-scheme-mode-hook geiser-mode-hook geiser-repl-mode-hook)) (setq help/prog-modes (append help/prog-modes help/lisp-modes)) #+END_SRC - IELM mode hook. - Does one or two more things. *** Prog-Mode Hook Function :PROPERTIES: :ID: org_gcr_2017-05-12_mara:750D5ACE-FB06-4A71-A0C1-634C71198A5F :END: **** Goal :PROPERTIES: :ID: org_gcr_2017-05-12_mara:34B0116F-B50F-487A-A605-0D31C07F6773 :END: - Indent at every opportunity and automatically. Verify that it makes sense for the mode then enable or disable it. Originally enabled for individual modes. That worked fine until I wanted to disable it for a mode where the mode hook ran before the ~prog-mode-hook~ ran. Well that didn't work because the child disabled this mode and then the parent enabled it again. You aren't supposed to rely on order of execution in them so I am switching to global mode and updating the excluded list in the same granular manner. In affect, nothing has changed. #+NAME: org_gcr_2017-05-12_mara_02408658-D767-4D6E-8AAA-2BE1933BCBD1 #+BEGIN_SRC emacs-lisp (use-package aggressive-indent :ensure t :diminish aggressive-indent-mode :config (global-aggressive-indent-mode) (add-to-list 'aggressive-indent-excluded-modes 'minibuffer-inactive-mode)) #+END_SRC - Always maintain balanced brackets. Easily wrap the selected region. Auto-escape strings pasted into other strings. Smartparens provides built-in correct behavior for most modes. #+NAME: org_gcr_2017-05-12_mara_3AB5C00B-E0FF-40A1-9C3B-420CB4E8D417 #+BEGIN_SRC emacs-lisp (use-package smartparens :ensure t :config (setq sp-show-pair-from-inside nil) (require 'smartparens-config) :diminish smartparens-mode) #+END_SRC **** Implementation :PROPERTIES: :ID: org_gcr_2017-05-12_mara:7917A66D-8F20-43A1-888A-E9F0C86C23A7 :END: #+NAME: org_gcr_2017-05-12_mara_A3C53136-65BE-4771-A214-19E102E0158B #+BEGIN_SRC emacs-lisp (defun help/prog-mode-hook-fn () (interactive) (help/text-mode-fn) (smartparens-strict-mode) (unless (equal major-mode 'fundamental-mode) (hs-minor-mode)) (help/on-gui (local-set-key (kbd "") #'newline-and-indent)) (turn-off-auto-capitalize-mode)) (let () (--each help/prog-modes (add-hook it #'help/prog-mode-hook-fn))) #+END_SRC ** General :PROPERTIES: :ID: org_gcr_2019-02-21T21-33-51-06-00_cosmicality:070707B9-13AD-46FC-B41A-515FAC425DAC :END: #+name: org_gcr_2019-02-21T21-33-51-06-00_cosmicality_0D9EEE4B-C8E1-423D-B8FA-68176011EF63 #+begin_src emacs-lisp (use-package dumb-jump :ensure t :config (setq dumb-jump-default-project "~/src") (setq dumb-jump-quiet t) (setq dumb-jump-selector 'ivy) (defhydra help/hydra/dumb-jump (:color blue :hint nil) " Dumb Jump _g_o (_o_ther) _b_ack _p_eek promp_t_ go e_x_ternal (othe_r_) _q_uit" ("g" dumb-jump-go) ("o" dumb-jump-go-other-window) ("b" dumb-jump-back) ("p" dumb-jump-quick-look) ("t" dumb-jump-go-prompt) ("x" dumb-jump-go-prefer-external) ("r" dumb-jump-go-prefer-external-other-window) ("q" nil))) #+end_src #+name: org_gcr_2019-02-23T23-09-09-06-00_cosmicality_522D8DFE-CD6B-4940-BF4C-73D7C4B0A4C3 #+begin_src emacs-lisp (use-package beginend :ensure t :config (beginend-global-mode)) #+end_src ** Literate Programming :PROPERTIES: :ID: org_gcr_2017-05-12_mara:18EBD4EF-AFAD-4421-A09F-A7DB14AD1398 :END: *** Emacs Lisp :PROPERTIES: :ID: org_gcr_2017-05-12_mara:3A31F89D-2534-4E5F-8C3B-3CEBAFAC9E2D :END: Have fun with scratch. #+NAME: org_gcr_2017-05-12_mara_C344E972-D31C-48F4-8E3B-83A799DE7D37 #+BEGIN_SRC emacs-lisp (setq initial-scratch-message ";; Happy Hacking ☕\n\n") #+END_SRC Use ~emacs-lisp~ in scratch. #+NAME: org_gcr_2017-05-12_mara_A929CBE0-E6D3-4A45-8341-15F50EF2F93A #+BEGIN_SRC emacs-lisp (setq initial-major-mode 'emacs-lisp-mode) #+END_SRC Immortal scratch [[https://www.reddit.com/r/emacs/comments/4cmfwp/scratch_buffer_hacks_to_increase_its_utility/][via]]. #+NAME: org_gcr_2017-05-12_mara_1F06F375-41F5-48FA-B787-8B937BDF56FC #+BEGIN_SRC emacs-lisp (with-current-buffer "*scratch*" (emacs-lock-mode 'kill)) #+END_SRC Persistent scratch. #+NAME: org_gcr_2017-05-12_mara_2757B16C-18ED-4F29-8DFD-CE51B930BA81 #+BEGIN_SRC emacs-lisp (use-package persistent-scratch :ensure t :config (persistent-scratch-setup-default)) #+END_SRC Broadcast scoping mode. #+NAME: org_gcr_2017-05-12_mara_BEA970EF-78FA-448D-96B3-1E135640D16A #+BEGIN_SRC emacs-lisp (use-package lexbind-mode :ensure t) #+END_SRC Symbol visualization. #+NAME: org_gcr_2017-07-16_mara_766EBC8F-2A7C-49BB-9916-BE2AAEE019A4 #+BEGIN_SRC emacs-lisp (use-package highlight-quoted :ensure t) #+END_SRC Quasi-Quote visualization. #+NAME: org_gcr_2017-07-16_mara_A1EC88B1-71CF-458E-A626-D6A07108BA3F #+BEGIN_SRC emacs-lisp (use-package highlight-stages :ensure t :config (diminish 'highlight-stages-mode)) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_D8F41BFE-D2F5-4B86-BFED-B3DE5EA2133C #+BEGIN_SRC emacs-lisp (defun help/elisp-eval-buffer () "Intelligently evaluate an Elisp buffer." (interactive) (help/save-all-file-buffers) (eval-buffer)) (defun help/elisp-mode-local-bindings () "Helpful behavior for Elisp buffers." (local-set-key (kbd "H-l eb") #'help/elisp-eval-buffer) (local-set-key (kbd "H-l ep") #'eval-print-last-sexp) (local-set-key (kbd "H-l td") #'toggle-debug-on-error) (local-set-key (kbd "H-l mef") #'macroexpand) (local-set-key (kbd "H-l mea") #'macroexpand-all) (local-set-key (kbd "H-0") #'pp-macroexpand-last-sexp) ;; TODO Don’t bind right side ;; (local-set-key (kbd "H-*") #'lispy-oneline) ;; (local-set-key (kbd "H-9") #'macrostep-expand) ;; (local-set-key (kbd "H-8") #'lispy-multiline) ) (defhydra help/hydra-elisp-mode (:color blue :hint nil) " elisp-mode: _q_uit Evaluation: buffe_r_, byte _c_ompile file, check _p_arens, e_d_ebug defun ERT: _i_nteractively, _b_atch, _d_elete all Reformat s-expr: _m_ultiline or _o_ne line Other: Generate _R_eadme _C_heckdoc " ("q" nil) ("r" eval-buffer) ("c" (lambda () (interactive) (byte-compile-file (buffer-file-name)))) ("p" check-parens) ("e" edebug-defun) ("i" (lambda () (interactive) (eval-buffer) (call-interactively 'ert))) ("b" (lambda () (interactive) (eval-buffer) (ert-run-tests-batch))) ("d" ert-delete-all-tests) ("m" lispy-multiline) ("o" lispy-oneline) ("R" (lambda () (interactive) (el2markdown-write-file "README.md" t))) ("C" checkdoc)) (key-chord-define emacs-lisp-mode-map "hh" #'help/hydra-elisp-mode/body) (defun help/emacs-lisp-mode-hook-fn () (interactive) (help/elisp-mode-local-bindings) (lexbind-mode) (eldoc-mode) (diminish 'eldoc-mode) (highlight-quoted-mode) (highlight-stages-mode) (let ((electric-quote-comment t) (electric-quote-string t)) (electric-quote-local-mode))) (setq ielm-noisy nil) (setq ielm-prompt "ⅇLISP⮞ ") (setq ielm-dynamic-return nil) (setq ielm-dynamic-multiline-inputs nil) (defun help/ielm-mode-hook-fn () "HELP customizations." (interactive) (help/ielm-auto-complete) (local-unset-key (kbd "C-j")) (local-set-key (kbd "") #'ielm-send-input)) (add-hook 'ielm-mode-hook #'help/ielm-mode-hook-fn) (defun help/general-lisp-prettify () (mapc (lambda (pair) (push pair prettify-symbols-alist)) '(("nil" . ?∅) ("*" . ?×) ("/" . ?÷) ("<=" . ?≤) (">=" . ?≥) ("lambda" . ?λ) ("not" . ?¬) ("and" . ?∧) ("or" . ?∨) ("sqrt" . ?√)))) (defun help/general-lisp-mode-hook-fn () (highlight-quoted-mode) (highlight-stages-mode) (help/general-lisp-prettify) (local-set-key (kbd "#") #'endless/sharp)) (let () (--each help/lisp-modes (add-hook it #'help/general-lisp-mode-hook-fn))) (add-hook 'emacs-lisp-mode-hook #'help/emacs-lisp-mode-hook-fn) #+END_SRC "find callers of elisp functions or macros". #+NAME: org_gcr_2017-05-12_mara_7DB4D819-0D2D-482B-AA02-9CB14F6DA288 #+BEGIN_SRC emacs-lisp (use-package elisp-refs :ensure t) #+END_SRC Package lint. #+NAME: org_gcr_2017-05-12_mara_2B359320-563A-4E80-BB8E-04965E20EBEE #+BEGIN_SRC emacs-lisp (use-package package-lint :ensure t) (use-package flycheck-package :ensure t :after (package-lint)) #+END_SRC Lispy super editing functions. #+name: org_gcr_2018-03-27T21-28-18-05-00_mara_02B76E03-F34A-45A7-A7DC-30209F91095E #+begin_src emacs-lisp (use-package lispy :ensure t) #+end_src Quality. #+name: org_gcr_2019-02-03T21-22-21-06-00_cosmicality_8E44B122-56DB-45EA-BCE2-4B39C0C2883E #+begin_src emacs-lisp (require 'checkdoc) (setq checkdoc-package-keywords-flag t) #+end_src Font lock ~let-alist~ names like keywords. #+name: org_gcr_2019-03-02T18-08-48-06-00_cosmicality_0D886E6B-2FB9-4B87-B17E-C67F964E80D4 #+begin_src emacs-lisp (font-lock-add-keywords 'emacs-lisp-mode '(("\\_<\\.\\(?:\\sw\\|\\s_\\)+\\_>" 0 font-lock-builtin-face))) #+end_src *** Org-Mode :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D017621F-5169-442A-A52C-7D91EEB7D796 :END: **** Literate Programming :PROPERTIES: :ID: org_gcr_2017-05-12_mara:CD4943EE-DE3D-4B3A-AB12-525580DC8EB7 :END: When source blocks are evaluated, their results get stored in a result area, typically for display. If the results are small, they are displayed with colons instead of an =example= block. Instead, *always* place them in an example block. This makes exports more consistent and other Org-Mode features seem to behave more predictably. #+NAME: org_gcr_2017-05-12_mara_9D21E326-1742-4DD0-BDF9-624D21873F92 #+BEGIN_SRC emacs-lisp (setq org-babel-min-lines-for-block-output 0) #+END_SRC Configure Org-Mode to manage it's Source-Block backed buffers the same as the rest of this system. #+NAME: org_gcr_2017-05-12_mara_9427EB38-B623-4B99-B562-C2FD737EB0D7 #+BEGIN_SRC emacs-lisp (setq org-edit-src-auto-save-idle-delay 0) (setq org-edit-src-turn-on-auto-save nil) #+END_SRC Update in-buffer images after Source-Block execution. This is a programming task. That is why it is under this heading and Evaluation. This is a setting configuring how the results of evaluation are refreshed in EMACS. #+NAME: org_gcr_2017-05-12_mara_780AFFD3-B8F3-4D0F-A3C1-DB30C2182730 #+BEGIN_SRC emacs-lisp (defun help/org-babel-after-execute-hook () "HELP settings for the `org-babel-after-execute-hook'. This does not interfere with exports. Attribution: URL `https://lists.gnu.org/archive/html/emacs-orgmode/2015-01/msg00534.html'" (interactive) (org-redisplay-inline-images)) (add-hook 'org-babel-after-execute-hook #'help/org-babel-after-execute-hook) #+END_SRC Never "automatically" evaluate a source block. #+NAME: org_gcr_2017-05-12_mara_F0536A1B-195D-4AB9-90B8-D73651740849 #+BEGIN_SRC emacs-lisp (setq org-confirm-babel-evaluate nil) #+END_SRC Make it unpleasant for Sysop to modify source-block outside of a source-block backed buffer. The next step is to write some code to prevent modifying source-blocks outside of that place. #+NAME: org_gcr_2017-05-12_mara_B804AA93-9D3B-4DC8-BFA3-658DD1FB0601 #+BEGIN_SRC emacs-lisp (setq org-src-tab-acts-natively nil) #+END_SRC **** Workflow / TO-DO Objects :PROPERTIES: :ID: org_gcr_2017-05-12_mara:0CFAE46B-8D06-48FB-8D7E-7B636C91D443 :END: - Custom TODO workflow states requirements, each answering the following questions: - Version 01 - What needs to be done? TODO - What is being done right now? IN-PROGRESS - What is waiting because an external agent? HELD-BLOCKED - What is waiting because I have put it on hold? HELD-FROZEN - What is waiting until another date? (although I'm not using the Agenda) HELD-UNTIL - What is complete and needs to be reviewed? REVIEW - What is complete? DONE - Version 02 - Questions about every state - When was it created? - The purpose of its creation is contained within its Headline and its contents "when?" and "why?" aren't required - When was it changed and why? - The reason for the change is probably in the body of the Headline so why bother keeping a note here? Bother because it makes it easier to review the state-change of a task because - It probably isn't worth keeping in the task long-term (it is transient) - But it still matters and I want to know about it - If it is worth keeping in the task long-term then it will be there but - It makes it easier to review the modification of a task without - Having to re-read the entire task to understand the context - Track down the why it modified - When did it complete (done or not) and why? - The goals for completion are probably in the body of the Headline itself so why keeping a note here? Bother because it makes it easier to review the completion of a task without - Having to re-read the entire task to understand the context - Track down the why it completed - Migration from Version 01 - TODO \rarr no change (timestamp) - IN-PROGRESS \rarr GO (timestamp) (not DO because of DONE fastkey) - HELD-BLOCKED \rarr WAIT with note (timestamp, explanation) - HELD-FROZEN \rarr WAIT with note (timestamp, explanation) - HELD-UNTIL \rarr WAIT with note (timestamp, explanation) - REVIEW \rarr no change (timestamp) - DONE \rarr no change (timestamp, explanation) - Workflow cheatsheet for every state change - Entry related - =!= store a timestamp when *entered* - =@= store a timestamp with a note when *entered* - =C-c C-c= provides an empty note - Exit related - =/!= *in addition* to the state's entry configuration - record a timestamp when *leaving* - /if and only if/ - the target state not already configure logging when entering it - Access related - =char= defines a fast-access key for the state name #+NAME: org_gcr_2017-05-12_mara_9DE5CE12-157D-4516-9FB1-7DAFA02C571E #+BEGIN_SRC emacs-lisp (setq org-todo-keywords '((sequence "TODO(t!)" "GO(g@)" "WAIT(w@)" "BLOCKED(b@)" "REVIEW(r!)" "|" "DONE(d@)" "CANCELED(c@)" "DUPLICATE(p@)" ))) #+END_SRC - Reference - [[http://stackoverflow.com/questions/12262220/add-created-date-property-to-todos-in-org-mode][StackOverflow: Add CREATED date property to TODOs in org-mode]] - [[http://orgmode.org/org.html#Workflow-states][Org: 5.2.1 TODO keywords as workflow states]] - [[http://orgmode.org/org.html#Tracking-TODO-state-changes][5.3.2 Tracking TODO state changes]] It is easier to understand the history of a task by reading it in chronological order. #+NAME: org_gcr_2017-05-12_mara_B237C004-4827-4C39-A9B9-4D0FF9B01053 #+BEGIN_SRC emacs-lisp (setq org-log-states-order-reversed nil) #+END_SRC Make it easy to hide the state changes until I want to see them with a Drawer. #+NAME: org_gcr_2017-05-12_mara_32AAD797-A7D7-416D-9CE2-425EB96781A7 #+BEGIN_SRC emacs-lisp (setq org-log-into-drawer t) #+END_SRC Maintain state when archiving a heading. #+NAME: org_gcr_2017-05-12_mara_B6F42ECC-14C0-4C60-8E00-6BBF883B3043 #+BEGIN_SRC emacs-lisp (setq org-archive-mark-done nil) #+END_SRC Inline Tasks. #+name: org_gcr_2018-05-23T09-03-14-05-00_mara_E899B70E-F49F-4ADC-9C4C-819F1B40D5AE #+begin_src emacs-lisp (require 'org-inlinetask) #+end_src **** Refile :PROPERTIES: :ID: org_gcr_2017-05-12_mara:C09D993C-6E48-4C84-8460-585F0A10DA63 :END: ***** Context :PROPERTIES: :ID: org_gcr_2017-05-12_mara:DFCC7C00-F3B3-4C35-BBE6-A5ADBB60326D :END: I wrote my first to-do list on a funeral home notepad. It was either that or it was from the furniture store. My dad worked at both. The National Selected Morticians logo sat somewhere on its pages. There wasn't much for me to note back then and the notepad worked fine. When I got a little older I graduated to a Mead spiral notebook. I wasn't organized and wasted space. When you tore out the pages they made a mess. At home we had two computers over the years an Apple 2E and then a IBM PC compatible. Mom used PFS Write on the 2E and I used Notepad once in a while but my usage on both games. They were at home but they were not my home. The mad was my home until college where I made two new friends: Composition Book (CB) and Bill Joy's ~vi~. CB seemed like an elegant upgrade from the Mead spiral but it didn't last. CB's lines were too tall and the pages were too short, the worst of both worlds. The speckled black and white covers were its most useful part which was it's beauty as no one would ever have guessed. Compared to the Mead, the CB's were downright elegant. That leaves ~vi~. Mrs. Marian Manyo prepared a handout to help us learn ~vi~. It was a single page. ~SunOS~ was at a whopping version of 5.7 yet the handout left ink on your finger suggesting that it a mimeograph instead of a Xerox that deposited it into our awaiting writing fingers. It has seven commands that I learned: open, close, save, close and save, insert and command mode. That worked to store my todo list for years. This as before CVS usurped RCS so backups were basic. My workflow had two states: existence and non-existence. Simple. This well for another nineteen years. Until I followed the GTD approach but in a simpler ad-hock form. Emacs was never part of my life even when it lived next door to vi. Growing up on the cusp of beefy IDEs living on puny desktops most schools weren't rooted in the tradition of LISP and Emacs and I never joined it. Scheme got my attention though and it sucked me into Emacs, but it didn't keep me. Twice I tried. Nope. Three times I tried and at the end I liked Emacs a little bit worse. Then something funny happened: I wanted to learn OCaml. Emacs was the only good editor for it, so I dug up Emacs. Then I wanted to learn SML and go figure: Emacs was the only good editor for it. The same story was retold ten or fifteen times. The proverbial lotus kept expanding every time you touched because not only did satisfy your ideas but it gave you new ones. Totally hooked, I am still keeping my todo lists in ASCII text files. Then three years I heard about Org-Mode. My first Org file had you guessed it: lists converted into headings. Oops, that wasn't right so I converted them all to lists. That worked well for years. Then I got interested in publishing and spent another year with headings and lists. A year or so ago I got tired of my ad-hock workflow I checked if Org had a way to deal with workflow. Of course it did! Then I got interested in tracking state changes, and of course it had that. Beautiful. This whole story lives here to introduce refile. When I moved headings I moved them by selecting the whole subtree, killing it, and pasting it somewhere else. Fifteen or twenty times I lost the heading. Sure VCS saved it but it was a hassle and a mess, a total frustration. My error was not marking the entire subtree. Oops. When I searched for a solution I ended up on the refile page. Of course that is how you do it. Now /what/ was the /it/ that I wanted to do? ***** Desire :PROPERTIES: :ID: org_gcr_2017-05-12_mara:E2BDFB86-4DCC-41BE-9F00-BFB085E547D6 :END: Three or four Org-Mode files sit open in buffers for the entire year. Once in a while there are new ones added but they usually replace one of the original four. Exceptions are one-offs like provisioning scripts for my systems at work or at home. Rarely a heading grows so large that it graduates to its own file. This is by design: I refuse to pre-optimize and grow a menagerie files to house every ever taxonomy conceivable only to end up retiring the file having closed only a single heading. Here is how my usage looks to me: - 99.00% of the time I am working in the same three files - Refiling across subtrees at level two - <00.90% of the time I am moving headings to level zero, or the top level of the document - <00.09% of the time I am moving headings into a different file My predictable and small usage makes for an easy system configuration goal below. ***** Implementation :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BB186822-AFD2-4609-8CFB-DD7542E3D532 :END: ****** Core :PROPERTIES: :ID: org_gcr_2017-05-12_mara:59F948C7-2606-4637-8EF6-4922BD231A9B :END: Because 99% of the time I will refile headings as sub-headings within the same file I never need to configure =Refile= file targets in ~org-refile-targets~. Refiling at any depth makes #+NAME: org_gcr_2017-05-12_mara_DEE287C2-5B88-4015-9B4F-57DA0F922B0C #+BEGIN_SRC emacs-lisp (setq org-refile-targets '((nil . (:maxlevel . 10)))) (setq org-refile-use-outline-path t) #+END_SRC doing so natural, flexible and efficient Because <90% I'm moving headings to level zero I want to - Make it easy when I need it which is not often - Make it difficult the rest of the time because I don't want to accidentally move headings there. It isn't the end of the world I just don't want to do it accidentally because I will be /rarely/ doing so in the first place. - Single previx argument (4) Because <09% of the time I am moving headings into a new file - Make it as easy and a difficult as moving to the top-level - Prompt for the file name - If it does not exist ~Org~ will transparently create it - Perform the move - Single previx argument (16) #+NAME: org_gcr_2017-05-12_mara_7B11F38B-157A-400A-8F93-68E610D47128 #+BEGIN_SRC emacs-lisp (defun help/org-refile (arg) "Refile to /level/ in /file/ by using use /prefix args/: 2+/this/[none], 1+/this/1, 1/choose-file/2" (interactive "P") (cond ((not (null arg)) (let ((val (car current-prefix-arg)) (current-prefix-arg nil) (org-refile-use-outline-path 'file) (org-reverse-note-order nil)) (cond ((= val 4) (call-interactively 'org-refile)) ((= val 16) (let* ((fil (read-file-name "Enter destination file: ")) (xfil (expand-file-name fil)) (_ (when (not (file-exists-p xfil)) (with-temp-file xfil (insert)))) (org-refile-targets `((,xfil :maxlevel . 10)))) (progn (call-interactively 'org-refile) (find-file xfil))))))) (t (call-interactively 'org-refile)))) #+END_SRC ****** General Operation :PROPERTIES: :ID: org_gcr_2017-05-12_mara:16842F15-40C2-4E68-83F2-EBD425569FCB :END: - Refiles are always coming from another headline to this headline. They are new and need to be prioritized. When they are in front it is easy to notice because your eyes go there first (even know you /are/ the one refiling) #+NAME: org_gcr_2017-05-12_mara_29930A09-6462-4BE7-9AE2-18DC1858666C #+BEGIN_SRC emacs-lisp (setq org-reverse-note-order t) #+END_SRC - Select headings with the full path immediately instead of with clunky depth-first navigation #+NAME: org_gcr_2017-05-12_mara_E0E01F45-C01E-4F6E-AE8D-1B0073ECB377 #+BEGIN_SRC emacs-lisp (setq org-outline-path-complete-in-steps nil) #+END_SRC - Create a new parent heading destination first instead of using this GUI to do it because it is error prone to do it in the naviation GUI despite the available confirmation message #+NAME: org_gcr_2017-05-12_mara_07650079-9AE1-4291-97A3-BCFD0628C95D #+BEGIN_SRC emacs-lisp (setq org-refile-allow-creating-parent-nodes nil) #+END_SRC - Track refile operations to make sense of why the =Refile= occurred in the same spirit of how the workflow state changes are recorded #+NAME: org_gcr_2017-05-12_mara_7E513EE1-3EF9-415B-BB94-2135CBFB0E74 #+BEGIN_SRC emacs-lisp (setq org-log-refile 'note) #+END_SRC **** Properties :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D73BDF5F-AA12-4832-9B28-CADEC71D2B6C :END: Select a region, yank it, maybe choose a property under the current headline and set it's value to the killed text. #+NAME: org_gcr_2017-05-12_mara_1F938B98-B056-4381-833C-2C9B835B1C23 #+BEGIN_SRC emacs-lisp (defun org-read-entry-property-name () "Read a property name from the current entry." (let ((completion-ignore-case t) (default-prop (or (and (org-at-property-p) (org-match-string-no-properties 2)) org-last-set-property))) (org-completing-read (format "Property [%s]: " (if default-prop default-prop "")) (org-entry-properties nil nil) nil nil nil nil default-prop))) (defun my-org-region-to-property (&optional property) "Copies the region as value to an Org-mode property" (interactive) ;; if no region is defined, do nothing (if (use-region-p) ;; if a region string is found, ask for a property and set property to ;; the string in the region (let ((val (replace-regexp-in-string "\\`[ \t\n]*" "" (replace-regexp-in-string "[ \t\n]*\\'" "" (substring (buffer-string) (- (region-beginning) 1) (region-end)))) ) ;; if none was stated by user, read property from user (prop (or property (org-read-entry-property-name)))) ;; set property (org-set-property prop val)))) #+END_SRC **** Tables :PROPERTIES: :ID: org_gcr_2017-05-12_mara:862B1BEA-4FAD-4FA1-8666-39E2FFA2BB4F :END: Essential for using tables with split windows. #+NAME: org_gcr_2017-05-12_mara_8CE235AC-A7C4-48DF-8C97-46CC7F31CDF4 #+BEGIN_SRC emacs-lisp (use-package org-table-sticky-header :ensure t :config (add-hook 'org-mode-hook #'org-table-sticky-header-mode) (diminish 'org-table-sticky-header-mode)) #+END_SRC Exports to TSV. CSV is too much of a pain for handling commas. #+name: org_gcr_2018-05-17T22-08-31-05-00_mara_AE590C3B-9E70-4694-A2B1-B4EA164D36FB #+begin_src emacs-lisp (setq org-table-export-default-format "orgtbl-to-tsv") #+end_src **** Publishing With TeX :PROPERTIES: :ID: org_gcr_2018-03-07_mara:5C1154DE-B06C-444D-BB7B-32F0294BF64B :END: ***** Engine :PROPERTIES: :ID: org_gcr_2018-03-07_mara:BF9E72A9-58C7-4BD8-B0E3-60185434EADF :END: Use XeTeX. #+name: org_gcr_2018-03-07_mara_D89CE4CB-12B1-47A6-9B0B-EA544343BA85 #+begin_src emacs-lisp (setq org-latex-compiler "xelatex") (setq org-latex-pdf-process '("latexmk -xelatex -quiet -shell-escape -f %f")) #+end_src ***** Packages :PROPERTIES: :ID: org_gcr_2018-03-07_mara:AE89B25B-486B-41BD-B3C5-C9499D93A4F2 :END: ****** Installation :PROPERTIES: :ID: org_gcr_2018-04-28T19-58-14-05-00_mara:B51D7F56-0F8F-4206-8775-E6871618E28C :END: Copied and customized from [[https://github.com/kaushalmodi/.emacs.d/blob/master/setup-files/setup-org.el][here]]. #+name: org_gcr_2018-03-07_mara_C60306B4-7FB0-45AB-B39F-2BF47FA39604 #+begin_src emacs-lisp (setq org-latex-default-packages-alist (delq (rassoc '("hyperref" nil) org-latex-default-packages-alist) org-latex-default-packages-alist)) (defconst help/org-latex-packages-alist-pre-hyperref '(("letterpaper,margin=1.0in" "geometry") ("" "float"))) (defconst help/org-latex-packages-alist-post-hyperref '(("" "fontspec") ("section" "placeins") ("" "tikz") ("" "caption") ("" "latexsym") ("" "lettrine") ("" "listings") ("" "color") ("" "fancyvrb") ("" "fancyhdr") ("" "scrlayer-scrpage") ("" "lastpage") ("" "polyglossia") ("" "tabularx") ("" "tabu") ("" "grantcrettke"))) (setq org-latex-packages-alist (append help/org-latex-packages-alist-pre-hyperref '(("" "hyperref" nil)) help/org-latex-packages-alist-post-hyperref)) #+end_src ****** Configuration :PROPERTIES: :ID: org_gcr_2018-04-28T19-58-14-05-00_mara:8CC6E1C3-5300-4D9D-AB13-A064276342FB :END: #+name: org_gcr_2018-04-28T19-58-14-05-00_mara_50C0EEF0-A896-44B3-AC2B-0635552A723A #+begin_src emacs-lisp (setq org-latex-listings-options '(("basicstyle" "\\ttfamily") ("breakatwhitespace" "false") ("breakautoindent" "true") ("breaklines" "true") ("columns" "[c]fullflexible") ("commentstyle" "") ("emptylines" "*") ("extendedchars" "false") ("fancyvrb" "true") ("firstnumber" "auto") ("flexiblecolumns" "false") ("frame" "single") ("frameround" "tttt") ("identifierstyle" "") ("keepspaces" "true") ("keywordstyle" "") ("mathescape" "false") ("numbers" "left") ("numbers" "none") ("numbersep" "5pt") ("numberstyle" "\\tiny") ("resetmargins" "false") ("showlines" "true") ("showspaces" "false") ("showstringspaces" "false") ("showtabs" "true") ("stepnumber" "2") ("stringstyle" "") ("tab" "↹") ("tabsize" "4") ("texcl" "false") ("upquote" "false"))) #+end_src ***** Classes :PROPERTIES: :ID: org_gcr_2018-03-07_mara:D397AC3E-DFED-4228-B8CD-7D62318414E9 :END: Standard article class. #+NAME: org_gcr_2017-05-12_mara_006EB5E3-5478-43C7-AEAC-34CCF49127AC #+BEGIN_SRC emacs-lisp (eval-after-load "ox-latex" '(add-to-list 'org-latex-classes '("help-article" "\\documentclass[12pt]{article}"))) (setq org-latex-default-class "help-article") #+END_SRC ***** Printing Source Code :PROPERTIES: :ID: org_gcr_2018-04-28T19-58-14-05-00_mara:5CF00598-18B1-473C-804E-6A49AE8E0C51 :END: #+name: org_gcr_2018-04-28T19-58-14-05-00_mara_C24D46F9-B35E-4D87-B47D-662D29F4173A #+begin_src emacs-lisp (setq org-latex-listings t) #+end_src ***** Unclassified :PROPERTIES: :ID: org_gcr_2018-03-07_mara:593C2BE0-5AD2-4654-B44B-C7F80F33F99A :END: Don't float images. #+name: org_gcr_2018-03-07_mara_22B13787-67AA-4462-949B-3C1E6702EB7C #+begin_src emacs-lisp (setq org-latex-default-figure-position "H") #+end_src **** Unclassified :PROPERTIES: :ID: org_gcr_2017-05-12_mara:FD7E89EA-72DC-4395-AE07-4CAA66B8BD28 :END: When running in a GUI, I would like linked images to be displayed inside of Emacs. #+NAME: org_gcr_2017-05-12_mara_9A50B1B6-9446-4CE2-AC58-5ED8878E9041 #+BEGIN_SRC emacs-lisp (setq org-startup-with-inline-images (display-graphic-p)) #+END_SRC Org-Mode lets you use single letter commands to do stuff on headers. I like to use =c= for cycling the header expansion. #+NAME: org_gcr_2017-05-12_mara_C5BBF231-E413-4A62-9367-A25932090329 #+BEGIN_SRC emacs-lisp (setq org-use-speed-commands t) #+END_SRC Ask before execution of shell links. This might seem like an Evaluation activity. It is. It is interactive. #+NAME: org_gcr_2017-05-12_mara_D874DF5C-61BE-4EF9-97F7-5C77927F8656 #+BEGIN_SRC emacs-lisp (setq org-confirm-shell-link-function 'y-or-n-p) #+END_SRC Ask before execution of Emacs-Lisp. #+NAME: org_gcr_2017-05-12_mara_7715C738-ADCF-4DA7-BB26-DF37B5A55460 #+BEGIN_SRC emacs-lisp (setq org-confirm-elisp-link-function 'y-or-n-p) #+END_SRC Make sure that incomplete TODO entries prevent the enclosing parent from ever turning to DONE. #+NAME: org_gcr_2017-05-12_mara_40EE32EF-D461-4A4C-BDDA-5203A0EB5279 #+BEGIN_SRC emacs-lisp (setq org-enforce-todo-dependencies t) #+END_SRC Allow the mouse to do Org-Mode things like expand and collapse headings. #+NAME: org_gcr_2017-05-12_mara_065D8A70-E573-4204-B75B-B69F81926188 #+BEGIN_SRC emacs-lisp (when (display-graphic-p) (use-package org-mouse)) #+END_SRC Use a real ellipsis to render an ellipsis for Org-Mode stuff like showing that a header is collapsed. [[http://endlessparentheses.com/changing-the-org-mode-ellipsis.html?source=rss][Artur]] Artur go me thinking that an arrow would be more expressive; in particular revealing that there is more content to be "unrolled" below the current line. #+NAME: org_gcr_2017-05-12_mara_BD01DD8A-9BA2-4240-8B63-6479D1C868CC #+BEGIN_SRC emacs-lisp (setq org-ellipsis "…") #+END_SRC It is easy to see indentation of headlines without having to count asterisks, so don't show them, only show the significant and last one. #+NAME: org_gcr_2017-05-12_mara_D567F41E-C336-402E-A1A3-EB8D4F91CBDC #+BEGIN_SRC emacs-lisp (setq org-hide-leading-stars t) #+END_SRC Maximize character space for writing. Do not indent according to the outline node level because it would waste a lot of space. Ident the next body just like any other text document. #+NAME: org_gcr_2017-05-12_mara_95F90F5A-E6EB-43BE-9EF1-B3F0CCE4B331 #+BEGIN_SRC emacs-lisp (setq org-adapt-indentation nil) #+END_SRC Display emphasized text as you would in a WYSIWYG editor. #+NAME: org_gcr_2017-05-12_mara_563BB770-66CC-431C-98DE-BD3B5B5762AC #+BEGIN_SRC emacs-lisp (setq org-fontify-emphasized-text t) #+END_SRC Use Unicode characters to visualize things like right arrow eg \rarr . Most of those symbols are correctly exported to the destination format. The most obvious is this example in LaTeX versus Text. #+NAME: org_gcr_2017-05-12_mara_5A4B6DC2-4F16-4177-9C8E-0D0CFDE2B24C #+BEGIN_SRC emacs-lisp (setq org-pretty-entities t) #+END_SRC Enable sub and super scripts *only* when wrapped in squiggly brackets. #+NAME: org_gcr_2017-05-12_mara_6488365E-DF20-4300-A979-BA8CE807BBE4 #+BEGIN_SRC emacs-lisp (setq org-use-sub-superscripts '{}) #+END_SRC Highlight LaTeX and related markup. Normally, I don't do any syntax highlighting, as I believe that should be delegated to source buffers, thinking that to do otherwise is distracting. However, I already do configure subscripts and Greek letters to be displayed with syntax highlighting, because I want to indicate to the human reader that they are special, and specifically /not/-Unicode. Do the same thing for LaTeX and related markup. #+NAME: org_gcr_2017-05-12_mara_8D163D72-07DD-42F2-93BA-9C70EC04D22F #+BEGIN_SRC emacs-lisp (setq org-highlight-latex-and-related '(latex script entities)) #+END_SRC Allow "refactoring" of Footnotes between documents. #+NAME: org_gcr_2017-05-12_mara_7A828354-84C9-42DE-B123-E9936D2CC914 #+BEGIN_SRC emacs-lisp (setq org-footnote-define-inline t) (setq org-footnote-auto-label 'random) (setq org-footnote-auto-adjust nil) (setq org-footnote-section nil) #+END_SRC This is an amazingly easy way to screw up your document. The more you edit org docs, the more you realize how you must truly protect it. #+NAME: org_gcr_2017-05-12_mara_C7174763-7D1F-491E-9395-8C4100AEA78D #+BEGIN_SRC emacs-lisp (setq org-catch-invisible-edits 'error) #+END_SRC Though I am not delving deep, it is hard not to want to customize some stuff and perhaps this is the start. Even though I enabled this, I don't think that I ever used it. #+NAME: org_gcr_2017-05-12_mara_E8933212-1893-466F-95D1-BE41ADD2DD68 #+BEGIN_SRC emacs-lisp (setq org-loop-over-headlines-in-active-region t) #+END_SRC It is /almost always/ faster to work with org documents when they are fully expanded. Anyway, the structure cycling makes it really, really easy to get an /outline view/ again. #+NAME: org_gcr_2017-05-12_mara_018F43BF-99DA-4632-B5B0-A291CEBBA6B5 #+BEGIN_SRC emacs-lisp (setq org-startup-folded "nofold") #+END_SRC When images are displayed in the buffer, display them in their actual size. As the operator, I want to know their true form. Any modifications required for export will be stated explicitly. Override this by setting =#+ATTR_ORG: :width N= in the file. #+NAME: org_gcr_2017-05-12_mara_85DCD661-A0DA-4AC2-8EB2-5BD9A4C2D0CB #+BEGIN_SRC emacs-lisp (setq org-image-actual-width t) #+END_SRC Hide the delimeter for emphasized text. Unicode characters break table alignment. #+NAME: org_gcr_2017-05-12_mara_2DD6E6FC-375C-4FA5-BFA4-C6C9B0EAB483 #+BEGIN_SRC emacs-lisp (setq org-hide-emphasis-markers t) #+END_SRC Realign tables automatically. #+NAME: org_gcr_2017-05-12_mara_B5F4B79C-70AD-46D1-AAAF-A4E31091F9B2 #+BEGIN_SRC emacs-lisp (setq org-startup-align-all-tables t) #+END_SRC Always use Unicode checkboxes. #+NAME: org_gcr_2017-05-12_mara_75CA3C3E-CFA6-4FA5-98DA-7EC394781A17 #+BEGIN_SRC emacs-lisp (setq org-html-checkbox-type 'unicode) #+END_SRC You may display syntax highlighting for code in source blocks. I don't. #+NAME: org_gcr_2017-05-12_mara_F04CC035-CFB3-47DB-B1A0-9E58ECE5B01D #+BEGIN_SRC emacs-lisp (setq org-src-fontify-natively nil) #+END_SRC When edit mode is exited, the option exists to automatically remove empty opening and closed lines for the source block. Never do this. The thing is that I forgot why. When I was working on a recent analysis with R there was a space appearing in the opening and closing line of the source block that didn't appear in the source editing buffer. That surprised me. I am sure that I've forgotten why this is the case. I don't like it because you add a bunch of empty lines in the source buffer for every source block. With that in mind I will enable this feature and try it out again. #+NAME: org_gcr_2017-05-12_mara_829BF364-D929-4B12-BFB7-82C6F4105CDA #+BEGIN_SRC emacs-lisp (setq org-src-strip-leading-and-trailing-blank-lines t) #+END_SRC The source block buffer may be configured to appear in a few different places. For a while I really liked =reorganize-frame= because sometimes you want to be able to see the code you are editing in edition to the rest of the document. At least that is what I am telling myself. Once I learned you could change it I realized that 1 I should have asked if it could be changed and 2 I should have changed it. The flow that I've got configured here is that you are either in the source document where code blocks are not highlighted or you are in the source block so you are editing in a buffer that is full-fledged HELP. That is the best way so you can focus completely on each task at hand in the ideal mode for that task. Anything else results in distractions and errors. #+NAME: org_gcr_2017-05-12_mara_A4769342-BBC0-40C1-B144-BD24CE74523C #+BEGIN_SRC emacs-lisp (setq org-src-window-setup 'current-window) #+END_SRC Org-Mode has a really nice feature that hitting =C-c C-c= will generally just do the /right thing/. It is really nice. That feature extends to source blocks of course. Ironically I had a typo here, typing /of curse/ instead of /of course/. The thing is that you really, really need to develop a personal workflow, and then configure the tool to enable it. The more I learn about Org-Mode, the more leery I am about making it really easy to evaluate code. I want it to be a really, really specific and decided action to evaluate a code block, so don't make it so easy as =C-c C-c=. #+NAME: org_gcr_2017-05-12_mara_7120E516-C6D1-4FD5-A925-7F79B3FE9323 #+BEGIN_SRC emacs-lisp (setq org-babel-no-eval-on-ctrl-c-ctrl-c t) #+END_SRC Configure the system to successfully use ~vc-next-action~ while editing a Source-Block. Before perfoming the edit, check if it is Org-Mode and exit the Source-Block Buffer (SBB). If this system stays in the SBB when calling ~vc-next-action~ the entire contents of the buffer are escaped as Org-Mode source code upon returning to the source buffer (this). Do the same thing before any version control modes that would result in the same condition. #+NAME: org_gcr_2017-05-12_mara_E4B28E49-C537-4BA9-B929-A638DBFEED94 #+BEGIN_SRC emacs-lisp (defun help/vc-next-action () "If in org source block, exit it before `vc-next-action'." (interactive) (when (condition-case nil (org-src-edit-buffer-p) (error nil)) (org-edit-src-exit)) (vc-next-action nil)) (defun help/magit-status () "If in org source block, exit it before `magit-status'." (interactive) (when (condition-case nil (org-src-edit-buffer-p) (error nil)) (org-edit-src-exit)) (magit-status)) #+END_SRC Never use the original version. #+NAME: org_gcr_2017-05-12_mara_1AE94FA9-77C0-4A30-8A70-AFAFD4E4011F #+BEGIN_SRC emacs-lisp (setq org-edit-src-code nil) #+END_SRC Let pretify minimize macro text. #+NAME: org_gcr_2017-05-12_mara_258FD451-015B-4195-8349-8B4EFA61B581 #+BEGIN_SRC emacs-lisp (setq org-hide-macro-markers nil) #+END_SRC Follow links without using the mouse or more. #+NAME: org_gcr_2017-05-12_mara_7CFE23CC-8EBC-46F3-889F-BF36EC45D6CA #+BEGIN_SRC emacs-lisp (setq org-return-follows-link t) #+END_SRC In Org mode release 9.2 the template system was replaced by org-tempo. When I switched back to Org mode release 9.0.9 I had to comment this out. #+name: org_gcr_2018-06-15T10-59-11-05-00_mara_18E869DD-ECC4-4267-B019-CBACA6D89465 #+begin_src emacs-lisp :tangle no (require 'org-tempo) #+end_src **** Keybindings :PROPERTIES: :ID: org_gcr_2017-05-12_mara:F5256DB3-BD52-409B-80CF-6E601A29AA4A :END: Started questioning why after hitting RETURN while in lists I have to hit TAB to get indented properly. Kind of a dead giveaway that I should be return-and-indenting! Looked at =org-return= to find that it has an argument about indenting and then saw that =org-return-indent= passes it for you. With that in mind, RETURN is bound to that now. Now HELP has four different kinds of "returns" in Org in order of likelihood of usage: - org-return-indent :: Make it really easy to work in existing list items, headings, and tables - This is listed first because I often go back to modify entries - because it is used the most - org-meta-return :: Make it really easy to add new list items, headings, and table contents - M- because the binding comes with Org - *newline* :: For when I want to break out of the default Org indentation to start working at the beginning of the line for example when I'm done working in a list or have just created a new heading - C-M- because it is next step "lower" in the binding - help/smart-open-line :: When I want to insert a new line between the current and next line then position the cursor correctly indented at the start of it. - s- because it is that is the last place in the modifier key chain #+NAME: org_gcr_2017-05-12_mara_711B4205-DC28-4A35-B620-23AFD46E3973 #+BEGIN_SRC emacs-lisp (help/on-gui (define-key org-mode-map (kbd "") #'org-return-indent) (define-key org-mode-map (kbd "C-M-") #'newline)) #+END_SRC ***** Row 5 :PROPERTIES: :ID: org_gcr_2017-05-12_mara:B493B118-37D7-4C49-B300-EFBBEF91F0D6 :END: #+NAME: org_gcr_2017-05-12_mara_1A8FB05F-FF18-45DD-BFC4-89E76C366B9F #+BEGIN_SRC emacs-lisp (define-key org-mode-map (kbd "H-7") #'org-babel-load-in-session) (define-key org-mode-map (kbd "H-8") #'org-babel-switch-to-session) (define-key org-mode-map (kbd "H-*") #'org-babel-switch-to-session-with-code) #+END_SRC Easily manipulate lists and headlines staying close to home. #+NAME: org_gcr_2017-05-12_mara_6BA97DBC-AE5D-4C60-AD03-EF150686A03F #+BEGIN_SRC emacs-lisp (progn (key-chord-define org-mode-map "y7" #'org-shifleft) (key-chord-define org-mode-map "Y&" #'org-shifup)) (progn (key-chord-define org-mode-map "u8" #'org-shiftmetaleft) (key-chord-define org-mode-map "U*" #'org-shiftmetaup) (key-chord-define org-mode-map "i9" #'org-shiftmetaright) (key-chord-define org-mode-map "I(" #'org-shiftmetadown)) (progn (key-chord-define org-mode-map "o0" #'org-shiftright) (key-chord-define org-mode-map "O)" #'org-shiftdown)) #+END_SRC ***** Row 3 :PROPERTIES: :ID: org_gcr_2017-05-12_mara:ADB2113A-6D9F-4145-9D78-1DDFE5A2C916 :END: Release these bindings. #+NAME: org_gcr_2019-02-22T23-11-36-06-00_cosmicality_138EE053-3BAE-45F5-B19B-B8FB19580AF3 #+BEGIN_SRC emacs-lisp (global-unset-key (kbd "C-M-t")) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_49522E70-EE2D-4CF9-95D7-8E43524A469D #+BEGIN_SRC emacs-lisp (define-key org-mode-map (kbd "H-]") (lambda () (interactive) (message "Removing all source block resuls") (help/org-2every-src-block 'org-babel-remove-result) (message "Done removing all source block results"))) (define-key org-mode-map (kbd "H-y") #'help/safb-org-babel-execute-buffer) (define-key org-mode-map (kbd "H-u") #'help/safb-org-babel-execute-subtree) (define-key org-mode-map (kbd "H-U") #'org-mark-ring-goto) (define-key org-mode-map (kbd "H-i") #'org-babel-execute-src-block) (define-key org-mode-map (kbd "H-I") #'org-table-insert-row) (define-key org-mode-map (kbd "H-o") #'org-babel-remove-result-one-or-many) (define-key org-mode-map (kbd "H-O") #'org-org-export-to-org) (define-key org-mode-map (kbd "H-p") #'org-babel-execute-maybe) (define-key org-mode-map (kbd "H-[") #'org-babel-remove-inline-result) (defun help/unset-C-M-t () (interactive) (local-unset-key (kbd "C-M-t"))) (add-hook 'org-mode-hook #'help/unset-C-M-t) #+END_SRC ***** Row 2 :PROPERTIES: :ID: org_gcr_2017-05-12_mara:AA97F835-E969-43E4-AC84-B3CF472B8726 :END: #+NAME: org_gcr_2017-05-12_mara_EC7D6149-4451-443D-BFFF-1A40073D7D98 #+BEGIN_SRC emacs-lisp (define-key org-mode-map (kbd "C-c C-k") nil) (define-key org-mode-map (kbd "H-h") #'help/safb-org-babel-tangle) (define-key org-mode-map (kbd "H-j") #'org-babel-next-src-block) (define-key org-mode-map (kbd "H-k") #'org-babel-previouH-src-block) (define-key org-mode-map (kbd "H-l") #'help/safb-org-edit-src-code) (define-key org-mode-map (kbd "H-;") #'help/safb-help/org-babel-demarcate-block) (define-key org-mode-map (kbd "C->") #'(lambda () (interactive) (insert "\\rarr{}"))) (defun help/org-insert-subscript (arg) "Maybe insert a subscript with the postfix space." (interactive "MSubscript: ") (if (s-blank? arg) (message "Nothing to insert") (insert "_{" arg "} "))) (defun help/org-insert-superscript (arg) "Maybe insert a super with the postfix space." (interactive "MSuperscript: ") (if (s-blank? arg) (message "Nothing to insert") (insert "^{" arg "} "))) #+END_SRC Because I only use this for Org-Mode. #+NAME: org_gcr_2017-07-12_mara_65D0CDCC-66C7-4C81-ABF3-D22AAF71868E #+BEGIN_SRC emacs-lisp (define-key global-map (kbd "H-o") nil) #+END_SRC ***** Row 1 :PROPERTIES: :ID: org_gcr_2017-05-12_mara:680824E4-2C0B-4E0F-BA6E-62AA84D484E4 :END: #+NAME: org_gcr_2017-05-12_mara_8C00E3FE-4AE1-49BA-97E7-FAB2784DD0A9 #+BEGIN_SRC emacs-lisp (define-key org-mode-map (kbd "H-n") #'org-babel-view-src-block-info) (define-key org-mode-map (kbd "H-m") #'org-babel-expand-src-block) (define-key org-mode-map (kbd "H-,") #'org-babel-open-src-block-result) #+END_SRC Because I only use this for Org-Mode. #+NAME: org_gcr_2017-07-12_mara_97C70CDA-DFBF-4422-942A-00E732D3AB6A #+BEGIN_SRC emacs-lisp (define-key global-map (kbd "H-m") nil) #+END_SRC ***** Hydra :PROPERTIES: :ID: org_gcr_2017-05-12_mara:08A11E45-D41A-44D6-945D-45DF85F8D037 :END: #+NAME: org_gcr_2017-05-12_mara_90AA8396-E8A0-439C-A1E4-373E90C4DC84 #+BEGIN_SRC emacs-lisp (defhydra help/hydra/right-side/org-mode (:color blue :hint nil) " Org-Mode: (_q_uit) Row 4: _1_ SHA-1-hash _2_ display images _3_ hide images _4_ id-create _8_ ltx/noindent Row 3: _w_ ob-clip-formatted _e_ edit field _E_ list entities _r_ help/org-refile _R_ insert \"refile\" _t_oggle macro marker ATT_R_HTML 4 table export format _u_tf2xtx _p_ copy-reg-2-property Row 2: _a_ archive-subtree _s_ sort _S_ lobigst _d_ g2s-b/hd _g_ goto _k_ ob-check-src-blk _l_ lint _L_ insert inline task Row 1: _z_ insert-superscript _Z_ insert-subscript _x_ tangled file permissions _c_ org-fill-para _C_ount words _b_ swtch2sessn _B_ NOrg2Blog _n_ n2sbtre _m_ mark-subtree" ("q" org-babel-switch-to-session-with-code) ;; Row 4 ("1" org-babel-sha1-hash) ("2" org-display-inline-images) ("3" org-remove-inline-images) ("4" org-id-get-create) ("8" (lambda () (interactive) (insert "@@latex:\\noindent{}@@"))) ;; Row 3 ("w" ox-clip-formatted-copy) ("e" org-table-edit-field) ("W" help/org-mark-subtree/kill-ring-save) ("E" org-entities-help) ("r" help/org-refile) ("R" (lambda () (interactive) (insert "(refile)"))) ("t" help/org-toggle-macro-markers) ("R" (lambda () (interactive) (insert "#+ATTR_HTML: :border 2 :rules all :frame border"))) ("u" org-utf-to-xetex-insert-or-wrap-with-macro) ("p" my-org-region-to-property) ;; TODO ;; Row 2 ("a" org-archive-subtree-default) ("s" org-sort) ("S" org-babel-lob-ingest) ("d" org-babel-goto-src-block-head) ("g" org-goto) ("i" org-babel-do-key-sequence-in-edit-buffer) ("I" org-babel-insert-header-arg) ("k" org-babel-check-src-block) ("l" org-lint) ("L" org-inlinetask-insert-task) ;; Row 1 ("z" help/org-insert-superscript) ("Z" help/org-insert-subscript) ("x" help/org-insert-tangle-mode-permission) ("c" org-fill-paragraph) ("C" help/org-count-words) ("b" org-babel-switch-to-session) ("B" o2b-gui/body) ("n" org-narrow-to-subtree) ("m" org-mark-subtree) ("M" org-mark-element)) (defun help/org-mark-subtree/kill-ring-save () "" (interactive) (call-interactively 'org-mark-subtree) (call-interactively 'kill-ring-save)) (key-chord-define org-mode-map "hh" #'help/hydra/right-side/org-mode/body) (defun help/org-insert-tangle-mode-permission () (interactive) (insert ":tangle-mode (identity #o755)")) #+END_SRC Save all buffers before working with Exports. #+NAME: org_gcr_2017-05-12_mara_B41A9D3F-254B-4E44-8585-380BF23D158D #+BEGIN_SRC emacs-lisp (define-key org-mode-map (kbd "C-c C-e") #'help/safb-org-export-dispatch) #+END_SRC Make =s-l= do the same thing to leave the Source-Block-Buffer. #+NAME: org_gcr_2017-05-12_mara_5DE43FD1-AEF3-40D0-8C67-1ACBB6EA8317 #+BEGIN_SRC emacs-lisp (define-key org-src-mode-map (kbd "H-l") #'org-edit-src-exit) #+END_SRC Easily enter guillemots. #+NAME: org_gcr_2017-05-12_mara_BF73D071-57B8-4DBA-93E9-5A1D532A6321 #+BEGIN_SRC emacs-lisp (key-chord-define org-mode-map "<<" (lambda () (interactive) (insert "\\laquo{}"))) (key-chord-define org-mode-map ">>" (lambda () (interactive) (insert "\\raquo{}"))) #+END_SRC **** Prettification :PROPERTIES: :ID: org_gcr_2018-04-20T15-46-50-05-00_mara:356CA076-3E60-4908-BED1-DD7715C51C8C :END: Macro markers. #+name: org_gcr_2018-06-21T13-13-25-05-00_mara_91DB03A0-F253-41EF-B3D7-820293D5AD94 #+begin_src emacs-lisp (setq org-hide-macro-markers nil) #+end_src Prettifications. #+name: org_gcr_2018-03-15_mara_05415B89-71CA-4176-80EF-FB36F2D97F20 #+begin_src emacs-lisp (defun help/prettify-org-mode () (interactive) (setq prettify-symbols-alist (help/alist-set "#+NAME\:" ?╭ prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+name\:" ?╭ prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+BEGIN_SRC" ?├ prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+begin_src" ?├ prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+END_SRC" ?╰ prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+end_src" ?╰ prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+BEGIN_EXAMPLE" ?💡 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+begin_example" ?💡 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+END_EXAMPLE" ?💡 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+end_example" ?💡 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+BEGIN_QUOTE" ?🗣 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+begin_quote" ?🗣 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+END_QUOTE" ?🗣 prettify-symbols-alist)) (setq prettify-symbols-alist (help/alist-set "#+end_quote" ?🗣 prettify-symbols-alist)) (help/prettify-org-mode-names)) (add-hook 'org-mode-hook #'help/prettify-org-mode) (defun help/prettify-org-mode-names (&optional replacement) (interactive) (or replacement (setq replacement ?╮)) (save-excursion (goto-char (point-min)) (let ((case-fold-search t)) (while (re-search-forward "#\\+name: " nil t) (copy-region-as-kill (point) (line-end-position)) (let ((name (substring-no-properties(pop kill-ring)))) (when (string-prefix-p "org_" name) (setq prettify-symbols-alist (help/alist-set name replacement prettify-symbols-alist)))))))) #+end_src Custom font lock - Hyphen appears as em-dash #+name: org_gcr_2018-06-14T14-15-42-05-00_mara_2F1F424E-F780-4D04-B582-7770987CC960 #+begin_src emacs-lisp (font-lock-add-keywords 'org-mode '(("^[[:space:]]*\\(-\\) " 0 (prog1 () (compose-region (match-beginning 1) (match-end 1) "—"))))) #+end_src **** HTML Exporter :PROPERTIES: :ID: org_gcr_2018-07-02T07-07-57-05-00_mara:7236EDFF-7176-4C5F-842C-7919D3E73C28 :END: Doctype—use the default. ~org-html-table-default-attributes~ (which are ignored in the ~HTML5~). #+name: org_gcr_2018-07-02T07-07-57-05-00_mara_50C8A3C0-835D-4DE9-B5AE-161C127BF850 #+begin_src emacs-lisp :tangle no (setq org-html-table-default-attributes (plist-put org-html-table-default-attributes :rules "all")) (setq org-html-table-default-attributes (plist-put org-html-table-default-attributes :frame "border")) #+end_src **** Hooks :PROPERTIES: :ID: org_gcr_2019-01-14T09-58-00-06-00_cosmicality:A9834827-BB7D-4DA6-8AD0-F5733437C30F :END: #+name: org_gcr_2019-01-14T09-58-00-06-00_cosmicality_9D450653-5C54-48DB-B0A9-24E8408B0CF2 #+begin_src emacs-lisp (defun help/org-mode-hook-fun () (local-unset-key (kbd "C-j"))) (add-hook 'org-mode-hook #'owp-maybe-start) #+end_src *** Intermittent Literate Programming :PROPERTIES: :ID: org_gcr_2018-01-04_mara:43462ECD-9C40-43D2-872F-A2E9DB134199 :END: See [[https://www.wisdomandwonder.com/link/8610/lightweight-multiple-modes-for-semi-literate-programming][this post]]. Edit region in separate buffer. "Final" version works without carrying over buffer properties. #+NAME: org_gcr_2018-01-04_mara_42B53E96-5046-4A7B-8CC9-A7046CCD3BF1 #+BEGIN_SRC emacs-lisp (use-package edit-indirect :ensure t) #+END_SRC *** Transliteration :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D15B4305-4503-4D8C-8CDA-258FA4AF7EB2 :END: Black board bold characters. #+NAME: org_gcr_2017-05-12_mara_37C3019C-7C06-4952-888C-AA4660B4310E #+BEGIN_SRC emacs-lisp (use-package blackboard-bold-mode :ensure t) #+END_SRC Fraktur characters. #+NAME: org_gcr_2017-05-12_mara_AF4667B6-7922-4BC4-840F-63F099E1BC63 #+BEGIN_SRC emacs-lisp (use-package fraktur-mode :ensure t) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_A27A9A2F-11B8-4B31-A68C-6A5E27BCCD8D #+BEGIN_SRC emacs-lisp (defhydra help/hydra/transliterate (:color blue :hint nil) " _b_ black-board-bold _f_ fraktur " ("b" blackboard-bold-mode) ("f" fraktur-mode)) #+END_SRC *** Words :PROPERTIES: :ID: org_gcr_2017-08-04_mara:0A02BFBE-91BE-4629-B4B3-F72F2AAEAD3E :END: #+NAME: org_gcr_2017-08-04_mara_24E4983A-3842-4365-8C3A-8D2019AB223D #+BEGIN_SRC emacs-lisp (use-package lorem-ipsum :ensure t :config (defun help/lorem-ipsum-insert-word () (interactive) (let* ((paragraph (nth (random (length lorem-ipsum-text)) lorem-ipsum-text)) (sentence (concat (nth (random (length paragraph)) paragraph) lorem-ipsum-sentence-separator)) (words (split-string sentence)) (word (nth (random (length words)) words))) (insert word)) (insert " "))) (use-package academic-phrases :ensure t) (defhydra help/hydra/words (:color blue :hint nil) " Words: _C_ount, Count In _O_rg , _T_op#, _G_rade Level, _R_eading Ease, _A_ffect vs Effect Lorem Ipsum: _w_ord _s_entence _p_aragraphs _l_ist Academic Phrases: _a_ll or by se_c_tion _E_macs Name (insert _e_macs name) _F_lame (insert _f_lame) _H_oroscope (insert _h_oroscope) _K_ibologize _S_hop _m_iddle name _Y_ouwill (insert youwill) Corporate _B_.S.: (_I_nsert B.S.) (A_d_d B.S. To Kill Ring) Spoo_k_ _q_uit" ("q" nil) ("C" count-words :exit nil) ("O" help/org-count-words :exit nil) ("T" help/most-used-words) ("G" writegood-grade-level :exit nil) ("R" writegood-reading-ease :exit nil) ("A" affect-vs-effect-explanation) ("w" help/lorem-ipsum-insert-word :exit nil) ("s" lorem-ipsum-insert-sentences :exit nil) ("p" lorem-ipsum-insert-paragraphs :exit nil) ("l" lorem-ipsum-insert-list :exit nil) ("a" academic-phrases) ("c" academic-phrases-by-section) ("E" emacs-name :exit nil) ("e" (lambda () (interactive) (insert (emacs-name) " ")) :exit nil) ("F" flame) ("f" (lambda () (interactive) (insert-flame) (insert " ")) :exit nil) ("H" horoscope) ("h" (lambda () (interactive) (horoscope t))) ("K" kibologize) ("S" shop) ("m" shop-middle-name :exit nil) ("Y" youwill) ("B" corporate-bs-generator-create) ("I" (lambda () (interactive) (let ((current-prefix-arg '(4))) (corporate-bs-generator-create)))) ("d" (lambda () (interactive) (let ((current-prefix-arg '(16))) (corporate-bs-generator-create)))) ("k" spook)) #+END_SRC *** Dash :PROPERTIES: :ID: org_gcr_2017-05-12_mara:B541F7EE-BF7E-4055-9EE6-3B0AC34A1602 :END: #+NAME: org_gcr_2017-05-12_mara_AAEBDA8A-3939-42B1-B7A2-230C43EEF1AB #+BEGIN_SRC emacs-lisp (use-package dash-at-point :ensure t) #+END_SRC *** TO-DOs :PROPERTIES: :ID: org_gcr_2018-11-14T01-09-50-06-00_cosmicality:FBB5DEF5-F814-4F81-8EE7-715FF3428782 :END: - TO-DOs are - Reminders, discussion prompts, and small-scale checklists - Worth remembering to do - Short-lived - Not big enough for - An Org task - For creating an issue - Categories (copied from [[https://github.com/bbatsov/emacs-lisp-style-guide#comment-annotations][here]]) (all [[https://www.w3schools.com/colors/colors_picker.asp][RGB]] values 40% of the primary) - Use TODO (yellow )to note missing features or functionality that should be added at a later date. - Use OPTIMIZE (blue) to note slow or inefficient code that may cause performance problems. - Use REVIEW (orange) to note anything that should be looked at to confirm it is working as intended. For example: REVIEW: Are we sure this is how the client does X currently? - Use HACK (fuscia) to note "code smells" where questionable coding practices were used and should be refactored away. - Use FIXME (red) to note broken code that needs to be fixed. #+name: org_gcr_2018-11-14T01-09-50-06-00_cosmicality_928B587E-CCAC-42D3-A727-B579A008FCC1 #+begin_src emacs-lisp (use-package hl-todo :ensure t :config) (defhydra help/hydra/left/todo (:color blue :hint nil) " (hl-todo): [_n_] Next [_p_] Previous [_i_] Insert [_o_] Occur [_q_] Quit " ("n" hl-todo-next :exit nil) ("p" hl-todo-previous :exit nil) ("i" hl-todo-insert-keyword) ("o" hl-todo-occur) ("q" nil)) #+end_src *** Table of Contents :PROPERTIES: :ID: org_gcr_2019-03-01T15-03-54-06-00_cosmicality:891BDA52-62B7-444B-ACBD-0780438766C2 :END: #+name: org_gcr_2019-03-01T15-03-54-06-00_cosmicality_003D7FD4-DB09-462E-BBB8-56FD63CD64C7 #+begin_src emacs-lisp (use-package org-make-toc :ensure t) #+end_src *** Typing :PROPERTIES: :ID: org_gcr_2019-05-17T23-00-51-05-00_cosmicality:34BEE178-C60A-453C-867B-5FFCB070CBF1 :END: #+name: org_gcr_2019-05-17T23-00-51-05-00_cosmicality_26B9AD8B-3CDD-4A38-BFAD-62755A785497 #+BEGIN_SRC emacs-lisp (use-package speed-type :ensure t) #+END_SRC ** Unicode :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:DD18C2DA-10EE-43BD-AED0-5DD4680CA566 :END: *** System :PROPERTIES: :ID: org_gcr_2018-06-16T16-57-47-05-00_mara:189DB36F-0E6F-451F-B879-3F17390AD826 :END: Prefer UTF-8 by default. #+NAME: org_gcr_2017-05-12_mara_0BCAB755-9914-473F-9543-37130529809F #+BEGIN_SRC emacs-lisp (let ((lang 'utf-8)) (message "In the environment, 'LANG' and 'LC_ALL' are set to '%s' and '%s'." (getenv "LANG") (getenv "LC_ALL")) (message "However, the init file is overriding them with the profile for '%s', manually configuring the language and coding system." (buffer-file-name) lang) (set-language-environment lang) (prefer-coding-system lang)) #+END_SRC Make copying and pasting easier: On the GUI. #+name: org_gcr_2018-06-16T16-57-47-05-00_mara_B04ABAAC-94BC-460E-970F-30E13D8A08BA #+BEGIN_SRC emacs-lisp (help/on-gui (setq x-select-request-type '(UTF8_STRING COMPOUND_TEXT TEXT STRING))) #+END_SRC On Windows. #+name: org_gcr_2018-06-16T16-57-47-05-00_mara_C5558E79-8862-409B-A591-F7401A0EB969 #+begin_src emacs-lisp (help/on-gui (help/on-windows (set-clipboard-coding-system 'utf-16le-dos))) #+end_src *** Font :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:99E80492-40C4-4879-B2D6-582362D0FC58 :END: Configure fonts for Unicode blocks. #+name: org_gcr_2018-06-03T01-16-43-05-00_mara_3374BEB2-6CF3-4F07-B2D6-7D84147CEDF3 #+begin_src emacs-lisp (use-package unicode-fonts :ensure t :config (unicode-fonts-setup)) #+end_src - Test with - view-hello-file - list-charset-chars RET unicode-bmp RET - list-charset-chars RET unicode-smp RET - unicode-fonts-debug-insert-block RET Mathematical_Operators RET *** Utility :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:702B80D4-22BB-4A0B-B33C-1D314A337C83 :END: Show all code points in a block **** Char :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:D507FC09-B53D-4206-8789-297DEDDFE4C7 :END: Escape and unescape characters. #+NAME: org_gcr_2017-05-12_mara_B7889E2D-2E2E-402B-BFC6-F8EC056D1F6E #+BEGIN_SRC emacs-lisp (use-package unicode-escape :ensure t :config) #+END_SRC Homoglyph warning system. #+NAME: org_gcr_2017-05-12_mara_96974788-400B-439B-9005-04569A326C29 #+BEGIN_SRC emacs-lisp (use-package unicode-troll-stopper :ensure t) #+END_SRC Roland's utilities. #+name: org_gcr_2018-06-06T22-01-54-05-00_mara_15766015-F908-40FF-81B2-71DADC8FE0A7 #+begin_src emacs-lisp (use-package ucs-utils :ensure t :config (ucs-utils-install-aliases)) #+end_src Convert to ASCII. #+name: org_gcr_2018-06-07T23-45-23-05-00_mara_B658364A-13A0-411F-8DA7-A3FF3B92F38D #+begin_src emacs-lisp (use-package unidecode :ensure t :config (defun help/unidecode-region (beginning end) "Unidecode region. For example try it on: Déjà vu" (interactive "r") (if (use-region-p) (unidecode-region beginning end) (message "Sorry, there was no active region to unidecode."))) (defun help/unidecode-sanitize-region (beginning end) "Unidecode sanitize region. For example try it on: 北亰" (interactive "r") (if (use-region-p) (unidecode-sanitize-region beginning end) (message "Sorry, there was no active region to unidecode sanitize.")))) #+end_src **** File :PROPERTIES: :ID: org_gcr_2017-05-12_mara:ADAE0A1B-3FD8-4605-8611-388E5ADBAFA8 :END: :LOGBOOK: - Refiled on [2018-06-07 Thu 22:16] \\ Move to Unicode hack heading. :END: Warn of UTF [[https://en.wikipedia.org/wiki/Byte_order_mark][BOM]] bytes via [[https://www.reddit.com/r/emacs/comments/4tw0iz/can_i_have_a_warning_if_i_open_a_file_with_utf8/d5kszsh][skeeto]]. #+BEGIN_QUOTE The UTF-8 representation of the BOM is the byte sequence 0xEF,0xBB,0xBF. #+END_QUOTE #+NAME: org_gcr_2017-05-12_mara_063B5AFB-C687-49D3-8FE2-3BE2BDCB8E84 #+BEGIN_SRC emacs-lisp (defun warn-if-utf-8-bom () "Warn if UTF-8 BOM bytes are present. Attribution: URL `https://www.reddit.com/r/emacs/comments/4tw0iz/can_i_have_a_warning_if_i_open_a_file_with_utf8/d5kszsh'" (let ((name (symbol-name buffer-file-coding-system))) (when (string-match-p "utf-8-with-signature" name) (message "Call the BOM squad! This UTF-8 file has a BOM!")))) (add-hook 'find-file-hook #'warn-if-utf-8-bom) #+END_SRC **** Point :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:5686D072-60ED-4F68-8A74-CB5CA0AD5E99 :END: Search code points by name and present the result(s). - code point - character - name #+name: org_gcr_2018-06-06T22-01-54-05-00_mara_9533C0F0-AAA8-4B6B-A06A-29AD18CF72D7 #+begin_src emacs-lisp (use-package list-unicode-display :ensure t) #+end_src **** Org-Mode :PROPERTIES: :ID: org_gcr_2018-06-18T11-01-53-05-00_mara:51B3EC8F-B3FB-46E4-A06F-E5BFF5E8920D :END: #+name: org_gcr_2018-06-18T11-01-53-05-00_mara_CF9E5234-BD32-4119-94F1-31D86953850F #+begin_src emacs-lisp (add-to-list 'load-path "~/src/org-utf-to-xetex") (require 'org-utf-to-xetex) (add-hook 'org-mode-hook #'org-utf-to-xetex-prettify) #+end_src *** Hydra :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:F0E4B9C4-4873-4519-9FE5-B7CF14103FE3 :END: #+name: org_gcr_2018-06-06T22-01-54-05-00_mara_61574A72-BF05-4C0A-B665-BC80C13C35E5 #+begin_src emacs-lisp (defhydra help/hydra/unicode (:color blue :hint nil) " Unicode: (_q_uit) Insert: ∧By _N_ame, ∧By _C_odepoint (name string | hex string | code point w/radix octal #o21430, hex #x2318, or decimal #10r8984) Search: RegE_x_🔎 'Ify Region: _A_scii'ify, _R_oman'ify _E_scape Region: 😄 → \\\\uD83D\\\\uDE04 _U_nescape Region: \\\\uD83D\\\\uDE04 → 😄 Blocks: _B_lock Name At Point, _I_nsert Block Char: _U_CS Name At Point, _H_omoglyph Warning System " ("q" nil) ("N" ucs-utils-ucs-insert) ("C" insert-char) ("x" list-unicode-display) ("A" help/unidecode-region) ("R" help/unidecode-sanitize-region) ("E" unicode-escape) ("U" unicode-unescape) ("B" org-utf-to-xetex-get-unicode-block-for-string-char-after) ("I" (lambda () (interactive) (unicode-fonts-debug-insert-block))) ("U" ucs-utils-eval) ("H" unicode-troll-stopper-mode)) (global-set-key (kbd "C-M-u") #'help/hydra/unicode/body) #+end_src ** Applied Mathematics :PROPERTIES: :ID: org_gcr_2017-05-12_mara:423BA6AA-5F7D-450D-B686-78A028A37FE2 :END: *** APL :PROPERTIES: :ID: org_gcr_2017-05-12_mara:5CB03225-60DE-4AC2-8A67-3D7D21BF7818 :END: - Prefix key options - C-M: No structural navigation - C-M-s: No that is for the operating system - M-s: Existing bindings that I don't want to mess with - M-s: Pretty much never use this, so use it #+NAME: org_gcr_2017-05-12_mara_C30EFFA1-FDBA-413F-AD23-29C0C2095231 #+BEGIN_SRC emacs-lisp (use-package gnu-apl-mode :ensure t :init (setq gnu-apl-show-keymap-on-startup nil) (setq gnu-apl-show-apl-welcome nil) (setq gnu-apl-show-tips-on-start nil) (setq gnu-apl-mode-map-prefix "M-s-") (setq gnu-apl-interactive-mode-map-prefix gnu-apl-mode-map-prefix) :config (defun em-gnu-apl-init () (setq buffer-face-mode-face 'gnu-apl-default) (buffer-face-mode)) (add-hook 'gnu-apl-interactive-mode-hook 'em-gnu-apl-init) (add-hook 'gnu-apl-mode-hook 'em-gnu-apl-init) (defun help/gnu-apl-runningp () (interactive) (let ((session (gnu-apl--get-interactive-session-with-nocheck))) (if session 'ON 'OFF))) (defun help/start-gnu-apl () (interactive) (if (equal (help/gnu-apl-runningp) 'ON) (message "GNU APL is already ON.") (call-interactively 'gnu-apl))) (defun help/stop-gnu-apl () (interactive) (if (equal (help/gnu-apl-runningp) 'OFF) (message "GNU APL is already OFF.") (progn (gnu-apl-switch-to-interactive) (switch-to-buffer "*gnu-apl*") (insert ")off") (comint-send-input)))) (defun help/gnu-apl-prefix-string () (interactive) gnu-apl-mode-map-prefix) (defhydra help/hydra/gnu-apl (:color blue :hint nil) " GNU APL: ⏼%(help/gnu-apl-runningp) _y_ eval-buffer _u_ eval-region _i_ eval-line _o_ eval-function _f_ apropos-symbol _g_ help-symbol _h_ keyboard _j_ next _k_ previous _c_ start APL _v_ stop APL _b_ switch to APL _n_ switch back Prefix key is: %(help/gnu-apl-prefix-string) " ("i" help/gnu-apl-eval-line) ("o" gnu-apl-interactive-send-current-function) ("j" (lambda () (interactive) (call-interactively 'next-logical-line)) :exit nil) ("k" (lambda () (interactive) (call-interactively 'previous-logical-line)) :exit nil) ("b" gnu-apl-switch-to-interactive) ("u" gnu-apl-interactive-send-region) ("h" gnu-apl-show-keyboard) ("y" gnu-apl-interactive-send-buffer) ("t" gnu-apl-trace) ("f" gnu-apl-apropos-symbol) ("g" gnu-apl-show-help-for-symbol) ("c" help/start-gnu-apl) ("v" help/stop-gnu-apl) ("n" (lambda () (interactive) (other-window -1))) ("q" nil)) (key-chord-define gnu-apl-mode-map "hh" #'help/hydra/gnu-apl/body) (key-chord-define gnu-apl-interactive-mode-map "hh" #'help/hydra/gnu-apl/body) (defun help/gnu-apl-eval-line () "Evaluate this line and move to next." (interactive) (end-of-line) (set-mark (line-beginning-position)) (call-interactively 'gnu-apl-interactive-send-region) (deactivate-mark) (call-interactively 'next-logical-line)) (define-key gnu-apl-mode-map (kbd "C-") #'help/gnu-apl-eval-line) (add-hook 'gnu-apl-interactive-mode-hook #'help/gnu-apl-interactive-mode-hook-fn) (add-to-list 'org-babel-load-languages '(gnu-apl . t))) #+END_SRC *** Scheme :PROPERTIES: :ID: org_gcr_2017-05-12_mara:80DF94ED-4868-47CE-BAC8-978863BEF5AF :END: File extensions: - Traditional. #+NAME: org_gcr_2017-05-12_mara_CC727094-99D3-4C48-BE27-C28FC738DF34 #+BEGIN_SRC emacs-lisp (add-to-list 'auto-mode-alist '("\\.scm\\'" . scheme-mode)) (add-to-list 'auto-mode-alist '("\\.ss\\'" . scheme-mode)) #+END_SRC - R6RS. #+NAME: org_gcr_2017-05-12_mara_998AB8A6-A934-4E5A-B869-E1348D919529 #+BEGIN_SRC emacs-lisp (add-to-list 'auto-mode-alist '("\\.sls\\'" . scheme-mode)) (add-to-list 'auto-mode-alist '("\\.sps\\'" . scheme-mode)) #+END_SRC - Racket. #+NAME: org_gcr_2017-05-12_mara_A80E9E8F-A5B7-4C48-A3E5-2C365178EFAF #+BEGIN_SRC emacs-lisp (add-to-list 'auto-mode-alist '("\\.rkt\\'" . scheme-mode)) #+END_SRC Scheme. #+NAME: org_gcr_2017-07-27_mara_EAEF335C-A35D-4746-AB2F-58BDDDFB6CC0 #+BEGIN_SRC emacs-lisp (use-package scheme :config (setq scheme-program-name "chez") (defun help/scheme-mode-hook-fn () "HELP Scheme Mode Hook Function") (add-hook 'scheme-mode-hook #'help/scheme-mode-hook-fn) (defun help/inferior-scheme-mode-hook-fn () "HELP Inferior Scheme Mode Hook Function") (add-hook 'inferior-scheme-mode-hook #'help/inferior-scheme-mode-hook-fn)) #+END_SRC Geiser. #+NAME: org_gcr_2017-05-12_mara_5457F0EC-AAB3-4502-ACCD-7F9C1579293D #+BEGIN_SRC emacs-lisp (use-package geiser :ensure t :config (setq geiser-default-implementation 'chez) (setq geiser-active-implementations (list geiser-default-implementation)) (setq geiser-repl-history-no-dups-p t) (defun help/geiser-exit-chez () (interactive) (call-interactively 'geiser-mode-switch-to-repl) (insert "(exit)") (geiser-repl--maybe-send)) (defun help/geiser-on-p () (if (geiser-repl--live-p) 'ON 'OFF)) (defun help/geiser-eval-line () "Evaluate this line and move to next." (interactive) (end-of-line) (set-mark (line-beginning-position)) (call-interactively 'geiser-eval-region) (deactivate-mark) (call-interactively 'next-logical-line)) (defhydra help/hydra-geiser-mode (:color blue :hint nil) " Geiser REPL: ⏼%(help/geiser-on-p) _y_ eval-buffer _u_ eval-region _U_ (and go) _z_ run (another) geiser _x_ stop latest chez _c_ exit geiser _b_ to latest geiser _n_ switch back _q_ quit " ("y" geiser-eval-buffer) ("u" geiser-eval-region) ("U" geiser-eval-region-and-go) ("z" run-geiser) ("x" help/geiser-exit-chez) ("b" geiser-mode-switch-to-repl) ("c" geiser-repl-exit) ("n" (lambda () (interactive) (other-window -1))) ("q" nil)) (defun help/geiser-mode-hook-fn () (local-unset-key (kbd "C-.")) (key-chord-define geiser-mode-map "hh" #'help/hydra-geiser-mode/body) (local-unset-key (kbd "C-j")) (local-set-key (kbd "") #'help/geiser-eval-line)) (add-hook 'geiser-mode-hook #'help/geiser-mode-hook-fn) (defun help/geiser-repl-mode-hook-fn () (local-unset-key (kbd "C-.")) (local-unset-key (kbd "C-j")) (local-set-key (kbd "") #'geiser-repl--maybe-send) (key-chord-define-local "hh" #'help/hydra-geiser-mode/body)) (add-hook 'geiser-repl-mode-hook #'help/geiser-repl-mode-hook-fn)) #+END_SRC Enable Auto-Complete via Geiser. #+NAME: org_gcr_2017-05-12_mara_221DF59F-0817-4F0A-BDE7-01FD9D87BAF9 #+BEGIN_SRC emacs-lisp (use-package ac-geiser :ensure t :config (add-hook 'geiser-mode-hook 'ac-geiser-setup) (add-hook 'geiser-repl-mode-hook 'ac-geiser-setup) (eval-after-load "auto-complete" '(add-to-list 'ac-modes 'geiser-repl-mode))) #+END_SRC *** C :PROPERTIES: :ID: org_gcr_2017-05-12_mara:F72D838E-4540-4EC1-AECB-B521DF78D8D8 :END: #+NAME: org_gcr_2017-05-12_mara_3C48D997-170E-40F4-9BB6-F6BAA9DE77F2 #+BEGIN_SRC emacs-lisp (defun help/c-mode-common-hook-fn () "HELP c-mode-common customizations." (interactive)) (add-hook 'c-mode-common-hook #'help/c-mode-common-hook-fn) #+END_SRC *** Go :PROPERTIES: :ID: org_gcr_2017-07-30_mara:2F891F22-5C0C-43BA-8891-62DA7E9540FD :END: #+NAME: org_gcr_2017-07-30_mara_04B4D7BA-6213-4EC0-8631-461270FE1B71 #+BEGIN_SRC emacs-lisp (use-package go-mode :ensure t :config (use-package go-eldoc :ensure t) (use-package go-autocomplete :ensure t :config (ac-config-default)) (use-package golint :ensure t) (use-package go-errcheck :ensure t) (use-package ob-go :ensure t :config (add-to-list 'org-babel-load-languages '(go . t))) (use-package go-snippets :ensure t) (use-package flycheck-gometalinter :ensure t :config (add-hook 'flycheck-mode-hook #'flycheck-gometalinter-setup) (setq flycheck-gometalinter-concurrency 2) (setq flycheck-gometalinter-deadline "7s") (setq flycheck-gometalinter-disable-all nil) (setq flycheck-gometalinter-disable-linters nil) (setq flycheck-gometalinter-enable-linters nil) (setq flycheck-gometalinter-errors-only nil) (setq flycheck-gometalinter-fast nil) (setq flycheck-gometalinter-tests t) (setq flycheck-gometalinter-vendor t)) (use-package go-guru :ensure t) (use-package gotest :ensure t) (use-package go-rename :ensure t) (use-package go-direx :ensure t) (add-to-list 'load-path "~/src/go-snippets") (require 'go-snippets) (defun help/go-mode/safb/go-run () "" (interactive) (let* ((compile-command (file-name-nondirectory (directory-file-name default-directory)))) (help/safb/compile))) (defun help/go-mode/safb/go-rename () "" (interactive) (help/save-all-file-buffers) (call-interactively 'go-rename)) (add-to-list 'load-path "~/git/github-anonymous/gorepl-mode") (require 'gorepl-mode) (defhydra help/hydra/right/go-mode (:color blue :hint nil) " Go: (_q_uit) |^ ^|^ ^| -^------------------------^+^-------------------^+----------------^^+-------- _e_: explorer | _r_: run | _t_: tools | g_o_re _g_: guru | _j_: previous error | _k_: next error | _c_: build | _n_: rename | ^^| " ("e" go-direx-switch-to-buffer) ("r" help/go-mode/safb/go-run) ("t" go-hydra-go-mode/body) ("o" gorepl-hydra/body) ("g" go-hydra-guru-go-mode/body) ("k" godef-jump-other-window) ("l" pop-tag-mark) ("c" help/safb/compile) ("n" help/go-mode/safb/go-rename) ("j" previous-error :exit nil) ("k" next-error :exit nil) ("q" nil)) (key-chord-define go-mode-map "hh" #'help/hydra/right/go-mode/body) (defun help/go-mode-hook-fn () (go-eldoc-setup) (setq gofmt-command "goimports") (add-hook 'before-save-hook #'gofmt-before-save) (setq compilation-read-command nil) (setq compile-command "go install && go test -v && gometalinter ./...") (local-set-key (kbd "H-i") #'godoc-at-point) (local-set-key (kbd "H-I") #'godoc) (local-set-key (kbd "H-j") #'help/safb/compile) (local-set-key (kbd "H-k") #'help/go-mode/safb/go-run) (local-set-key (kbd "=") #'(lambda () (interactive) (insert " = "))) (local-set-key (kbd "H-=") #'(lambda () (interactive) (insert " := "))) (local-set-key (kbd "H-<") #'(lambda () (interactive) (insert " <- "))) (local-set-key (kbd "H-o") #'gorepl-hydra/body) (go-guru-hl-identifier-mode) (gorepl-mode)) (add-hook 'go-mode-hook #'help/go-mode-hook-fn)) #+END_SRC *** Python :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BA88E1CC-386E-4CFF-89B3-7E003EC92504 :END: #+NAME: org_gcr_2017-06-28_mara_110DAD24-25A3-46B0-A0B1-FD26BFDB28C7 #+BEGIN_SRC emacs-lisp (defun help/python-mode-hook-fn () "HELP python mode customizatin." (interactive) (indent-guide-mode)) (add-hook 'python-mode-hook #'help/python-mode-hook-fn) #+END_SRC *** YASnippet & Abbrev :PROPERTIES: :ID: org_gcr_2017-05-12_mara:8B8B0626-3A67-4F10-9106-ACFD4E9731E5 :END: - Enable everywhere. - Never expand with =TAB= *anywhere*. - Allow expansion to occur within fields. - Load HELP snippets. #+NAME: org_gcr_2017-05-12_mara_B7B9F4BB-5899-4F2B-94B0-B38F098E9528 #+BEGIN_SRC emacs-lisp (use-package yasnippet :ensure t :config (use-package yasnippet-snippets :ensure t) (yas-global-mode t) (help/on-gui (define-key yas-minor-mode-map (kbd "") nil)) (define-key yas-minor-mode-map (kbd "C-'") #'yas-expand) (help/not-on-gui (define-key yas-keymap (kbd "TAB") #'yas-next-field)) (help/on-gui (define-key yas-keymap (kbd "") #'yas-next-field)) (add-to-list #'yas-snippet-dirs "~/src/help/yasnippet") (yas-reload-all) (defun help/yas-after-exit-snippet-hook-fn () (help/prettify-org-mode-names) (prettify-symbols-mode) (prettify-symbols-mode)) (add-hook 'yas-after-exit-snippet-hook #'help/yas-after-exit-snippet-hook-fn) :diminish yas-minor-mode) #+END_SRC Some modes turn on =abbrev-mode=. Diminish it. Fails with ~(eval-after-load 'abbrev (diminish 'abbrev-mode))~. #+NAME: org_gcr_2017-05-12_mara_E4D8989C-E363-4E6B-A308-B0E667FBCE7C #+BEGIN_SRC emacs-lisp (eval-after-load "abbrev" '(diminish 'abbrev-mode)) #+END_SRC *** Structured Query Language (SQL) :PROPERTIES: :ID: org_gcr_2017-05-12_mara:74BF0520-1F06-4FAF-921C-64E8109CEF03 :END: *** Web Development :PROPERTIES: :ID: org_gcr_2017-05-12_mara:58CFE4EF-8A8A-4C41-9ECF-C9F6D814218E :END: =web-mode= works great for =AngularJS= and now I see a whole lot more. #+NAME: org_gcr_2017-05-12_mara_6219D858-98BB-48CF-96F0-ABEB6756A658 #+BEGIN_SRC emacs-lisp (use-package web-mode :ensure t :init (setq web-mode-enable-current-element-highlight t) :config (add-to-list 'auto-mode-alist '("\\.tpl'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.[agj]sp\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.as[cp]x\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.erb\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.mustache\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.djhtml\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.html?\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.js?\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.jsx?\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.css?\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.scss?\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.xml?\\'" . web-mode)) (add-to-list 'auto-mode-alist '("\\.php?\\'" . web-mode)) (setq web-mode-enable-engine-detection t) (define-key web-mode-map (kbd "H-n") 'web-mode-tag-match)) (defun help/web-mode-hook-fn () "HELP web-mode customizations." (interactive) (setq web-mode-enable-auto-indentation nil) (setq web-mode-markup-indent-offset 2) (setq web-mode-css-indent-offset 2) (setq web-mode-code-indent-offset 2) (setq web-mode-style-padding 1) (setq web-mode-script-padding 1) (setq web-mode-block-padding 0) (setq web-mode-comment-style 2) (setq web-mode-extra-snippets '( ("php" . (("dowhile" . ("\n\n")) ("debug" . ("")))))) (setq web-mode-enable-auto-pairing nil) (defun sp-web-mode-is-code-context (id action context) (and (eq action 'insert) (not (or (get-text-property (point) 'part-side) (get-text-property (point) 'block-side))))) (sp-local-pair 'web-mode "<" nil :when '(sp-web-mode-is-code-context)) (setq web-mode-enable-css-colorization t) (setq web-mode-enable-block-face t) (setq web-mode-enable-part-face t) (setq web-mode-enable-comment-keywords t) (setq web-mode-enable-heredoc-fontification t) (setq ispell-skip-html t)) (add-hook 'web-mode-hook #'help/web-mode-hook-fn) #+END_SRC *** JavaScript :PROPERTIES: :ID: org_gcr_2017-05-12_mara:92C9A271-BC16-431B-8457-2901DE330164 :END: js2-mode is derived from js-mode and most of the indentation settings are done there. Add ~JavaScript~ language to Org-Mode. #+NAME: org_gcr_2017-05-12_mara_56F80A50-4914-4F8F-8771-5800A54F8300 #+BEGIN_SRC emacs-lisp (use-package js2-mode :ensure t :mode (("\\.js$" . js2-mode) ("\\.jsx$" . js2-mode)) :interpreter ("node" . js2-mode) :config (add-hook 'js2-mode-hook #'js2-imenu-extras-mode) (add-to-list 'org-src-lang-modes '("javascript" . js2))) (use-package js2-refactor :after (js2-mode) :ensure t :diminish js2-refactor-mode :config (add-hook 'js2-mode-hook #'js2-refactor-mode) (js2r-add-keybindings-with-prefix "C-c C-m")) #+END_SRC *** AppleScript :PROPERTIES: :ID: org_gcr_2018-04-22T00-19-01-05-00_mara:BB59BC9A-5CBE-4A0A-9276-C4835E28E8B4 :END: #+name: org_gcr_2018-04-20T15-46-50-05-00_mara_E248AEB6-4E35-40F3-A23A-E5D7BED863C4 #+begin_src emacs-lisp (use-package apples-mode :ensure t :config (setq apples-compile-create-file-flag t) (setq apples-continuation-offset 2) (setq apples-decompile-query ?o) (setq apples-follow-error-position t) (setq apples-indent-offset 2) (setq apples-prefer-coding-system coding-category-utf-8) (setq apples-tmp-dir "~/tmp") (defhydra help/hydra/right/apples-mode (:color blue :hint nil) " AppleScript: (_q_uit) |^ ^|^ ^| -^------------------------^+^-----------------------^+---------------------^^+ _j_: eval region | _o_: continuation | _i_: show last result _J_: eval buffer | _O_: continue+newline | _9_: open dict _i_: compile | _u_: close block | _0_: send-to-editor _I_: decompile | _U_: toggle-indentation | " ("j" apples-run-region) ("J" apples-run-buffer) ("i" apples-compile) ("I" apples-decompile) ("o" apples-insert-continuation-char) ("O" apples-insert-continuation-char-and-newline) ("u" apples-end-completion) ("U" apples-toggle-indent) ("i" apples-show-last-result) ("9" apples-open-dict-index) ("0" apples-send-to-applescript-editor) ("q" nil)) (eval-after-load "apples-mode" `(key-chord-define apples-mode-map "hh" #'help/hydra/right/apples-mode/body)) (use-package ob-applescript :ensure t :config (add-to-list 'org-babel-load-languages '(apples . t))) (defun help/apples-mode-hook-fun ()) (add-hook 'apples-mode-hook #'help/apples-mode-hook-fun) (autoload 'apples-mode "apples-mode" "Happy AppleScripting!" t) (autoload 'apples-open-scratch "apples-mode" "Open scratch buffer for AppleScript." t) (add-to-list 'auto-mode-alist '("\\.\\(applescri\\|sc\\)pt\\'" . apples-mode))) #+end_src *** Emacs Speaks Statistics (ESS) :PROPERTIES: :ID: org_gcr_2018-11-21T18-07-10-06-00_cosmicality:23926BE2-3E84-4B9D-BDED-6487EF7D5772 :END: This space used to contain a pretty awesome ESS configuration for The R Project. I removed it after switching go RStudio but you can find all of the necessary changes and support files here: - [[https://github.com/grettke/help/commit/f7a332e09371a0a683a2c713162c02902cb3c599][ESS+R Config]] - [[https://github.com/grettke/help/blob/master/.Renviron][.Renviron]] - [[https://github.com/grettke/help/blob/master/.Rinstall.r][.Rinstall.r]] - [[https://github.com/grettke/help/blob/master/.Rprofile][.Rprofile]] - [[https://github.com/grettke/help/blob/master/.Rsetup.sh][.Rsetup.sh]] *** PHP :PROPERTIES: :ID: org_gcr_2019-03-19T18-10-52-05-00_cosmicality:40EDF04F-3990-4FE8-94D2-196D10BDC1A0 :END: #+name: org_gcr_2019-03-19T18-10-52-05-00_cosmicality_13ABA1E7-2DDA-4496-AC42-FF7F4A52A0FB #+begin_src emacs-lisp (use-package php-mode :ensure t :config (defun help/php-mode-hook-fn () "HELP php-mode customization." (php-enable-wordpress-coding-style)) (add-hook 'php-mode-hook #'help/php-mode-hook-fn)) #+end_src ** Data :PROPERTIES: :ID: org_gcr_2018-04-20T15-46-50-05-00_mara:3259C745-2E58-4F02-B384-A2B341B598DA :END: *** JSON :PROPERTIES: :ID: org_gcr_2018-01-16_mara:59857D34-FF7E-49DC-B639-DCE18813974E :END: javascript-mode is an alias for json-mode. json-mode is derived from javascript-mode. #+NAME: org_gcr_2017-05-12_mara_498DAC46-DA9D-4AAA-82BF-46D712E4DBA5 #+BEGIN_SRC emacs-lisp (use-package json-mode :ensure t :diminish json-mode :mode (("\\.jshintrc$" . json-mode)) :config (defhydra help/hydra/json (:color blue :hint nil) " JSON: (q to quit) _b_eautify _s_how-path _k_ill-path _t_oggle boolean _n_ullify sexp _i_ncrement number _d_ecrement number " ("b" json-mode-beautify) ("s" json-mode-show-path) ("k" json-mode-kill-path) ("t" json-toggle-boolean) ("n" json-nullify-sexp) ("i" json-increment-number-at-point :exit nil) ("d" json-decrement-number-at-point :exit nil) ("q" nil)) (define-key json-mode-map (kbd "RET") #'newline) (defun help/json-mode-hook-fn () (indent-guide-mode) (turn-off-auto-capitalize-mode) (turn-off-auto-fill) (key-chord-define-local "hh" #'help/hydra/json/body)) (add-hook 'json-mode-hook #'help/json-mode-hook-fn)) #+END_SRC *** YAML :PROPERTIES: :ID: org_gcr_2018-01-16_mara:D8AD667E-3B40-44A1-A4D3-CC3383DAA4A0 :END: #+NAME: org_gcr_2018-01-16_mara_B1860F4D-930E-4DDE-8392-BDC52107B11F #+BEGIN_SRC emacs-lisp (use-package yaml-mode :ensure t :config (defun yaml-next-field () "Jump to next yaml field. URL: `https://stackoverflow.com/questions/12648388/emacs-yaml-editing'" (interactive) (search-forward-regexp ": *")) (defun yaml-prev-field () "Jump to next yaml field. URL: `https://stackoverflow.com/questions/12648388/emacs-yaml-editing'" (interactive) (search-backward-regexp ": *")) (defhydra help/hydra/yaml (:color blue :hint nil) " YAML: (q to quit) _i_ indent line _n_ narrow to block literal _c_ fill paragraph " ("i" yaml-indent-line) ("n" yaml-narrow-to-block-literal) ("c" yaml-fill-paragraph) ("q" nil)) (defun help/yaml-mode-hook-fn () (indent-guide-mode) (turn-off-auto-capitalize-mode) (turn-off-auto-fill) (setq flycheck-checker 'yaml-yamllint)) (add-hook 'yaml-mode-hook #'help/yaml-mode-hook-fn) (add-to-list 'auto-mode-alist '("\\.yml\\'" . yaml-mode)) (define-key yaml-mode-map (kbd "") nil) (define-key yaml-mode-map (kbd "") #'sp-backward-delete-char) (define-key yaml-mode-map (kbd "H-j") #'yaml-next-field) (define-key yaml-mode-map (kbd "H-k") #'yaml-prev-field) (key-chord-define yaml-mode-map "hh" #'help/hydra/yaml/body) (use-package flycheck-yamllint :ensure t :config (with-eval-after-load "flycheck" (add-hook 'flycheck-mode-hook 'flycheck-yamllint-setup)) (setq flycheck-yaml-yamllint-executable "/Users/gcr/yamllint/env/bin/yamllint"))) #+END_SRC *** Comma-Separated Values (CSV) :PROPERTIES: :ID: org_gcr_2018-05-11T16-33-31-05-00_mara:98E96CAF-25E3-420B-914C-60E7186466FA :END: FYI: Strip-buffer-mode doesn't help here. #+name: org_gcr_2018-05-11T16-33-31-05-00_mara_0045CEB5-A317-4B3F-8362-C60124D35AD7 #+begin_src emacs-lisp (use-package csv-mode :ensure t :config (use-package pcsv :ensure t) (use-package csv :ensure t) (use-package parse-csv :ensure t) (defun help/csv-mode/csv-descending () (interactive) csv-descending) (defun help/csv-mode/csv-invisibility () (interactive) buffer-invisibility-spec) (defhydra help/hydra/csv-mode (:color blue :hint nil) " CSV: (_q_uit) Row: Sort: _l_exographically _n_umerically Descending is %(help/csv-mode/csv-descending): _t_oggle it Re_v_erse Invisibility is %(help/csv-mode/csv-invisibility): toggle _i_t Row or Columns: t_r_anspose Fields or Columns: _k_ill _y_ank Fields: _a_lign _u_nalign Table: yank a_s_ new " ("q" nil) ("l" csv-sort-fields) ("n" csv-sort-numeric-fields) ("t" csv-toggle-descending :exit nil) ("v" csv-reverse-region) ("i" csv-toggle-invisibility) ("r" csv-transpose) ("k" csv-kill-fields) ("y" csv-kill-fields) ("a" csv-align-fields :exit nil) ("u" csv-unalign-fields :exit nil) ("s" csv-yank-as-new-table)) (key-chord-define csv-mode-map "hh" #'help/hydra/csv-mode/body) (defun help/csv-mode-hook-fn () (setq nlinum-format "%04d") (nlinum-mode) (visual-line-mode)) (add-hook 'csv-mode-hook #'help/csv-mode-hook-fn)) #+end_src *** Sparkline :PROPERTIES: :ID: org_gcr_2018-11-07T14-59-31-06-00_cosmicality:1B5AE823-4CE9-4544-B28B-A9BBF496CB73 :END: #+name: org_gcr_2018-11-07T14-59-31-06-00_cosmicality_D4832772-5D0C-437C-8B54-3ECCE63E4C99 #+begin_src emacs-lisp (defun help/sparkline-theory-and-practice () "Sparkline theory and practice" (interactive) (switch-to-buffer "*Sparkline*") (let ((inhibit-read-only t)) (erase-buffer)) (remove-overlays) (widget-insert "Sparkline theory and practice Edward Tufte\n") (widget-insert "------------------------------------------\n") (widget-insert "\n") (widget-insert "\"A sparkline is a small intense, simple, word-sized graphic with typographic\n") (widget-insert " resolution. Sparklines mean that graphics are no longer cartoonish special\n") (widget-insert " occasions with captions and boxes, but rather sparkline graphics can be\n") (widget-insert " everywhere a word or number can be: embedded in a sentence, table, headline,\n") (widget-insert " map, spreadsheet, graphic. Data graphics should have the resolution of\n") (widget-insert " typography.\"\n") (widget-insert "\n") (widget-insert "See Edward Tufte, ") (widget-create 'url-link :tag "Beautiful Evidence" "https://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=000262&topic_id=1") (widget-insert ", 46-63.\n") (widget-insert "\n") (widget-create 'url-link :tag "Source" "https://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0001OR") (let ((map (make-sparse-keymap))) (set-keymap-parent map widget-keymap) (define-key map "q" 'kill-this-buffer) (use-local-map map)) (widget-setup) (beginning-of-line)) #+end_src #+name: org_gcr_2018-11-07T14-59-31-06-00_cosmicality_411AA5A1-6838-4C31-B2D3-D0EB148FA016 #+begin_src emacs-lisp (use-package spark :ensure t) #+end_src ** Publishing :PROPERTIES: :ID: org_gcr_2017-05-12_mara:0A4A1510-41F7-4469-87D1-156D44A06216 :END: *** AUCTeX :PROPERTIES: :ID: org_gcr_2017-05-12_mara:2DF7BDAD-45C9-4D8D-AC34-FE77E119A093 :END: **** Introduction :PROPERTIES: :ID: org_gcr_2018-03-05_mara:EF3E6F3E-B457-477F-95B3-B08E83B797B6 :END: Load AUCTeX. #+NAME: org_gcr_2017-05-12_mara_D035C4E4-B983-4D74-9E3C-764EF00B3795 #+BEGIN_SRC emacs-lisp (use-package tex :ensure auctex) #+END_SRC Load LatexMk. #+name: org_gcr_2018-03-07_mara_F85003E7-83AD-4E9E-B333-E0FBD79872F5 #+begin_src emacs-lisp (use-package auctex-latexmk :ensure t :config (setq auctex-latexmk-inherit-TeX-PDF-mode t) (auctex-latexmk-setup)) #+end_src **** Editing the Document Source :PROPERTIES: :ID: org_gcr_2018-03-06_mara:15BDC594-E44E-41A0-B5E3-A5490E2DD3A7 :END: Insert and toggle inline math. #+name: org_gcr_2018-03-06_mara_4C2DF1A6-C32B-49F5-A88B-1268AFBD94C0 #+begin_src emacs-lisp (setq TeX-electric-math t) #+end_src Balance opening and closing brackets because I don't think that SmartParens will always know /the right thing/ to do here. #+name: org_gcr_2018-03-06_mara_88B1D568-BECF-464A-A4D0-A5AE34835C7D #+begin_src emacs-lisp (setq LaTeX-electric-left-right-brace t) #+end_src Section hooks. #+name: org_gcr_2018-03-06_mara_284DFD79-73E7-41FF-990D-7CD066DB225E #+begin_src emacs-lisp (setq LaTeX-section-hook '(LaTeX-section-heading LaTeX-section-title LaTeX-section-toc LaTeX-section-section LaTeX-section-label)) #+end_src Always prompt for item labels. #+name: org_gcr_2018-03-06_mara_43E5AAFE-542B-4ED2-9E1A-6F744E6EF1CA #+begin_src emacs-lisp (setq TeX-arg-item-label-p t) #+end_src Show Unicode symbols in the menu. #+name: org_gcr_2018-03-06_mara_0C89F53D-FA9C-4A41-889F-24F4E708AE03 #+begin_src emacs-lisp (setq LaTeX-math-menu-unicode t) #+end_src Automatically bracket sub and superscripts. #+name: org_gcr_2018-03-06_mara_A73A7792-02FB-400F-8805-B9C89E9F8ADA #+begin_src emacs-lisp (setq TeX-electric-sub-and-superscript t) #+end_src On macro insertion prompt for both required and optional arguments every time. #+name: org_gcr_2018-03-06_mara_9FBCFE6F-DFBF-4921-A6E6-DA7B98748A3A #+begin_src emacs-lisp (setq TeX-insert-macro-default-style 'show-all-optional-args) #+end_src Make =\= insert a macro. #+name: org_gcr_2018-03-06_mara_42A55264-E5F9-4FBE-A0A1-3C53CAB34932 #+begin_src emacs-lisp (setq TeX-electric-escape t) #+end_src Always bracket macros. #+name: org_gcr_2018-03-06_mara_DBAA8162-1455-436D-AD2C-37EFC820ACC4 #+begin_src emacs-lisp (setq TeX-insert-braces t) #+end_src Complete expert commands. #+name: org_gcr_2018-03-06_mara_6C656B2D-B4AB-4800-AE8D-C9D38F593430 #+begin_src emacs-lisp (setq TeX-complete-expert-commands t) #+end_src Always check environment indentation. #+name: org_gcr_2018-03-06_mara_D50FCEC2-0D5A-49C6-B599-E649F315375D #+begin_src emacs-lisp (setq LaTeX-indent-environment-check t) #+end_src Indent comment syntactically. #+name: org_gcr_2018-03-06_mara_24B30BAF-6284-48FA-BBAC-172979A25B71 #+begin_src emacs-lisp (setq LaTeX-syntactic-comments t) #+end_src Don't prompt every time you run =C-c C-c= about saving the file, instead, just save it. #+NAME: org_gcr_2017-05-12_mara_851CFD0C-D616-47D1-A0E0-044053B89B03 #+BEGIN_SRC emacs-lisp (setq TeX-save-query nil) #+END_SRC Load LCO files with AucTeX. #+NAME: org_gcr_2017-05-12_mara_5B99942E-0535-40CC-9C61-F895DAF8C545 #+BEGIN_SRC emacs-lisp (add-to-list 'auto-mode-alist '("\\.lco?\\'" . TeX-latex-mode)) #+END_SRC **** Controlling Screen Display :PROPERTIES: :ID: org_gcr_2018-03-06_mara:AD0AF49A-F5EE-4931-867A-63E0C7F87FC7 :END: Fontify super and subscripts. #+name: org_gcr_2018-03-06_mara_58F2B467-037A-4DE8-B780-886A7A0BEC09 #+begin_src emacs-lisp (setq font-latex-fontify-script t) #+end_src Allow =n= super and subscript depth. #+name: org_gcr_2018-03-06_mara_6C92D757-E7A6-4635-B1F5-762DAC8C8503 #+begin_src emacs-lisp (setq font-latex-fontify-script-max-level 3) #+end_src **** Starting Processors, Viewers and Other Programs :PROPERTIES: :ID: org_gcr_2018-03-06_mara:8D6395B6-CFE8-4A87-96E2-C4D1A24117E6 :END: Tell ~ispell~ to ignore things. #+name: org_gcr_2018-03-06_mara_10961961-251E-46A1-B155-FD424A99B2FF #+begin_src emacs-lisp (setq TeX-ispell-extend-skip-list t) #+end_src Create DVI from PDF. #+name: org_gcr_2018-03-07_mara_4533FF11-F0B1-48B8-A780-D737AC29F7D6 #+begin_src emacs-lisp (setq TeX-PDF-mode t) #+end_src Use XeTeX. #+name: org_gcr_2018-03-06_mara_C3C1359C-0A11-47C1-AEFD-4C657DF7787A #+begin_src emacs-lisp (setq-default TeX-engine 'xetex) (setq-default TeX-PDF-mode t) #+end_src Show compilation is another window. #+name: org_gcr_2018-03-06_mara_4826C62E-511D-453D-8FF2-3A916A9D3B65 #+begin_src emacs-lisp (setq TeX-show-compilation t) #+end_src Error message format. #+name: org_gcr_2018-03-06_mara_88CDF424-3E45-4D0E-838F-B9387054B7DB #+begin_src emacs-lisp (setq TeX-file-line-error t) #+end_src Prompt before cleaning. #+name: org_gcr_2018-03-06_mara_214A76EF-F021-4FE3-95B7-AFE7453EDB21 #+begin_src emacs-lisp (setq TeX-clean-confirm t) #+end_src **** Customization and Extension :PROPERTIES: :ID: org_gcr_2018-03-07_mara:B440BBB2-DC5D-421D-85BD-988BF56B7E2B :END: Never use multi-file document structure. #+name: org_gcr_2018-03-05_mara_5F1D507C-7E7F-40C0-9547-A2864763FFEC #+begin_src emacs-lisp (setq-default TeX-master t) #+end_src Automatically parse on load and save. #+name: org_gcr_2018-03-07_mara_8C054399-B5D2-4951-BB01-9D97FD1EBD4F #+begin_src emacs-lisp (setq TeX-parse-self t) (setq TeX-auto-save t) #+end_src Recursively search for all customizations. #+name: org_gcr_2018-03-07_mara_DB006B6E-953F-48B8-ABE2-1CC763558DA5 #+begin_src emacs-lisp (setq TeX-file-recurse t) #+end_src **** Key Bindings :PROPERTIES: :ID: org_gcr_2018-03-05_mara:D945AAE3-61B6-4EE8-8693-D67685344A17 :END: #+name: org_gcr_2018-03-05_mara_0A5B88B3-C1DE-4C06-B44C-98E5468CDCC2 #+begin_src emacs-lisp (define-key TeX-mode-map (kbd "C-c C-c") #'help/safb-TeX-command-master) (define-key TeX-mode-map (kbd "C-j") nil) (define-key TeX-mode-map (kbd "C-M-f") nil) (define-key TeX-mode-map (kbd "C-M-f") #'LaTeX-find-matching-end) (define-key TeX-mode-map (kbd "C-M-b") nil) (define-key TeX-mode-map (kbd "C-M-b") #'LaTeX-find-matching-begin) (define-key TeX-mode-map (kbd "H-l") nil) (define-key TeX-mode-map (kbd "H-l") #'TeX-complete-symbol) #+end_src **** Hydras :PROPERTIES: :ID: org_gcr_2018-03-05_mara:56F54131-AD99-411E-89D0-1AD104B3E228 :END: #+name: org_gcr_2018-03-05_mara_033D8FD5-B014-40CC-9EBD-095FF51EBD6A #+begin_src emacs-lisp (defhydra help/hydra/auctex (:color blue :hint nil) " AUCTeX: _H_elp _q_uit Do: Run_a_ll →R_e_gion →B_u_ffer →Section(_1_) _K_ill-Job Center-Buffer(_2_) Go-Home(_3_) Clean(_4_) Save-Belonging(_6_ Insert: _S_ection _E_nvironment _M_acro _F_ont(¿) _C_lose-Env _I_tem _N_o Indent Mark: E_n_vironment (_j_ust one) Se_c_tion (jus_t_ one) Fold: Fol_d_* Bu_f_fe_r_ Re_g_i_o_n _P_aragraph Macr_o_ En_v_ Mat_h_ Co_m_ment Narrow: _G_roup Env_i_ronment Errors: _R_eport ⏼_B_oxes ⏼_W_arnings " ;; Do ("a" TeX-command-run-all) ("e" TeX-command-region) ("u" TeX-command-buffer) ("1" LaTeX-command-section) ("K" TeX-kill-job) ("2" TeX-recenter-output-buffer) ("3" TeX-home-buffer) ("4" TeX-clean) ("H" TeX-documentation-texdoc) ("6" TeX-save-document) ;; Insert ("S" LaTeX-section) ("E" LaTeX-environment) ("M" TeX-insert-macro) ("F" TeX-font) ("C" LaTeX-close-environment) ("I" LaTeX-insert-item) ("N" (lambda () (interactive) (insert "\\noindent"))) ;; Mark ("n" LaTeX-mark-environment) ("j" (lambda (interactive) (let ((current-prefix-arg '(4))) (call-interactively 'LaTeX-mark-environment)) )) ("c" LaTeX-mark-section) ("t" (lambda (interactive) (let ((current-prefix-arg '(4))) (call-interactively 'LaTeX-mark-section)) )) ;; Folding ("d" TeX-fold-dwim) ("f" TeX-fold-buffer) ("r" TeX-fold-clearout-buffer) ("g" TeX-fold-region) ("i" TeX-fold-clearout-region) ("P" TeX-fold-paragraph) ("o" TeX-fold-macro) ("v" TeX-fold-env) ("h" TeX-fold-math) ("m" TeX-fold-comment) ;; Narrow: ("G" TeX-narrow-to-group) ("i" LaTeX-narrow-to-environment) ;; Errors ("R" TeX-error-overview) ("B" TeX-toggle-debug-bad-boxes) ("W" TeX-toggle-debug-warnings) ("q" nil)) #+end_src **** Hooks :PROPERTIES: :ID: org_gcr_2018-03-05_mara:5C39E41D-C6EC-4A6F-ACB5-A59B472D02CE :END: - Hook customization - If for all text modes then add it to ~text-mode-hook~ - If for all AUCTeX modes then add it to ~TeX-mode-hook~ - Otherwise add it to a mode specific hook #+name: org_gcr_2018-03-05_mara_8E7A881B-6807-4FA9-A37B-F5E5B1292181 #+begin_src emacs-lisp (defun help/TeX-mode-hook () (key-chord-define-local "hh" #'help/hydra/auctex/body) (LaTeX-math-mode) (TeX-fold-mode 1) (prettify-symbols-mode) (TeX-install-toolbar) (setq LaTeX-enable-toolbar t) (TeX-interactive-mode) (local-unset-key (kbd "C-j"))) (add-hook 'TeX-mode-hook 'help/TeX-mode-hook) #+end_src *** KOMA-Script :PROPERTIES: :ID: org_gcr_2017-05-12_mara:623E9A43-A969-48FD-9045-356F83B135E2 :END: I enjoy writing letters. I enjoy reading letters. LaTeX produces letters that are easy to print and read. Org provides a [[http://orgmode.org/worg/exporters/koma-letter-export.html][KOMA Script exporter]] for [[https://www.ctan.org/pkg/koma-script?lang%3Den][KOMA-script]]. The Org documentation mentions that the user should read the [[http://orgmode.org/cgit.cgi/org-mode.git/plain/contrib/lisp/ox-koma-letter.el][ox-koma-letter.el]] header documentation. The [[https://www.ctan.org/pkg/babel?lang%3Den][babel]] packages is mentioned in the Org documentation. The package documentation explains that it should be used with LaTeX, but not XeTeX. Some time ago I decided to stick with LaTeX. This decision needs documentation. This system leans towards LuaTeX because of its Unicode support and sticks with PDFLaTeX because of its broad acceptance. Those two goals are at odds with each other. Load the KOMA exporter. #+NAME: org_gcr_2017-05-12_mara_C74104AA-A25C-4BE8-A7DD-99DEA240FF73 #+BEGIN_SRC emacs-lisp (eval-after-load "ox" '(require 'ox-koma-letter)) #+END_SRC - Understanding KOMA and how to use it - There are 4 ways to set letter metadata, listed "from the most specific to the most general" (not sure exactly what this statement means, and the conclusion of my notes tries to make sense of what is really going on here and what is the best way to do things) - Org option lines (ORG) - Separate Org latex classes (LTX) - Emacs Lisp variables (LISP) - Letter Class Option files (LCO) - Notes and thoughts on the ways to use it - LTX - By following the setup directions, you do this, creating "help-letter" class - Familiar and easy if you already know LaTeX - At some point in your workflow, you *must* define a class to use, anyway - Very easy to do, just define the class template and set =org-koma-letter-default-class= - ORG - Simple way that makes it very easy to just focus on the document content - This metadata takes highest priority in the workflow - So you should set your typical defaults in LISP or LCO and customize it here. This is exactly what I wanted to know. - This lets you do your tweaking in each unique file while relying on the most common defaults defined elsewhere - LISP - Very familiar style of configuring things - LCO - LCO == Letter Class Option files - LCO files are TeX - They are included in the generated TeX source code from the letter - Gives *full* access to KOMA-Script - Big deal, because not everything is exposed through ORG or LISP - Also gives full access to any and all TeX and LaTeX code - LCO files are a KOMA-Script thing, so they are a LaTeX thing - #+begin_quote Letter metadata set in LCO files overwrites letter metadata set in Emacs variables but not letter metadata set in the Org file. #+end_quote - When you include multiple LCO files, they are evaluated LIFO. Properties are set as they first appear, and are not set again. Say you include "MyGeneralStuffForAnyLetter.lco" and then include "MyStuffSpecificToThisLetter.lco". The specific stuff will get set first. Then general stuff will get set last. - Surely there is a better way to phrase this. I will work on that. - Recommendations - What is the easiest way to start using KOMA-Script based on what you know today? - If you don't know any of the approaches - Then choose between learning LaTeX and Org - If you only know LaTeX - Then you will use the LTX/LCO metadata approach - If you only know ORG - Then you will use the ORG metadata approach - If you only know ORG and LISP - Then you will use the LISP approach for general metadata and the ORG approach specific metadata - If you know LTX/LCO, ORG, and LISP - Then you have total flexibility - The fact is that - ORG settings always trump LTX/LCO and LISP - LISP settings are a subset of all of the settings available in KOMA-Script, so you will always have to fall back to LTX/LCO if you want to use unexposed features - LCO files are just plain old LaTeX, which you already know - So the best thing to do - Is to use ORG for letter-specific settings - And LTX for general settings - Everything is a lot simpler this way because - One less metadata approach to keep track of - All KOMA-Script features are present - Need to learn details of KOMA-Script package anyway Configure the default class. [[https://tex.stackexchange.com/questions/102922/how-can-i-get-us-letter-output-from-koma-scripts-scrlttr2-class][This]] post explains how to default the US letter size. That is the likely default for my printed correspondence. #+NAME: org_gcr_2017-05-12_mara_8A241D12-24B3-4C4C-AC99-B55954611025 #+BEGIN_SRC emacs-lisp (eval-after-load "ox-koma-letter" '(progn (add-to-list 'org-latex-classes '("help-letter" "\\documentclass[12pt, pagesize, UScommercial9]{scrlttr2}")) (setq org-koma-letter-default-class "help-letter"))) #+END_SRC There are two formats for the letters: [[http://orgmode.org/w/?p%3Dworg.git%3Ba%3Dblob%3Bf%3Dexporters/koma-letter-new-example.org%3Bh%3D180a9a0e10dd8f7483a67946daf36732c316f821%3Bhb%3D180a9a0e10dd8f7483a67946daf36732c316f821][heading-based]] and [[http://orgmode.org/w/?p%3Dworg.git%3Ba%3Dblob%3Bf%3Dexporters/koma-letter-example.org%3Bh%3De21b8b00c3e895be9dd573d02ea84b08796296a3%3Bhb%3De21b8b00c3e895be9dd573d02ea84b08796296a3][property-based]]. Set up my default LCO files. #+NAME: org_gcr_2017-05-12_mara_33A83D5A-E541-474C-AA0D-2E039EC74CDD #+BEGIN_SRC emacs-lisp (setq org-koma-letter-class-option-file "KomaDefault") #+END_SRC *** BibTeX :PROPERTIES: :ID: org_gcr_2018-09-19T12-32-27-05-00_cosmicality:5B76D1FD-35D2-43F4-8CFB-B434671BEF29 :END: Load BibTeX mode. At some point I want to cut over to BibLaTeX. #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_4C483D43-7E0D-48E1-88D5-9353A0DBD83A #+begin_src emacs-lisp (require 'bibtex) #+end_src Helper functions. #+name: org_gcr_2018-11-13T18-00-23-06-00_cosmicality_32B5EE79-9019-4210-B45F-71B2781CEB4E #+begin_src emacs-lisp (defun help/bibtex-calculate-new-reference-key () (interactive) (bibtex-clean-entry)) (defun help/bibtex-maybe-troublesome-mode-disable (interactive) (aggressive-indent-mode 'toggle) (visual-line-mode 't)) (defun help/bibtex-maybe-troublesome-mode-enable (interactive) (aggressive-indent-mode nil) (visual-line-mode nil)) #+end_src Helper Hydra #+name: org_gcr_2018-11-13T18-00-23-06-00_cosmicality_62AAF44B-D738-4732-BD54-1111BCD6BB6E #+begin_src emacs-lisp (defhydra help/bibtex (:color blue :hint nil) " _c_ Clean Entry _C_ Clean Entry & Create New Reference _f_ Reindent Field _F_ Reindent Buffer/Region _m_ Disable Unhelpful Modes _M_ Enable Unhelpful Modes " ("c" bibtex-clean-entry) ("C" help/bibtex-calculate-new-reference-key) ("f" bibtex-fill-entry) ("F" bibtex-reformat) ("m" help/bibtex-maybe-troublesome-mode-disable) ("M" help/bibtex-maybe-troublesome-mode-enable)) #+end_src Mode hook and key bindings. #+name: org_gcr_2018-11-13T18-00-23-06-00_cosmicality_3B76ECF1-3D55-4066-BCC1-1436E41D5C2D #+begin_src emacs-lisp (defun help/bibtex-mode-hook-fn () (key-chord-define-local "hh" #'help/bibtex/body)) (add-hook 'bibtex-mode-hook #'help/bibtex-mode-hook-fn) #+end_src **** Entry Format Definition :PROPERTIES: :ID: org_gcr_2018-11-13T18-00-23-06-00_cosmicality:715AC227-1607-43DE-AA61-16018C9C53F9 :END: Start from scratch. #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_1CF3A243-94CC-4423-9BC3-35BAAA3C9A23 #+begin_src emacs-lisp (setq bibtex-entry-format nil) #+end_src "Delete empty optional and alternative fields and remove OPT and ALT prefixes from used fields." #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_94FCD330-3C5E-404E-AA19-0C3E9D1DB6D4 #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'opts-or-alts) #+end_src "Signal an error if a required field is missing." #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_1B324CB4-0390-43F2-9AE4-EDEC5D16614A #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'required-fields) #+end_src "Delete whitespace at the beginning and end of fields." #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_A0A4865A-E855-463C-8F55-43C47199CAD8 #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'whitespace) #+end_src "Realign entries, so that field texts and perhaps equal signs begin in the same column. Also fill fields." #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_21684BCC-04D4-4EE8-90E0-4F65764D1E26 #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'realign) #+end_src "Change delimiters according to variables ‘bibtex-field-delimiters’ and ‘bibtex-entry-delimiters’." #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_B493A48E-FDE3-4B0B-B935-FBDF3BB99C35 #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'delimiters) #+end_src BibTeX is a structured data format. Like most other ones after you stare at it a while you get the format stuck in your head pretty well. So well in fact that you only look at the field names as a reference point and fast confirmation that they are present in order to get what you really want—the field value. In other words, eventually you quit reading the field definitions. Therefore they ought to be as inconspicuous as possible. In my setup that means they are in lower case. "Change case of entry types and field names." by lower-casing them. #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_D5C9AF40-97B8-4F1B-8CBC-373DB521C1EF #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'unify-case) #+end_src "Sort fields to match the field order in ‘bibtex-BibTeX-entry-alist’." #+name: org_gcr_2018-11-13T18-00-23-06-00_cosmicality_CE975BCA-7E66-4E82-BC85-941FFBB216C5 #+begin_src emacs-lisp (add-to-list 'bibtex-entry-format 'sort-fields) #+end_src **** Autokey :PROPERTIES: :ID: org_gcr_2018-11-12T12-28-14-06-00_cosmicality:9E369A4B-01ED-4D50-A2A6-1CEB29D56A08 :END: The goal is to make key generation 100% automated and 100% future proof. A combination of rules and best-practices should make this "just work". ***** Key :PROPERTIES: :ID: org_gcr_2018-11-12T12-28-14-06-00_cosmicality:99541FA5-70D7-4FB8-82D6-1C880A9382CE :END: Separate them using a Hyphen-Minus sign. Theye easy to read, acceptable to operating systems, ASCII-safe, and don't take up much space. #+name: org_gcr_2018-11-12T12-28-14-06-00_cosmicality_48463172-68BE-4034-922F-50D0F572F73A #+begin_src emacs-lisp (setq bibtex-autokey-name-year-separator "-") (setq bibtex-autokey-year-title-separator "-") (setq bibtex-autokey-titleword-separator "-") #+end_src ***** Name :PROPERTIES: :ID: org_gcr_2018-11-12T12-28-14-06-00_cosmicality:0BC72687-242E-45C9-8DF6-906E99F85220 :END: When there are only one or two authors then include each of them, using their full names. Separate them using a Hyphen-Minus sign. When there are more than two authors then only use the first author, using his full name, followed by "[[https://www.merriam-webster.com/dictionary/et%2520al.][et al]]". #+name: org_gcr_2018-11-12T12-28-14-06-00_cosmicality_9BDC47DE-78C9-460E-9333-3E8E79C51AFD #+begin_src emacs-lisp (setq bibtex-autokey-names 1) (setq bibtex-autokey-names-stretch 1) (setq bibtex-autokey-name-separator "-") (setq bibtex-autokey-additional-names "-et-al") #+end_src ***** Year :PROPERTIES: :ID: org_gcr_2018-11-12T12-28-14-06-00_cosmicality:4E9BF2AD-F298-4D3C-B46A-B873FFBC27FD :END: Use four digits for the year: it is easier to read. #+name: org_gcr_2018-11-12T12-28-14-06-00_cosmicality_E1A42ADA-92E6-4479-9C21-87612AE656C4 #+begin_src emacs-lisp (setq bibtex-autokey-year-length 4) #+end_src ***** Title :PROPERTIES: :ID: org_gcr_2018-11-12T12-28-14-06-00_cosmicality:12B4D728-DFAB-44DD-B15F-0B453734428D :END: Include two title words. I don't want them to take up too much space to trim them to 5 characters. [[https://www.wolframalpha.com/input/?i=average+english+word+length][WolframAlpha]] says that the average word length in English 5.1 characters. What kind of words? All kinds. I looked at examples and it seems good enough to jog your memory of the publication. #+name: org_gcr_2018-11-12T12-28-14-06-00_cosmicality_2C0EDDD9-13CB-4A6D-BB57-D4CDDC671106 #+begin_src emacs-lisp (setq bibtex-autokey-titlewords 2) (setq bibtex-autokey-titlewords-stretch 1) (setq bibtex-autokey-titleword-length 5) #+end_src ***** Suggestions :PROPERTIES: :ID: org_gcr_2018-11-12T12-28-14-06-00_cosmicality:A10046EA-810A-46E0-ADDB-7A3B9A89AC4B :END: To reinforce this automated approach: disallow the user from editing the generated key before it is used. The idea here is that when key naming issues appear that it is better to correct it in the algorithm instead of individual key name. #+name: org_gcr_2018-09-19T12-32-27-05-00_cosmicality_C87F9898-F014-4A14-8CD9-DCA6554DD133 #+begin_src emacs-lisp (setq bibtex-autokey-edit-before-use nil) #+end_src *** Texinfo :PROPERTIES: :ID: org_gcr_2017-05-12_mara:2A19DF86-96B0-4371-8DE9-1F79861F5E89 :END: Perhaps the [[https://lists.gnu.org/archive/html/emacs-orgmode/2015-07/msg00042.html][first]] document typeset with Org-Texinfo. *** Pandoc :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BF923ADF-EB81-4695-9F98-F68D557D667B :END: #+name: org_gcr_2018-10-15T12-34-46-04-00_cosmicality_E59C952D-3D8E-4CDC-8B84-8DECB51438D4 #+begin_src emacs-lisp (use-package ox-pandoc :ensure t :config (setq org-pandoc-options-for-beamer-pdf '((pdf-engine . "xelatex"))) (setq org-pandoc-options-for-latex-pdf '((pdf-engine . "xelatex"))) (setq org-pandoc-format-extensions '(markdown_github+pipe_tables+raw_html)) (with-eval-after-load 'ox (require 'ox-pandoc))) #+end_src *** Markdown :PROPERTIES: :ID: org_gcr_2017-05-12_mara:005B395D-AF3F-471D-AD11-45FDBAA85D7A :END: Markdown. #+NAME: org_gcr_2017-05-12_mara_42D37E52-A420-4196-8B2C-6755441A5FC3 #+BEGIN_SRC emacs-lisp (use-package markdown-mode :ensure t :config (add-to-list 'auto-mode-alist '("\\.markdown\\'" . markdown-mode)) (add-to-list 'auto-mode-alist '("\\.md\\'" . markdown-mode)) (use-package ox-gfm :ensure t :config (add-to-list 'auto-mode-alist '("README\\.md\\'" . gfm-mode))) (help/on-mac-os (setq markdown-open-command "/Users/gcr/util/mark"))) #+END_SRC Generate Markdown from Emacs Lisp comments. #+NAME: org_gcr_2017-11-19_mara_60445A8D-329F-4816-BFA5-1283AC570D30 #+BEGIN_SRC emacs-lisp (use-package el2markdown :ensure t :config (defun help/el2markdown-post-convert-hook-fn (buf) (interactive) (message (format "el2markdowned: %s" buf))) (add-hook 'el2markdown-post-convert-hook #'help/el2markdown-post-convert-hook-fn)) #+END_SRC *** HTML :PROPERTIES: :ID: org_gcr_2017-05-12_mara:5AE61C99-1862-456E-B6FA-44225675B208 :END: Load Htmlize for HTML export. #+NAME: org_gcr_2017-05-12_mara_62E6542A-B340-470A-B7E0-2F4438EBBAE9 #+BEGIN_SRC emacs-lisp (use-package htmlize :config (setq org-html-htmlize-output-type htmlize-output-type) (setq htmlize-output-type 'inline-css)) #+END_SRC Export HTML to the clipboard. #+NAME: org_gcr_2017-12-03_mara_70A08E80-7CD1-4D4F-9584-34F6FBD7A32E #+BEGIN_SRC emacs-lisp (use-package ox-clip :ensure t) #+END_SRC *** ASCII :PROPERTIES: :ID: org_gcr_2017-05-12_mara:7BEBFA9B-E445-41F3-ABC6-08AFB3020D30 :END: #+NAME: org_gcr_2017-05-12_mara_41F8B285-650A-4394-8ECD-85C81181DF14 #+BEGIN_SRC emacs-lisp (setq org-ascii-text-width 80) (setq org-ascii-global-margin 0) #+END_SRC Show non-ascii characters #+NAME: org_gcr_2017-05-12_mara_96A9D762-036A-49C0-9E1B-5ACD3F5AE58E #+BEGIN_SRC emacs-lisp (defun help/occur-non-ascii () "Find any non-ascii characters in the current buffer. Attribution: URL `https://www.emacswiki.org/emacs/FindingNonAsciiCharacters'" (interactive) (occur "[^[:ascii:]]")) #+END_SRC *** Beamer :PROPERTIES: :ID: org_gcr_2017-05-12_mara:1D459BA8-B1B0-40B9-B733-6B59216FD1B2 :END: Load Beamer for creating presentations. #+NAME: org_gcr_2017-05-12_mara_8D4105B8-5215-4835-91BF-B0D03ACC3A78 #+BEGIN_SRC emacs-lisp (use-package ox-beamer) #+END_SRC *** Screenwriting :PROPERTIES: :ID: org_gcr_2017-05-12_mara:AE18CBCE-F03C-4422-AAC8-E1E2C76A7C5E :END: #+NAME: org_gcr_2017-05-12_mara_B19CF074-8B77-4843-912C-F68B6FB0FE2F #+BEGIN_SRC emacs-lisp (use-package fountain-mode :ensure t :config (add-to-list 'auto-mode-alist '("\\.fountain$" . fountain-mode)) (let ((fountain-stx '( "CONT'D" "CROSSFADE" "FLASHCUTS" "FLASHFORWARD" "INTERCUT" "PRE" "PRELAP" ))) (mapc (lambda (stx) (add-to-list 'ispell-skip-region-alist (list stx))) fountain-stx))) #+END_SRC ** DevOps :PROPERTIES: :ID: org_gcr_2017-05-12_mara:F79C9679-7887-40B8-8882-51EE6EC1BDE2 :END: *** Shell Scripty :PROPERTIES: :ID: org_gcr_2017-05-12_mara:68AC26B4-B52C-4A1F-AF1E-78AFE5A3D91D :END: **** Editing :PROPERTIES: :ID: org_gcr_2017-07-16_mara:D2B25F16-8384-4641-A2C0-C9D987A83E10 :END: This ~Bash~ IDE appears less valuable because it automatically inherits its best features unseen here (you are looking at the rest below this big block): - Standard programming configuration - ~ShellCheck~ integration - Default to Bash - Smart Hashbang line generation #+NAME: org_gcr_2017-07-16_mara_FB8AD647-F0FA-4004-B930-A9CD97E97900 #+BEGIN_SRC emacs-lisp (use-package sh-script :config (defun help/sh-mode-hook-fn () (interactive) (setq sh-basic-offset 2)) (add-hook 'sh-mode-hook #'help/sh-mode-hook-fn)) #+END_SRC Toggle string quotes between single and double. #+NAME: org_gcr_2017-07-16_mara_05CFE4C1-3363-42A3-A517-9A961282BB19 #+BEGIN_SRC emacs-lisp (use-package toggle-quotes :ensure t) #+END_SRC Sh-Mode Hydra. #+NAME: org_gcr_2017-07-16_mara_B4B1E9B3-3146-46AA-80C8-20B28C352E55 #+BEGIN_SRC emacs-lisp (defhydra help/hydra-sh-mode (:color blue :hint nil) " sh-mode: _i_ insert #!-line _q_ quit " ("i" sh-set-shell) ("q" nil)) (key-chord-define sh-mode-map "hh" #'help/hydra-sh-mode/body) #+END_SRC *** Make :PROPERTIES: :ID: org_gcr_2017-05-12_mara:4EC46A0A-2D59-4C21-8013-6A86CD46BC5F :END: #+name: org_gcr_2018-03-17T20-26-45-05-00_mara_AF83DB64-A5AD-4853-BE74-6DA4E4A4E2C6 #+begin_src emacs-lisp (use-package make-mode :config (defun help/make-mode-hook ())) (add-hook 'makefile-mode-hook #'help/make-mode-hook) (add-to-list 'auto-mode-alist '("Makefile" . makefile-mode)) #+end_src *** Vagrant :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D8A25DB9-FFAD-4C06-95C8-948AB0AFC4DE :END: ~ruby-mode~ supports =Vagrantfile= OOTB. *** Apache :PROPERTIES: :ID: org_gcr_2017-05-12_mara:719B95DC-1AF2-4581-BDEB-FC2430EAE076 :END: #+NAME: org_gcr_2017-05-12_mara_96443D6C-1E5B-48C5-9853-544D0EE79B1E #+BEGIN_SRC emacs-lisp (use-package apache-mode :ensure t) #+END_SRC *** SSH :PROPERTIES: :ID: org_gcr_2017-05-12_mara:EF50829C-C6BA-4D22-ACD0-5386EF38155D :END: #+NAME: org_gcr_2017-05-12_mara_D12C607E-C07C-41F8-A0B0-02A228C7AED7 #+BEGIN_SRC emacs-lisp (use-package ssh-config-mode :ensure t :mode (("/\\.ssh/config\\'" . ssh-config-mode) ("/sshd?_config\\'" . ssh-config-mode) ("/known_hosts\\'" . ssh-known-hosts-mode) ("/authorized_keys2?\\'" . ssh-authorized-keys-mode)) :config (add-hook 'ssh-config-mode-hook #'turn-on-font-lock) (add-hook 'ssh-config-mode-hook #'help/text-mode-fn)) #+END_SRC *** CRON :PROPERTIES: :ID: org_gcr_2017-06-13_mara:9B3AB875-4459-4EC7-A7C5-4C32EC3A5E18 :END: #+NAME: org_gcr_2017-06-13_mara_350A94E2-4280-4D5E-BB58-24887D9A57CD #+BEGIN_SRC emacs-lisp (require 'crontab-mode) (add-to-list 'auto-mode-alist '("\\.cron\\(tab\\)?\\'" . crontab-mode)) (add-hook 'crontab-mode-hook #'turn-on-stripe-buffer-mode) #+END_SRC *** Ansible :PROPERTIES: :ID: org_gcr_2018-01-17_mara:3CB6A9AB-EB08-4762-A017-249764566C1E :END: Remember it is a minor mode that will only ever run under YAML mode. :PROPERTIES: :ID: org_gcr_2018-01-03_mara:626CA760-B710-4A90-A585-66C5EEC2DAD9 :END: #+NAME: org_gcr_2018-01-03_mara_CD4698C2-3650-45E4-94F8-F8B3EB66DA57 #+BEGIN_SRC emacs-lisp (use-package ansible :ensure t :config (defhydra help/hydra/ansible (:color blue :hint nil) " Ansible: (q to quit) _D_ecrypt buffer _E_ncrypt buffer " ("D" #'ansible::decrypt-buffer) ("E" #'ansible::encrypt-buffer) ("q" nil)) (key-chord-define ansible-key-map "hh" #'help/hydra/ansible/body)) #+END_SRC ** Multimedia :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D3EE5DB5-EC7B-4D7C-9749-1BC351B8214D :END: *** Artist :PROPERTIES: :ID: org_gcr_2017-05-12_mara:4C5A0835-B5EE-4248-A04A-5F1E90FDC308 :END: #+NAME: org_gcr_2017-05-12_mara_AF516C01-3152-4194-954B-91A44A429972 #+BEGIN_SRC emacs-lisp (add-to-list 'auto-mode-alist '("\\.asc" . artist-mode)) (add-to-list 'auto-mode-alist '("\\.art" . artist-mode)) (add-to-list 'auto-mode-alist '("\\.asc" . artist-mode)) #+END_SRC *** DITAA :PROPERTIES: :ID: org_gcr_2017-05-12_mara:6D7CE54F-D123-4C90-BFB6-374B2ACB1D1C :END: #+NAME: org_gcr_2017-05-12_mara_9D0BBF2C-BB7C-4B72-BA10-0B497FE8CAA1 #+BEGIN_SRC emacs-lisp :wrap "RESULTS" (defconst help/ditaa-jar (getenv "DITAA")) (setq org-ditaa-jar-path help/ditaa-jar) #+END_SRC *** Graphviz :PROPERTIES: :ID: org_gcr_2017-05-12_mara:8523DEE7-31C4-445A-B300-4923BCA3F7D7 :END: #+NAME: org_gcr_2017-05-12_mara_362D21E8-3D98-4905-8942-A146C4A555D1 #+BEGIN_SRC emacs-lisp :wrap "RESULTS" (use-package graphviz-dot-mode :ensure t :config (setf (cdr (assoc "dot" org-src-lang-modes)) 'graphviz-dot)) (defhydra help/hydra/graphviz-dot-mode (:color blue :hint nil) " Graphviz ^╔═^═══^════════════════════════════╗ ^║ ^Use^ ║ ^╚═^═══^════════════════════════════╝ _p_: View _L_: Enable Live Preview On Save _l_: Disable Live Preview On Save _t_: Complete Word _c_: Compile _i_: Indent Graph _s_: Set Layout _q_: Quit " ("p" graphviz-dot-preview) ("L" graphviz-turn-on-live-preview) ("l" graphviz-turn-off-live-preview) ("t" graphviz-dot-complete-word) ("c" compile) ("i" graphviz-dot-indent-graph) ("s" graphviz-dot-set-layout) ("q" nil)) (defun help/graphviz-dot-mode-hook-fun () (setq graphviz-dot-view-command "open %s" graphviz-dot-view-edit-command nil graphviz-dot-save-before-view t graphviz-dot-auto-indent-on-newline nil graphviz-dot-indent-width 2 graphviz-dot-auto-indent-on-braces nil graphviz-dot-auto-indent-on-semi nil graphviz-dot-delete-completions t graphviz-dot-auto-preview-on-save t) (key-chord-define-local "hh" #'help/hydra/graphviz-dot-mode/body) (local-set-key (kbd "M-9") #'compile) (local-set-key (kbd "M-0") #'graphviz-dot-complete-word) (smartparens-global-strict-mode)) (add-hook 'graphviz-dot-mode-hook #'help/graphviz-dot-mode-hook-fun) #+end_src *** PlantUML :PROPERTIES: :ID: org_gcr_2017-05-12_mara:1AE2633B-E811-4117-ACE7-0D7D2F88EDEB :END: #+NAME: org_gcr_2017-05-12_mara_91D0CFDF-6FC2-4F4A-9CFC-825CED0061B6 #+BEGIN_SRC emacs-lisp (use-package plantuml-mode :ensure t :init (defconst help/plantuml-jar (getenv "PLANTUML")) (setq plantuml-jar-path help/plantuml-jar) :config (eval-after-load "ob-plantuml" (setq org-plantuml-jar-path help/plantuml-jar))) #+END_SRC *** X PixMap (XPM) :PROPERTIES: :ID: org_gcr_2017-06-25_mara:53D58BE5-1E7D-4E75-8359-AF7EF001CE2B :END: [[https://en.wikipedia.org/wiki/X_PixMap][X PixMap (XPM)]] Emacs' provide editing support. #+NAME: org_gcr_2017-06-25_mara_B33E6DF0-8A18-4DBA-A39D-B16649F6E793 #+BEGIN_SRC emacs-lisp (use-package xpm :ensure t) #+END_SRC *** Screencast :PROPERTIES: :ID: org_gcr_2019-03-02T11-51-40-06-00_cosmicality:47D6B93E-B758-45BD-B0AE-9405F274E458 :END: #+name: org_gcr_2019-03-02T10-53-38-06-00_cosmicality_1E12A9D7-2231-4949-82ED-98EB22B5F807 #+begin_src emacs-lisp (use-package gif-screencast :ensure t :config (global-set-key (kbd "M-H-1") 'gif-screencast) (define-key gif-screencast-mode-map (kbd "M-s-3") 'gif-screencast-toggle-pause) (define-key gif-screencast-mode-map (kbd "M-s-2") 'gif-screencast-stop) (help/on-mac-os (setq gif-screencast-args '("-x")) (setq gif-screencast-cropping-program "mogrify") (setq gif-screencast-capture-format "ppm"))) #+end_src ** Computer-aided design :PROPERTIES: :ID: org_gcr_2017-05-12_mara:50E7A50A-4259-4B6C-8612-99671C6723CC :END: ** Special :PROPERTIES: :ID: org_gcr_2017-06-25_mara:BEC7C2AA-4602-4F1C-8AE5-2DAD6439C90F :END: ~messages-mode~ inherits ~special-mode~ hooks but it didn't get stripe buffered so I'm trying to set it up here with ~message-mode-hook~ but that didn't work either * Quiet and Pleasant Appearance :PROPERTIES: :ID: org_gcr_2017-05-12_mara:298AA1C9-5745-464F-92A6-2FB04EFB079E :END: Configure EMACS to personal-taste for "noise" and "form". ** Buffer :PROPERTIES: :ID: org_gcr_2017-05-12_mara:4A3C9150-EC66-4462-B14A-92C8BE34FB94 :END: Never automatically convert the end of the line character. For most of us this is between UNIX and DOS. #+NAME: org_gcr_2017-05-12_mara_B1FCEF49-334F-4F64-B96F-A888ABE84BB0 #+BEGIN_SRC emacs-lisp (setq inhibit-eol-conversion t) #+END_SRC Give buffers backed by identically named files distinguishable names. #+NAME: org_gcr_2017-05-12_mara_5D771C42-CAAF-439D-BEC1-5A6559D168D2 #+BEGIN_SRC emacs-lisp (use-package uniquify) (setq uniquify-buffer-name-style 'forward) #+END_SRC Don't use audible bells, use visual bells. #+NAME: org_gcr_2017-05-12_mara_C5DA95E6-0F38-450E-96C8-6CED005DE0D1 #+BEGIN_SRC emacs-lisp (setq ring-bell-function 'ignore) (setq visible-bell t) #+END_SRC Highlight s-expressions. #+NAME: org_gcr_2017-05-12_mara_F6E5E796-E1A4-4599-B6D1-F0729C1619A0 #+BEGIN_SRC emacs-lisp (setq blink-matching-paren nil) (show-paren-mode) (setq show-paren-delay 0) (setq show-paren-style 'expression) #+END_SRC The cursor should not blink and distract you. On a graphic display make the cursor a box and stretch it as wide as the character below it. #+NAME: org_gcr_2017-05-12_mara_DD79CB65-2F96-40DD-8BD8-BECDCE8CD399 #+BEGIN_SRC emacs-lisp (blink-cursor-mode 0) (help/on-gui (setq-default cursor-type 'box) (setq x-stretch-cursor 1)) #+END_SRC Make it very easy to see the line with the cursor. #+NAME: org_gcr_2017-05-12_mara_C53AF7AE-494C-4916-83C8-F175554B1CAE #+BEGIN_SRC emacs-lisp (global-hl-line-mode t) #+END_SRC Make it very easy to input special-characters using TeX coding. #+NAME: org_gcr_2017-05-12_mara_8B8F5CDF-A2FF-49C3-8DB1-3551942F7573 #+BEGIN_SRC emacs-lisp (setq default-input-method 'TeX) #+END_SRC Automatically Copy Text Selected With The Mouse [[http://pragmaticemacs.com/emacs/automatically-copy-text-selected-with-the-mouse/][via]]. #+NAME: org_gcr_2017-05-12_mara_DD49BAEE-1C39-40E1-93B5-9CBDCD5E284A #+BEGIN_SRC emacs-lisp (setq mouse-drag-copy-region t) #+END_SRC The macro recorder and Multiple-Cursors provide two ways to do the right thing in different situations. Be very thoughtful and allow every function. My configuration /barely/ utilizes MC because I use all that I can handle right now. #+NAME: org_gcr_2017-05-12_mara_828D7008-4B78-44AE-B5B7-15B60B03B3A6 #+BEGIN_SRC emacs-lisp (use-package multiple-cursors :ensure t :config (setq mc/always-run-for-all t)) #+END_SRC Recenter near top of screen. #+NAME: org_gcr_2017-05-12_mara_AA76B6F1-AC3F-42D8-B321-2BD1B05DDE2C #+BEGIN_SRC emacs-lisp (defun help/recenter-line-near-top-fn () "Move current line near top" (interactive) (let ((recenter-positions '(5))) (recenter-top-bottom))) #+END_SRC Visualize ASCII strings with Unicode. #+name: org_gcr_2018-03-14_mara_385BE196-A42C-4086-9BA4-948DB62C2E26 #+begin_src emacs-lisp (global-prettify-symbols-mode) (setq prettify-symbols-unprettify-at-point 'right-edge) #+end_src Entire buffer view. #+name: org_gcr_2019-05-17T23-00-51-05-00_cosmicality_1D0A0BBA-6228-4FA9-BA97-89232B1FF1ED #+BEGIN_SRC emacs-lisp (require 'bird-mode) #+END_SRC Screensaver. #+name: org_gcr_2019-05-17T23-00-51-05-00_cosmicality_F0F23ABE-1931-44F4-8349-203487DAD841 #+BEGIN_SRC emacs-lisp (require 'zone) (defun zone-choose (pgm) "Choose a PGM to run for `zone'." (interactive (list (completing-read "Program: " (mapcar 'symbol-name zone-programs)))) (let ((zone-programs (list (intern pgm)))) (zone))) #+END_SRC ** Color Theme :PROPERTIES: :ID: org_gcr_2017-05-12_mara:3C38AF9D-1905-4B33-A4F5-065D17E9B647 :END: [[https://github.com/bbatsov/solarized-emacs][Solarized Theme]] - ~1,000 Faces Defined - 110,003 - A distinct fringe provides a definition of space. - The modeline is always at the bottom and doesn't need differentiation. - Minimize bold and italic faces. - Minimize fringe indicators. #+NAME: org_gcr_2017-05-12_mara_1AD36955-5FAC-4794-A9B0-A8DC6639A04C #+BEGIN_SRC emacs-lisp (unless (getenv "EMACSNOTHEME") (add-to-list 'load-path "~/src/solarized-emacs") (add-to-list 'custom-theme-load-path "~/src/solarized-emacs") (setq solarized-distinct-fringe-background t) (setq solarized-use-variable-pitch nil) (setq solarized-high-contrast-mode-line nil) (setq solarized-use-less-bold t) (setq solarized-use-more-italic nil) (setq solarized-emphasize-indicators nil) (setq solarized-scale-org-headlines t) (load-theme 'solarized-dark t) (eval-after-load "smart-mode-line" '(sml/setup))) #+END_SRC ** Comint :PROPERTIES: :ID: org_gcr_2017-05-12_mara:EFB91C72-0036-49D8-B4B9-C7473C838E11 :END: =comint-mode= is only maybe the second most important thing for making Emacs really, really special. #+NAME: org_gcr_2017-05-12_mara_96BD218B-65E7-4ACA-98CE-108C3BFC29A3 #+begin_src emacs-lisp (setq comint-scroll-to-bottom-on-input 'this) (setq comint-scroll-to-bottom-on-output 'others) (setq comint-move-point-for-output 'others) (setq comint-show-maximum-output t) (setq comint-scroll-show-maximum-output t) (setq comint-move-point-for-output t) #+end_src This configuration had been working fine for a long time. The intent was for it to be crystal clear that the prompt line in comint buffers would be read only. This turned out to be a mistake; though I am not sure why, when, or how it became a mistake. Nonetheless, this should be left alone. The way the issue here manifested was that all R buffers opened by =ess= were 100% read only which obviously is a *big issue* if you actually want to use! ROFL #+NAME: org_gcr_2017-05-12_mara_F4517BF4-A876-4E3B-B636-9A60BED7174F #+BEGIN_SRC emacs-lisp (setq comint-prompt-read-only nil) #+END_SRC ** Font :PROPERTIES: :ID: org_gcr_2017-05-12_mara:948F97ED-7FD3-4AC9-89D4-CB270CD0540C :END: The best programming font is Deja Vu Sans Mono because it sans-serif and support a lot of Unicode characters. Set it to a good default for an 80 character wide buffer and make it easy to adjust it. Then Hack made it a little better. #+NAME: org_gcr_2017-05-12_mara_6B639D09-DA18-40C5-ABA0-8647820507E6 #+BEGIN_SRC emacs-lisp (help/on-gui (defvar help/font-size-current 10 "The preferred font size.") (help/on-mac-os (setq help/font-size-current 19)) (help/on-windows (setq help/font-size-current 13)) (defconst help/font-size-ideal help/font-size-current "The ideal font for this system.") (defconst help/font-base "Hack" "The preferred font name.") (defun help/font-ok-p () "Is the configured font valid?" (interactive) (member help/font-base (font-family-list))) (defun help/font-name () "Compute the font name and size string." (interactive) (let* ((size (number-to-string help/font-size-current)) (name (concat help/font-base "-" size))) name)) (defun help/update-font () "Updates the current font given configuration values." (interactive) (if (help/font-ok-p) (progn (message "%s : Font Set" (help/font-name)) (set-frame-font (help/font-name))) (message (concat "Your preferred font is not available: " help/font-base)))) (defun help/font-size-reset () "Restore the ideal font size." (interactive) (setq help/font-size-current help/font-size-ideal) (help/update-font)) (help/update-font)) #+END_SRC ** Frame :PROPERTIES: :ID: org_gcr_2017-05-12_mara:8D473EA1-DFEE-408E-A1F5-AF1C7D03317D :END: *** Inviting and familiar GUI features :PROPERTIES: :ID: org_gcr_2017-06-23_mara:77B3D3E9-B7F7-44FB-8B82-A23CAC02C83B :END: Title. #+NAME: org_gcr_2017-07-13_mara_A81CE2F3-CD06-40C9-AD1A-8AB74AB88016 #+BEGIN_SRC emacs-lisp (setq frame-title-format '("" "%b - PIE Interactive Editor ")) #+END_SRC **** Bitmaps :PROPERTIES: :ID: org_gcr_2017-07-11_mara:02FCF4D1-5613-49B3-A247-6BFA846D7EEA :END: Use local bitmaps. #+NAME: org_gcr_2017-07-11_mara_27556B29-B77D-445F-8A54-00BDB89B452A #+BEGIN_SRC emacs-lisp (add-to-list 'image-load-path "~/src/help/xpm") (add-to-list 'image-load-path "~/src/help/tiff") #+END_SRC Bitmap requirements - 24x24 seems to be the most common dimension Finding bitmaps - Search for an existing bitmap [[https://commons.wikimedia.org/wiki/Category:Icons_by_subject][by subject]] - Prefer SVG for flexibility - [[https://github.com/encharm/Font-Awesome-SVG-PNG][Font Awesome]] seems like the best Font Generating bitmaps - By hand - Emacs already supports editing and visuaation - Gimp - Convert SVG to XPM - Convert SVG to PNG #+BEGIN_EXAMPLE rsvg-convert --width=24 --height=24 --format=png --keep-aspect-ratio --output new.png existing.svg #+END_EXAMPLE - Convert PNG to XPM #+BEGIN_EXAMPLE convert new.png new.xpm #+END_EXAMPLE Emacs added macOS support for TIFF. Emacs now prefers TIFF. XPM should work everywhere so I want those to be the masters. They are the masters because when I make corrections they go there. For example I had a 27x24 bitmap that I had to trim to 24x24. So I converted XPMs to TIFF and use those. Then I switched to stock Emacs and deleted the TIFF files. **** Menu bar :PROPERTIES: :ID: org_gcr_2017-06-23_mara:47EF669D-E999-4573-AA5C-5CF038ADA870 :END: Disable the menu bar. #+NAME: org_gcr_2017-05-12_mara_03B4E8E1-083B-4F5D-A4A0-BAE8A0553FAF #+BEGIN_SRC emacs-lisp (menu-bar-mode t) #+END_SRC **** Tool bar :PROPERTIES: :ID: org_gcr_2017-06-23_mara:EC50EB46-7878-4799-9805-EF0CB3D3E526 :END: Disable the tool bar. #+NAME: org_gcr_2017-05-12_mara_D462D343-9EA8-4BCF-BD08-8FDD4F3E11E9 #+BEGIN_SRC emacs-lisp (tool-bar-mode t) #+END_SRC Style the tool bar. #+NAME: org_gcr_2017-07-13_mara_A03A79D4-52D0-40CC-8149-5E200FAF82FD #+BEGIN_SRC emacs-lisp (setq tool-bar-style 'both) #+END_SRC ibuffer. #+NAME: org_gcr_2017-07-11_mara_F035C9D9-EAE9-48CF-BE67-5BFF1F0A23FD #+BEGIN_SRC emacs-lisp (tool-bar-add-item "list-alt" 'ibuffer 'Buffers :help "List buffers") #+END_SRC swap. #+NAME: org_gcr_2017-07-11_mara_9D659239-693A-430C-A4CE-6003BD650A60 #+BEGIN_SRC emacs-lisp (tool-bar-add-item "exchange" 'help/safb-switch-to-previous-buffer 'Swap :help "Swap buffers") #+END_SRC Page up and down. #+name: org_gcr_2018-06-04T06-09-31-05-00_mara_6DA26126-B1ED-467A-B4FD-DB729AE2B04C #+begin_src emacs-lisp (tool-bar-add-item "arrow-up" 'scroll-down-command 'ScrollUp :help "Scroll Down") (tool-bar-add-item "arrow-down" 'scroll-up-command 'ScrollDown :help "Scroll Up") #+end_src OS Banner. #+NAME: org_gcr_2017-07-23_mara_949332F2-28B2-4BC3-B1E7-C7A24DF56269 #+BEGIN_SRC emacs-lisp (help/on-mac-os (tool-bar-add-item "apple" 'do-nothing 'Powered-by-macOS :help "Powered by macOS" :enable nil)) (help/on-gnu/linux (tool-bar-add-item "linux" 'do-nothing 'Powered-by-GNU-Linux :help "Powered by GNU/Linux" :enable nil)) (help/on-windows (tool-bar-add-item "windows" 'do-nothing 'Powered-by-Microsoft-Windows :help "Powered by Microsoft Windows" :enable nil)) #+END_SRC **** Scroll bar :PROPERTIES: :ID: org_gcr_2017-06-23_mara:590AD87D-0567-454F-98AE-3AE64A171012 :END: Enable both the vertical and horizontal scroll bar. #+NAME: org_gcr_2017-05-12_mara_D967070F-06B7-4433-94A8-36E360600C9E #+BEGIN_SRC emacs-lisp (scroll-bar-mode nil) (help/on-gnu/linux (horizontal-scroll-bar-mode nil)) #+END_SRC ** Pointer :PROPERTIES: :ID: org_gcr_2017-05-12_mara:17DB4E08-F6C4-44AF-935B-27E8984F13DB :END: Hide the pointer when typing. #+NAME: org_gcr_2017-05-12_mara_DD263B9E-EFF2-49BF-B367-4F4505F8E618 #+BEGIN_SRC emacs-lisp (setq make-pointer-invisible t) #+END_SRC ** Version Control :PROPERTIES: :ID: org_gcr_2017-05-12_mara:09918DB9-3AE3-44DF-9E1F-A4A3918F3315 :END: Ediff split frame horizontally. #+NAME: org_gcr_2017-05-12_mara_2E9A617A-5D88-4E71-88EB-595AA1F16EC2 #+BEGIN_SRC emacs-lisp (setq ediff-split-window-function 'split-window-horizontally) #+END_SRC Smerge. #+name: org_gcr_2018-11-17T16-38-07-06-00_cosmicality_27D8595B-4D4F-48BD-A0C4-D3AB70270721 #+begin_src emacs-lisp (diminish 'smerge-mode) #+end_src ** Window :PROPERTIES: :ID: org_gcr_2017-05-12_mara:FBD41A4B-9764-49CB-8439-74581B2211A0 :END: #+name: org_gcr_2018-11-21T18-07-10-06-00_cosmicality_CBE7DBFB-4758-4A24-862C-D0C95847844C #+begin_src emacs-lisp (use-package eyebrowse :ensure t :config (setq eyebrowse-wrap-around t) (eyebrowse-mode t)) (use-package windmove :config (setq windmove-wrap-around t)) (use-package ace-window :ensure t :config (setq aw-keys '(?j ?k ?l ?i ?o ?p)) (setq aw-scope 'frame) (setq aw-background nil))(require 'windmove) (use-package resize-window :ensure t) (use-package golden-ratio :ensure t :config (setq golden-ratio-auto-scale t)) (defhydra help/hydra/megawin (:color blue :hint nil :timeout 10) " 👀: %(let* ((window-configs (eyebrowse--get 'window-configs))(match (assq (eyebrowse--get 'current-slot) window-configs))(desc (eyebrowse-format-slot match))) desc) _1_ _2_ _3_ _4_ _5_ _6_ _7_ _8_ _9_ _0_ _-_ _C_reate _R_ename _T_o Prev_I_ous _O_ther _P_op ↑←↓→ 🏃 🡄🡆 ⊕⊕⊕⊕ ─│┼ φ ☠☣ ⟲⟳ ⚖ 🚪 _e__s__d__f_ _a_ _c__n_ _i__j__k__l_ _v__b__g_ _x_ _z__/_ _w__r_ _B_ _q_ " ("1" #'eyebrowse-switch-to-window-config-1 :exit nil) ("2" #'eyebrowse-switch-to-window-config-2 :exit nil) ("3" #'eyebrowse-switch-to-window-config-3 :exit nil) ("4" #'eyebrowse-switch-to-window-config-4 :exit nil) ("5" #'eyebrowse-switch-to-window-config-5 :exit nil) ("6" #'eyebrowse-switch-to-window-config-6 :exit nil) ("7" #'eyebrowse-switch-to-window-config-7 :exit nil) ("8" #'eyebrowse-switch-to-window-config-8 :exit nil) ("9" #'eyebrowse-switch-to-window-config-9 :exit nil) ("0" #'eyebrowse-switch-to-window-config-0 :exit nil) ("-" #'eyebrowse-close-window-config :exit nil) ;; ("C" #'eyebrowse-create-window-config :exit nil) ("R" #'eyebrowse-rename-window-config :exit nil) ("T" #'eyebrowse-switch-to-window-config :exit nil) ("I" #'eyebrowse-prev-window-config :exit nil) ("O" #'eyebrowse-next-window-config :exit nil) ("P" #'eyebrowse-last-window-config :exit nil) ;;;; ("e" windmove-up :exit nil) ("s" windmove-left :exit nil) ("d" windmove-down :exit nil) ("f" windmove-right :exit nil) ;; ("a" ace-window :exit nil) ;; ("c" (lambda () (interactive) (resize-window--cycle-window-negative)) :exit nil) ("n" (lambda () (interactive) (resize-window--cycle-window-positive)) :exit nil) ;; ("i" (lambda () (interactive) (resize-window--enlarge-down)) :exit nil) ("j" (lambda () (interactive) (resize-window--shrink-horizontally)) :exit nil) ("k" (lambda () (interactive) (resize-window--enlarge-up)) :exit nil) ("l" (lambda () (interactive) (resize-window--enlarge-horizontally)) :exit nil) ;; ("v" split-window-vertically :exit nil) ("b" split-window-horizontally :exit nil) ("g" (lambda () (interactive) (resize-window--reset-windows)) :exit nil) ;; ("x" golden-ratio :exit nil) ("X" golden-ratio-toggle-widescreen :exit nil) ;; ("z" kill-this-buffer) ("/" delete-other-windows :exit nil) ;; ("w" winner-undo :exit nil) ("r" winner-redo :exit nil) ;; ("B" balance-windows) ;; ("q" nil)) #+end_src Cycle forward and backward in window flow. #+NAME: org_gcr_2017-05-12_mara_8E367FFF-FCF3-4AC8-9542-A20CE62081C4 #+BEGIN_SRC emacs-lisp (setq winner-dont-bind-my-keys t) (winner-mode t) (defhydra help/hydra/winner-mode (:color blue :hint nil) " winner-mode: 🚪_q_uit ⟲_p_revious ⟳_n_ext " ("p" winner-undo :exit nil) ("n" winner-redo :exit nil) ("q" nil)) #+END_SRC Frequently use between 1 and 4 windows. #+NAME: org_gcr_2017-05-12_mara_94DA6C06-BCBB-4231-B0C7-EFD4B1310530 #+BEGIN_SRC emacs-lisp (defun help/1-window () "Work with this buffer in 1 window." (interactive) (delete-other-windows)) (defun help/2-window () "Work with this buffer in 2 windows." (interactive) (delete-other-windows) (split-window-right) (balance-windows)) (defun help/3-window () "Work with this buffer in 3 windows." (interactive) (delete-other-windows) (split-window-below) (split-window-below) (balance-windows)) (defun help/4-window () "Work with this buffer in 4 windows." (interactive) (delete-other-windows) (split-window-right) (split-window-below) (call-interactively #'other-window) (call-interactively #'other-window) (split-window-below) (call-interactively #'other-window) (call-interactively #'other-window) (balance-windows)) #+END_SRC Most of the time when opening other buffers, go to them. This configuration appears for different modes in this system. Modes distributed with Emacs are configured here. #+NAME: org_gcr_2017-05-12_mara_B5190A4E-4174-471F-9C82-C454D269B867 #+BEGIN_SRC emacs-lisp (setq help-window-select t) #+END_SRC Fling buffers left and right. #+NAME: org_gcr_2017-06-20_mara_6C4B1CDD-CF71-4A5F-B900-6D3CC06D4028 #+BEGIN_SRC emacs-lisp (use-package buffer-move :ensure t :config (defhydra help/hydra/buf-move (:color blue :hint nil) " Buf-Move: (q to quit) ↑ _e__i_ ← _s__j_ _f__l_ → _d__k_ ↓ " ("e" buf-move-up :exit nil) ("d" buf-move-down :exit nil) ("s" buf-move-left :exit nil) ("f" buf-move-right :exit nil) ("i" buf-move-up :exit nil) ("k" buf-move-down :exit nil) ("j" buf-move-left :exit nil) ("l" buf-move-right :exit nil) ("q" nil))) #+END_SRC Resize window. #+NAME: org_gcr_2017-12-27_mara_AA4152A3-5D5C-4D41-AF55-4828F8BDEF7D #+BEGIN_SRC emacs-lisp (use-package resize-window :ensure t :config (global-set-key (kbd "C-c W") #'resize-window)) #+END_SRC Line numbers. #+name: org_gcr_2019-04-07T11-02-10-05-00_cosmicality_6C49F34A-16C8-428E-BB1B-86DEB2AB8D1B #+begin_src emacs-lisp (use-package nlinum :ensure t) #+end_src * Piano Lessons :PROPERTIES: :ID: org_gcr_2017-05-12_mara:B9C71531-F4DD-4180-950D-AD3494C5D566 :END: ** A Fine Cup of EMACS :PROPERTIES: :ID: org_gcr_2017-05-12_mara:80EEF715-CC24-4B14-A12B-1CD4F16D13A9 :END: Every EMACS user ought to have a [[http://shop.fsf.org/product/gnu-emacs-reference-mugs/][Emacs Reference Mug]] at their desk. The mug invites other users to ask questions. Give the mug as a gift to every user you know who would benefit from learning EMACS. The mug reminds us all that EMACS is the perfect configuration of EMACS. It is available on every machine. When you break your system, you can always fall back to the good and reliable default EMACS configuration to get your system up and running again. The OOTB configuration of EMACS is one of the most important system configurations that you will every find. That is why it is important never to ruin it. This system wants to maximize accessibility for new users. It wants anyone to be able to download and use it without surprises. It wants the mug to serve as a fine reference for anyone to use. It wants to keep things simple and familiar so that anyone who has learned EMACS OOTB can use it pleasantly and productively. These goals are essential to configuring the keyboard for this system. This system will always respect the POLA. ** A Keyboard on Every Desk :PROPERTIES: :ID: org_gcr_2017-05-12_mara:7A27D97D-9D7D-43DC-B961-A4AFC9032609 :END: The configuration of the keyboard on an EMACS system can completely change the experience. No keyboard makes it impossible. A Kinesis Ergo makes it feel really good. Soft keys make it feel soft; hard keys make it feel faster. The [[http://xahlee.info/kbd/dvorak_and_all_keyboard_layouts.html][layout of letters]] is claimed to make you "more productive" using statistics. You may even study the statistics of your own writing and choose a layout optimized for you. The ways to configure your keyboard are limitless because everyone is unique. How to get the best configuration tips for your system? Do what works for everyone. Choose a keyboard that will satisfy 80% of EMACS users using 80% of the keyboards out there. Make this system easy to use on any one of those keyboards. Make this system easy to use in English. Make this system easy to use with average hand strength using two hands. These goals are essential to configuring the keyboard for this system. ** A Display with Every Keyboard :PROPERTIES: :ID: org_gcr_2017-05-12_mara:ED485AD6-A185-465C-9B8A-2E9E848E02DA :END: Every system requires an output. You have two options. The first is a terminal that only displays characters. The second is a display that provides detailed graphics. "Display" is the EMACS term for a GUI. Some users prefer the former. Some users prefer the latter. Some users prefer to use a $4000USD machine to emulate the latter. Both are good options. This system is configured to work pleasantly for either type of output. ** A Full Pot of EMACS on Every Desk :PROPERTIES: :ID: org_gcr_2017-05-12_mara:3165655B-5F9B-4712-896B-32EE9EEEF946 :END: *** Keyboard Layout & Operation :PROPERTIES: :ID: org_gcr_2017-05-12_mara:10CA1648-3A69-47DA-B20C-495E24D7E54A :END: - Use QWERTY layout. - Everyone knows it. - Easy to learn. - Available on every keyboard. - Inexpensive. - When graduation time comes, plenty of great alternatives available like DVORAK and Colemak. - Keep hands in home position as much as possible. - Every finger is strong in the home position so RSI reduced. - Single key presses are easy there. - Table-bang the shift, caps-lock and enter keys. - Table-bang is a position of your hand. Make it by: - Starting with your hands in the home position. - Make a "high-five" with both of them parallel to the keyboard. - Turn your left hand counter-clockwise and right hand clockwise to make them perpendicular to the keyboard. - Squeeze all of your fingers together. - Push the keys using the side of your Pinky. - In this position you are using the strength of all of your fingers. - Never use those key using your Pinky alone. - Practice depends 100% on user-discipline. - Try to achieve balance with meta keys. - Provide same key of each side of the keyboard. - Be conscious of key operations [[http://ergoemacs.org/emacs/emacs_key_notation_return_vs_RET.html][on different outputs]]. - Always provide both. - Note what is getting stomped on. - For return bind to: - =RET= in the terminal. - == in the GUI. - Also for tab =TAB= vs =C-i=. - Also for escape =ESC= vs =C-[= *** Understanding Your Cognitive Landscape. :PROPERTIES: :ID: org_gcr_2017-05-12_mara:7CAD36B9-85CC-4417-B1BF-34BF0E1FD704 :END: You operate within a cognitive landscape. Every moment you are in a single =place=. While residing in each =place= you perform logically related =activities=. Activities facilitate logical actions like modification within that =place=. Modifications are performed objects. Objects include things like the contents of a buffer, contents of memory, or the file that backs a buffer. While performing those =activities= there is a logical sense of "flow". That should never be interrupted. Usually an interruption occurs when you are going to go to a new =place=. The =distance= between =places= is measured in the similarity between the =actions= that you find there. As you develop these ides it will be obvious where key-bindings should go *** Key-Bindings Take You to Places to Perform Activities :PROPERTIES: :ID: org_gcr_2017-05-12_mara:B2C6C0E2-03F4-4C9E-828D-E972EF84F7AB :END: OOTB you wil be visiting many =places= and performing many =activities=. EMACS comes with a good configuration that minimizes =distance=. This isn't worth changing. You can use EMACS for a lifetime without ever having to customize any of the key-bindings. This is what lets anyone use your system. This is what lets you use the system with =-Q= when you break it. You need to decide if you every want to alter the default configuration. This system does not want to. It wants to keep EMACS true to EMACS and your hands happy. To satisfy those goals the following practices were defined. - 99.999% of the time never bind to the =C= or =M= or ~C-M-s~ name-space. - They are for system key-bindings. You can break them. Don't. - In theory =C-c= is the "user name-space" but packages stomp on this all of the time anyway so don't use it. - Some bindings are just too valuable to pass up: - =C-;= - Your hands are in the home position already. - Every modifier key with return. - ~C-M-s~ is for the operating system - Discovered this in macOS - Never bind to =F= keys. - They are a painful stretch on most keyboards. - Some require a lone Pinky with is worse. - Most operating systems bind actions to them OOTB anyway. - EMACS comes with key-bindings OOTB. - Don't try to set up a Hyper-key. - I tried it. It is great to open another namespace. But it ruins cross-platform portability. - However I'm leaving it available for anything possible. - Use shift as a name-space expansion vehicle. - Shift doubles every name-space in which you use it. - Use cautiously, not every name-space vehicle supports it. - About the =s= (super) name-space. - In theory it is the best place for user-defined key-bindings because EMACS OOTB uses =C= and =M= completely leaving =s= mostly open. - In practice =C= and =M= are running out of space because there are a lot of new packages being added to EMACS. Most new packages are binding key in the =s= name-space. - This system reserves =s= completely for Sysop. These practices say nothing about the =places= or =activities= that you choose to peform. The practices only look at the key-binding configuration. There are a limited number of keys on a keyboard and there are physical limitations on your hands. Along with the previous assuptions it may look like there are less. Fortunately it just looks that way and it isn't true. There are a lot of powerful ways to "go places" with EMACS. The next heading contains my attempt. *** How to Get There Pleasantly and Quickly :PROPERTIES: :ID: org_gcr_2017-05-12_mara:28C3C38D-A81D-4E09-8AEA-38C8E7F05CC4 :END: You need to learn how to use EMACS. You need to develop a personal preference. You need to develop an idea of =places= and =activities= and =distance=. The following headings are delineated by breaks in flow. The examples try to talk about doing those things and do it by exploring: - "going places to do things". - "how quickly I will get there and how long I will be there" - "how quickly I want to go somewhere else". They were initially described by the properties: - Actions :: The number of related actions in that place. - Expertise :: The level of skill and speed with which you are performing the activity. - Relationship :: How closely those activities are related in the current place. - Frequency :: How many times you perform these actions when you here. The relationship between "doing those things" and those 4 properties is still unclear and being explored. **** =s= :PROPERTIES: :Actions: High :Expertise: High :Relationship: High :Frequency: High :ID: org_gcr_2017-05-12_mara:6477D74C-FC51-4722-A665-B26F33541078 :END: - =Actions= here are for the =place= inside of the buffer itself. They are for immediate acting upon the contents of the buffer. They are logically related, used frequently, and likely to be memorized. - When you come here, you are likely to stay for some time before getting out. - Only use single key bindings; anything more may be a new logical name-space and may use a Hydra. - Split the home sides of the keyboard in half. - The left side of the keyboard should be use for operations common to every mode. - For example ~goto-line~ and ~ispell~. - It has 15 bindings available; 20 if you use 1-5. 40 if you shift them. - The right side of the keyboard should be used operations specific to the current major mode. - For example in Org-Mode navigating between source-blocks and evaluating them. - It has 19 bindings available; 26 if you use 6-=. 52 if you shift them. - 2017-07-24 - This worked out well and close to expected. The ~s(uper)~ name-space is mostly free. Any package using it well I stomped on its bindings without even looking at them. They are supposed to be free but the ~C-c~ and ~C-x~ name-space is running out and people get mad about it (I did, and my solution is below). Despite my approach I still ran out of namesake for my super bindings. That surprised me. So I tried using ~H(yper)~ but isn't easily on every keyboard so I converted all of those bindings to ~C-M-~ and that worked out great but now I can't use that for more specific bindings. The whole =left= and =right= zones of the keyboard has worked out well when I remember and it is pretty easy to remember. The only problem with this approach is that I still ran out of name-space despite my approach below. So between key-chords and using the super key and moving a bunch of stuff into Hydras I still ran out of space. That leaves ~C-s~ for more name-space for the left and right side. I'm glad to try this out. For example, in Org-Mode: - I traverse the entire document very quickly with ~org-babel-previous-src-block~ and and ~org-babel-next-src-block.~ - I execute source-blocks. - I edit source-blocks. Every activity is related to reading, modifying, executing, and tangling code. **** =Key-Chord= :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D7EDA057-1289-4EB9-8A72-3B00DC3C87BA :END: Key-Chord is intriguing because it works on every keyboard. It is powerful because it can you bring you to any =place= easily. It is good for taking you places in two differnt kinds of scenarios. One example is grammar-checking. There are a few ways to do that. I don't remember them all. In a given mode I want to see a list of all the ways. I really just want to see all of the stuff that I value for a given mode and don't use frequently. Another example are things that I value for a mode and use a lot but are not logically related to other activities in that place. For example moving the mark around and going to lines are performed a lot so they need to be done quickly and left. This is a place where key-chords and the shift modifier are a fast and intuitive way to go places. ***** Single-Key Key-Chord Name-Space. :PROPERTIES: :ID: org_gcr_2017-05-12_mara:13704474-DDBB-4D3E-995B-51B7860535DD :END: :Actions: High :Expertise: Low :Frequency: High :Relationship: Low - Nice if you don't mind hitting the same key twice. - You will use come here often, perform your single =action=, and be done and leave very frequently and quickly. - Using alphabetical characters always results in unpleasant surprises. - Harder for breakage but it still occurs. - =#FF= color code. - =cc= carbon copy. - =JJ= nick-name. - Rare! Using. - =dd= add - Symbols are more likely to be safer bets. - Only use the symbols. - 8 if you use rows 3-4; 16 if you shift. - Fifth row has 13; 26 with shift. - Good vehicle to reach a Hydra. ***** Two-Key Key-Chord Name-Space. :PROPERTIES: :ID: org_gcr_2017-05-12_mara:033FD965-8C1D-46E4-87FC-4A1E50C746A9 :END: :Actions: Low :Expertise: High :Frequency: High :Relationship: Low - Very attractive. - Nice if you don't like hitting the same key twice. - Easy to use all fingers. - Finger strength is not an issue here; use any of them. - Unexpected breakage very easy. - =cd= in ~=eshell=~. - Use sparingly. - Not worth analyzing ideal combinations; just use it and see if it doesn't break. - Bringing over existing bindings. They are all for every mode so I will keep it that way. **** =Hydra= :PROPERTIES: :Actions: High :Expertise: Low :Frequency: Low :Relationship: High :ID: org_gcr_2017-05-12_mara:631201BF-3F66-4C64-A7DC-00B46A3B39ED :END: - Sometimes you want to do something in a =place= but you aren't sure what and you aren't sure where you will go next from there. For example you might want to perform an Org-Mode =action= that is important but you don't really use much. For example exporting to HTML might not be common for you but you value. - =Hydras= can be used for very related actions too. The difference between the =s= name-space is the distance between them and where you are now. In the =s= namespace you go there very quickly. For =Hydras= sometimes you can get the fast and sometimes more slowly. They are complementary to every name-space. - =SHIFT= doubles your key-space. - Use =C-g= to exit the Hydra. For example, in Org-Mode I am still learning about functions and haven't used them much and forget their names. It is faster to put them in a Hydra. If they get used a lot, I will add them to =s=. *** Building Your Own Keyboard :PROPERTIES: :ID: org_gcr_2017-05-12_mara:BED4C08B-260A-4FC5-B5FF-AFEC420E9C66 :END: As your mastery of EMACS grows so too will your desire to build your own keyboard. It is natural. As you explore various dimensions of expression you will have a lot of fun. You will act more quickly and skillfully. Even with the goals of this system in place the desire grows. 3D printing is one area worth exploring. A lot of EMACS users design and print their own custom keyboards. That looks very fun. [[http://scripts.sil.org/cms/scripts/page.php?site_id%3Dnrsi&id%3Dukelele][Ukulele]] is softer way to explore your keyboard. Reading its user manual is important. It contains ideas about stack-able-environments for bindings. You may use Ukulele or Hydras to do the same thing. [[https://pqrs.org/osx/karabiner/][Karabiner]] is a nice way to re-map your keys. It's easiest adjustment is to make return act as return when pressed alone and as control when pressed with another key. That introduces a symmetry to your keyboard which can be helpful. All of those dimensions are worth exploring. When I explored them I felt that they led me further away from the majority of users. Every time explored a different key-mapping (not key-binding) it reduced accessibility for new users. Each time I tried to work around that hiccup. The last pursuit was =;= and space. It would be great to set up your keyboard with the meta keys on the bottom like this: #+BEGIN_EXAMPLE +---------------------------------------+ | +-----+ +-----+ | | |RET | | RET| | | +-----+ +-----+ | | +------+ +------+ | | |SHIFT | | SHIFT| | | +------+ +------+ | | +-+ +-+ +-----+ +-+ +-+ | | |s| |M| |C/spc| |M| |s| | | +-+ +-+ +-----+ +-+ +-+ | | | +---------------------------------------+ #+END_EXAMPLE Karabiner was too slow for my typing speed though. It [[https://www.reddit.com/r/emacs/comments/38qllb/karabiner_space_as_control/][happens]]. It seemed like a minimal change to use Ukelele to: - Make space send =C= - Make =;= send space - Make ='= a dead key - In it's dead key state make - =;= \rarr =;= - =:= \rarr =:= - ='= \rarr ='= - ="= \rarr ="= The trouble is that it violates the POLA. Therefore, I left it alone and stuck with a simple "Get C on both sides". That has worked out very well. It is very easy to do on every operating system. It holds true to the values of this system. When you develop an idea of =places= and how often you go there the key-mapping becomes more obvious. Make it easy to get to key-bindings that take you to familiar places. For this system it is the home keys, =s=, and =key-chord=. Make those keys more easily accessible. =C= and =M= often have symmetric-definitions. =s= and =SHIFT= also often have symmetric definitions in this system (mostly through Key-Chords). Therefore those key-mappings are kept close together #+BEGIN_EXAMPLE +---------------------------------------+ | +-----+ +-----+ | | |s | |s/ret| | | +-----+ +-----+ | | +------+ +------+ | | |SHIFT | | SHIFT| | | +------+ +------+ | | +-+ +-+ +-----+ +-+ +-+ | | |M| |C| |spc | |C| |M| | | +-+ +-+ +-----+ +-+ +-+ | | | +---------------------------------------+ #+END_EXAMPLE On macOS Dyalog uses an input source for entering APL symbols. Enable its input source, press option-i, and you get the symbol ⍳ (APL FUNCTIONAL SYMBOL IOTA). It should work in every macOS application. When I tried to use it in Emacs though it didn't work. This configuration swallows the option key and translates it to the Emacs Super key. Any option chords are never sent to macOS. This had worked fine because I'd never used command. Most of the time I want Emacs to work this way, but some of the time I want to pass command through to macOS. How can I do this? When I read the Emacs documentation they explained that you can choose whether or not you want ALT or GUI (option and command on macOS) to be swallowed by Emacs or passed through to the OS. Most of us already have this in our config. How can we switch it back and forth then? Elisp is of course the solution so I wrote some code to toggle this behavior. It didn't work! Didn't look like a bug in my code so I dug a little further into the documentation. Around the same time I was reading the USB HID specification. The spec explains that for every modifier there is both a left and a right code. When I got to the relevant document for Emacs it all started to make sense: the toggling modifier keys in Emacs only works for the right keys! It is exciting to learn that Emacs makes this distinction. What I found next though was that it only works when the OS tells Emacs which modifier it is, but not from Karabiner. It makes sense, Emacs expects to be told at a lower level than Karabiner runs. Long story short I had to change the layout to get the toggling behavior that I wanted. For simplicity I added a Hydra to toggle both the option and the function key between being sent to the OS or swallowed by Emacs. Function started making a place in my config as Hyper after I got tired of searching for combinations of Hydras for common actions. These changes helped guide the custom keyboard design. #+BEGIN_EXAMPLE +---------------------------------------+ | +-----+ +-----+ | | |C | |C/ret| | | +-----+ +-----+ | | +------+ +------+ | | |SHIFT | | SHIFT| | | +------+ +------+ | | +-+ +-+ +-+ +-----+ +-+ +-+ | | |H| |s| |M| |spc | |M| |s| | | +-+ +-+ +-+ +-----+ +-+ +-+ | | | +---------------------------------------+ #+END_EXAMPLE - Cheat-Sheet - C, M, C-M, C-M, C-S, C-s are for Emacs - C-M-s are for the operating system ** Take a Sip :PROPERTIES: :ID: org_gcr_2017-05-12_mara:D33533BC-3E1F-4E7E-B9B3-2C0D0518400E :END: *** Left Side :PROPERTIES: :ID: org_gcr_2017-05-12_mara:6F293EA2-D2D4-42F7-8684-D5B53CB849DA :END: Keybindings for every mode. Starts and stop: - 1-5 - Q-T - A-G - Z-B **** Row 5 :PROPERTIES: :ID: org_gcr_2018-04-04T19-35-03-05-00_mara:5674E80B-C4B1-4AFA-A93D-E466FA7C37EB :END: Try to reserve this for the OS. :PROPERTIES: :ID: org_gcr_2018-01-08_mara:D12EA6D3-9746-4AA3-A622-71314840A6FA :END: #+NAME: org_gcr_2018-01-08_mara_82A71AA0-C415-49B1-8554-334215625E4F #+BEGIN_SRC emacs-lisp (global-set-key (kbd "M-H-1") #'help) (global-set-key (kbd "M-H-3") #'kmacro-start-macro-or-insert-counter) (global-set-key (kbd "M-H-4") #'kmacro-end-or-call-macro) (global-set-key [kbd "M-H-5"] #'kmacro-name-last-macro) (global-set-key [kbd "M-H-6"] #'insert-kbd-macro) (global-set-key (kbd "M-H-7") #'elmacro-show-last-macro) #+END_SRC **** Row 4 :PROPERTIES: :ID: org_gcr_2018-04-03T15-26-04-05-00_mara:8EE3BC1F-945D-422C-847F-4EFD8D02A8C6 :END: #+NAME: org_gcr_2017-05-12_mara_8125C96A-8971-45FC-A8D2-30FDC438B71C #+BEGIN_SRC emacs-lisp (global-set-key (kbd "C-4") #'hs-toggle-hiding) (global-set-key (kbd "C-3") #'help/my-toggle-hideshow-all) (defun help/kill-buffer () (interactive) (kill-buffer (current-buffer))) (global-set-key (kbd "C-5") #'help/kill-buffer) (global-set-key (kbd "C-M-=") #'edit-indirect-region) (global-set-key (kbd "C-M-4") #'help/1-window) ;; Leave C-8, C-9, and C-0 free for the OS (defun help/insert-em-dash () "Insert a EM-DASH. - \"best limited to two appearances per sentence\" - \"can be used in place of commas to enhance readability. Note, however, that dashes are always more emphatic than commas\" - \"can replace a pair of parentheses. Dashes are considered less formal than parentheses; they are also more intrusive. If you want to draw attention to the parenthetical content, use dashes. If you want to include the parenthetical content more subtly, use parentheses.\" - \"Note that when dashes are used in place of parentheses, surrounding punctuation should be omitted.\" - \"can be used in place of a colon when you want to emphasize the conclusion of your sentence. The dash is less formal than the colon.\" - \"Two em dashes can be used to indicate missing portions of a word, whether unknown or intentionally omitted.\" - \"When an entire word is missing, either two or three em dashes can be used. Whichever length you choose, use it consistently throughout your document. Surrounding punctuation should be placed as usual.\" - \"The em dash is typically used without spaces on either side, and that is the style used in this guide. Most newspapers, however, set the em dash off with a single space on each side.\" Source: URL `https://www.thepunctuationguide.com/em-dash.html'" (interactive) (help/real-insert ?—)) (defun help/insert-en-dash () "Insert a EN-DASH. - \"is used to represent a span or range of numbers, dates, or time. There should be no space between the en dash and the adjacent material. Depending on the context, the en dash is read as “to” or “through.”\" - \"If you introduce a span or range with words such as 'from' or 'between', do not use the en dash.\" - \"is used to report scores or results of contests.\" - \"an also be used between words to represent conflict, connection, or direction.\" - \"When a compound adjective is formed with an element that is itself an open compound or hyphenated compound, some writers replace the customary hyphen with an en dash. This is an aesthetic choice more than anything. Source: URL `https://www.thepunctuationguide.com/en-dash.html'" (interactive) (help/real-insert ?–)) (defun help/insert-hyphen () "Insert a HYPHEN - \"For most writers, the hyphen’s primary function is the formation of certain compound terms. The hyphen is also used for word division [in typesetting]. - \"Compound terms are those that consist of more than one word but represent a single item or idea.\" Source: URL `https://www.thepunctuationguide.com/hyphen.html'" (interactive) (help/real-insert ?-)) (global-set-key (kbd "-") #'help/insert-hyphen) (global-set-key (kbd "H-_") #'help/insert-em-dash) (global-set-key (kbd "H--") #'help/insert-en-dash) (global-set-key (kbd "H-1") #'mc/edit-lines) (global-set-key (kbd "H-2") #'mc/mark-all-like-this) (global-set-key (kbd "H-3") #'mc/mark-previouH-like-this) (global-set-key (kbd "H-4") #'mc/mark-next-like-this) (global-set-key (kbd "H-$") #'mc-hide-unmatched-lineH-mode) (global-set-key (kbd "H-5") #'mc/skip-to-previouH-like-this) (global-set-key (kbd "H-6") #'mc/skip-to-next-like-this) (global-set-key (kbd "H-9") #'owp-user-interface) #+END_SRC Checking things. #+NAME: org_gcr_2017-06-13_mara_2DFDC64B-DBF2-473E-979F-D7D8D0DD2206 #+BEGIN_SRC emacs-lisp (defhydra help/hydra-checking (:color blue :hint nil) " Flycheck: ⏼%(bound-and-true-p flycheck-mode) Controls: _u_: checker/toggle _i_ checker/list Navigate: _j_ next _k_ previous _f_irst _l_ast Error: _d_escribe _e_xplain _q_ quit " ("u" flycheck-mode :exit nil) ("i" help/safb-flycheck-list-errors) ("j" flycheck-next-error :exit nil) ("k" flycheck-previous-error :exit nil) ("f" flycheck-first-error) ("l" flycheck-last-error) ("d" flycheck-display-error-at-point) ("e" flycheck-explain-error-at-point) ("q" nil)) (global-set-key (kbd "C-M-9") #'help/hydra-checking/body) #+END_SRC **** Row 3 :PROPERTIES: :ID: org_gcr_2018-06-06T22-01-54-05-00_mara:D34D40ED-F8E3-405D-88AA-AB8C52533706 :END: :PROPERTIES: :ID: org_gcr_2017-12-07_mara:752198AC-06ED-436E-B526-5A3C8ED32375 :END: #+name: org_gcr_2018-11-22T00-38-52-06-00_cosmicality_B388F591-C237-4181-A4A3-8C971EFDB516 #+begin_src emacs-lisp (global-set-key (kbd "H-w") #'help/hydra/megawin/body) #+end_src Date related things. #+NAME: org_gcr_2019-02-22T23-11-36-06-00_cosmicality_422125E1-AB16-4F3A-9C82-17DC7713E487 #+BEGIN_SRC emacs-lisp (defhydra help/hydra/timestamp (:color blue :hint nil) " Timestamps: (_q_uit) Date: _I_SO, _U_S, US With _Y_ear and _D_ashes, US In _W_ords, _J_ekyll Date/Time: _N_o Colons or _w_ith, _L_og Entry (compact with note) Time: _H_our:Seconds Org-Mode: _T_oday, _R_ight Now, or _c_hoose " ("q" nil) ("I" help/insert-datestamp) ("U" help/insert-datestamp-us) ("Y" help/insert-datestamp-us-full-year) ("D" help/insert-datestamp-us-full-year-and-dashes) ("W" help/insert-datestamp-us-words) ("J" help/insert-jekyll-timestamp) ("N" help/insert-timestamp-no-colons) ("w" help/insert-timestamp) ("H" help/insert-hour-seconds) ("L" help/insert-log-entry) ("T" help/insert-org-datestamp) ("R" help/org-time-stamp-with-seconds-now) ("c" org-time-stamp)) (global-set-key (kbd "C-t") #'help/hydra/timestamp/body) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_1251CF6D-E4D3-45D9-A3DB-FF68D814E389 #+BEGIN_SRC emacs-lisp (global-set-key (kbd "H-t") #'help/hydra/left/todo/body) (global-set-key (kbd "C-M-") #'help/untabify-buffer-or-region-if-not-indent-tabs-mode) (global-set-key (kbd "C-M-\\") #'help/indent-region-or-buffer) (defun help/copy-entire-buffer () (interactive) (save-excursion (call-interactively 'mark-whole-buffer) (call-interactively 'kill-ring-save) (message "Buffer contents copied"))) (global-set-key (kbd "C-c C-r") 'ivy-resume) (global-set-key (kbd "C-M-y") #'insert-char) (define-key org-mode-map (kbd "C-o") nil) (global-set-key (kbd "C-o") nil) (global-set-key (kbd "C-o") #'counsel-find-file) (global-set-key (kbd "C-M-o") #'help/occur-dwim) (global-set-key (kbd "M-i") nil) (global-set-key (kbd "M-i") #'help/hydra/left/describe/body) (use-package helpful :ensure t :config (global-set-key (kbd "H-a") #'helpful-at-point)) (defhydra help/hydra/left/describe (:color blue :hint nil) " Describe Something: (q to quit) _a_ all help for everything screen _A_ macro _b_ bindings _B_ personal bindings _r_ character char name only _c_ character briefly _C_ character full _e_ interactive function _E_ function, macro or special form _T_ character set _1_ list characters in oneset _2_ list all set2 _S_ coding system _f_ function _F_ flycheck checker _g_ categories _i_ input method _I_ info buffer _k_ key briefly _K_ key _l_ language environment _L_ mode lineage _m_ major mode _M_ minor mode _n_ current coding system briefly _N_ current coding system full _o_ lighter indicator _O_ lighter symbol _p_ package _P_ text properties _s_ symbol _t_ theme _v_ variable _w_ where is something defined " ("e" helpful-command) ("E" helpful-callable) ("1" list-charset-chars) ("2" list-character-sets) ("b" describe-bindings) ("B" describe-personal-keybindings) ("r" ucs-eval) ("c" (lambda () (interactive) (unicode-fonts-debug-info-at-point))) ("C" describe-char) ("f" helpful-function) ("F" flycheck-describe-checker) ("g" describe-categories) ("i" describe-input-method) ("I" info-buffer) ("K" helpful-key) ("k" describe-key-briefly) ("l" describe-language-environment) ("L" help/parent-mode-display) ("M" describe-minor-mode) ("m" describe-mode) ("N" describe-current-coding-system) ("n" describe-current-coding-system-briefly) ("o" describe-minor-mode-from-indicator) ("O" describe-minor-mode-from-symbol) ("p" describe-package) ("P" describe-text-properties) ("q" nil) ("a" help) ("A" helpful-macro) ("s" describe-symbol) ("S" describe-coding-system) ("t" describe-theme) ("T" describe-character-set) ("v" helpful-variable) ("w" where-is)) #+END_SRC :PROPERTIES: :ID: org_gcr_2017-05-12_mara:20E96ACD-1D91-480C-BA3B-D5730EA2173C :END: Org handle ~TAB~ correctly and nothing is bound to it like ~Auto-Complete~ or ~yasnippet~ so this doesn't /need/ to use ~C-i~ freeing it up. Rebinding ~C-g~ seems to make the minibuffer and ~eval-*~ become confused \rarr quit working. **** Row 2 :PROPERTIES: :ID: org_gcr_2017-05-12_mara:C0B604C5-F530-4770-9061-92E8468C8557 :END: CAPS-LOCK is disappeared with my Karabiner-Elements config so duplicate it. #+name: org_gcr_2018-12-08T13-39-29-06-00_cosmicality_24EADA89-3A90-4C39-B04C-C15AE629E401 #+begin_src emacs-lisp (use-package caps-lock :ensure t :config (global-set-key (kbd "C-M-s-c") #'caps-lock-mode)) #+end_src #+name: org_gcr_2018-11-14T01-09-50-06-00_cosmicality_F9D27274-71B1-4AFA-9FEA-610569715A96 #+begin_src emacs-lisp (global-set-key (kbd "C-s") #'swiper) #+end_src Eval expression. #+NAME: org_gcr_2017-06-13_mara_8E6A3551-A1CE-4879-AC6F-EF74EA1D8A7D #+BEGIN_SRC emacs-lisp (global-set-key (kbd "C-M-a") #'help/hydra/apropo/body) (global-set-key (kbd "C-d") #'delete-forward-char) (global-set-key [(control shift ?d)] #'backward-delete-char) (global-set-key (kbd "C-M-k") #'my-eval-expression) (global-set-key (kbd "C-c C-k") #'help/delete-this-buffer-and-file) (global-set-key (kbd "C-M-'") #'toggle-quotes) (global-set-key (kbd "M-'") #'yas-insert-snippet) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_E8ABDA7D-AC92-4C24-8287-1505E2377B2C #+BEGIN_SRC emacs-lisp (global-set-key (kbd "C-h") nil) (global-set-key (kbd "C-h") #'help/ace-window) #+END_SRC In Org-Mode I constantly use ~s-h~ for tangling. When I forget that I am /out of/ Org-Mode and I hit ~s-h~ it hides Emacs. Oops! #+NAME: org_gcr_2017-05-12_mara_A26325F2-9D6C-49EE-8CBE-DC552C6F315F #+BEGIN_SRC emacs-lisp (global-set-key (kbd "H-h") nil) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_20330335-75E6-4AB4-A661-D291315FAFD7 #+BEGIN_SRC emacs-lisp (global-set-key (kbd "C-M-j") #'help/safb-switch-to-previous-buffer) (global-set-key (kbd "H-d") #'er/expand-region) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_095E1EC7-12A2-43BB-8ED5-CF2BC6E7D158 #+BEGIN_SRC emacs-lisp (defhydra help/hydra/left-side/global (:color blue :hint nil) " _1_ reset-font _2_ -font _3_ +font _4_ ellipsis _5_ UUID _6_ bfr-cdng-systm _8_ 👍_9_ 👎 _0_ 👏_-_ split-window-vertically _=_ reposition-window _q_uit _Q_ exit-Emacs _w_ widen _W_ git time machine _E_ prettify-symbols-mode _r_ rename this buffer and file _R_ insert the default file header _t_ rectangle-mark _T_ trademarks _y_ yas tables _Y_ transparency _u_ universal-emotions-emoticons _U_ git-grep _o_ dbgOnErr _O_ base64-encode-region _p_ query-replace _P_ base64-decode-region _}_ transliterate _|_ split-window-horizontally _[_ single bracket, white, square, left _]_ single bracket, white, square, right _d_ dired _D_ help/safb-org-babel-detangle _f_ ag _F_ ag* _g_ grep _h_ hidden-mode-line _H_ hack-local-variables (see also normal-mode) _J_ org-babel-tangle-jump-to-org _l_ visual-line-mode _L_ aggressive-indent-mode _K_ nextLogLine _;_ toggle-lax-whitespace _x_ delete-indentation _X_ checkmarks _c_ fill-paragraph _V_ view-only mode _b_ erase-buffer _N_ normal-mode (see also hack-local-variables) _m_ font lock _M_ Marked 2 _<_ double bracket, angle, left _>_ double bracket, angle, right _,_ snip comment start _._ snip comment stop _?_ tons of scissors " ("Q" help/safb-save-buffers-kill-terminal) ("q" nil) ("E" prettify-symbols-mode) ("|" split-window-horizontally) ("-" split-window-vertically) ("1" help/font-size-reset :exit nil) ("2" help/text-scale-decrease :exit nil) ("3" help/text-scale-increase :exit nil) ("4" help/insert-ellipsis) ("5" help/uuid) ("6" set-buffer-file-coding-system) ("8" (lambda () (interactive) (insert "👍"))) ("9" (lambda () (interactive) (insert "👎"))) ("0" (lambda () (interactive) (insert "👏")) :exit nil) ("[" (lambda () (interactive) (insert "⟦"))) ("]" (lambda () (interactive) (insert "⟧"))) ("r" help/rename-current-buffer-file) ("R" auto-insert) ("T" help/trademark/body) ("=" reposition-window) ("g" grep) ("h" hidden-mode-line-mode) ("H" (lambda () (interactive) (hack-local-variables) (message "Local variables hacked"))) ("l" visual-line-mode) ("L" aggressive-indent-mode) ("x" delete-indentation) ("X" help/checks/body) ("f" ag) ("F" help/hydra/ag/body) ("v" help/hydra/vocabulary/body) ("V" view-mode) ("w" widen) ("W" git-timemachine) ("t" rectangle-mark-mode) ("y" yas-describe-tables) ("Y" hydra-transparency/body) ("J" org-babel-tangle-jump-to-org) ("u" universal-emotions-emoticons) ("U" counsel-git-grep) ("d" dired) ("D" help/safb-org-babel-detangle) ("K" next-logical-line :exit nil) ("N" (lambda () (interactive) (help/safb-normal-mode) (message "Entering normal-mode"))) ("m" font-lock-mode) ("M" help/preview-buffer-file-in-marked-2) ("<" (lambda () (interactive) (insert "⟪"))) (">" (lambda () (interactive) (insert "⟫"))) ("," help/chs) ("." help/che) ("?" help/insert-noticeable-snip-comment-line) (";" isearch-toggle-lax-whitespace) ("o" toggle-debug-on-error) ("p" anzu-query-replace) ("O" base64-encode-region) ("P" base64-decode-region) ("}" help/hydra/transliterate/body) ("c" fill-paragraph) ("b" erase-buffer) ("'" help/move-file) ("\"" imenu-list-minor-mode)) #+END_SRC #+NAME: org_gcr_2017-05-12_mara_28B4A661-E888-4EFA-ADE3-4B1C05F6E92B #+BEGIN_SRC emacs-lisp (key-chord-define-global "vv" #'help/hydra/left-side/global/body) #+END_SRC [[https://github.com/abo-abo/hydra/blob/master/hydra-examples.el][Attribution.]] #+NAME: org_gcr_2017-05-12_mara_C93A4DB7-1441-4DBA-B586-76266C5C30DF #+BEGIN_SRC emacs-lisp (defhydra help/hydra/apropo (:color blue :hint nil) " ===============+=================================================== Apropos' (_q_uit) ===============+=================================================== Everything: \"…all meaningful Lisp _s_ymbols…\" Info: \"…all known _I_nfo files…\" ===============+=================================================== Documentation \"…symbols whose _d_ocumentation…\" User Manual: \"…the Emacs _U_ser Manual.\" Lisp Manual: \"…the Emacs _L_isp Reference Manual.\" ===============+=================================================== Commands \"…_c_ommands (interactively callable functions)…\" Variables \"…_v_ariables…\" Printed Value: \"…symbols whose value’s printed _r_epresentation…\" ===============+=================================================== Library: \"…variables and functions defined by _l_ibrary…\" or _F_ind It User Options: \"…user _o_ptions…\" ===============+=================================================== " ("s" apropos) ("I" info-apropos) ("d" apropos-documentation) ("U" emacs-index-search) ("L" elisp-index-search) ("F" counsel-find-library) ("c" apropos-command) ("v" apropos-variable) ("r" apropos-value) ("l" apropos-library) ("o" apropos-user-option) ("q" nil)) #+END_SRC Trademark. #+NAME: org_gcr_2017-05-12_mara_EE5F8793-8604-4041-8D91-DBC419809947 #+BEGIN_SRC emacs-lisp (defhydra help/trademark (:color blue :hint nil) " American _R_egistered Trademark American _U_nregistered Trademark American _S_ervice Mark _J_apanese Industrial Standard _K_orean Standard " ("R" (lambda () (interactive) (insert "®"))) ("U" (lambda () (interactive) (insert "™"))) ("S" (lambda () (interactive) (insert "℠"))) ("J" (lambda () (interactive) (insert "〄"))) ("K" (lambda () (interactive) (insert "㉿")))) #+END_SRC Kinds of checks. #+NAME: org_gcr_2017-05-12_mara_E4413D83-9743-468B-BBAF-3FAF9E31F491 #+BEGIN_SRC emacs-lisp (defhydra help/checks (:color blue :hint nil) " _a_ ✓ _s_ ✗ _d_ ☐ _f_ ☑ _g_ ☒_ " ("a" (lambda () (interactive) (insert "✓")) :exit nil) ("s" (lambda () (interactive) (insert "✗")) :exit nil) ("d" (lambda () (interactive) (insert "☐")) :exit nil) ("f" (lambda () (interactive) (insert "☑")) :exit nil) ("g" (lambda () (interactive) (insert "☒")) :exit nil)) #+END_SRC #+name: org_gcr_2018-05-24T12-09-16-04-00_mara_09A8135C-9B9B-4039-A091-6DB640A7C3EF #+begin_src emacs-lisp (global-set-key (kbd "M-s M-s") #'shell) #+end_src Timestamp. #+name: org_gcr_2018-12-18T22-18-02-06-00_cosmicality_50833A40-39D4-4EDD-9656-418DB31D9AA3 #+begin_src emacs-lisp (global-set-key (kbd "M-4") #'help/insert-timestamp-no-colons) #+end_src **** Row 1 :PROPERTIES: :ID: org_gcr_2017-07-17_mara:B91C9779-B2AD-403B-A11F-5847EF8883C6 :END: Scroll window by line: pretty sure this is somewhere already in here. #+name: org_gcr_2019-01-17T16-40-26-06-00_cosmicality_34B10462-8FD6-4AA3-BA6C-9101C7BFB941 #+begin_src emacs-lisp (global-set-key (kbd "C-s-n") (kbd "C-u 1 C-v")) (global-set-key (kbd "C-s-p") (kbd "C-u 1 M-v")) #+end_src #+NAME: org_gcr_2017-05-12_mara_63E4B554-A5C6-46AB-9A34-E93FAF8B848B #+BEGIN_SRC emacs-lisp ;; Leave C-z free for Tmux (global-set-key (kbd "C-z") nil) (global-set-key (kbd "C-x C-c") #'help/safb-save-buffers-kill-terminal) (define-key org-mode-map (kbd "C-j") nil) (global-set-key (kbd "C-j") nil) (global-set-key (kbd "C-j") #'ivy-switch-buffer) (global-set-key (kbd "M-j") nil) (define-key org-mode-map (kbd "M-j") nil) (global-set-key (kbd "M-j") #'counsel-M-x) (global-set-key (kbd "C-M-,") #'ibuffer) (global-set-key (kbd "C-M-.") nil) (global-set-key (kbd "M-s-m") #'ns-do-hide-emacs) (global-set-key (kbd "C-M-n") #'info-buffer) (global-set-key (kbd "H-s") #'shell) (global-set-key (kbd "H-g") #'help/hydra/dumb-jump/body) (global-set-key (kbd "H-v") #'help/hydra/megawin/body) (global-set-key (kbd "H-c") #'help/hydra/buf-move/body) (global-set-key (kbd "H-x") #'help/hydra/smart-shift/body) #+END_SRC **** Row 0 :PROPERTIES: :ID: org_gcr_2017-05-12_mara:A791BE09-ED4B-46F4-8225-EE73C15C1DD0 :END: Cycle through common options for removing space between characters. Thank you [[http://pragmaticemacs.com/emacs/cycle-spacing/][Pragmatic Emacs]]. #+NAME: org_gcr_2017-05-12_mara_5FAD516B-B4C1-4F47-A6B9-7CA12F9AFF5D #+BEGIN_SRC emacs-lisp (global-set-key (kbd "H-SPC") #'cycle-spacing) #+END_SRC **** Unsorted :PROPERTIES: :ID: org_gcr_2017-05-12_mara:4FEBE5F3-3B9E-438D-9E7F-DA337FB43BB7 :END: Powerful buffer movement. Split between home and lower because - It is important if you have multiple windows - So it is close to home - It interrupts flow naturally - So it isn't on the home row but it is close Can't use ~nv~ because of: - Canvas - Conve* - Envision - Inverse There are a lot. [[http://www.wordfind.com/ends-with/nv/][Ways]] to [[https://www.morewords.com/contains/nv/][find]] [[https://www.morewords.com/pair/nv/][them]] [[http://www.thefreedictionary.com/words-containing-nv][and]] [[http://www.wordhippo.com/what-is/containing/6-letter-words-nv.html][where]] Toggle utility buffers ("logical F" key, so left side; "logical J" key on right). #+NAME: org_gcr_2017-05-12_mara_0CA60630-37AA-4192-91A1-FFC1B16DC3E4 #+BEGIN_SRC emacs-lisp (key-chord-define-global "f9" #'help/util-cycle) #+END_SRC *** Left & Right Side :PROPERTIES: :ID: org_gcr_2017-05-12_mara:AF27A71C-C30D-45C8-B3E7-BB044506B534 :END: Exploratory programming in EMACS. Don't use "qi"; "unique". Make =ispell= accessible. #+NAME: org_gcr_2017-05-12_mara_921A07BB-6FBA-46E3-824D-F9F0B92F48B3 #+BEGIN_SRC emacs-lisp (key-chord-define-global "qp" #'ispell) (key-chord-define-global "qo" #'ispell-word) #+END_SRC Easily kill buffers. Can't use "df" because of "PDF". Can't use "fr" because of "fright" and "France". Can't use "dc" because of =cd (change directory)=. Can't use "gr" brecause of "Grant" and "Great. Go to a word. #+NAME: org_gcr_2017-05-12_mara_2C04C038-F246-4E90-92C6-15ABF018BCD3 #+BEGIN_SRC emacs-lisp (key-chord-define-global "fj" #'avy-goto-char-2) (key-chord-define-global "FJ" #'avy-pop-mark) #+END_SRC Go to a line. #+NAME: org_gcr_2017-05-12_mara_0729FB1D-FE71-417C-A3F7-AC1A92D71FBC #+BEGIN_SRC emacs-lisp (key-chord-define-global "fk" #'help/safb-help/goto-line) #+END_SRC Pop the mark back. #+NAME: org_gcr_2017-05-12_mara_ED3BE98E-B863-447A-AB97-F4E878F2C483 #+BEGIN_SRC emacs-lisp (key-chord-define-global "FK" #'pop-to-mark-command) #+END_SRC *** Right Side :PROPERTIES: :ID: org_gcr_2017-05-12_mara:6F9375AB-C92C-4986-AECE-ABC945375CA2 :END: Reserve the right side for mode-specific activities. It starts with: - 6 - Y - H - N Try to use ~s-i~ for things like ~info-at-point~. *** Exceptions :PROPERTIES: :ID: org_gcr_2017-05-12_mara:187B7649-D799-4E41-9DE7-448BC50E0250 :END: Return. Do smart new line inside, indenting given the mode. #+NAME: org_gcr_2017-05-12_mara_9302B01F-93C0-4D21-8BB6-53ECF1478153 #+BEGIN_SRC emacs-lisp (help/on-gui (global-set-key (kbd "H-") #'help/smart-open-line)) #+END_SRC Ansu. #+NAME: org_gcr_2017-05-12_mara_BF926B57-9097-483F-AB90-E3F55869B0D9 #+BEGIN_SRC emacs-lisp (global-set-key (kbd "M-%") #'anzu-query-replace) (global-set-key (kbd "C-M-%") #'anzu-query-replace-regexp) #+END_SRC