Skip to content

Commit

Permalink
clarify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Reagle committed Jun 25, 2012
1 parent 0a33a68 commit f2f1248
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 20 deletions.
1 change: 1 addition & 0 deletions class.dzslides
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ $endfor$
/* h1 can take children and become a traditional slide */
h1:not(:only-child) {
margin-top: -120px; /* at top of slide */
margin-left: 5px; margin-right: 5px;
margin-bottom: 20px;
font-size: 60px; /* give slide a little more room */
}
Expand Down
13 changes: 9 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@

This fork of dzslides includes a default `template.html` with a much wider range of slides types (e.g., traditional, Takahashi black and white; images with shadowed overlay, centered, floated left and right, etc.)

Furthermore, this template is trivially generated from a markdown file (`template.md`) using pandoc and *its* template `class.dzslides`. (**WARNING**: You must remove empty H1s (`<h1></h1>`) until this is fixed upstream; this is easy to do with `sed`.)
The [pandoc](http://johnmacfarlane.net/pandoc/README.html) markdown file (`template.md`) and pandoc template (`class.dzslides`) can be used to generate a [dzslides](http://paulrouget.com/dzslides/) deck (`template.html`). This generated deck includes a wider range of slides types than the default dzslides `template.html` (e.g., traditional, [Takahashi](http://en.wikipedia.org/wiki/Takahashi_method) black and white; images with shadowed overlay, centered, and floated left and right).

~~~~
pandoc --template=class.dzslides -t dzslides template.md \
| sed '/<h1><\/h1>/d' > template.html
~~~~

pandoc --template=class.dzslides -t dzslides template.md | sed '/<h1><\/h1>/d' > template.html
## Issues

~~~~
This is not so much a fork of dzslides, but a fork of pandoc's built-in dzslides. This means:

1. Newer functionality of dzslides (such as overview mode) doesn't work until pandoc's `$dzslides-core$` is updated to include it.
2. You must remove empty H1s (`<h1></h1>`) until this is fixed in pandoc; this is easy to do with `sed`, as above.
21 changes: 5 additions & 16 deletions template.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ <h1>Outline</h1>
</ul>
</section>
<section class="slide level1" id="section">

<h2 id="text-styles">Text Styles</h2>
</section>
<section class="slide level1" id="traditional-style">
Expand All @@ -33,45 +32,40 @@ <h1>Traditional Style</h1>
<h1>white/black <a href="http://en.wikipedia.org/wiki/Takahashi_method">Takahashi</a> style (single h1)</h1>
</section>
<section class="slide level1" id="section-1">

<h2 id="blackwhite-always-takashi-h2-w-no-children">black/white always Takashi (h2 w/ no children)</h2>
</section>
<section class="slide level1" id="traditional-w-quote">
<h1>Traditional w/ quote</h1>
<p>Some text followed by a blockquote.</p>
<blockquote>
<p>Whos brave enough to fly into something we all keep calling a death sphere?</p>
<p>Who's brave enough to fly into something we all keep calling a death sphere?</p>
</blockquote>
<p>With more text.</p>
</section>
<section class="slide level1" id="section-2">

<blockquote>
<p>Loneliness is everything its cracked up to be. — Alan Alda</p>
<p>Loneliness is everything it's cracked up to be. — Alan Alda</p>
<p>We are in paragraph elements.</p>
</blockquote>
</section>
<section class="slide level1" id="section-3">

<ul>
<li>A lone</li>
<li>unordered list</li>
<li>is just the thing</li>
</ul>
</section>
<section class="slide level1" id="section-4">

<h2 id="images">Images</h2>
</section>
<section class="slide level1" id="section-5">

<figure>
<img src="http://placekitten.com/g/800/600" alt="figcaption on image"><figcaption>figcaption on image</figcaption>
</figure>
<p><details>Kittens are so cute!</details></p>
</section>
<section class="slide level1" id="pimg-p-a">
<h1>(p&gt;img) + p A </h1>
<section class="slide level1" id="pimg-p-a-...">
<h1>(p&gt;img) + p A ...</h1>
<p><img src="http://nafcflying.org/images/Test%20Icon.jpg" alt="Alt"> </p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
</section>
Expand All @@ -89,15 +83,12 @@ <h1>Header with single img</h1>
<p><img src="http://nafcflying.org/images/Test%20Icon.jpg" alt="Alt"> </p>
</section>
<section class="slide level1" id="section-6">

<p><img src="http://nafcflying.org/images/Test%20Icon.jpg" alt="Alt"> </p>
</section>
<section class="slide level1" id="section-7">

<a title="By Gabriel Ehrnst GRUNDIN (Own work) [Public domain], via Wikimedia Commons" href="http://commons.wikimedia.org/wiki/File%3AFlag_of_Esperanto.svg"><img width="512" alt="Flag of Esperanto" src="http://upload.wikimedia.org/wikipedia/commons/thumb/f/f5/Flag_of_Esperanto.svg/512px-Flag_of_Esperanto.svg.png"/></a>
</section>
<section class="slide level1" id="section-8">

<figure>
<img src="http://www.cowboybooks.com.au/pictures/puppetmaster.jpg" alt="Or this?"><figcaption>Or this?</figcaption>
</figure>
Expand All @@ -107,19 +98,16 @@ <h1>Do you agree with the cultural imperialism thesis?</h1>
<p><a href="http://commons.wikimedia.org/wiki/File%3AQuestion_mark_alternate.svg" title="By User:Stannered [Public domain], via Wikimedia Commons"><img src="http://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Question_mark_alternate.svg/256px-Question_mark_alternate.svg.png" alt="Question"></a></p>
</section>
<section class="slide level1" id="section-9">

<h2 id="video">Video</h2>
</section>
<section class="slide level1" id="section-10">

<figure> <!-- Videos are automatically played -->

<video src="http://videos-cdn.mozilla.net/brand/Mozilla_Firefox_Manifesto_v0.2_640.webm" poster="http://www.mozilla.org/images/about/poster.jpg"></video> <figcaption>A video</figcaption>
</figure>

</section>
<section class="slide level1" id="section-11">

<iframe width="560" height="315" src="http://www.youtube.com/embed/mzPxo7Y6JyA" frameborder="0" allowfullscreen></iframe>
</section>
</section>
Expand Down Expand Up @@ -172,6 +160,7 @@ <h1>End!</h1>
/* h1 can take children and become a traditional slide */
h1:not(:only-child) {
margin-top: -120px; /* at top of slide */
margin-left: 5px; margin-right: 5px;
margin-bottom: 20px;
font-size: 60px; /* give slide a little more room */
}
Expand Down

0 comments on commit f2f1248

Please sign in to comment.