diff --git a/README.md b/README.md index 20db06c..8affff4 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,222 @@ This app has the following default slide separators: - Horizontal separator: `---` (`← →`) - Vertical separator: `--` (`↓ ↑`) +## Using Templates + +To use the templates in the presentation viewer, use the front matter to provide default metadata followed by slide +contents. + +The front matter is used to define the default values for the presentation and will be applied to every slides. The +default metadata can be defined as below: + +```markdown +--- +slide: +presenter: +logo: +color: +footer: +aboutUs: + - title: + text: + - title: + text: + - title: + text: +--- +``` + +These are the supported metadata required for the presentation template. + +| Default Metadata | Description | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `slide` | Default slide for presentation. Most used slide template can be given in the default metadata. | +| `presenter` | Name of the presenter. | +| `logo` | Logo appears on the top right corner of the slide. The logo path should be relative to the markdown file. | +| `color` | Font color of the slide title. | +| `footer` | Content to be shown in the footer of the slide. | +| `aboutUs` | Column wise content to be shown in the about-us slide. Use this metadata only if about-us slide is used for the presentation. More [here](#slide-about-us) | +| `aboutUs:title` | Title for each column in about-us slide. | +| `aboutUs:text` | Text under each title for column in about-us slide. | + +Following the front matter, create slides as described in [Creating Presentation](#creating-presentation) + +Besides default metadata, you can also provide inline metadata for each slide. This will be useful when you want to +override the default metadata for a specific slide and this will be applied to that slide only. The inline metadata can +be defined by adding metadata directly on the slide title as below: + +```markdown +# Title of the slide ::metadata_key_1:metadata_value_1 ::metadata_key_2:metadata_value_2 +``` + +Example: +```markdown +# Title of slide ::slide:title-content-image ::logo:logo.png +``` + +For this slide, the `slide` template will be set to `title-content-image`, and the `logo` will be set to `logo.png`. + +### Slide Templates + +The slide template should be provided in the default metadata. The slide type set in the default metadata will be used as the default. The mostly used slide template can be set as default. When you set a slide template in the default metadata, you don’t need to specify the slide type again in the inline metadata for slides that are already defined in the default metadata. + +| Slide Template | Desctiption | Usage | +|-----------------------|-----------------------------------------------------------------------------------|-------------------------------| +| `cover` | This slide template can be used for cover slide | `::slide:cover` | +| `title-content` | A slide with a title and some content (the content can also be an image) | `::slide:title-content` | +| `title-content-image` | A slide with a title, and content on the left side and an image on the right side | `::slide:title-content-image` | +| `about-us` | The slide with about-us info (e.g., Values, mission, Vision) | `::slide:about-us` | + +#### Slide "Cover" + +Code: + +```markdown +# TITLE ::slide:cover +``` + +Preview: + +```text +┌────────────────────────────────────────────────────┐ +│ │ +│ │ +│ LOGO │ +│ TITLE │ +│ PRESENTER NAME │ +│ │ +│ │ +├────────────────────────────────────────────────────┤ +│ LOGO │ +└────────────────────────────────────────────────────┘ +``` + +#### Slide "title-content" + +Code: + +```markdown +# TITLE ::slide:title-content + +CONTENT +``` + +Preview: + +```text +┌────────────────────────────────────────────────────┐ +│ TITLE LOGO │ +├────────────────────────────────────────────────────┤ +│ │ +│ │ +│ CONTENT │ +│ │ +│ │ +├────────────────────────────────────────────────────┤ +│ FOOTER PAGENR │ +└────────────────────────────────────────────────────┘ +``` + +Image can also be included in the content of the slide. + +Code: + +```markdown +# TITLE ::slide:title-content + +CONTENT + +![This is image description](./image.png) +``` + +Preview: + +```text +┌────────────────────────────────────────────────────┐ +│ TITLE LOGO │ +├────────────────────────────────────────────────────┤ +│ CONTENT │ +├────────────────────────────────────────────────────┤ +│ │ +│ IMAGE │ +│ │ +├────────────────────────────────────────────────────┤ +│ FOOTER PAGENR │ +└────────────────────────────────────────────────────┘ +``` + +#### Slide "title-content-image" + +Code: + +```markdown +# TITLE ::slide:title-content-image + +CONTENT + +![This is image description](image.png) +``` + +Preview: + +```text +┌────────────────────────────────────────────────────┐ +│ TITLE LOGO │ +├──────────────────────────┬─────────────────────────┤ +│ │ │ +│ │ │ +│ CONTENT │ IMAGE │ +│ │ │ +│ │ │ +├──────────────────────────┴─────────────────────────┤ +│ FOOTER PAGENR │ +└────────────────────────────────────────────────────┘ +``` + +#### Slide "about-us" + +Code: + +```markdown +# TITLE ::slide:about-us + +CONTENT +``` + +The `title` and `text` can be provided via default metadata in front matter as: + +```markdown +--- +aboutUs: + - title: Title 1 + text: Some text under title 1 + - title: Title 2 + text: Some text under title 2 + - title: Title 3 + text: Some text under title 3 +--- +``` + +Preview: + +```text +┌────────────────────────────────────────────────────┐ +│ TITLE LOGO │ +├────────────────────────────────────────────────────┤ +│ │ +│ ┌────────────────────────────────────────────┐ │ +│ │ CONTENT │ │ +│ └────────────────────────────────────────────┘ │ +│ ┌────────┐ │ ┌────────┐ │ ┌────────┐ │ +│ │ TITLE │ │ │ TITLE │ │ │ TITLE │ │ +│ │ TEXT │ │ │ TEXT │ │ │ TEXT │ │ +│ └────────┘ │ └────────┘ │ └────────┘ │ +│ │ +├────────────────────────────────────────────────────┤ +│ FOOTER PAGENR │ +└────────────────────────────────────────────────────┘ +``` + ## Development > [!IMPORTANT] When switching between OpenCloud and oCIS, make sure to clean the browser cache! diff --git a/public/templates/about-us-template.html b/public/templates/about-us-template.html new file mode 100644 index 0000000..7524a3d --- /dev/null +++ b/public/templates/about-us-template.html @@ -0,0 +1,40 @@ + diff --git a/public/templates/cover-template.html b/public/templates/cover-template.html new file mode 100644 index 0000000..b040ced --- /dev/null +++ b/public/templates/cover-template.html @@ -0,0 +1,16 @@ + diff --git a/public/templates/title-content-image-template.html b/public/templates/title-content-image-template.html new file mode 100644 index 0000000..07d97e3 --- /dev/null +++ b/public/templates/title-content-image-template.html @@ -0,0 +1,26 @@ + diff --git a/public/templates/title-content-template.html b/public/templates/title-content-template.html new file mode 100644 index 0000000..07d97e3 --- /dev/null +++ b/public/templates/title-content-template.html @@ -0,0 +1,26 @@ + diff --git a/src/App.vue b/src/App.vue index 38242db..d13fadd 100644 --- a/src/App.vue +++ b/src/App.vue @@ -1,6 +1,7 @@