Markdown To Powerpoint User Guide
This document describes the md2pptx Markdown preprocessor, which turns Markdown text into a Powerpoint presentation (whether .pptx or .pptm).
In this document we’ll refer to it as “md2pptx”, pronounced “em dee to pee pee tee ex”.
+As you can see in the change log, md2pptx is frequently updated - both for bug fixes and enhancements.
Table Of Contents
- Why md2pptx?
-
@@ -1167,6 +1168,11 @@
- Specifying Metadata
- Metadata Keys
-
@@ -1211,6 +1217,7 @@
Table Of ContentsCard Border Width -
CardBorderWidth - Card Title Size -
CardTitleSize - Card Title Colour -
cardTitleColour
+ - Card Divider Colour -
cardDividerColour - Card Shadow -
CardShadow - Card Size -
CardPercent - Card Layout Direction -
CardLayout
@@ -1431,6 +1438,11 @@ - Card Title Font Size
- Card Title Colour +
- Card Divider Colour
- Card Shadow
- Card Size
- Card Layout Direction @@ -2855,6 +2868,50 @@
- A theme colour +
- An RGB value +
- NONE +
- ACCENT 1 +
- ACCENT 2 +
- ACCENT 3 +
- ACCENT 4 +
- ACCENT 5 +
- ACCENT 6 +
- BACKGROUND 1 +
- BACKGROUND 2 +
- DARK 1 +
- DARK 2 +
- FOLLOWED HYPERLINK +
- HYPERLINK +
- LIGHT 1 +
- LIGHT 2 +
- TEXT 1 +
- TEXT 2 +
- MIXED +
- NONE -
- ACCENT 1 -
- ACCENT 2 -
- ACCENT 3 -
- ACCENT 4 -
- ACCENT 5 -
- ACCENT 6 -
- BACKGROUND 1 -
- BACKGROUND 2 -
- DARK 1 -
- DARK 2 -
- FOLLOWED HYPERLINK -
- HYPERLINK -
- LIGHT 1 -
- LIGHT 2 -
- TEXT 1 -
- TEXT 2 -
- MIXED -
Table Of ContentsControlling The Presentation With Metadata
Change Log3.7 +
26 March 2023 +Added + +cardDividerColour. Most colours now RGB or Theme Colour (documented in Specifying Colours).3.6 18 March 2023 Added @@ -2174,6 +2186,7 @@cardTitleColour&lineforcardshape. Allow multiple colours forcardColour.Card SlidesCard Border Width
Processing SummarySample Macro To Remove The First Slide for an example of where these might be useful. +
+Specifying Colours
+In most places where you specify colours they can be of one of two forms:
+-
+
Theme Colours
+ +Powerpoint themes have named theme colours. The names you can use with md2pptx are:
+-
+
As you can probably guess, these are standard values for python-pptx and, ultimately, PowerPoint.
+Here is an example:
+
+BoldColour: ACCENT 1 +This will give you more consistent colouring than RGB Colours.
+Note: For the values you can use any capitalisation you like (or none). e.g.
+ItalicColor: dark 1.RGB Colours
+ +RGB stands for “Red, Green, and Blue”. You specify RGB values as 6 hexadecimal digits. For example:
+
+ItalicColour: #FF0000 +Each pair of hexadecimal digits represents Red, Green, and Blue, respectively. Each is a hexadecimal encoding of 0-255, with 0 being “none of this colour” and 255 being “saturated in this colour”.
+This will give you more precise colouring than Theme Colours.
+Note: You must include the octothorpe (
#) before the hexadecimal value.Metadata Keys
The following sections describe each of the metadata keys.
@@ -3039,29 +3096,6 @@BoldColour: ACCENT 1Will cause text marked like so
-**I am bold**to be rendered in the presentation’s smartmaster’s “Accent 1” colour.The values you can use for
-BoldColourandItalicColourare:-
-
As you can probably guess, these are standard values for python-pptx and, ultimately, PowerPoint.
-Note: For the values you can use any capitalisation you like (or none). e.g.
ItalicColor: dark 1.Specifying Bold And Italic Text Effects With
BoldBoldAndItalicItalicYou can modify how md2pptx formats bold and italic text.
@@ -3244,6 +3278,12 @@Card Title Colour -
cardTitleCoCardTitleColour: DARK 1would set the cards’ titles to the theme’s “DARK 1” colour.
+Card Divider Colour -
+ +cardDividerColourYou can specify the colour of lines between cards - if the
+linestyle is chosen. For example:
+CardLineColour: ACCENT 1 +would set the lines between cards to the theme’s “ACCENT 1” colour.
Card Shadow -
CardShadowYou can specify whether a card has a shadow - using
diff --git a/user-guide.log b/user-guide.log index d49394c..78b1c6f 100644 --- a/user-guide.log +++ b/user-guide.log @@ -5,8 +5,8 @@ mdpre Markdown Preprocessor v0.6.5 (17 February, 2023) Def mdpre_date = 17 February, 2023 Def mdpre_level = 0.6.5 Def userid = martinpacker -Def time = 14:13 -Def date = 18 March, 2023 +Def time = 13:59 +Def date = 26 March, 2023 Def TOC = Table Of Contents Def md = Markdown Def pp = Powerpoint @@ -83,6 +83,9 @@ CSV Stop ..... Controlling The Presentation With Metadata ..... ..... Specifying Metadata ..... ..... ..... Processing Summary +..... ..... ..... Specifying Colours +..... ..... ..... ..... Theme Colours +..... ..... ..... ..... RGB Colours ..... ..... Metadata Keys ..... ..... ..... Title And Subtitle Font Sizes And Alignment ..... ..... ..... ..... Page Title Size - `pageTitleSize` @@ -121,6 +124,7 @@ CSV Stop ..... ..... ..... ..... Card Border Width - `CardBorderWidth` ..... ..... ..... ..... Card Title Size - `CardTitleSize` ..... ..... ..... ..... Card Title Colour - `cardTitleColour` +..... ..... ..... ..... Card Divider Colour - `cardDividerColour` ..... ..... ..... ..... Card Shadow - `CardShadow` ..... ..... ..... ..... Card Size - `CardPercent` ..... ..... ..... ..... Card Layout Direction - `CardLayout` diff --git a/user-guide.md b/user-guide.md index 05117b2..562b014 100644 --- a/user-guide.md +++ b/user-guide.md @@ -5,6 +5,8 @@ This document describes the md2pptx Markdown preprocessor, which turns Markdown In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee tee ex". +As you can see in the [change log](#change-log), md2pptx is frequently updated - both for bug fixes and enhancements. + ### Table Of Contents * [Why md2pptx?](#why-md2pptx) @@ -70,6 +72,9 @@ In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee t * [Controlling The Presentation With Metadata](#controlling-the-presentation-with-metadata) * [Specifying Metadata](#specifying-metadata) * [Processing Summary](#processing-summary) + * [Specifying Colours](#specifying-colours) + * [Theme Colours](#theme-colours) + * [RGB Colours](#rgb-colours) * [Metadata Keys](#metadata-keys) * [Title And Subtitle Font Sizes And Alignment](#title-and-subtitle-font-sizes-and-alignment) * [Page Title Size - `pageTitleSize`](#page-title-size-pagetitlesize) @@ -108,6 +113,7 @@ In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee t * [Card Border Width - `CardBorderWidth`](#card-border-width-cardborderwidth) * [Card Title Size - `CardTitleSize`](#card-title-size-cardtitlesize) * [Card Title Colour - `cardTitleColour`](#card-title-colour-cardtitlecolour) + * [Card Divider Colour - `cardDividerColour`](#card-divider-colour-carddividercolour) * [Card Shadow - `CardShadow`](#card-shadow-cardshadow) * [Card Size - `CardPercent`](#card-size-cardpercent) * [Card Layout Direction - `CardLayout`](#card-layout-direction-cardlayout) @@ -313,6 +319,7 @@ To quote from the python-pptx license statement: |Level|Date|What| |:-|-:|:-| +|3.7|26 March 2023|Added [`cardDividerColour`](#card-divider-colour-carddividercolour). Most colours now RGB or Theme Colour (documented in [Specifying Colours](#specifying-colours)).| |3.6|18 March 2023|Added [`cardTitleColour`](#card-title-colour-cardtitlecolour) & `line` for [`cardshape`](#card-shape-cardshape). Allow multiple colours for [`cardColour`](#card-background-colour-cardcolour).| |3.5.2|14 March 2023|Added [`pageTitleAlign`](#page-title-alignment-pagetitlealign) - for content page title alignment.| |3.5.1|3 March 2023|[`pageSubtitleSize`](#page-subtitle-size-pagesubtitlesize) supports `same` meaning "same font size as first line".| @@ -840,6 +847,7 @@ In the above example there has been a small amount of tweaking of the format, us * [Card Border Width](#card-border-width-cardborderwidth) * [Card Title Font Size](#card-title-size-cardtitlesize) * [Card Title Colour](#card-title-colour-cardtitlecolour) +* [Card Divider Colour](#card-divider-colour-carddividercolour) * [Card Shadow](#card-shadow-cardshadow) * [Card Size](#card-size-cardpercent) * [Card Layout Direction](#card-layout-direction-cardlayout) @@ -1527,6 +1535,61 @@ As described in [Creating Slides](#creating-slides), md2pptx will populate the f 1. You can suppress `style.` metadata items by specifying the metadata item `hideMetadata: style`. In the md2pptx developer's experience `style.` metadata items can become numerous and could obscure more important items in the Processing Summary slide. The default is not to hide such items. 1. Before the metadata table is created md2pptx will remove all but the title item in this slide. The one type of item that won't be removed is any Action Buttons. See [Sample Macro To Remove The First Slide](#sample-macro-to-remove-the-first-slide) for an example of where these might be useful. +#### Specifying Colours + + +In most places where you specify colours they can be of one of two forms: + +* A theme colour +* An RGB value + +##### Theme Colours + + +Powerpoint themes have named theme colours. The names you can use with md2pptx are: + +* NONE +* ACCENT 1 +* ACCENT 2 +* ACCENT 3 +* ACCENT 4 +* ACCENT 5 +* ACCENT 6 +* BACKGROUND 1 +* BACKGROUND 2 +* DARK 1 +* DARK 2 +* FOLLOWED HYPERLINK +* HYPERLINK +* LIGHT 1 +* LIGHT 2 +* TEXT 1 +* TEXT 2 +* MIXED + +As you can probably guess, these are standard values for python-pptx and, ultimately, PowerPoint. + +Here is an example: + + BoldColour: ACCENT 1 + +This will give you more consistent colouring than [RGB Colours](#rgb-colours). + +**Note:** For the values you can use any capitalisation you like (or none). e.g. `ItalicColor: dark 1`. + +##### RGB Colours + + +RGB stands for "Red, Green, and Blue". You specify RGB values as 6 hexadecimal digits. For example: + + ItalicColour: #FF0000 + +Each pair of hexadecimal digits represents Red, Green, and Blue, respectively. Each is a hexadecimal encoding of 0-255, with 0 being "none of this colour" and 255 being "saturated in this colour". + +This will give you more precise colouring than [Theme Colours](#theme-colours). + +**Note:** You must include the octothorpe (`#`) before the hexadecimal value. + ### Metadata Keys @@ -1798,30 +1861,6 @@ For example: Will cause text marked like so `**I am bold**` to be rendered in the presentation's smartmaster's "Accent 1" colour. -The values you can use for `BoldColour` and `ItalicColour` are: - -* NONE -* ACCENT 1 -* ACCENT 2 -* ACCENT 3 -* ACCENT 4 -* ACCENT 5 -* ACCENT 6 -* BACKGROUND 1 -* BACKGROUND 2 -* DARK 1 -* DARK 2 -* FOLLOWED HYPERLINK -* HYPERLINK -* LIGHT 1 -* LIGHT 2 -* TEXT 1 -* TEXT 2 -* MIXED - -As you can probably guess, these are standard values for python-pptx and, ultimately, PowerPoint. - -**Note:** For the values you can use any capitalisation you like (or none). e.g. `ItalicColor: dark 1`. #### Specifying Bold And Italic Text Effects With `BoldBold` And `ItalicItalic` @@ -2094,6 +2133,15 @@ You can specify the colour of cards' titles with `cardTitleColour`. For example: would set the cards' titles to the theme's "DARK 1" colour. +##### Card Divider Colour - `cardDividerColour` + + +You can specify the colour of lines between cards - if the `line` style is chosen. For example: + + CardLineColour: ACCENT 1 + +would set the lines between cards to the theme's "ACCENT 1" colour. + ##### Card Shadow - `CardShadow` diff --git a/user-guide.mdp b/user-guide.mdp index cce2bde..b05771f 100644 --- a/user-guide.mdp +++ b/user-guide.mdp @@ -8,6 +8,8 @@ This document describes the md2pptx &md; preprocessor, which turns &md; text int In this document we'll refer to it as "md2pptx", pronounced "em dee to pee pee tee ex". +As you can see in the [change log](#change-log), md2pptx is frequently updated - both for bug fixes and enhancements. + =toc 2 * &TOC; ## Why md2pptx? @@ -152,6 +154,7 @@ To quote from the python-pptx license statement: =colalign l r l =csv Level,Date,What +3.7,26 March 2023,Added [`cardDividerColour`](#card-divider-colour-carddividercolour). Most colours now RGB or Theme Colour (documented in [Specifying Colours](#specifying-colours)). 3.6,18 March 2023,Added [`cardTitleColour`](#card-title-colour-cardtitlecolour) & `line` for [`cardshape`](#card-shape-cardshape). Allow multiple colours for [`cardColour`](#card-background-colour-cardcolour). 3.5.2,14 March 2023,Added [`pageTitleAlign`](#page-title-alignment-pagetitlealign) - for content page title alignment. 3.5.1,3 March 2023,[`pageSubtitleSize`](#page-subtitle-size-pagesubtitlesize) supports `same` meaning "same font size as first line". @@ -749,6 +752,7 @@ You can control the exact format using many tweaks: * [Card Border Width](#card-border-width-cardborderwidth) * [Card Title Font Size](#card-title-size-cardtitlesize) * [Card Title Colour](#card-title-colour-cardtitlecolour) +* [Card Divider Colour](#card-divider-colour-carddividercolour) * [Card Shadow](#card-shadow-cardshadow) * [Card Size](#card-size-cardpercent) * [Card Layout Direction](#card-layout-direction-cardlayout) @@ -1519,6 +1523,67 @@ The default is not to hide such items. 1. Before the metadata table is created md2pptx will remove all but the title item in this slide. \ The one type of item that won't be removed is any Action Buttons. See [Sample Macro To Remove The First Slide](#sample-macro-to-remove-the-first-slide) for an example of where these might be useful. +#### Specifying Colours + + +In most places where you specify colours they can be of one of two forms: + +* A theme colour +* An RGB value + +##### Theme Colours + + +Powerpoint themes have named theme colours. \ +The names you can use with md2pptx are: + +* NONE +* ACCENT 1 +* ACCENT 2 +* ACCENT 3 +* ACCENT 4 +* ACCENT 5 +* ACCENT 6 +* BACKGROUND 1 +* BACKGROUND 2 +* DARK 1 +* DARK 2 +* FOLLOWED HYPERLINK +* HYPERLINK +* LIGHT 1 +* LIGHT 2 +* TEXT 1 +* TEXT 2 +* MIXED + +As you can probably guess, these are standard values for python-pptx and, ultimately, PowerPoint. + +Here is an example: + + BoldColour: ACCENT 1 + +This will give you more consistent colouring than [RGB Colours](#rgb-colours). + +**Note:** \ +For the values you can use any capitalisation you like (or none). e.g. `ItalicColor: dark 1`. + +##### RGB Colours + + +RGB stands for "Red, Green, and Blue". \ +You specify RGB values as 6 hexadecimal digits. \ +For example: + + ItalicColour: #FF0000 + +Each pair of hexadecimal digits represents Red, Green, and Blue, respectively. \ +Each is a hexadecimal encoding of 0-255, with 0 being "none of this colour" and 255 being "saturated in this colour". + +This will give you more precise colouring than [Theme Colours](#theme-colours). + +**Note:** \ +You must include the octothorpe (`#`) before the hexadecimal value. + ### Metadata Keys @@ -1808,31 +1873,6 @@ For example: Will cause text marked like so `**I am bold**` to be rendered in the presentation's smartmaster's "Accent 1" colour. -The values you can use for `BoldColour` and `ItalicColour` are: - -* NONE -* ACCENT 1 -* ACCENT 2 -* ACCENT 3 -* ACCENT 4 -* ACCENT 5 -* ACCENT 6 -* BACKGROUND 1 -* BACKGROUND 2 -* DARK 1 -* DARK 2 -* FOLLOWED HYPERLINK -* HYPERLINK -* LIGHT 1 -* LIGHT 2 -* TEXT 1 -* TEXT 2 -* MIXED - -As you can probably guess, these are standard values for python-pptx and, ultimately, PowerPoint. - -**Note:** \ -For the values you can use any capitalisation you like (or none). e.g. `ItalicColor: dark 1`. #### Specifying Bold And Italic Text Effects With `BoldBold` And `ItalicItalic` @@ -2126,6 +2166,16 @@ For example: would set the cards' titles to the theme's "DARK 1" colour. +##### Card Divider Colour - `cardDividerColour` + + +You can specify the colour of lines between cards - if the `line` style is chosen. \ +For example: + + CardLineColour: ACCENT 1 + +would set the lines between cards to the theme's "ACCENT 1" colour. + ##### Card Shadow - `CardShadow`CardShadow. For example: