Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alphapapa/org-auto-expand
Automatically expand certain Org headings
https://github.com/alphapapa/org-auto-expand
emacs org-mode
Last synced: 3 months ago
JSON representation
Automatically expand certain Org headings
- Host: GitHub
- URL: https://github.com/alphapapa/org-auto-expand
- Owner: alphapapa
- License: gpl-3.0
- Created: 2019-08-12T19:26:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T08:54:15.000Z (over 1 year ago)
- Last Synced: 2024-08-21T21:27:54.729Z (6 months ago)
- Topics: emacs, org-mode
- Language: Shell
- Size: 49.8 KB
- Stars: 32
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
README
#+TITLE: org-auto-expand
#+PROPERTY: LOGGING nil
# Note: This readme works with the org-make-toc package, which automatically updates the table of contents.
# [[https://melpa.org/#/org-auto-expand][file:https://melpa.org/packages/org-auto-expand-badge.svg]] [[https://stable.melpa.org/#/org-auto-expand][file:https://stable.melpa.org/packages/org-auto-expand-badge.svg]]
[[https://melpa.org/#/org-auto-expand][file:https://melpa.org/packages/org-auto-expand-badge.svg]] [[https://stable.melpa.org/#/org-auto-expand][file:https://stable.melpa.org/packages/org-auto-expand-badge.svg]]
This package automatically expands certain headings in an Org file depending on properties set, making it easy to always get the same initial view when finding a file.
* Installation
:PROPERTIES:
:TOC: 0
:END:
** MELPA
If you installed from [[https://melpa.org/#/org-auto-expand][MELPA]], you're already done!
** Quelpa
Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy:
1. Install [[https://framagit.org/steckerhalter/quelpa-use-package#installation][quelpa-use-package]] (which can be installed directly from MELPA).
2. Add this form to your init file:
#+BEGIN_SRC elisp
(use-package org-auto-expand
:quelpa (org-auto-expand :fetcher github :repo "alphapapa/org-auto-expand"))
#+END_SRC
** Manual
Put =org-auto-expand.el= in your ~load-path~, and put this in your init file:
#+BEGIN_SRC elisp
(require 'org-auto-expand)
#+END_SRC
* Usage
:PROPERTIES:
:TOC: 0
:END:
1. Define auto-expansion settings in an Org file (see below).
2. Run ~org-auto-expand~ to set visibility accordingly. You may do this automatically in a file with a file- or dir-local variable. See examples.
+ The global minor mode ~org-auto-expand-mode~ automatically applies expansion settings when visiting Org files.
+ To start with all entries folded, set the variable ~org-startup-folded~ as desired, or use the ~#+STARTUP~ keyword (see Org manual).
** Auto-expansion Settings
Auto-expansion settings may be set in two ways: with Org properties on headings, and with the file- or dir-local variable ~org-auto-expand-nodes~.
*** Properties
Set the =auto-expand= property on a node to a list of one or more of these values:
- =heading=: Show just the heading.
- =body=: Show the heading and its body, but not its children.
- =children=: Show the heading's children, but not its body.
- A number =N=: Show child headings =N= levels deep.
- A symbol that =org-show-context= accepts as an argument.
For example, in this Org file:
#+BEGIN_SRC org
,* Daily tasks
:PROPERTIES:
:auto-expand: body 1
:END:
Things to do every day.
,** Check email
,** Walk dog
,* Weekly tasks
Things to do every week.
,** Check tire pressure
,** Attempt to walk cat
#+END_SRC
After running ~org-auto-expand~, you would see:
#+BEGIN_EXAMPLE
,* Daily tasks
:PROPERTIES:...
Things to do every day.
,** Check email
,** Walk dog
,* Weekly tasks...
#+END_EXAMPLE
*** Variable =org-auto-expand-nodes=
The variable =org-auto-expand-nodes= may be set as file-local or dir-local (e.g. using command ~add-file-local-variable~). It should be an alist, the key of which should be an Org outline path (a list of heading strings corresponding to a node's hierarchy), and the value of which should be one of the values accepted by the =auto-expand= property. The corresponding example, which also calls ~org-auto-expand~ automatically:
#+BEGIN_SRC org
# Local Variables:
# org-auto-expand-nodes: ((("Daily tasks") body 1))
# eval: (org-auto-expand)
# End:
#+END_SRC
* Changelog
:PROPERTIES:
:TOC: 0
:END:
** 0.2-pre
Org version 9.6 or later is now required.
*Fixes*
+ Mode ~org-auto-expand-mode~ adds ~org-auto-expand~ to ~org-mode-hook~.
+ Call ~org-back-to-heading~ with ~INVISIBLE-OK~ argument. (Necessary with some newer Org versions.)
** 0.1
Initial release.
* Development
:PROPERTIES:
:TOC: ignore
:END:
Bug reports, feature requests, suggestions — /oh my/!
* License
:PROPERTIES:
:TOC: ignore
:END:
GPLv3
# Local Variables:
# eval: (require 'org-make-toc)
# before-save-hook: org-make-toc
# org-export-with-properties: ()
# org-export-with-title: t
# End: