mirror of
https://github.com/foo-dogsquared/wiki.git
synced 2025-01-31 04:58:21 +00:00
25dafd751c
In this case, it's mostly about the additional perspectives on how learning works from the act of managing your information through various note-taking methods. I also restructured the note on org-babel and moved as its own note on the hierarchical notebook. I think summarizing a tool and giving my own comments about it is a nicer way of describing it. Plus, I can freely link between any other types of note so I figured it would be better. That said, I should be picky on how to make org-roam entries. And also org-roam v2 is better, after all. :)
48 lines
2.0 KiB
Org Mode
48 lines
2.0 KiB
Org Mode
:PROPERTIES:
|
|
:ID: 0efb9c51-3a12-4e5a-9e9b-d48cf4bd53ce
|
|
:END:
|
|
#+title: Using the built-in help system of Emacs
|
|
#+date: "2021-04-21 16:26:50 +08:00"
|
|
#+date_modified: "2021-05-04 20:51:21 +08:00"
|
|
#+language: en
|
|
|
|
|
|
[[roam:Emacs][GNU Emacs]], being a flexible program with a supremely overwhelming number of options to choose from (arguably), has a comprehensive help system.
|
|
[fn:: It's a necessity after all by how massive of a software this is.]
|
|
|
|
|
|
|
|
|
|
* General help system
|
|
|
|
- ~help-for-help~ is a function that gives you a metahelp interface to a number of options such as searching through pattern, logging the last keybindings, display the documentation from a keybinding, describe a language environment, and so on.
|
|
Most, if not all, of the options presented can be accessed in another way.
|
|
|
|
- ~apropos~, like its similarly named Unix program, searches through the entire symbol list of Emacs (e.g., variable, function) through a pattern.
|
|
|
|
- The series of functions from ~describe-*~ has multiple options for various specific things.
|
|
Among the list of describe functions, I recommend to start with ~describe-key~, ~describe-function~, ~describe-variable~, ~describe-package~, ~describe-mode~, and ~describe-variable~.
|
|
|
|
- Most of the objects (e.g., functions, variables, hooks) in Emacs also require a docstring so you'll have more relevant information at hand.
|
|
|
|
|
|
|
|
|
|
* evil-mode
|
|
|
|
evil-mode, being inspired from Vim keybindings, adds further into more ways for an instant access to documentation.
|
|
|
|
- ~evil-lookup~, similar to Vim's lookup key (~:help K~), searches through documentation of the language written on.
|
|
|
|
- ~evil-goto-definition~ can sometimes go into the original file where the keyword was defined.
|
|
It is only useful when the keyword is defined in the project or at least located on the project root.
|
|
|
|
|
|
|
|
|
|
* Doom Emacs-specific
|
|
|
|
- ~doom/help~ for Doom-specific documentations.
|
|
- ~doom/help-faq~ jumps ahead into the FAQ file with a convenient interface.
|
|
- ~doom/help-modules~ prompts you to search the documentation for Doom modules.
|