From 0f173e6a394c1a54cac61c43672b83c1ecdabd8c Mon Sep 17 00:00:00 2001
From: berteh <berteh@gmail.com>
Date: Sun, 5 Jun 2016 23:49:55 +0200
Subject: [PATCH] improve documentation

---
 MindSlide-Export.html | 67 ++++++++++++++++++++++++++-----------------
 MindSlide-Export.mm   | 56 +++++++++++++++++++++++-------------
 README.md             |  8 ++++++
 3 files changed, 85 insertions(+), 46 deletions(-)

diff --git a/MindSlide-Export.html b/MindSlide-Export.html
index 5a4bea1..65ab4d4 100644
--- a/MindSlide-Export.html
+++ b/MindSlide-Export.html
@@ -189,11 +189,9 @@ <h2>How To</h2>
 </li>
 <li>Install MindSlide<a href="#/ID_1405033759" class="link subsection"> &#8628;</a>
 </li>
-<li>Configure<a href="#/ID_1593867677" class="link subsection"> &#8628;</a>
+<li>Use MindSlide<a href="#/ID_1592220697" class="link subsection"> &#8628;</a>
 </li>
-<li>Hide Nodes<a href="#/ID_378704017" class="link subsection"> &#8628;</a>
-</li>
-<li>View Speakers Notes<a href="#/ID_1605694183" class="link subsection"> &#8628;</a>
+<li>Configure MindSlide<a href="#/ID_1593867677" class="link subsection"> &#8628;</a>
 </li>
 <li>Contribute / Contact<a href="#/ID_1128763901" class="link subsection"> &#8628;</a>
 </li>
@@ -236,37 +234,34 @@ <h3>Install MindSlide</h3>
 </pre>
 </li>
 <li>copy mindslide/mindslide.xsl, mindslide/config.xml and mindslide/reveal-configuration.xsl into your freeplane/resources/xslt directory</li>
-<li>launch freemind and select file &gt; export &gt; Using XSLT... &gt; MindeSlid Presentation (.html) to export your mindmap</li>
+</ul>
+</section>
+<section class="content" id="ID_1592220697">
+<h3>Use MindSlide</h3>
+<ul>
+<li>Easy as pie:</li>
+<li>launch freemind, edit your mindmap to your liking.</li>
 <li>
 <p>
-<b>save the HTML presentation in mindslide directory</b>! (for now)
+      select <i>file &gt; export &gt; Animation MindSlide (.html)</i>&nbsp;to export your mindmap
     </p>
 </li>
-</ul>
-</section>
-<section class="content" id="ID_1593867677">
-<h3>Configure</h3>
-<ul>
-<li>Many options are available</li>
-<li>edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality.</li>
-<li>developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too.</li>
 <li>
-<a href="https://github.com/hakimel/reveal.js#configuration" class="link external">see reveal.js configuration</a>
+<p>
+<b>save the HTML presentation in mindslide directory</b>! <small>(or edit settings in config.xml to use the online CDN as base directory)</small>
+</p>
+<a href="#/ID_1593867677" class="link connector"> &#8605;</a>
+</li>
+<li>Hide Nodes<a href="#/ID_378704017" class="link subsection"> &#8628;</a>
+</li>
+<li>View Speakers Notes<a href="#/ID_1605694183" class="link subsection"> &#8628;</a>
 </li>
 </ul>
-<div class="illustrations w1">
-<a href="assets/themes.jpg" class="image" title="edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality."><img src="assets/themes.jpg" alt="edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality."></a>
-</div>
-<aside class="notes">
-<p>
-      &nbsp;
-    </p>
-</aside>
 </section>
 <section class="content" id="ID_378704017">
-<h3>Hide Nodes</h3>
+<h4>Hide Nodes</h4>
 <ul>
-<li>Great for creating content in Freeplane, and presenting only when it's ready.</li>
+<li>Great functionaliy for creating content in Freeplane, and presenting only when it's ready.</li>
 <li>
 <p>
       To hide a node from your mindslides simply add the attribute "slide-hide" to it:
@@ -291,8 +286,9 @@ <h3>Hide Nodes</h3>
 </aside>
 </section>
 <section class="content" id="ID_1605694183">
-<h3>View Speakers Notes</h3>
+<h4>View Speakers Notes</h4>
 <ul>
+<li>Including preview of the next slide, notes for current slide, and timer.</li>
 <li>
 <p>
       Speaker notes require the presentation be served by a <b>webserver</b>, they don't work from a local file.
@@ -310,6 +306,25 @@ <h3>View Speakers Notes</h3>
 </li>
 </ul>
 </section>
+<section class="content" id="ID_1593867677">
+<h3>Configure MindSlide</h3>
+<ul>
+<li>Many options are available</li>
+<li>edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality.</li>
+<li>developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too.</li>
+<li>
+<a href="https://github.com/hakimel/reveal.js#configuration" class="link external">see reveal.js configuration</a>
+</li>
+</ul>
+<div class="illustrations w1">
+<a href="assets/themes.jpg" class="image" title="edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality."><img src="assets/themes.jpg" alt="edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality."></a>
+</div>
+<aside class="notes">
+<p>
+      &nbsp;
+    </p>
+</aside>
+</section>
 <section class="content" id="ID_1128763901">
 <h3>Contribute / Contact</h3>
 <ul>
diff --git a/MindSlide-Export.mm b/MindSlide-Export.mm
index acc06a0..c28eb33 100755
--- a/MindSlide-Export.mm
+++ b/MindSlide-Export.mm
@@ -150,7 +150,6 @@
     </p>
   </body>
 </html>
-
 </richcontent>
 </node>
 <node ID="ID_765812044" CREATED="1377866554077" MODIFIED="1401984309302"><richcontent TYPE="NODE">
@@ -186,7 +185,6 @@
     </p>
   </body>
 </html>
-
 </richcontent>
 <arrowlink SHAPE="CUBIC_CURVE" COLOR="#000000" WIDTH="2" TRANSPARENCY="80" FONT_SIZE="9" FONT_FAMILY="SansSerif" DESTINATION="ID_1494003336" STARTINCLINATION="299;-5;" ENDINCLINATION="590;0;" STARTARROW="NONE" ENDARROW="DEFAULT"/>
 </node>
@@ -221,7 +219,6 @@
     </p>
   </body>
 </html>
-
 </richcontent>
 </node>
 <node ID="ID_904082165" CREATED="1465150543428" MODIFIED="1465160670703"><richcontent TYPE="NODE">
@@ -236,7 +233,6 @@
     </p>
   </body>
 </html>
-
 </richcontent>
 </node>
 <node TEXT="slides shuffling" ID="ID_897064875" CREATED="1465150601857" MODIFIED="1465150637310"/>
@@ -252,7 +248,6 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
     </p>
   </body>
 </html>
-
 </richcontent>
 </node>
 </node>
@@ -306,8 +301,11 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
 </richcontent>
 </node>
 <node TEXT="copy mindslide/mindslide.xsl, mindslide/config.xml and mindslide/reveal-configuration.xsl into your freeplane/resources/xslt directory" ID="ID_1487207699" CREATED="1378221411490" MODIFIED="1379066167787"/>
-<node TEXT="launch freemind and select file &gt; export &gt; Using XSLT... &gt; MindeSlid Presentation (.html) to export your mindmap" ID="ID_916240691" CREATED="1378221446025" MODIFIED="1378376960147"/>
-<node ID="ID_765546127" CREATED="1378221476933" MODIFIED="1378383162779"><richcontent TYPE="NODE">
+</node>
+<node TEXT="Use MindSlide" ID="ID_1592220697" CREATED="1465162473408" MODIFIED="1465162589552">
+<node TEXT="Easy as pie:" ID="ID_445118759" CREATED="1465162491212" MODIFIED="1465162894153"/>
+<node TEXT="launch freemind, edit your mindmap to your liking." ID="ID_916240691" CREATED="1378221446025" MODIFIED="1465162526342"/>
+<node ID="ID_1269583054" CREATED="1465162527207" MODIFIED="1465162733776"><richcontent TYPE="NODE">
 
 <html>
   <head>
@@ -315,19 +313,14 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
   </head>
   <body>
     <p>
-      <b>save the HTML presentation in mindslide directory</b>! (for now)
+      select <i>file &gt; export &gt; Animation MindSlide (.html)</i>&#160;to export your mindmap
     </p>
   </body>
 </html>
+
 </richcontent>
-<font BOLD="false"/>
 </node>
-</node>
-<node TEXT="Configure" ID="ID_1593867677" CREATED="1377867328934" MODIFIED="1377867331019">
-<node TEXT="Many options are available" ID="ID_62454801" CREATED="1377867358677" MODIFIED="1377993859049"/>
-<node TEXT="edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality." ID="ID_1538743762" CREATED="1377993859657" MODIFIED="1379066223883">
-<hook URI="assets/themes.jpg" SIZE="0.48640913" NAME="ExternalObject"/>
-<richcontent TYPE="NOTE">
+<node ID="ID_765546127" CREATED="1378221476933" MODIFIED="1465162830638"><richcontent TYPE="NODE">
 
 <html>
   <head>
@@ -335,14 +328,14 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
   </head>
   <body>
     <p>
-      &#160;
+      <b>save the HTML presentation in mindslide directory</b>! <small>(or edit settings in config.xml to use the online CDN as base directory)</small>
     </p>
   </body>
 </html>
+
 </richcontent>
-</node>
-<node TEXT="developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too." ID="ID_1691472387" CREATED="1379066226604" MODIFIED="1379066253209"/>
-<node TEXT="see reveal.js configuration" ID="ID_1201663334" CREATED="1377993908853" MODIFIED="1377993985014" LINK="https://github.com/hakimel/reveal.js#configuration"/>
+<font BOLD="false"/>
+<arrowlink SHAPE="CUBIC_CURVE" COLOR="#000000" WIDTH="2" TRANSPARENCY="80" FONT_SIZE="9" FONT_FAMILY="SansSerif" DESTINATION="ID_1593867677" STARTINCLINATION="598;0;" ENDINCLINATION="598;0;" STARTARROW="NONE" ENDARROW="DEFAULT"/>
 </node>
 <node TEXT="Hide Nodes" ID="ID_378704017" CREATED="1401981390393" MODIFIED="1401981798026"><richcontent TYPE="NOTE">
 
@@ -360,7 +353,7 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
   </body>
 </html>
 </richcontent>
-<node TEXT="Great for creating content in Freeplane, and presenting only when it&apos;s ready." ID="ID_934607387" CREATED="1401982775751" MODIFIED="1401982777749">
+<node TEXT="Great functionaliy for creating content in Freeplane, and presenting only when it&apos;s ready." ID="ID_934607387" CREATED="1401982775751" MODIFIED="1465162858061">
 <node TEXT="Indeed" ID="ID_12152597" CREATED="1401982778911" MODIFIED="1401982789291">
 <attribute NAME="slide-hide" VALUE=""/>
 </node>
@@ -400,6 +393,7 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
 </node>
 </node>
 <node TEXT="View Speakers Notes" ID="ID_1605694183" CREATED="1378390526444" MODIFIED="1378391591570">
+<node TEXT="Including preview of the next slide, notes for current slide, and timer." ID="ID_996228764" CREATED="1465162982945" MODIFIED="1465163037591"/>
 <node ID="ID_254618814" CREATED="1378390551836" MODIFIED="1378392970150"><richcontent TYPE="NODE">
 
 <html>
@@ -425,6 +419,28 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
 </richcontent>
 </node>
 </node>
+</node>
+<node TEXT="Configure MindSlide" ID="ID_1593867677" CREATED="1377867328934" MODIFIED="1465162622225">
+<node TEXT="Many options are available" ID="ID_62454801" CREATED="1377867358677" MODIFIED="1377993859049"/>
+<node TEXT="edit the config.xml in your freeplane/xslt directory (or the exported .html presentation file) for your prefered theme, transition, extra behaviour or functionality." ID="ID_1538743762" CREATED="1377993859657" MODIFIED="1379066223883">
+<hook URI="assets/themes.jpg" SIZE="0.48640913" NAME="ExternalObject"/>
+<richcontent TYPE="NOTE">
+
+<html>
+  <head>
+    
+  </head>
+  <body>
+    <p>
+      &#160;
+    </p>
+  </body>
+</html>
+</richcontent>
+</node>
+<node TEXT="developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too." ID="ID_1691472387" CREATED="1379066226604" MODIFIED="1379066253209"/>
+<node TEXT="see reveal.js configuration" ID="ID_1201663334" CREATED="1377993908853" MODIFIED="1377993985014" LINK="https://github.com/hakimel/reveal.js#configuration"/>
+</node>
 <node TEXT="Contribute / Contact" ID="ID_1128763901" CREATED="1377867379405" MODIFIED="1377991801097">
 <node TEXT="Contributions are welcome in all kinds:" ID="ID_756109089" CREATED="1377867407739" MODIFIED="1378374264424"/>
 <node TEXT="Share your ideas" ID="ID_1278307251" CREATED="1377867391933" MODIFIED="1377991159466" LINK="https://github.com/berteh/mindslide/issues"/>
diff --git a/README.md b/README.md
index 5cadd90..abf1722 100755
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 #Mindslide
+#Mindslide
 
 View mindmap as an HTML animation / presentation (aka Freeplane/Freemind to powerpoint slideshow).
 
@@ -11,6 +12,13 @@ Mindslide is an export extension for [Freeplane](http://sourceforge.net/projects
 - [Install](http://berteh.github.io/mindslide/#/ID_1405033759)
 - [Contribute](http://berteh.github.io/mindslide/#/ID_1128763901)
 
+Using Mindslide is then easy as pie:
+- launch freemind, edit your mindmap to your liking.
+- select file > export > Animation MindSlide (.html) to export your mindmap
+- save the HTML presentation in mindslide directory! (or edit settings in config.xml to use the CDN as base directory)
+
+More information for additional features [online]((http://berteh.github.io/mindslide/#/ID_1592220697), such as hiding nodes (or drafts) from your mindmap, or using speaker notes.
+
 
 ## Help and support