Changeset 2191

Timestamp:

2006-03-15 20:49:15 (3 years ago)

Author:

cchiu

Message:

Updated documentation and and finalised release notes.

Files:

• AnnodexFirefoxExtension/trunk/Docs/DevDoc_MediaEngine.html (modified) (7 diffs)
• AnnodexFirefoxExtension/trunk/Docs/DevDoc_XULCore.html (modified) (4 diffs)
• AnnodexFirefoxExtension/trunk/Docs/Release_Notes.html (modified) (1 diff)
• AnnodexFirefoxExtension/trunk/Installer/WinSetup.bat (modified) (1 diff)
• AnnodexFirefoxExtension/trunk/LICENSE.txt (modified) (1 diff)

AnnodexFirefoxExtension/trunk/Docs/DevDoc_MediaEngine.html

@@ -44 +44 @@
-  </tr>
-  <tr>
-
-
-
+
+
-  </tr>
-</table>
@@ -115 +114 @@
-
-<p>The chrome and media engine are packaged as separate .XPIs. While the chrome 
-
+-
-operating system and CPU architecture. The two main components to AFE are as 
-follows:</p>
@@ -128 +127 @@
-  display. The chrome is platform-independent, and it registers itself with 
-  Mozilla as the handler for application/x-annodex, and it embeds the video 
-
+-
-  information implementing JavaScript's XML to RDF parser functions.<br>
-&nbsp;</li>
-  <li><b>Media Engine</b><br>
-
-
+-
+-
-  engine on all platforms, though this may change in the future. The video 
-
+-
-  Linux (x86 and PowerPC) and MacOS. Each media engine registers with Mozilla as 
-
+-
-  registered as application/x-annodex-vlc-viewer-plugin.</li>
-</ol>
@@ -145 +144 @@
-
-
-
+-
-playback of the video or audio file. Currently, VLC is used on all three 
-supported platforms (Windows, Linux, Mac OS X) as the media engine. You will 
-
+-
-work correctly. Without a media engine, you can download and view the CMML 
-content in the Table of Contents list for the video (as this is handled by the 
@@ -164 +163 @@
-&nbsp;</li>
-  <li>The Gecko (Mozilla) SDK, which includes some header files and utility 
-
+-
-        common to all the media engines, which contain Mozilla header files and 
-        tools that the plug-ins will require to compile correctly:<br>
@@ -195 +194 @@
-  <br>
-  See the toplevel README.txt file (the one in the main AnnodexFirefoxExtension/ 
-
+-
-        into an XPI.<br>
-  <br>
@@ -209 +208 @@
-provide prebuilt Gecko SDK binaries for those platforms for you.</p>
-<ul>
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-</ul>
-<blockquote>
-        <p>cd MediaEngine/VLC<br>./Patch<br>cd build<br>./Build<br>cd ..<br>./PrepareInstall.sh</p>
-</blockquote>
-<p>These steps will patch and build the VLC media engine, and put the needed 
-
-
-
-
-
+
+
+
+
+
+
-placed into the Installer directory. After making the XPIs using the scripts in 
-
-
+
+
+
+
+
+
+
-<h4><a name="2.1.2_Compiling_VLC_on_Linux">2.1.2 Compiling VLC on Linux</a></h4>
-
+-
-on Linux:</p>
-<ol>
-        <li>As mentioned above, ensure that you only have static libraries of 
-{ogg,theora,vorbis,speex}
-<br>
-'s fine (and much more sensible)
+ (ogg, theora, vorbis, speex)
+
+ is fine
-        against your distribution's packages rather than statically compiling them 
-        in.<br>
-&nbsp;</li>
- mozilla-config
-       plugin doesn't unnecessarily link against lib{plds4,plc4,nspr4,xpcom}
-
+<font face="Courier New"> mozilla-config</font>
+    plug-in doesn't unnecessarily link against lib (plds4, plc4, nspr4, xpcom)
+-
-        all, and causes problems because almost all end-users won't have those 
-        libraries installed in the locations you have them installed in.<br>
-        <br>
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-        the dynamic linker throwing an error.<br>
-        <br>
-
-
+
+
+
-        --libs mozilla&quot; doesn't produce the -l flags to link against those 
-
+
+
-        package is in your distribution (mozilla-dev) to ensure that those libraries 
-        are installed.<br>
-&nbsp;</li>
+    </ul>
+    </li>
-        <li>Be aware that if you are building an XPI intended to work across 
-        different distributions, you will want to statically link in libstdc++ (the 
-
-
-
+
+
+
+
+
+
+
-        and libstdc++6. This is taken care of in the Annodex patches to VLC; if you 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-        will try Xvideo then X11 (in that order) for video output. If you wish to 
-
-
-
+
+
+
+
-</ol>
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-</body>

AnnodexFirefoxExtension/trunk/Docs/DevDoc_XULCore.html

@@ -40 +40 @@
-  </tr>
-  <tr>
-
+
+
+
+
+
-  </tr>
-</table>
@@ -206 +210 @@
-
-<p>The chrome and media engine are packaged as separate .XPIs. While the chrome 
-
+-
-operating system and CPU architecture. The two main components to AFE are as 
-follows:</p>
@@ -218 +222 @@
-  display. The chrome is platform-independent, and it registers itself with 
-  Mozilla as the handler for application/x-annodex, and it embeds the video 
-in
+-ins
-  information implementing JavaScript's XML to RDF parser functions.<br>
-&nbsp;</li>
-  <li><b>Media Engine: </b>Refer to the Media Engine documentation for further 
-        details.<br>
-
-
+-
+-
-  engine on all platforms, though this may change in the future. The video 
-
+-
-  Linux (x86 and PowerPC) and MacOS. Each media engine registers with Mozilla as 
-
+-
-  registered as application/x-annodex-vlc-viewer-plugin. </li>
-</ol>
@@ -243 +247 @@
-        This is because all the XUL and the Javascript code is loaded into memory 
-        upon startup. The use of existing Javascript debuggers for Mozilla Firefox 
-
+-
-        trace the internal Javascript code.</li>
-</ol>
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-</body>

AnnodexFirefoxExtension/trunk/Docs/Release_Notes.html

@@ -9 +9 @@
-
-<h1>Annodex Firefox Extension Viewer (AFE): Release Notes</h1>
+
+
+<p>For further information about the development notes and documentation, refer 
+to relevant document on the Media Engine and XUL Core in the /Docs directory.</p>
-
-

AnnodexFirefoxExtension/trunk/Installer/WinSetup.bat

@@ -41 +41 @@
-@ echo ======================================================
-@ echo.
-     
-     
-     
+
+
+
-@ copy  /y "..\MediaEngines\VLC\bin-win32\npanxvlc.dll" "%ProgramFiles%\Mozilla Firefox\plugins\npanxvlc.dll"
-@ echo.

AnnodexFirefoxExtension/trunk/LICENSE.txt

@@ -24 +24 @@
-  Conrad Parker <Conrad.Parker@csiro.au>
-  Silvia Pfeiffer <Silvia.Pfeiffer@csiro.au>
+  Chris Chiu <Chris.Chiu@csiro.au>
-
-Alternatively, the contents of this file may be used under the terms of