From 100e0df5ef558faa1ff1c3cbc85138576e71d6ee Mon Sep 17 00:00:00 2001
From: Fabien Benetou <fabien.benetou.fr>
Date: Fri, 29 Jul 2011 13:13:40 +0200
Subject: [PATCH] clarified documentation and added backlink

---
 pmwiki_recipes/pim_functions.php | 29 ++++++++++++++++++-----------
 1 file changed, 18 insertions(+), 11 deletions(-)

diff --git a/pmwiki_recipes/pim_functions.php b/pmwiki_recipes/pim_functions.php
index 186b99e..14ee612 100644
--- a/pmwiki_recipes/pim_functions.php
+++ b/pmwiki_recipes/pim_functions.php
@@ -165,22 +165,29 @@ textFont(font);
         $older_gnuplot_version = "<div><center><img src=\"/pub/visualization/edits_per_page/{$pagename}.png\" alt=\"/pub/visualization/edits_per_page/{$pagename}.png\"/></br>(<a href=\"$ScriptUrl/Wiki/Visualization#timeline\">visualization details</a>).</center></div><hr />";
 }
 
-// generated via e.g.
-// P=ReadingNotes.TheThingsWeDo; grep ^text= $P | sed "s/%0a/\\n/g" | sed "s/[^a-zA-Z]/ /g" > $P.txt && espeak -f $P.txt -w ../pub/audio/$P.wav && oggenc ../pub/audio/$P.wav && rm ../pub/audio/$P.wav $P.txt
-// note that the output could be improved by better parsing and exploring SSML/HTML support
-// details on the HTML markup
-//	https://developer.mozilla.org/en/HTML/Element/audio
-//	http://www.w3.org/TR/html5/video.html#attr-media-controls
+/*
+details at http://fabien.benetou.fr/MemoryRecalls/ImprovingPIM#AudioPIM
+	generated via e.g.
+		P=ReadingNotes.TheThingsWeDo; grep ^text= $P | sed "s/%0a/\\n/g" | sed "s/[^a-zA-Z]/ /g" > $P.txt && espeak -f $P.txt -w ../pub/audio/$P.wav && oggenc ../pub/audio/$P.wav && rm ../pub/audio/$P.wav $P.txt
+	note that the output could be improved by better parsing and exploring SSML/HTML support
+	details on the HTML markup
+		https://developer.mozilla.org/en/HTML/Element/audio
+		http://www.w3.org/TR/html5/video.html#attr-media-controls
+*/
 function DisplayAudio($pagename){
         global $ScriptUrl, $PubDir, $FarmD;
 	$audiofile = $FarmD."/pub/audio/".$pagename.".ogg";
 	$audiourl = $ScriptUrl."/pub/audio/".$pagename.".ogg";
 	if (file_exists($audiofile))
-		print "<div width=\"100px\"><a name=\"audiodisplay\">
-<audio width=\"100\" controls=\"controls\" >
-<source src=\"$audiourl\"  type=\"audio/ogg\"  />
-Your browser does not allow HTML5 audio.</audio>
-</a></br>Download the <a href=\"$audiourl\">audio file (ogg)</a> to play later.</div>";
+		print "
+<div width=\"100px\"><a name=\"DisplayAudio\">
+	<audio width=\"100\" controls=\"controls\" >
+		<source src=\"$audiourl\"  type=\"audio/ogg\"  />
+		Your browser does not allow HTML5 audio.
+	</audio>
+	</a></br>Download the <a href=\"$audiourl\">audio file (ogg)</a> to play later
+	(see <a href=\"$ScriptUrl/MemoryRecalls/ImprovingPIM#AudioPIM\">details</a>).
+</div>";
 }
 
 //display images with transparancy invertionnaly proportional to last time of update