org-el-index

Generate an index of Elisp definitions for org-mode
git clone https://git.jamzattack.xyz/org-el-index
Log | Files | Refs | LICENSE

ModeNameSize
-rw-r--r--.gitignore5L
-rw-r--r--LICENSE674L
-rw-r--r--README.org265L
-rw-r--r--org-el-index.el279L
Org Elisp Index

Org Elisp Index

This library provides a way to generate a full list of definitions from an Elisp file in org-mode.

To generate an index, simply open up your org file, use M-x org-el-index-file RET, and select the file to index. This will insert a big list of definitions into the current buffer.

Scope of indexing

Three custom options are supported:

Three additional commands are also defined, which will disregard the above options:

  • Function: (org-el-index-file-large file)

    Generate a large org mode index for the definitions in FILE. This includes all supported definitions.

  • Function: (org-el-index-file-medium file)

    Generate a medium org mode index for the definitions in FILE. This includes all definitions unless their name contains "–"

  • Function: (org-el-index-file-small file)

    Generate a small org mode index for the definitions in FILE. This includes only custom options and interactive commands.

Examples

"Small" index

You can exclude non-interactive functions and non-customizable variables by using org-el-index-file-small or setting the below options:

(setq org-el-index-custom-only t
      org-el-index-interactive-only t
      org-el-index-single-hyphen-only t)

"Large" index

Of course, you can include all definitions by using org-el-index-file-large or setting the below options:

(setq org-el-index-custom-only nil
      org-el-index-interactive-only nil
      org-el-index-single-hyphen-only nil)

"Medium" index

A good middle ground between the above two can be achieved using org-el-index-file-medium, which uses the following (default) settings:

(setq org-el-index-custom-only nil
      org-el-index-interactive-only nil
      org-el-index-single-hyphen-only t)

License

GPL3+