[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/pulsar a84b2d86f1 10/28: Document integration with othe
From: |
ELPA Syncer |
Subject: |
[elpa] externals/pulsar a84b2d86f1 10/28: Document integration with other packages |
Date: |
Tue, 22 Mar 2022 06:58:02 -0400 (EDT) |
branch: externals/pulsar
commit a84b2d86f14b1691dba53d8d1fd109c5671e26db
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Document integration with other packages
---
README.org | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/README.org b/README.org
index 685c09c458..9c8644b7e7 100644
--- a/README.org
+++ b/README.org
@@ -172,6 +172,37 @@ Remember to read the doc string of each of these variables.
(setq pulsar-delay 0.055)
#+end_src
+* Integration with other packages
+:PROPERTIES:
+:CUSTOM_ID: h:b884f2ac-82f3-48c0-bee5-6709d6647b1d
+:END:
+#+cindex: Helper functions for integration with other packages
+
+Beside ~pulsar-pulse-line~, Pulsar defines a few functions that can be
+added to hooks that are provided by other packages.
+
+#+findex: pulsar-recenter-top
+#+findex: pulsar-recenter-middle
+There are two functions to recenter and then pulse the current line:
+~pulsar-recenter-top~ and ~pulsar-recenter-middle~.
+
+#+findex: pulsar-reveal-entry
+There also exists ~pulsar-reveal-entry~ which displays the hidden
+contents of an Org or Outline heading. It can be used in tandem with
+the aforementioned recentering functions.
+
+Example use-cases:
+
+#+begin_src emacs-lisp
+;; integration with the `consult' package:
+(add-hook 'consult-after-jump-hook #'pulsar-recenter-top)
+(add-hook 'consult-after-jump-hook #'pulsar-reveal-entry)
+
+;; integration with the built-in `imenu':
+(add-hook 'imenu-after-jump-hook #'pulsar-recenter-top)
+(add-hook 'imenu-after-jump-hook #'pulsar-reveal-entry)
+#+end_src
+
* GNU Free Documentation License
:PROPERTIES:
:APPENDIX: t
- [elpa] branch externals/pulsar created (now 40b1aa8c48), ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 7a17c1ab55 01/28: Add pulsar.el, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar e0ae86378f 06/28: Remove recentering at bottom, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar a335e52505 03/28: Add commands to pulse+recenter, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 0cc2f4af56 02/28: Make outline structure more detailed, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar de1fa21ae3 05/28: Refine pulsar-reveal-entry, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 4748f55eee 08/28: Expand the pulsar-pulse-functions, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar a84b2d86f1 10/28: Document integration with other packages,
ELPA Syncer <=
- [elpa] externals/pulsar a7b7ac4f7e 11/28: Document pulse-setup, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 23a8ef7fbf 13/28: Release version 0.1.0, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 54702c9e1f 12/28: Add package keywords, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar bc084499c4 04/28: Add function to reveal Org or Outline entry, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 98d970dcdf 09/28: Add minor rewording, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar fca0e53815 15/28: Exert control over the pulse effect, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 486645f81b 16/28: Always ':extend t' the generic pulse face, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar dcc94662a9 07/28: Stop pulsing during pulsar-reveal-entry, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 82946880b5 14/28: Add missing function to sample package setup, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 42f8a03b8a 18/28: Fix typo, ELPA Syncer, 2022/03/22