Skip to content

Latest commit

 

History

History
135 lines (94 loc) · 3.87 KB

readme.md

File metadata and controls

135 lines (94 loc) · 3.87 KB
Raw

External.js

This is a plugin for Reveal.js. It allows you to specify external files to be loaded into a presentation. This extension also allows external files in already external files (Subfiles). It allows a course, which may be hundreds of slides, to be broken into modules and managed individually.

Installation

There are several ways to install reveal_external:

  • The manual way: Download external/external.js and save it to your project structure
  • Install with bower: bower install reveal_external
  • Install with npm: npm install reveal_external

Example

Please find the example folder in this repository for a working demo presentation.

Using external.js

Using the plugin is easy. First, register it in your Reveal.js initialize block.

{ 
    src: 'plugin/external/external.js', 
    condition: function() { 
        return !!document.querySelector( '[data-external],[data-external-replace]' ); 
    } 
},

Then simply add an element into your presentation with a data-external or data-external-replace attribute.

data-external

Will put the loaded content into the node with the data-external attribute.

<section data-external="module_01/index.html"> </section>

data-external-replace

Will replace the node with the loaded content.

<section data-external-replace="module_02/index.html"> </section>

Load Fragments

You can specify a CSS selector to add only a part of the loaded content.

<section data-external-replace="short.html#.slides > section"> </section>

Options

external: {
    async: false,
    mapAttributes: ['src']
}

async

By default the external files will be loaded synchronously. This avoids conflicts with other plugins. You can activate asynchronous loading with this option.

mapAttributes

By default the plugin will convert relative paths (dot as first character) in src attributes. This allows you to specify the path relative to the file you're in, rather then the one it is included in.

Set to false to disable, or provide an array of attribute names.

Recursion

If you want to load external files, you have to choose relative paths in the "data-external*"-attribute. In the following there is a simple example of how to include many files in one reveal presentation:

Folder structure:

  • includes
    • chapter1
      • chapter1_1
        • index1_1.html
      • chapter1_2
        • index1_2.html
      • index_1.html
    • chapter_2
      • index_2.html
    • chapter_3
      • index_3.html
  • index.html

Code of index.html:

...
<div class="reveal">
    <!-- Any section element inside of this container is displayed as a slide -->

    <div class="slides">
         <section data-external="includes/chapter1/index_1.html"> </section>
         <section data-external="includes/chapter2/index_2.html"> </section>
         <section data-external="includes/chapter3/index_3.html"> </section>
    </div> <!-- slides -->

</div> <!-- Reveal -->
...

Now you may wish to include the subchapters 1.1 and 1.2 to the content of chapter 1. This would be the code of index_1.html:

...
	<section data-external="chapter1_1/index1_1.html"> </section>
	<section data-external="chapter1_2/index1_2.html"> </section>
...

Remember that all the paths entered in "data-external" were relative!

It is also possible to include files outside of section-tags, as this would result in seperate slides. If you don't want the included content to be a new slide, you can include the content to another element, too (e.g. a div).

...
	<div data-external="chapter1_1/index1_1.html"> </div>
...

Credits

By: Jan Schoepke, originally by Cal Evans. Thanks to Thomas Weinert for massive improvements in version 1.3!

License: MIT