Anleitung zur Verwendung des MIPMs ausserhalb von Math&Industry ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Bei der Erstellung der MIPM-Tools wurde weitgehend darauf geachtet, sie spaeter auch ausserhalb von Math&Industry einsetzen zu koennen. Zu den normalen Konfigurierungsmoeglichkeiten lesen Sie bitte die README-Datei des entsprechenden MIPMs. Einige Dinge wurden jedoch mit Ruecksicht auf den dabei entstehenden Aufwand nicht konfigurierbar gehalten, bzw. sind nur konfigurierbar durch kleine Aenderungen am Programmcode. In dieser Datei sind nun alle noetigen bzw. moeglichen Schritte beschrieben um die MIPMs ausserhalb von Math&Industry einzusetzen. Es wird dabei weiterhin davon ausgegangen, dass Sie die Software in einem Projektzusammenhang einsetzen. Falls nicht, werden noch weitergehende Aenderungen in den Eingabeformularen, der XHTML-Erzeugung und den RDF-Metadaten noetig. Vor allem wuerde dann eine Ueberarbeitung der Application-Profiles (den Metadatenstrukturen) notwendig. 1. Generelle Aenderungen 1.1 Kopfzeile der MIPM-Tools 1.2 Zielverzeichnis eines MIPM-Tools 1.3 Hinweis auf 'toolmaster[at]mathematik-21.de' 2. Aenderung der XHTML-Ausgabe 2.1 Allgemein 2.2 MIPMGlossary 3. Aenderung der RDF-Metadaten 3.1 Allgemein 3.1.1 Erstellung des RDF 3.1.2 Lesen des RDF 3.2 MIPMGlossary 3.2.1 Erstellung des RDF 3.2.2 Lesen des RDF 4. Aenderungen in der Hilfe 4.1 Versionierung 4.2 Aenderungen im Text ---------------------------------------------------- 1. Generelle Aenderungen ~~~~~~~~~~~~~~~~~~~~~~~~ 1.1 Kopfzeile der MIPM-Tools Wenn Sie in der Kopfzeile den Namen des MIPMs aendern wollen, muessen Sie dies in der Variable $appTitle in der Datei MIPM*.cgi machen. 1.2 Zielverzeichnis eines MIPM-Tools Um den Verzeichnisnamen zu aendern in dem die MIPMs (ausser MIPMText und MIPMLinks) ihre Dateien schreiben, aendern Sie in MIPM*.cgi die Variable $LOCALDIR. 1.3 Hinweis auf 'toolmaster[at]mathematik-21.de' Auf der Startseite der MIPMs findet sich der Hinweis "Senden Sie bitte Kommentare und Fragen an toolmaster[at]mathematik-21.de." Diesen Hinweis aendern sie bitte in der CGI-Datei des jeweiligen MIPMs in der Funktion front_side(). 2. Aenderung der XHTML-Ausgabe ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2.1 Allgemein Anderungen am Layout der XHTML-Ausgabe muessen Sie in dem Funktions-Modul des jeweiligen MIPMs in der Funktion create_html() vornehmen. Um die Erscheinung der Uebersichtsdatei anzupassen, aendern Sie bitte create_html_overview(). Im Paket MTool::Base befindet sich die Datei mipm.css. Dort sind mittels CSS alle algemeinen Formatierungen festgelegt. Folgende Klassen werden verwendet (teilweise nur von einzelnen MIPMs): button buttondummy mipm_glossary_term mipm_itemheading mipm_line1 mipm_line2 mipm_line4 mipm_line8 mipm_overview_list mipm_table_border mipm_table_cell mipm_table_link mipm_table_title mipm_title mipm_subtitle navitemright radio radio1 redstar style3 tabbor tabbor1 2.2 MIPMGlossary Anderungen am Layout der XHTML-Ausgabe muessen Sie in der Methode create_html() in der Datei Vocabulary.pm vornehmen. Um die Erscheinung der Uebersichtsdatei anzupassen, aendern Sie bitte create_html_overview() in MIPMGlossary*.cgi. 3. Aenderung der RDF-Metadaten ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3.1 Allgemein ============= 3.1.1 Erstellung des RDF Aendern Sie in create_rdf() (und create_rdf_overview()) das Praefix fuer den Projektidentifikator "uri:x_maind:" (z.B. zu "uri:irgendwasanderes:"). Diese Funktionen finden sich in den Funktions-Modulen eines jeweiligen MIPMs (MTool/MIPM*.pm). Optional koennen Sie bei jedem MIPM eine Typisierung der erstellten Seiten vornehmen. Dafuer ist der Parameter 'mm_pagetype' vorgesehen. In Math&Industry wurde eine Klassifizierung der Website durch das Schema http://www.iwi-iuk.org/material/RDF/Schema/Descriptor/midesc.html (Math&Industry Descriptors) vorgenommen. Analog dazu koennen Sie auch eine eigenes Schema entwickeln und eigene Seitentypen verwenden. In MTool/Pagetypes.pm muessen Sie dann die entsprechende "Praefix-URI" der Variable $pagetype_scheme_uri zuweisen. Ausserdem wird der Wert von 'mm_pagetype' anhand von @pagetypes ueberprueft. Aenders Sie die Liste der Seitentypen entsprechend ab. 3.1.2 Lesen des RDF 3.1.2.1) Sie koennen aus MTool/MIPM*.pm einige Funktionen entfernen, die nur aus Gruenden der Abwaertskompatibilitaet enthalten sind. Alle Funktionen der folgenden Arten bis auf die, mit der hoechsten Versionsnummer: read_rdf_*(), read_rdf_overview_*() und ggf. versionsspezifische Hilfsfunktonen. Entsprechend aendern sollten Sie dann auch die Auswahlfunktion read_rdf() und read_rdf_overview(). 3.1.2.2) Aendern Sie ggf. in MTool/MIPM*.pm in den Funktionen read_rdf_*() und ggf. weiteren vorhandenen Hilfsfunktionen das Praefix des Projektidentifikators entsprechend Ihrer Aenderung in 3.1.1. 3.2 MIPMGlossary ================ 3.2.1 Erstellung des RDF Aendern Sie in create_rdf() und rdf_create_projectterms() in der Datei Vocabulary.pm das Praefix fuer den Projektidentifikator "uri:x_maind:" (z.B. zu "uri:irgendwasanderes:"). 3.2.2 Lesen des RDF Aendern Sie ggf. in Vocabulary.pm in den Funktionen read_rdf() und rdf_read_mainterms() das Praefix des Projektidentifikators entsprechend Ihrer Aenderung in 3.2.1. Ggf. muessen Sie deses auch in Vocabulary/Apply.pm, Vocabulary/Math.pm und Vocabulary/Science.pm tun. 4. Aenderungen in der Hilfe ~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4.1 Versionierung Stellen Sie immer sicher, dass der Name der Hilfedatei mit der Version des MIPMs korrespondiert und das die Versionsnummer innerhalb der Hilfe ebenfalls uebereinstimmt (sie taucht an 2 Stellen auf). 4.2 Aenderungen im Text 4.2.1) Passen Sie die Metaangaben im HTML-Kopf entsprechend Ihrem Verwendungszweck an. 4.2.2) Das 1. Kapitel der Hilfe enthaelt einen sehr Math&Industry spezifischen Einleitungtext, der sicherlich angepasst werden sollte. 4.2.3) Sie sollten im Fuss der Datei einen Kontaktlink (bzw. eine Emailaddresse) zu sich selbst einfuegen.