Skip to content

Commit 0f173e6

Browse files
bertehberteh
committed
improve documentation
1 parent ab89c1c commit 0f173e6

File tree

3 files changed

+85
-46
lines changed

3 files changed

+85
-46
lines changed

‎MindSlide-Export.html

+41-26
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,9 @@ <h2>How To</h2>
189189
</li>
190190
<li>Install MindSlide<a href="#/ID_1405033759" class="link subsection"> &#8628;</a>
191191
</li>
192-
<li>Configure<a href="#/ID_1593867677" class="link subsection"> &#8628;</a>
192+
<li>Use MindSlide<a href="#/ID_1592220697" class="link subsection"> &#8628;</a>
193193
</li>
194-
<li>Hide Nodes<a href="#/ID_378704017" class="link subsection"> &#8628;</a>
195-
</li>
196-
<li>View Speakers Notes<a href="#/ID_1605694183" class="link subsection"> &#8628;</a>
194+
<li>Configure MindSlide<a href="#/ID_1593867677" class="link subsection"> &#8628;</a>
197195
</li>
198196
<li>Contribute / Contact<a href="#/ID_1128763901" class="link subsection"> &#8628;</a>
199197
</li>
@@ -236,37 +234,34 @@ <h3>Install MindSlide</h3>
236234
</pre>
237235
</li>
238236
<li>copy mindslide/mindslide.xsl, mindslide/config.xml and mindslide/reveal-configuration.xsl into your freeplane/resources/xslt directory</li>
239-
<li>launch freemind and select file &gt; export &gt; Using XSLT... &gt; MindeSlid Presentation (.html) to export your mindmap</li>
237+
</ul>
238+
</section>
239+
<section class="content" id="ID_1592220697">
240+
<h3>Use MindSlide</h3>
241+
<ul>
242+
<li>Easy as pie:</li>
243+
<li>launch freemind, edit your mindmap to your liking.</li>
240244
<li>
241245
<p>
242-
<b>save the HTML presentation in mindslide directory</b>! (for now)
246+
select <i>file &gt; export &gt; Animation MindSlide (.html)</i>&nbsp;to export your mindmap
243247
</p>
244248
</li>
245-
</ul>
246-
</section>
247-
<section class="content" id="ID_1593867677">
248-
<h3>Configure</h3>
249-
<ul>
250-
<li>Many options are available</li>
251-
<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>
252-
<li>developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too.</li>
253249
<li>
254-
<a href="https://github.com/hakimel/reveal.js#configuration" class="link external">see reveal.js configuration</a>
250+
<p>
251+
<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>
252+
</p>
253+
<a href="#/ID_1593867677" class="link connector"> &#8605;</a>
254+
</li>
255+
<li>Hide Nodes<a href="#/ID_378704017" class="link subsection"> &#8628;</a>
256+
</li>
257+
<li>View Speakers Notes<a href="#/ID_1605694183" class="link subsection"> &#8628;</a>
255258
</li>
256259
</ul>
257-
<div class="illustrations w1">
258-
<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>
259-
</div>
260-
<aside class="notes">
261-
<p>
262-
&nbsp;
263-
</p>
264-
</aside>
265260
</section>
266261
<section class="content" id="ID_378704017">
267-
<h3>Hide Nodes</h3>
262+
<h4>Hide Nodes</h4>
268263
<ul>
269-
<li>Great for creating content in Freeplane, and presenting only when it's ready.</li>
264+
<li>Great functionaliy for creating content in Freeplane, and presenting only when it's ready.</li>
270265
<li>
271266
<p>
272267
To hide a node from your mindslides simply add the attribute "slide-hide" to it:
@@ -291,8 +286,9 @@ <h3>Hide Nodes</h3>
291286
</aside>
292287
</section>
293288
<section class="content" id="ID_1605694183">
294-
<h3>View Speakers Notes</h3>
289+
<h4>View Speakers Notes</h4>
295290
<ul>
291+
<li>Including preview of the next slide, notes for current slide, and timer.</li>
296292
<li>
297293
<p>
298294
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>
310306
</li>
311307
</ul>
312308
</section>
309+
<section class="content" id="ID_1593867677">
310+
<h3>Configure MindSlide</h3>
311+
<ul>
312+
<li>Many options are available</li>
313+
<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>
314+
<li>developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too.</li>
315+
<li>
316+
<a href="https://github.com/hakimel/reveal.js#configuration" class="link external">see reveal.js configuration</a>
317+
</li>
318+
</ul>
319+
<div class="illustrations w1">
320+
<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>
321+
</div>
322+
<aside class="notes">
323+
<p>
324+
&nbsp;
325+
</p>
326+
</aside>
327+
</section>
313328
<section class="content" id="ID_1128763901">
314329
<h3>Contribute / Contact</h3>
315330
<ul>

‎MindSlide-Export.mm

+36-20
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,6 @@
150150
</p>
151151
</body>
152152
</html>
153-
154153
</richcontent>
155154
</node>
156155
<node ID="ID_765812044" CREATED="1377866554077" MODIFIED="1401984309302"><richcontent TYPE="NODE">
@@ -186,7 +185,6 @@
186185
</p>
187186
</body>
188187
</html>
189-
190188
</richcontent>
191189
<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"/>
192190
</node>
@@ -221,7 +219,6 @@
221219
</p>
222220
</body>
223221
</html>
224-
225222
</richcontent>
226223
</node>
227224
<node ID="ID_904082165" CREATED="1465150543428" MODIFIED="1465160670703"><richcontent TYPE="NODE">
@@ -236,7 +233,6 @@
236233
</p>
237234
</body>
238235
</html>
239-
240236
</richcontent>
241237
</node>
242238
<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
252248
</p>
253249
</body>
254250
</html>
255-
256251
</richcontent>
257252
</node>
258253
</node>
@@ -306,43 +301,41 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
306301
</richcontent>
307302
</node>
308303
<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"/>
309-
<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"/>
310-
<node ID="ID_765546127" CREATED="1378221476933" MODIFIED="1378383162779"><richcontent TYPE="NODE">
304+
</node>
305+
<node TEXT="Use MindSlide" ID="ID_1592220697" CREATED="1465162473408" MODIFIED="1465162589552">
306+
<node TEXT="Easy as pie:" ID="ID_445118759" CREATED="1465162491212" MODIFIED="1465162894153"/>
307+
<node TEXT="launch freemind, edit your mindmap to your liking." ID="ID_916240691" CREATED="1378221446025" MODIFIED="1465162526342"/>
308+
<node ID="ID_1269583054" CREATED="1465162527207" MODIFIED="1465162733776"><richcontent TYPE="NODE">
311309

312310
<html>
313311
<head>
314312

315313
</head>
316314
<body>
317315
<p>
318-
<b>save the HTML presentation in mindslide directory</b>! (for now)
316+
select <i>file &gt; export &gt; Animation MindSlide (.html)</i>&#160;to export your mindmap
319317
</p>
320318
</body>
321319
</html>
320+
322321
</richcontent>
323-
<font BOLD="false"/>
324322
</node>
325-
</node>
326-
<node TEXT="Configure" ID="ID_1593867677" CREATED="1377867328934" MODIFIED="1377867331019">
327-
<node TEXT="Many options are available" ID="ID_62454801" CREATED="1377867358677" MODIFIED="1377993859049"/>
328-
<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">
329-
<hook URI="assets/themes.jpg" SIZE="0.48640913" NAME="ExternalObject"/>
330-
<richcontent TYPE="NOTE">
323+
<node ID="ID_765546127" CREATED="1378221476933" MODIFIED="1465162830638"><richcontent TYPE="NODE">
331324

332325
<html>
333326
<head>
334327

335328
</head>
336329
<body>
337330
<p>
338-
&#160;
331+
<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>
339332
</p>
340333
</body>
341334
</html>
335+
342336
</richcontent>
343-
</node>
344-
<node TEXT="developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too." ID="ID_1691472387" CREATED="1379066226604" MODIFIED="1379066253209"/>
345-
<node TEXT="see reveal.js configuration" ID="ID_1201663334" CREATED="1377993908853" MODIFIED="1377993985014" LINK="https://github.com/hakimel/reveal.js#configuration"/>
337+
<font BOLD="false"/>
338+
<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"/>
346339
</node>
347340
<node TEXT="Hide Nodes" ID="ID_378704017" CREATED="1401981390393" MODIFIED="1401981798026"><richcontent TYPE="NOTE">
348341

@@ -360,7 +353,7 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
360353
</body>
361354
</html>
362355
</richcontent>
363-
<node TEXT="Great for creating content in Freeplane, and presenting only when it&apos;s ready." ID="ID_934607387" CREATED="1401982775751" MODIFIED="1401982777749">
356+
<node TEXT="Great functionaliy for creating content in Freeplane, and presenting only when it&apos;s ready." ID="ID_934607387" CREATED="1401982775751" MODIFIED="1465162858061">
364357
<node TEXT="Indeed" ID="ID_12152597" CREATED="1401982778911" MODIFIED="1401982789291">
365358
<attribute NAME="slide-hide" VALUE=""/>
366359
</node>
@@ -400,6 +393,7 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
400393
</node>
401394
</node>
402395
<node TEXT="View Speakers Notes" ID="ID_1605694183" CREATED="1378390526444" MODIFIED="1378391591570">
396+
<node TEXT="Including preview of the next slide, notes for current slide, and timer." ID="ID_996228764" CREATED="1465162982945" MODIFIED="1465163037591"/>
403397
<node ID="ID_254618814" CREATED="1378390551836" MODIFIED="1378392970150"><richcontent TYPE="NODE">
404398

405399
<html>
@@ -425,6 +419,28 @@ auto advancing slides (see <a href="https://github.com/hakimel/reveal.js#auto-sl
425419
</richcontent>
426420
</node>
427421
</node>
422+
</node>
423+
<node TEXT="Configure MindSlide" ID="ID_1593867677" CREATED="1377867328934" MODIFIED="1465162622225">
424+
<node TEXT="Many options are available" ID="ID_62454801" CREATED="1377867358677" MODIFIED="1377993859049"/>
425+
<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">
426+
<hook URI="assets/themes.jpg" SIZE="0.48640913" NAME="ExternalObject"/>
427+
<richcontent TYPE="NOTE">
428+
429+
<html>
430+
<head>
431+
432+
</head>
433+
<body>
434+
<p>
435+
&#160;
436+
</p>
437+
</body>
438+
</html>
439+
</richcontent>
440+
</node>
441+
<node TEXT="developpers may load extra librairies by editing reveal-configuration.xsl in freeplane/xslt too." ID="ID_1691472387" CREATED="1379066226604" MODIFIED="1379066253209"/>
442+
<node TEXT="see reveal.js configuration" ID="ID_1201663334" CREATED="1377993908853" MODIFIED="1377993985014" LINK="https://github.com/hakimel/reveal.js#configuration"/>
443+
</node>
428444
<node TEXT="Contribute / Contact" ID="ID_1128763901" CREATED="1377867379405" MODIFIED="1377991801097">
429445
<node TEXT="Contributions are welcome in all kinds:" ID="ID_756109089" CREATED="1377867407739" MODIFIED="1378374264424"/>
430446
<node TEXT="Share your ideas" ID="ID_1278307251" CREATED="1377867391933" MODIFIED="1377991159466" LINK="https://github.com/berteh/mindslide/issues"/>

‎README.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#Mindslide
2+
#Mindslide
23

34
View mindmap as an HTML animation / presentation (aka Freeplane/Freemind to powerpoint slideshow).
45

@@ -11,6 +12,13 @@ Mindslide is an export extension for [Freeplane](http://sourceforge.net/projects
1112
- [Install](http://berteh.github.io/mindslide/#/ID_1405033759)
1213
- [Contribute](http://berteh.github.io/mindslide/#/ID_1128763901)
1314

15+
Using Mindslide is then easy as pie:
16+
- launch freemind, edit your mindmap to your liking.
17+
- select file > export > Animation MindSlide (.html) to export your mindmap
18+
- save the HTML presentation in mindslide directory! (or edit settings in config.xml to use the CDN as base directory)
19+
20+
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.
21+
1422

1523
## Help and support
1624

0 commit comments

Comments
 (0)