You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A followup to the removal of the child action. There is less need to be
distinct, and this simplifies the configuration API just a bit more.
While `section-actions' is still used internally in some places, and its meaning
should be well understood by org hackers.
Signed-off-by: Psionik K <73710933+psionic-k@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.org
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -64,10 +64,12 @@ If you display the slideshow in one window or frame, you can configure the point
64
64
- *Deck*: an object that is used to relate the display and base buffer and is the root of all sequences. It's another word for "presentation" or PT.
65
65
- *Slide*: an object that interprets an org heading to hydrate its actions
66
66
- *Action*: an object that responds to ~dslide-deck-forward~ and ~dslide-deck-backward~ calls and implements lifecycle methods to initialize and clean up state
67
+
+ *Slide Action*: an action subclass that handles initial display of the slide and creation of child slides from sub-headings.
68
+
+ *Section Actions*: actions that typically control the display and behavior of a heading's section, the region between the headline and child headings.
67
69
- *Step*: a single call to ~dslide-deck-foward~ or ~dslide-deck-backward~, usually delegated down to ~dslide-forward~ and ~dslide-backward~ methods
68
-
- *Contents*: use org folding to create a view of folded headings to quickly navigate slides
70
+
- *Contents*: A view of the folded root headings that is used for quickly navigating between headings during a presentation.
69
71
- *Slide Buffer*: the slides are shown in an indirect buffer that is cloned from your org document buffer. The source is called the *base buffer*. Check for the =deck: my-presentation.org= buffer name.
70
-
+ Inderect buffer and =slide-buffer= are used interchangeably
72
+
+ Indirect buffer and =slide-buffer= are used interchangeably
71
73
+ Base buffer or =base-buffer= is used pretty exclusively
72
74
* Configuring
73
75
Be sure to check =M-x= ~customize-group~ =dslide= to see all declared custom variables. All of the variables are configured to recommended defaults except hooks, which would depend on other packages usually.
@@ -120,7 +122,7 @@ The out-of-the-box experience can be a bit messy due to property drawers, keywor
120
122
Headings are treated as slides. Slides have actions. Actions are configured in the property drawer.
121
123
122
124
- =DSLIDE_SLIDE_ACTION=: Usually narrows to the slide and creates children from child headings. Lifecycle encloses the section.
123
-
- =DSLIDE_SECTION_ACTIONS:= Most commonly customized. You can list multiple actions. Each one will step through its forward and backward steps.
125
+
- =DSLIDE_ACTIONS:= Most commonly customized. You can list multiple actions. Each one will step through its forward and backward steps.
124
126
125
127
Some actions must be fully enclosed by the lifecycle of a surrounding action, such as narrowing to the headline and section before displaying a contained list item-by-item.
126
128
@@ -141,14 +143,14 @@ Many actions understand arguments, allowing tuning of similar behaviors from the
141
143
Configuring the slot is done by adding plist-style properties after the class name:
142
144
#+begin_src org
143
145
:PROPERTIES:
144
-
:DSLIDE_SECTION_ACTIONS: dslide-action-item-reveal :inline t
146
+
:DSLIDE_ACTIONS: dslide-action-item-reveal :inline t
145
147
:END:
146
148
#+end_src
147
149
You can also use "property+" syntax to add to a property, and these accept plist arguments too:
148
150
#+begin_src org
149
151
:PROPERTIES:
150
-
:DSLIDE_SECTION_ACTIONS: dslide-action-babel
151
-
:DSLIDE_SECTION_ACTIONS+: dslide-action-images :fullscreen t
152
+
:DSLIDE_ACTIONS: dslide-action-babel
153
+
:DSLIDE_ACTIONS+: dslide-action-images :fullscreen t
152
154
:END:
153
155
#+end_src
154
156
* Customizing
@@ -310,7 +312,7 @@ A consequence of this is that there are usually multiple actions alive at once.
310
312
** Work In Progress 🚧
311
313
Open issues and give feedback on feature requests. Contributions welcome.
312
314
*** Secondary Commands
313
-
See the section about bindings for context. Video play or other situations where the presentation might branch should be supported by overloading the behavior of ~dslide-deck-start~
315
+
See the section about bindings for context. Video play or other situations where the presentation might branch should be supported by overloading the behavior of ~dslide-deck-start~. I think this command will turn into ~dslide-deck-secondary~ in the ~dslide-mode-map~.
314
316
*** ~dslide-goto~, starting from point
315
317
Since not many actions currently have implemented this very accurately, playing from point is likely not that accurate. Progress updating in the base buffer is also currently only at the slide level of granularity.
@@ -108,7 +108,7 @@ Positron is deeply committed to bringing you the finest in:
108
108
=M-x describe-symbol dslide-action-narrow=
109
109
* Babel Slide Integration
110
110
:PROPERTIES:
111
-
:DSLIDE_SECTION_ACTIONS: dslide-action-babel
111
+
:DSLIDE_ACTIONS: dslide-action-babel
112
112
:END:
113
113
Go 2-3 steps forwards and then backwards. This slide also supports starting at the end. Just go to the next slide and back up.
114
114
#+attr_dslide: begin end
@@ -153,7 +153,7 @@ Can has display?
153
153
** No Display! Only Execute!
154
154
:PROPERTIES:
155
155
:DSLIDE_SLIDE_ACTION: nil
156
-
:DSLIDE_SECTION_ACTIONS: dslide-action-babel
156
+
:DSLIDE_ACTIONS: dslide-action-babel
157
157
:END:
158
158
These four org blocks will not be displayed since this slide has no slide action. They will however execute when navigating forward and backward. Note these features:
159
159
@@ -195,7 +195,7 @@ Our cleanup is always run, after everything
195
195
#+end_src
196
196
* Package Integration
197
197
:PROPERTIES:
198
-
:DSLIDE_SECTION_ACTIONS: dslide-action-babel
198
+
:DSLIDE_ACTIONS: dslide-action-babel
199
199
:END:
200
200
- You need the ~master-of-ceremonies~ package installed to complete this slide.
201
201
- Let arbitrary buffers be shown while still completing steps within the slide-show.
@@ -229,7 +229,7 @@ Our cleanup is always run, after everything
229
229
#+end_src
230
230
* Babel is every Feature
231
231
:PROPERTIES:
232
-
:DSLIDE_SECTION_ACTIONS: dslide-action-babel
232
+
:DSLIDE_ACTIONS: dslide-action-babel
233
233
:END:
234
234
If a feature seems like it's missing, it can probably be added. There is a babel block below this paragraph, but if you are viewing this presentation, you won't see it because it has hidden itself with an overlay. File an issue, but don't be held back. A quick hunk of [[info:elisp#Top][elisp]] can solve every problem.
235
235
#+attr_dslide: begin end
@@ -262,7 +262,7 @@ Positron is cheating and also apply custom line-spacing and line-height. While
262
262
Bind the command ~dslide-deck-start~ in the ~org-mode-map~. Any key will do.
263
263
** Custom Actions
264
264
:PROPERTIES:
265
-
:DSLIDE_SECTION_ACTIONS: dslide-action-babel
265
+
:DSLIDE_ACTIONS: dslide-action-babel
266
266
:END:
267
267
The babel block below is a custom action supporting both forward, each step making a paragraph red when going forward or removing the red when going backward. Key methods you want to use in your custom actions:
268
268
- ~dslide-section-next~
@@ -306,7 +306,7 @@ The babel block below is a custom action supporting both forward, each step maki
Massachusetts, in particular, has always been one of the laboratories of democracy. It's where people try things before they're popular. It's where we experiment.
0 commit comments