[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/org-tree-slide d6529bc2df: Update docstrings
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/org-tree-slide d6529bc2df: Update docstrings |
Date: |
Sun, 16 Oct 2022 12:59:04 -0400 (EDT) |
branch: elpa/org-tree-slide
commit d6529bc2df727d09014e0e56abf4f15a8e8fc20f
Author: Takaaki ISHIKAWA <takaxp@ieee.org>
Commit: Takaaki ISHIKAWA <takaxp@ieee.org>
Update docstrings
Reflect a user comment (#57)
---
.gitignore | 4 ++++
org-tree-slide.el | 17 ++++++++---------
2 files changed, 12 insertions(+), 9 deletions(-)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..ed45a5dc79
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+README.html
+index.html
+*.elc
+.DS_Store
diff --git a/org-tree-slide.el b/org-tree-slide.el
index e035b5c008..4bc04800d8 100644
--- a/org-tree-slide.el
+++ b/org-tree-slide.el
@@ -123,10 +123,10 @@ When nil, the body of the subtrees will be revealed."
:group 'org-tree-slide)
(defcustom org-tree-slide-cursor-init t
- "Specify a cursor position when exit slideshow.
+ "Specify a cursor position at start and exit of the slideshow.
Non-nil: the cursor will move automatically to the head of buffer.
-nil: keep the same position."
+nil: keep the same position. The slideshow will start from the heading that
has the cursor."
:type 'boolean
:group 'org-tree-slide)
@@ -243,7 +243,7 @@ If you want to show anything, just specify nil."
;;;###autoload
(define-minor-mode org-tree-slide-mode
- "A presentation tool for org-mode.
+ "A presentation tool for Org Mode.
Usage:
- Set minimal recommendation settings in .emacs
@@ -257,7 +257,7 @@ Usage:
Profiles:
- [ Simple ]
- => M-x `org-tree-slide-simple-profile'
+ => \\`M-x org-tree-slide-simple-profile'
1. No header display
2. No slide-in effect
@@ -266,7 +266,7 @@ Profiles:
5. Display every type of tree
- [ Presentation ]
- => M-x `org-tree-slide-presentation-profile'
+ => \\`M-x org-tree-slide-presentation-profile'
1. Display header
2. Enable slide-in effect
@@ -275,14 +275,13 @@ Profiles:
5. Display every type of tree
- [ TODO Pursuit with narrowing ]
- => M-x `org-tree-slide-narrowing-control-profile'
+ => \\`M-x org-tree-slide-narrowing-control-profile'
1. No header display
2. No slide-in effect
3. The cursor will keep the same position when exit
4. Display slide number in mode line
- 5. Display TODO trees only
-"
+ 5. Display TODO trees only"
:init-value nil
:lighter (:eval (org-tree-slide--update-modeline))
:keymap org-tree-slide-mode-map
@@ -764,7 +763,7 @@ concat the headers."
(if (re-search-forward regexp limit t) (match-string 1) nil)))
(defface org-tree-slide-header-overlay-face '((t :inherit default))
- "Face for org-tree-slide--header-overlay"
+ "Face for org-tree-slide--header-overlay."
:group 'org-tree-slide)
(defun org-tree-slide--get-parents (&optional delim)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [nongnu] elpa/org-tree-slide d6529bc2df: Update docstrings,
ELPA Syncer <=