v3.4 Slide Transitions

MartinPacker · Oct 16, 2022 · 1da38bd · 1da38bd
1 parent 70f8fed
commit 1da38bd
Show file tree

Hide file tree

Showing 4 changed files with 105 additions and 10 deletions.
diff --git a/user-guide.html b/user-guide.html
@@ -1067,7 +1067,7 @@
 .highlight .il{color:#009999}
 .highlight .gc{color:#999;background-color:#EAF2F5}
 </style><title>user-guide</title></head><body><article class="markdown-body"><h1 id="markdown-to-powerpoint-user-guide">Markdown To Powerpoint User Guide<a class="headerlink" href="#markdown-to-powerpoint-user-guide" title="Permanent link"></a></h1>
-<p>This document describes the md2pptx Markdown preprocessor, which turns Markdown text into a Powerpoint pptx presentation.</p>
+<p>This document describes the md2pptx Markdown preprocessor, which turns Markdown text into a Powerpoint presentation (whether .pptx or <a href="#invoking-a-vba-macro">.pptm</a>).</p>
 <p>In this document we&rsquo;ll refer to it as &ldquo;md2pptx&rdquo;, pronounced &ldquo;em dee to pee pee tee ex&rdquo;.</p>
 <h3 id="table-of-contents">Table Of Contents<a class="headerlink" href="#table-of-contents" title="Permanent link"></a></h3>
 <ul>
@@ -1255,6 +1255,7 @@ <h3 id="table-of-contents">Table Of Contents<a class="headerlink" href="#table-o
 <li><a href="#make-expandable-sections-sectionsexpand">Make Expandable Sections - <code>SectionsExpand</code></a></li>
 </ul>
 </li>
+<li><a href="#slide-transitions-transition">Slide Transitions - <code>Transition</code></a></li>
 </ul>
 </li>
 <li><a href="#dynamic-metadata">Dynamic Metadata</a><ul>
@@ -1293,6 +1294,7 @@ <h3 id="table-of-contents">Table Of Contents<a class="headerlink" href="#table-o
 <li><a href="#marginbase"><code>MarginBase</code></a></li>
 <li><a href="#numbersheight"><code>NumbersHeight</code></a></li>
 <li><a href="#tablemargin"><code>TableMargin</code></a></li>
+<li><a href="#transition"><code>Transition</code></a></li>
 </ul>
 </li>
 </ul>
@@ -1420,6 +1422,11 @@ <h2 id="change-log">Change Log<a class="headerlink" href="#change-log" title="Pe
 </thead>
 <tbody>
 <tr>
+<td align="left">3.4</td>
+<td align="right">16&nbsp;October&nbsp;2022</td>
+<td align="left">Added support for a small number of <a href="#slide-transitions-transition">slide transitions</a>.</td>
+</tr>
+<tr>
 <td align="left">3.3.3</td>
 <td align="right">8&nbsp;October&nbsp;2022</td>
 <td align="left">Fixed bug where coding a MultiMarkdown style heading ID deleted the text to the right. Noted outbound links from headings are a <a href="#deviations-from-standard-markdown">deviation from standard Markdown</a>.</td>
@@ -3528,6 +3535,21 @@ <h5 id="make-expandable-sections-sectionsexpand">Make Expandable Sections - <cod
 </li>
 <li>In testing only PowerPoint has demonstrated the ability to display collapsible sections. Neither LibreOffice nor Keynote showed any understanding of collapsible sections, though both otherwise loaded the test presentation fine.</li>
 </ul>
+<p><a id="slide-transitions-transition"></a></p>
+<h4 id="slide-transitions-transition">Slide Transitions - <code>Transition</code><a class="headerlink" href="#slide-transitions-transition" title="Permanent link"></a></h4>
+<p>With md2pptx you can create transitions between slides.</p>
+<p>To do so code, for example:</p>
+<pre><code>transition: ripple
+</code></pre>
+<p>A limited number have been successfully tested:</p>
+<ul>
+<li><code>ripple</code></li>
+<li><code>reveal</code></li>
+<li><code>honeycomb</code></li>
+<li><code>shred</code></li>
+</ul>
+<p>The default is <code>no</code> - which prevents slide transition effects being generated.</p>
+<p>You can override this value with <a href="#transition-dynamic">Dynamic Metadata</a>.</p>
 <p><a id="dynamic-metadata"></a></p>
 <h3 id="dynamic-metadata">Dynamic Metadata<a class="headerlink" href="#dynamic-metadata" title="Permanent link"></a></h3>
 <p>md2pptx can alter some in-effect settings, starting at a particular slide. Straight after the heading code a special form of (HTML) comment like so:</p>
@@ -3696,6 +3718,12 @@ <h4 id="tablemargin"><code>TableMargin</code><a class="headerlink" href="#tablem
 <p>You can override the presentation <a href="#margin-size-marginbase-and-tablemargin">TableMargin</a> specification on a slide-by-slide-basis:</p>
 <pre><code>&lt;!-- md2pptx: tablemargin: 0.25 --&gt;
 </code></pre>
+<p><a id="transition-dynamic"></a></p>
+<h4 id="transition"><code>Transition</code><a class="headerlink" href="#transition" title="Permanent link"></a></h4>
+<p>You can override the presentation <a href="#slide-transitions-transition">Transition</a> specification on a slide-by-slide basis:</p>
+<pre><code>&lt;!-- md2pptx: transition: reveal --&gt;
+</code></pre>
+<p>It&rsquo;s important to note that doing this will affect the transition <strong>into</strong> this slide. Likewise all subsequent slides - until overridden again or reverted.</p>
 <h2 id="modifying-the-slide-template">Modifying The Slide Template<a class="headerlink" href="#modifying-the-slide-template" title="Permanent link"></a></h2>
 <p><a id="modifying-the-slide-template"></a></p>
 <p>The included template presentation - Martin Template.pptx - is what the author tested with and gives good results. However, you probably want to develop your own template from it.</p>

diff --git a/user-guide.log b/user-guide.log
@@ -1,12 +1,12 @@
 
-mdpre Markdown Preprocessor v0.6.4+ (15 August, 2022)
-=====================================================
+mdpre Markdown Preprocessor v0.6.4+ (19 June, 2022)
+===================================================
 - opened <stdout> for writing
-Def mdpre_date = 15 August, 2022
+Def mdpre_date = 19 June, 2022
 Def mdpre_level = 0.6.4+
 Def userid = martinpacker
-Def time = 12&colon;04
-Def date = 8 October&comma; 2022
+Def time = 16&colon;44
+Def date = 16 October&comma; 2022
 Def TOC = Table Of Contents
 Def md = Markdown
 Def pp = Powerpoint
@@ -160,6 +160,7 @@ CSV Stop
 ..... ..... ..... .....  Section Navigation Buttons - `SectionArrows`
 ..... ..... ..... .....  Section Navigation Button Colour - `SectionArrowsColour`
 ..... ..... ..... .....  Make Expandable Sections - `SectionsExpand`
+..... ..... .....  Slide Transitions - `Transition`
 ..... .....  Dynamic Metadata
 ..... ..... .....  Tables
 ..... ..... ..... .....  `CompactTables`
@@ -190,6 +191,7 @@ CSV Stop
 ..... ..... .....   `MarginBase`
 ..... ..... .....   `NumbersHeight`
 ..... ..... .....  `TableMargin`
+..... ..... .....  `Transition`
 .....  Modifying The Slide Template
 ..... .....  Basics
 ..... .....  Slide Template Sequence
@@ -203,7 +205,7 @@ CSV Stop
 ..... ..... .....   Blank Slide - `BlankLayout`
 ..... ..... .....  Content Slide - `ContentSlideLayout`
 .....  Deviations From Standard Markdown
------------------------------------------------------
+---------------------------------------------------
 - Processing completed.
------------------------------------------------------
+---------------------------------------------------
 
diff --git a/user-guide.md b/user-guide.md
@@ -1,6 +1,7 @@
+
 # Markdown To Powerpoint User Guide
 
-This document describes the md2pptx Markdown preprocessor, which turns Markdown text into a Powerpoint pptx presentation.
+This document describes the md2pptx Markdown preprocessor, which turns Markdown text into a Powerpoint presentation (whether .pptx or [.pptm](#invoking-a-vba-macro)).
 
 In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee tee ex".
 
@@ -140,6 +141,7 @@ In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee t
 			* [Section Navigation Buttons - `SectionArrows`](#section-navigation-buttons-sectionarrows)
 			* [Section Navigation Button Colour - `SectionArrowsColour`](#section-navigation-button-colour-sectionarrowscolour)
 			* [Make Expandable Sections - `SectionsExpand`](#make-expandable-sections-sectionsexpand)
+		* [Slide Transitions - `Transition`](#slide-transitions-transition)
 	* [Dynamic Metadata](#dynamic-metadata)
 		* [Tables](#tables)
 			* [`CompactTables`](#compacttables)
@@ -170,6 +172,7 @@ In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee t
 		* [`MarginBase`](#marginbase)
 		* [`NumbersHeight`](#numbersheight)
 		* [`TableMargin`](#tablemargin)
+		* [`Transition`](#transition)
 * [Modifying The Slide Template](#modifying-the-slide-template)
 	* [Basics](#basics)
 	* [Slide Template Sequence](#slide-template-sequence)
@@ -304,6 +307,7 @@ To quote from the python-pptx license statement:
 
 |Level|Date|What|
 |:-|-:|:-|
+|3.4|16&nbsp;October&nbsp;2022|Added support for a small number of [slide transitions](#slide-transitions-transition).|
 |3.3.3|8&nbsp;October&nbsp;2022|Fixed bug where coding a MultiMarkdown style heading ID deleted the text to the right. Noted outbound links from headings are a [deviation from standard Markdown](#deviations-from-standard-markdown).|
 |3.3.2|6&nbsp;September&nbsp;2022|Fixed bug where expanding sections crashed md2pptx. Clarified supported section name characters. See [sectionsExpand](#make-expandable-sections-sectionsexpand).|
 |3.3.1|3&nbsp;September&nbsp;2022|[Processing Summary](#processing-summary) slide can have up to 5 column pairs. `<span class=>` matching lower cased.|
@@ -2502,6 +2506,26 @@ The default is `no`.
     * Asterisks (coded as `&lowast;`)
 * In testing only PowerPoint has demonstrated the ability to display collapsible sections. Neither LibreOffice nor Keynote showed any understanding of collapsible sections, though both otherwise loaded the test presentation fine.
 
+<a id="slide-transitions-transition"></a>
+#### Slide Transitions - `Transition`
+
+With md2pptx you can create transitions between slides.
+
+To do so code, for example:
+
+    transition: ripple
+
+A limited number have been successfully tested:
+
+* `ripple`
+* `reveal`
+* `honeycomb`
+* `shred`
+
+The default is `no` - which prevents slide transition effects being generated.
+
+You can override this value with [Dynamic Metadata](#transition-dynamic).
+
 <a id="dynamic-metadata"></a>
 ### Dynamic Metadata
 
@@ -2743,6 +2767,16 @@ You can override the presentation [TableMargin](#margin-size-marginbase-and-tabl
 
     <!-- md2pptx: tablemargin: 0.25 -->
 
+<a id="transition-dynamic"></a>
+#### `Transition`
+
+You can override the presentation [Transition](#slide-transitions-transition) specification on a slide-by-slide basis:
+
+    <!-- md2pptx: transition: reveal -->
+
+It's important to note that doing this will affect the transition **into** this slide. Likewise all subsequent slides - until overridden again or reverted.
+
+
 ## Modifying The Slide Template
 <a id="modifying-the-slide-template"></a>
 

diff --git a/user-guide.mdp b/user-guide.mdp
@@ -4,7 +4,7 @@
 
 # &md; To &pp; User Guide
 
-This document describes the md2pptx &md; preprocessor, which turns &md; text into a &pp; pptx presentation.
+This document describes the md2pptx &md; preprocessor, which turns &md; text into a &pp; presentation (whether .pptx or [.pptm](#invoking-a-vba-macro)).
 
 In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee tee ex".
 
@@ -152,6 +152,7 @@ To quote from the python-pptx license statement:
 =colalign l r l
 =csv
 Level,Date,What
+3.4,16&nbsp;October&nbsp;2022,Added support for a small number of [slide transitions](#slide-transitions-transition).
 3.3.3,8&nbsp;October&nbsp;2022,Fixed bug where coding a MultiMarkdown style heading ID deleted the text to the right. Noted outbound links from headings are a [deviation from standard Markdown](#deviations-from-standard-markdown).
 3.3.2,6&nbsp;September&nbsp;2022,Fixed bug where expanding sections crashed md2pptx. Clarified supported section name characters. See [sectionsExpand](#make-expandable-sections-sectionsexpand).
 3.3.1,3&nbsp;September&nbsp;2022,[Processing Summary](#processing-summary) slide can have up to 5 column pairs. `<span class=>` matching lower cased.
@@ -2575,6 +2576,26 @@ The default is `no`.
 * In testing only PowerPoint has demonstrated the ability to display collapsible sections. \
 Neither LibreOffice nor Keynote showed any understanding of collapsible sections, though both otherwise loaded the test presentation fine.
 
+<a id="slide-transitions-transition"></a>
+#### Slide Transitions - `Transition`
+
+With md2pptx you can create transitions between slides.
+
+To do so code, for example:
+
+    transition: ripple
+
+A limited number have been successfully tested:
+
+* `ripple`
+* `reveal`
+* `honeycomb`
+* `shred`
+
+The default is `no` - which prevents slide transition effects being generated.
+
+You can override this value with [Dynamic Metadata](#transition-dynamic).
+
 <a id="dynamic-metadata"></a>
 ### Dynamic Metadata
 
@@ -2820,6 +2841,16 @@ You can override the presentation [TableMargin](#margin-size-marginbase-and-tabl
 
     <!-- md2pptx: tablemargin: 0.25 -->
 
+<a id="transition-dynamic"></a>
+#### `Transition`
+
+You can override the presentation [Transition](#slide-transitions-transition) specification on a slide-by-slide basis:
+
+    <!-- md2pptx: transition: reveal -->
+
+It's important to note that doing this will affect the transition **into** this slide. Likewise all subsequent slides - until overridden again or reverted.
+
+
 ## Modifying The Slide Template
 <a id="modifying-the-slide-template"></a>