branch: elpa/org-tree-slide
commit 6608f8d43bf40acbddeb4434715283e5884c8a02
Author: Takaaki ISHIKAWA <tak...@ieee.org>
Commit: Takaaki ISHIKAWA <tak...@ieee.org>
Refine README and add a link to Moom
---
README.org | 24 ++++++++++++++++++------
org-tree-slide.el | 11 ++++++-----
2 files changed, 24 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index 7b0a153a58..599d84f717 100644
--- a/README.org
+++ b/README.org
@@ -1,8 +1,8 @@
#+TITLE: README for Org Tree Slide
#+AUTHOR: Takaaki Ishikawa
#+EMAIL: tak...@ieee.org
-#+DATE: 2017-11-30
-#+UPDATE: 15:33:29
+#+DATE: 2018-04-25
+#+UPDATE: 08:35:36
#+STARTUP: content
[[http://melpa.org/#/org-tree-slide][http://melpa.org/packages/org-tree-slide-badge.svg]]
@@ -10,7 +10,7 @@
* 1. What's this?
-The main purpose of this elisp is to handle each tree in an org buffer as a
slide by simple narrowing. This emacs lisp is a minor mode for Emacs Org-mode.
+The main purpose of this elisp is to handle each tree in an org buffer as a
slide by simple narrowing. This emacs lisp is a minor mode for Emacs Org-mode.
Main features:
@@ -21,11 +21,11 @@ Main features:
- CONTENT view during a presentation
- Slide-in effect
- Slide header from org file's header
- - Countdown timer
+ - Countdown timer
** 1-1. Related packages
-There are various packages to make a presentation with org-mode. See
[[http://orgmode.org/worg/org-tutorials/non-beamer-presentations.html]].
+There are various packages to make a presentation with org-mode. See
[[http://orgmode.org/worg/org-tutorials/non-beamer-presentations.html]]. For
more simple use,
[[https://github.com/zonuexe/emacs-presentation-mode][presentation.el]] may
suitable.
* 2. Install
@@ -39,6 +39,15 @@ OR
Then open an org file, just type =C-<= and =C->=, which means =C-M-,= and
=C-M-.=, you can see a presentation will begin with a header, slide-in effect,
and slide number in mode line.
+It is recommended to change the keybindings to make your presentation
smoothly. Here is an example.
+
+#+BEGIN_SRC emacs-lisp
+(with-eval-after-load "org-tree-slide"
+ (define-key org-tree-slide-mode-map (kbd "<f9>")
'org-tree-slide-move-previous-tree)
+ (define-key org-tree-slide-mode-map (kbd "<f10>")
'org-tree-slide-move-next-tree)
+ )
+#+END_SRC
+
** 2.1 el-get recipe
If you are an [[https://github.com/dimitri/el-get][el-get]] user, just do
@@ -52,6 +61,9 @@ Now, you can install `org-tree-slide' via
[[http://melpa.org/#/org-tree-slide][M
** 2.2 Requirements
- Org-mode 6.33x or higher version is required.
- This elisp doesn't require any additional packages.
+** 2.3 additional package (moom.el)
+
+Normally, presentations will appear in full screen or frame maximized.
[[https://github.com/takaxp/moom#org-mode-org-tree-slide][moom]] is useful in
such cases since the package can change frame position and size by keyboard and
the font size will be increased suitably for your presentation.
* 3. Recommended settings
@@ -104,7 +116,7 @@ Type =M-x org-tree-slide-simple-profile= while
=org-tree-slide-mode= is ON.
** 4-2. `Presentation'
-This profile is the default setting of org-tree-slide. If an org buffer
includes =#+TITLE:=, =#+EMAIL:=, and =#+AUTHOR:=, org-tree-slide attempts to
use those variables in the slide header. A date in the header will be set with
the presentation of the day. You can enjoy a slide-in effect, the current slide
number in mode line.
+This profile is the default setting of org-tree-slide. If an org buffer
includes =#+TITLE:=, =#+EMAIL:=, and =#+AUTHOR:=, org-tree-slide attempts to
use those variables in the slide header. A date in the header will be set with
the presentation of the day. You can enjoy a slide-in effect, the current slide
number in mode line.
# A presentation with a count down timer is started by =M-x
org-tree-slide-play-with-timer=.
diff --git a/org-tree-slide.el b/org-tree-slide.el
index fa866125d8..e8377a8385 100644
--- a/org-tree-slide.el
+++ b/org-tree-slide.el
@@ -3,7 +3,7 @@
;; Copyright (C) 2011-2017 Takaaki ISHIKAWA
;;
;; Author: Takaaki ISHIKAWA <takaxp at ieee dot org>
-;; Version: 2.8.6
+;; Version: 2.8.7
;; Maintainer: Takaaki ISHIKAWA <takaxp at ieee dot org>
;; Twitter: @takaxp
;; Repository: https://github.com/takaxp/org-tree-slide
@@ -44,9 +44,9 @@
;; 3. Open an org-mode file
;; 4. Toggle org-tree-slide-mode (M-x org-tree-slide-mode)
;; then Slideshow will start and you can find "TSlide" in mode line.
-;; 5. <left>/<right> will move between slides
+;; 5. `C-<'/`C->' will move between slides
;; 6. `C-x s c' will show CONTENT of the org buffer
-;; Select a heading and type <right>, then Slideshow will start again.
+;; Select a heading and type `C-<', then Slideshow will start again.
;; 7. Toggle org-tree-slide-mode again to exit this minor mode
;;
;; Recommended minimum settings:
@@ -69,6 +69,7 @@
;; Note:
;; - Make sure key maps below when you introduce this elisp.
;; - Customize variables, M-x customize-group ENT org-tree-slide ENT
+;; - see also moom.el (https://github.com/takaxp/moom) to control Emacs
frame
;;; Code:
@@ -76,7 +77,7 @@
(require 'org-timer)
;;(require 'org-clock) ; org-clock-in, -out, -clocking-p
-(defconst org-tree-slide "2.8.5"
+(defconst org-tree-slide "2.8.7"
"The version number of the org-tree-slide.el")
(defgroup org-tree-slide nil
@@ -236,7 +237,7 @@ Usage:
(global-set-key (kbd \"S-<f8>\") 'org-tree-slide-skip-done-toggle)
- Open an org file
- Type <f8> to start org-tree-slide-mode
- - Type <left>/<right> to move between trees
+ - Type C-< / C-> to move between trees
- To exit this minor mode, just type <f8> again.
Profiles:
![http://melpa.org/#/org-tree-slide][http://melpa.org/packages/org-tree-slide-badge.svg](http://melpa.org/#/org-tree-slide][http://melpa.org/packages/org-tree-slide-badge.svg){kind=link}