HowTo install and run semAuth

semAuth is an xslt2 script. It has to be run from the command line in a batch process.

Install semAuth

  • Extract the zip file into your downloads directory, e.g. /home/you/downloads/ This will create a directory like /home/you/downloads/semAuth-06 or Win7: C:\Users\you\AppData\Local\Temp\semAuth06-yyyy-mm-dd
  • Move the extracted directory semAuth06-yyyy-mm-dd to a reasonable place in order to make to your semAuth working directory:
    • mv /home/you/downloads/semAuth06-yyyy-mm-dd /home/you/mySemAuth/
  • Change into your semAuth working directory:
    • cd /home/you/mySemAuth/
    Can you see the file semAuth.bat? Then anything went ok.

Install freemind

semAuth.xsl is a stand alone xslt tool. It is completely independend from any other other tool. Because of that you need a third party mindmap application to create and edit mindmaps.

We suggest to use freemind. It is available under GPL licence for the Win, Linux and Mac platform. Download and install freemind version 0.9 (not 0.8!) from http://freemind.sourceforge.net/. If you run freemind you will recognize that there are about 30 or 40 icons available, under them many flags and person icons.

After having installed freemind please locate your locall, user specific freemind configuration directory. Under linux this typically is the directory /home/you/.freemind , under Win7 this might be the directory C:\users\you\.freemind You are in the right directory if you can see e.g. the file auto.properties (auto.properties is the file where advanced users e.g. can modify directly their freemind keystrokes.)

semAuth brings some own icons with it. You have to add them to your freemind installation manually. This is rather simple:

  • If not already there allocate the new directory /home/you/.freemind/icons
  • Copy semAuth icons from your semAuth installation into this new icons directory: cp /home/you/mySemAuth/semAuthIcons/* /home/you/.freemind/icons/

Restart freemind. Now you should have about a dozend more icons available in the left toolbar.

Run the example file HelloWorld.mm:

  • Change into the directory /home/you/mySemAuth
  • You are in the right directory if you can see the batch file /home/you/mySemAuth/semAuth.bat and the directory /home/you/mySemAuth/examples/
  • Edit the mindmap examples/HelloWorld.mm with freemind. Save it again.
  • Run the batch file semAuthRdf.bat or semAuth.bat (depending whether you are using the RDF version - GPL license - or the OWL/ObjectLogic version - commercial license) from a command shell: 
                                     semAuthRdf.bat examples/HelloWorld.mm exampleResults
  • ()
    Note that in version semAuth v0.6 your output directory (here: exampleResults ) has to be a sibling of the directories /home/you/mySemAuth/xslt and /home/you/mySemAuth/java
  • Control the result:
    • Change into the output directory /home/you/mySemAuth/exampleResults . Here you will find an bunch of generated files, under them also the file exampleResults/HelloWorld.html
    • ()
      Note that the link to the file HelloWorld.html should not work unless you have sucessfully run the script as shown above.

How to re-produce this complete documentation:

  • Change (again) into the directory /home/you/mySemAuth
  • Edit (if you really want to) the mindmap examples/semauth06.mm
  • Run the batch file from a command shell: 
                                     semAuthRdf.bat examples/semauth06.mm semAuth
  • This documentation is compiled from a whole bunch of mindmaps within the example directory. Some of them are included automatically by the script.
  • Find the result in the directory semAuth

The zip file of our distribution comprises a set of example documents (i.e. commented ontologies). We here describe some of the contents of the files. To learn more about the variety of modelling styles we suggest you

  • to inspect each of the provided files with freemind
  • to translate the resepctive example file with semAuth into your work directory and compare the results with yur expectations
  • to modify the examples slightly and try out what happens