Pflichtenheft

Dokument 

Pflichtenheft 

Diplomarbeit B36.10 

Titel 

Web-fähiger MathML-Editor 

Klasse, Datum B36, 16.11.2006 

Abstract 

Erstellen eines Editor für formatfreien Text, der beliebig mit 

MathML Formeln gemixt werden kann. Der Editor soll in einer 

Webanwendung laufen. Der editierte Text soll serverseitig in ein 

XML- oder HTML-Dokument transformiert werden. 

Schlüsselwörter MathML, Editor, Webanwendung 

Autor 

Martin Rüfli 

Unterer Eggen 11 

CH-2543 Lengnau 

Tel.: +41 32 652 48 75 

Betreuerin 

Dr. Beatrice Amrhein 

Software-Schule Schweiz 

Wankdorffeldstrasse 102 

CH-3014 Bern 

Tel.:+41 31 84 83 276 

www.sws.bfh.ch 

Expertin 

Ursula Deriu 

Fachinformationszentrum Technik e.V. 

Hanauer Landstr. 151-153 

60314 Frankfurt a.M. 

www.fiz-technik.de



Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

1 Inhalt 

1 Inhalt ...........................................................................................................................................3 

2 Dokumentinformation ...............................................................................................................5 

2.1 Änderungskontrolle..............................................................................................................5 

2.2 Prüfung ................................................................................................................................5 

2.3 Freigabe...............................................................................................................................5 

3 Allgemeines.................................................................................................................................6 

3.1 Sinn und Zweck ....................................................................................................................6 

3.2 Leserkreis.............................................................................................................................6 

3.3 Umfeld..................................................................................................................................6 

3.4 Umfang und Anwendungsgebiet...........................................................................................6 

3.5 Offene Fragen ......................................................................................................................7 

3.6 Glossar.................................................................................................................................8 

3.7 Referenzen............................................................................................................................9 

4 Allgemeine Beschreibung ........................................................................................................10 

4.1 Summary of Presentation Elements ...................................................................................10 

4.1.1 Table of argument requirements ................................................................................10 

4.1.2 Token Elements..........................................................................................................11 

4.1.3 General Layout Schemata ..........................................................................................12 

4.1.4 Script and Limit Schemata.........................................................................................12 

4.1.5 Tables and Matrices ...................................................................................................12 

4.2 Übersicht............................................................................................................................13 

4.2.1 Systemkomponenten ..................................................................................................13 

4.2.1.1 Editor Applet..........................................................................................................13 

4.2.1.2 Controller ...............................................................................................................13 

4.2.1.3 View.......................................................................................................................14 

4.2.1.4 Modell ....................................................................................................................14 

4.2.1.5 Dokument...............................................................................................................14 

4.2.2 Grundfunktionen des Editors .....................................................................................14 

4.3 Abgrenzung des Umfelds....................................................................................................14 

4.4 Beziehungen zu anderen Systemen.....................................................................................14 

4.5 Infrastrukturanforderungen ...............................................................................................15 

4.5.1 Zielsystem Webserver................................................................................................15 

4.5.1.1 Hardware................................................................................................................15 

4.5.1.2 Software .................................................................................................................15 

4.5.2 Zielsystem Client .......................................................................................................15 

4.5.2.1 Hardware................................................................................................................15 

4.5.2.2 Software .................................................................................................................15 

Pflichtenheft.doc Seite: 3 /25



Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4.5.2.3 Netz ........................................................................................................................15 

4.5.3 Entwicklungsumgebung.............................................................................................16 

4.5.3.1 Hardware................................................................................................................16 

4.5.3.2 Software .................................................................................................................16 

5 Technische Anforderungen .....................................................................................................17 

5.1 Allgemeine Funktionen ......................................................................................................17 

5.1.1 Installation..................................................................................................................17 

5.1.2 Selbsttest und Funktionsnachweis .............................................................................17 

5.1.3 Dokumentation...........................................................................................................17 

5.1.4 Hilfesystem ................................................................................................................17 

5.1.5 Systemstart und Shutdown.........................................................................................17 

5.1.6 Verhalten bei Stromausfall oder bei Verbindungsunterbruch....................................18 

5.1.7 Verbindungsüberwachung .........................................................................................18 

5.1.8 Sprachen.....................................................................................................................18 

5.2 Systemfunktionen................................................................................................................18 

5.2.1 Prioritäten der Funktionen .........................................................................................18 

5.2.2 Editor Applet..............................................................................................................19 

5.2.2.1 Allgemeine Anforderungen....................................................................................19 

5.2.2.2 Mathml Root Element............................................................................................19 

5.2.2.3 Token Elements......................................................................................................20 

5.2.2.4 General Layout Schemata ......................................................................................20 

5.2.2.5 Script and Limit Schemata.....................................................................................21 

5.2.2.6 Tables and Matrices ...............................................................................................21 

5.2.2.7 Dynamisches Element............................................................................................21 

5.2.3 Webapplikation ..........................................................................................................21 

6 Schnittstellen ............................................................................................................................23 

6.1 Benutzeroberfläche ............................................................................................................23 

6.2 Softwareschnittstellen ........................................................................................................23 

6.2.1 Parameterübergabe.....................................................................................................23 

6.2.2 Export von Texten......................................................................................................23 

6.3 Drucker ..............................................................................................................................23 

7 Tests und Abnahme .................................................................................................................24 

7.1 Modultest............................................................................................................................24 

7.2 Abnahmetest.......................................................................................................................24 

7.3 Usability Test .....................................................................................................................24 

8 Anhang ......................................................................................................................................25 

8.1 Terminplan.........................................................................................................................25 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

2 Dokumentinformation 

2.1 Änderungskontrolle 

Version Datum 

Ausführende 

Stelle 

Bemerkungen / Art der Änderung 

1.31 21.08.2006 Ruf Weitere Ergänzungen gemäss Frau Deriu 

msqrt wird prio1 

Menüs für Zeichensätze müssen 

konfigurierbar sein. 

1.3 21.08.2006 Ruf Adresse der Firma 

Fachinformationszentrum Technik e.V. 

hat geändert. 

1.2 18.08.2006 Ruf Aufwand verringert um den Prototypen hin 

zu kriegen. 

1.1 28.07.2006 Ruf Korrekturen gemäss Angaben von Frau 

Amrhein und von Frau Deriu eingefügt. 

1.0 09.07.2006 Ruf Erste Version fertig 

0.1 02.07.2006 Ruf Entwurf, Arbeitsgrundlage 

2.2 Prüfung 

Version Prüfdatum Prüfende Stelle Bemerkungen 

1.3 20.08.2006 Frau Deriu Firmenadresse und Priorität für msqrt 

ändern. 

Dokumentation der Auswahl für die 

Formelzeichen (Inhalt der MathML Token) 

einfügen. 

1.0 23.07.2006 Frau Amrhein 

Frau Deriu 

Diverse Korrekturen 

2.3 Freigabe 

Version Freigabe- 

Datum 

1.31 

Freigebende 

Stelle/n 

Unterschrift 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

3 Allgemeines 

3.1 Sinn und Zweck 

Dieses Pflichtenheft beschreibt die Anforderungen an die zu realisierende Applikation aus 

Sicht des Kunden. Es dient ebenfalls als Grundlage für die Bewertung der Diplomarbeit. 

3.2 Leserkreis 

Dieses Pflichtenheft richtet sich an folgende Personen: 

Betreuer der Diplomarbeit (Auftraggeber) 

Experte der Diplomarbeit 

Alle beteiligten Softwareentwickler 

3.3 Umfeld 

Das Fachinformationszentrum Technik in Frankfurt am Main (www.fiz-technik.de) und die 

Technische Informationsbibliothek in Hannover (www.tib.uni-hannover.de) bereiten mit 

Web-Anwendungen technische Informationen auf und stellen diese im Internet zur 

Verfügung. Da diese technischen Informationen oft mit Formeln durchsetzt sind wird ein 

Editor gebraucht mit dem man von Formeln durchsetzte Text erfassen kann. Da es in 

dieser Applikation um reine Datenerfassung geht wird auf eine Formatierung der Texte 

verzichtet. Die erfassten Texte sollen serverseitig in ein XML- oder HTML-Dokument mit 

einer einfachen Struktur transformiert werden. 

3.4 Umfang und Anwendungsgebiet 

Der neu zu entwickelnde Editor soll sich einfach in die Web-Anwendungen einfügen 

lassen. Die erfassten Texte mit den Formeln sollen auf den Webserver geschickt werden, 

der diese dann in einer Datenbank oder als Files abspeichert. Falls bereits ein Text erfasst 

wurde, soll er beim öffnen der Applikation automatisch vom Webserver angefordert und in 

den Editor geladen werden damit er sofort weiter bearbeitet werden kann. Der Editor soll 

so gekapselt sein, dass er sich nicht um die Persistenzebene zu kümmern braucht. Er 

muss fähig sein genau einen XML-Stream automatisch oder auf verlangen von dem 

Webserver zu laden, die darin enthaltenen Daten zu bearbeiten und sie auch wieder an 

den Webserver zurück zu schicken. Das Format für die Formeln soll MathML gemäss der 

Spezifikation - Mathematical Markup Language (MathML) Version 2.0 (Second Edition) - 

sein. Falls auf dem Webserver noch keine Datei existiert, so soll ein neuer Text erfasst 

werden können. Es ist die Aufgabe des Webservers zu verhindern, dass ungewollt Daten 

überschrieben werden. 

Ein kompletter MathML Editor würde Umfang dieser Diplomarbeit bei weitem sprengen, 

deshalb wird nur soviel implementiert: 

1. Um zu zeigen, dass das Konzept funktioniert 

2. Das die Firma Fachinformationszentrum Technik e.V. den Editor basierend auf 

dieser Arbeit mit dem entsprechenden Fachpersonal fertig stellen kann. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

3.5 Offene Fragen 

Auf diese offenen Fragen wird eventuell erst im Diplombericht oder während der Tests 

eine Antwort zu finden sein. 

Nr. Wer Frage Antwort 

1 Besteller Es sollen Internet 

Explorer und Firefox 

unter Windows und 

Firefox unter Linux 

Betriebssystem 

unterstützt werden. Stellt 

Firefox unter Linux ein 

Problem dar 

Soweit es durch Recherchen im Internet 

feststellbar war hat Firefox keine grösseren 

Probleme mit MathML und Linux. Es ist zu 

beachten, dass Firefox folgende Anforderungen 

hat: 

• Red Hat Linux 7.0 und höher 

• Mac OS X 10.3.x und höher 

• Windows 98 und höher 

Zitat aus c't 14/2006, S. 166: Linux-Distributionen 

(http://www.heise.de/ct/06/14/166/): 

2 Besteller Druckt der Browser denn 

die erfassten Texte aus 

Bitte erarbeiten Sie eine 

Möglichkeit, um ein 

erfasstes Abstract zu 

drucken. 

Fedora und Suse Linux dienen Red Hat und 

Novell als Spielwiese für neue technische 

Entwicklungen, die hier ausprobiert werden, 

bevor sie Einzug in Red Hat Enterprise Linux 

(RHEL) und Suse Linux Enterprise Server 

(SLES) halten. 

Der Browser druckt die erfassten Formeln unter 

Windows mit Mozilla Firefox korrekt. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

3.6 Glossar 

Begriff / Abkürzung 

Element 

GUI 

HTML 

MathML 

Mozilla Firefox 

rendern 

SGML 

Token 

Beschreibung 

MathML Elemente sind einerseits Container, die andere MathML 

Elemente und Token aufnehmen können andererseits bestimmen 

sie den Layout des Elementes. Beispiele: Bruchstrich, 

Wurzelzeichen, Potenzen etc. Entspricht den Knoten des MathML 

Baumes. 

Graphical User Interface. 

Technische Bezeichnung der grafischen Benutzeroberfläche 

Die Hypertext Markup Language (HTML) dient der Darstellung 

von meist statischen Inhalten wie Texten, Bildern und Hyperlinks 

in einem Webbrowser. HTML wird auch als Hypertext bezeichnet. 

Neben den vom Browser angezeigten Inhalten einer Webseite 

enthält HTML auch Metainformationen, die die Intention oder 

Bedeutung des Textes zusammenfassen aber auch Informationen 

über z. B. die Sprache geben. HTML beschreibt Informationen im 

Sinn einer Auszeichnungssprache. HTML wurde vom World Wide 

Web Consortium (W3C) bis Version 4.01 weiterentwickelt, darauf 

folgende Versionen heißen XHTML. 

Die Mathematical Markup Language (MathML) ist im 

Computerdaten-Verkehr ein Dokumentenformat zur Darstellung 

von mathematischen Formeln und komplexen Ausdrücken. Der 

Standard MathML 2.0 wird durch eine Spezifikation des World 

Wide Web Consortium von 2001 festgelegt. Wie in allen XML- 

Sprachen (z. B. XHTML) werden in MathML die Inhalte eines 

Dokumentes in einer logischen Struktur unabhängig von ihrer 

graphischen Gestaltung abgelegt. 

Mozilla Firefox ist ein aus dem Mozilla-Projekt hervorgegangener 

freier Webbrowser vor allen Dingen zum Betrachten von 

Webseiten. Es ist einer der wenigen Browser der MathML ohne 

Plugin anzeigen kann. 

(Von engl. to render: wiedergeben, vortragen) bezeichnet den 

Vorgang, aus Rohdaten – durch Anwendung geeigneter Verfahren 

– neue Daten zu generieren. 

Im Bereich der Computergrafik bezeichnet rendern die Erzeugung 

eines digitalen Bildes aus einer Bildbeschreibung. In 

Zusammenhang mit dem zu erstellenden Editor das Zeichnen von 

Formeln. 

SGML (engl. Standard Generalized Markup Language) ist eine 

Metasprache, mit deren Hilfe man verschiedene 

Auszeichnungssprachen (engl. markup languages) für Dokumente 

definieren kann. SGML ist ein ISO-Standard: ISO 8879:1986 

Information Processing — Text and Office Systems — Standard 

Generalized Markup Language (SGML). 

MathML Element, das einen Operator, einen Bezeichner, eine 

Zahl oder einen Text enthalten kann. Entspricht den Blättern im 

MathML Baum. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

Tooltipps 

Webanwendung 

XHTML 

XML 

Ein Tooltipp ist ein allgemeines GUI Benutzer Interface. Er wird in 

Verbindung mit einem Cursor, normalerweise dem Mauszeiger, 

verwendet. Der Benutzer bewegt den Mauszeiger über ein GUI- 

Element auf dem Bildschirm ohne dieses zu klicken. Nach kurzer 

Zeit klappt eine kleine Box mit dem Namen und der Beschreibung 

des Elementes auf. 

Eine Webanwendung oder Webapplikation ist ein Computer- 

Programm, das auf einem Webserver ausgeführt wird, wobei eine 

Interaktion mit dem Benutzer ausschließlich über einen 

Webbrowser erfolgt. Hierzu sind der Computer des Benutzer 

(Client) und der Server über ein Netzwerk, wie das Internet oder 

über ein Intranet miteinander verbunden, so dass die räumliche 

Entfernung zwischen Client und Server unerheblich ist. 

Der W3C-Standard Extensible HyperText Markup Language 

(XHTML) ist eine Neuformulierung von HTML 4 in XML 1.0: Im 

Gegensatz zu seinem Vorgänger HTML, welcher mittels SGML 

definiert wurde, verwendet XHTML die strengere und einfacher zu 

parsende SGML-Teilmenge XML als Sprachgrundlage. XHTML- 

Dokumente entsprechen also den Syntaxregeln von XML. 

Die Extensible Markup Language (engl. für „erweiterbare 

Auszeichnungs-Sprache“), abgekürzt XML, ist ein Standard zur 

Erstellung maschinen- und menschenlesbarer Dokumente in Form 

einer Baumstruktur, der vom World Wide Web Consortium (W3C) 

definiert wird. XML definiert dabei die Regeln für den Aufbau 

solcher Dokumente. Für einen konkreten Anwendungsfall ("XML- 

Anwendung") müssen die Details der jeweiligen Dokumente 

spezifiziert werden. Dies betrifft insbesondere die Festlegung der 

Strukturelemente und ihre Anordnung innerhalb des 

Dokumentenbaums. XML ist damit ein Standard zur Definition von 

beliebigen in ihrer Grundstruktur jedoch stark verwandten 

Auszeichnungssprachen. 

3.7 Referenzen 

Nr. Beschreibung 

[1] Hilfsmittel Projekt-Management von SW- 

Entwicklungs-Projekten 

[2] Spezifikation von MathML 2.0 des W3 Consortiums. 

Mathematical Markup Language (MathML) Version 

2.0 (Second Edition) 

Quelle 

Othmar Bürgi (Dozent SWS) 

Info Top AG 

CH-7412 Scharans 

http://www.w3.org/TR/MathML2 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4 Allgemeine Beschreibung 

4.1 Summary of Presentation Elements 

Dieses Kapitel gibt eine kurze Übersicht über die wichtigsten Presentation MathML 

Elemente und Token [Kapitel 4.1.2] und ihre Bedeutung. Die Tabellen sind Kopien aus der 

MathML Spezifikation ([2] Kapitel 3 Presentation Markup). Die Texte wurden absichtlich 

nicht übersetzt. Für die wichtigsten Begriffe sind die Übersetzungen im Kapitel 

Systemfunktionen 5.2 zu finden. 

Die meisten MathML Elemente können als Container verstanden werden, welche 

wiederum andere Container oder Token Elemente aufnehmen können. 

4.1.1 Table of argument requirements 

In dieser Tabelle sind alle MathML Elemente aufgelistet die andere MathML Elemente 

aufnehmen können. In der 2. Spalte steht wie viele andere Argumente (Elemente) als 

Inhalt erwartet werden. Jedes Argument in Required argument count kann durch ein 

mrow Element gekapselt werden, so ist es möglich beliebige Formelteile zu schachteln. 

Dies ist vor allem darum wichtig, da die meisten Formeln mehrere Token aufweisen. 

Beispiel für (a+b) 2 : 

 

 

( 

a 

+ 

b 

) 

 

2 

 

// mrow kapselt mehrere Token als Basis 

// Als Exponent kommt nur eine Zahl vor, 

// deshalb ist keine Kapselung nötig 

Beispiel für Wurzel aus a+b: 

 

a 

+ 

b 

 

// Es ist keine Kapselung nötig ohne die Token 

// müsste mindestens ein leeres mrow Element 

// vorhanden sein. (Siehe 1* Regel) 

1* Regel 

Die Anzahl mit 1* in Required argument count bedeutet, dass mindestens ein Token 

oder Element enthalten sein muss. Maximal dürfen beliebig viele Token vorhanden sein. 

Das Besondere an diesen Containern ist, dass die enthaltenen Token nicht zwingend in 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

ein mrow Element gekapselt werden müssen, sie dürfen einfach nacheinander 

hingeschrieben werden. Ist hingegen weder ein MathML Element noch ein Token 

vorhanden, so ist zwingend ein leeres mrow Element zu erfassen. 

Element Required argument Argument roles (when these differ by position) 

count 

mrow 0 or more 

mfrac 2 numerator denominator 

msqrt 1* 

mroot 2 base index 

mstyle 1* 

merror 1* 

mpadded 1* 

mphantom 1* 

mfenced 0 or more 

menclose 1* 

msub 2 base subscript 

msup 2 base superscript 

msubsup 3 base subscript superscript 

munder 2 base underscript 

mover 2 base overscript 

munderover 3 base underscript overscript 

mmultiscripts 1 or more 

base (subscript superscript)* [ 

(presubscript presuperscript)*] 

mtable 0 or more rows 0 or more mtr or mlabeledtr elements 

mlabeledtr 1 or more a label and 0 or more mtd elements 

mtr 0 or more 0 or more mtd elements 

mtd 1* 

maction 1 or more depend on actiontype attribute 

math 1* 

4.1.2 Token Elements 

Diese Elemente sind die eigentlichen Blätter des MathML Baumes und enthalten die 

einzelnen Operatoren, Bezeichner, Zahlen oder Texte. 

Element Inhalt 

mi identifier 

mn number 

mo operator, fence, or separator 

mtext text 

mspace space 

ms string literal 

mglyph accessing glyphs for characters from MathML 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4.1.3 General Layout Schemata 

Diese Elemente gehören dem generellen Layout Schema an, das heisst es sind Container 

die mit einem speziellen Layout, wie Bruchstriche, Wurzelzeichen, hoch gestellte Texte, 

tief gestellte Texte etc. gerendert werden. 


mrow group any number of sub expressions horizontally 

mfrac form a fraction from two sub-expressions 

msqrt form a square root (radical without an index) 

mroot form a radical with specified index 

mstyle style change 

merror enclose a syntax error message from a preprocessor 

mpadded adjust space around content 

mphantom make content invisible but preserve its size 

mfenced surround content with a pair of fences 

menclose enclose content with a stretching symbol such as a long division sign. 

4.1.4 Script and Limit Schemata 

Diese Element erweitern andere Elemente um hoch oder tief gestellte Texte wie Indexe 

oder Potenzen. 


msub attach a subscript to a base 

msup attach a superscript to a base 

msubsup attach a subscript-superscript pair to a base 

munder attach an underscript to a base 

mover attach an overscript to a base 

munderover attach an underscript-overscript pair to a base 

mmultiscripts attach prescripts and tensor indices to a base 

4.1.5 Tables and Matrices 

Mit diesen Elementen werden Tabellen und Matrizen dargestellt. 

Element 

Inhalt 

mtable 

table or matrix 

mlabeledtr 

row in a table or matrix with a label or equation number 

mtr 

row in a table or matrix 

mtd 

one entry in a table or matrix 

maligngroup and malignmark alignment markers 



4.2 Übersicht 


Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4.2.1 Systemkomponenten 

HTML / XHTML 

 

Web Browser 

 

Web Server 

HTTP (get;post) / XML 

Editor Applet 

 

Modell 

 

View 

 

Controller 

Systemgrenze 

Systemgrenze 

4.2.1.1 Editor Applet 

Das Editor Applet (im weiteren kurz Editor genannt) enthält den Controller, die View und 

das Modell. Falls sich auf dem Web Server bereits ein vorher bearbeitetes Dokument zu 

der entsprechenden Seite befindet, wird dieses automatisch geladen. Auf dem Applet 

werden sämtliche Interaktionselemente angezeigt. 

4.2.1.2 Controller 

Der Controller fügt neue Texte oder MathML Elemente in das Dokumenten Modell ein und 

entfernt sie bei Bedarf wieder aus dem Modell. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4.2.1.3 View 

Die View bereitet die Daten aus dem Modell so auf, dass sie für den Benutzer bearbeitbar 

werden. Das GUI wird laufend den geänderten Daten angepasst. 

4.2.1.4 Modell 

Das Modell hält die Daten aus dem Dokument. 

4.2.1.5 Dokument 

Das Dokument ist aus der Sicht des Editors ein Stream, der vom Server gelesen und in 

das Modell geladen wird. Nach getaner Arbeit wird das Modell wieder in einen Stream 

umgewandelt und auf den Server geschickt. Vorerst ist kein lokales File handling 

vorgesehen. Später kann der Editor ausgebaut werden, so dass er auch mit Files arbeiten 

kann. 

4.2.2 Grundfunktionen des Editors 

Der Editor soll die folgenden Funktionalitäten abbilden: 

• Einfach in beliebigen Web-Applikationen einsetzbar. 

• Text mit beliebig vielen Formeln soll erfasst werden können. 

• In Rahmen dieser Arbeit wird ein Ausschnitt aus dem MathML-Teil für die 

Präsentation unterstützt. (muss vom Besteller fertig gestellt werden). 

• Ein neues Dokument muss erfasst werden können. 

• Ein bereits vorher bearbeitetes Dokument soll vom Web Server geladen und 

verändert werden können. 

• Der bearbeitete Text soll auf den Web Server geschickt und dort gespeichert 

werden. 

4.3 Abgrenzung des Umfelds 

Der Editor ist ein in sich geschlossenes Modul und hat nur minimale Schnittstellen. Da es 

in der zur Verfügung stehenden Zeit nicht möglich ist das ganze Spektrum von MathML 

abzudecken, wird er sich nur auf ein Subset des Präsentations-Teiles von MathML 

konzentrieren. Die Arbeit soll so erledigt werden, dass der Editor Prototype später leicht 

fertig gestellt werden kann und für die jeweiligen Bedürfnisse anpassbar ist. Die Auswahl 

von bereits bearbeiteten Dokumenten ist eine Aufgabe der Webapplikation die den Editor 

benutzt. 

4.4 Beziehungen zu anderen Systemen 

Der Editor kommuniziert ausschliesslich mit dem Web Server von dem er geladen wurde. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4.5 Infrastrukturanforderungen 

Die Anforderungen sind immer als Mindestanforderungen zu verstehen um mit dem 

System einigermassen flüssig arbeiten zu können. 

4.5.1 Zielsystem Webserver 

4.5.1.1 Hardware 

Arbeitsspeicher 512 MB – 3 GB, mindestens 256 MB pro Prozessor 

Festplatte 

Prozessor 

min. 4 GB freier Speicherplatz 

Intel Pentium 4, CPU 1600 MHz 

4.5.1.2 Software 

Betriebsystem: Suse Linux Enterprise-Edition 

Web Server 

Beliebig z.B. Apache Tomcat 

4.5.2 Zielsystem Client 


Arbeitsspeicher 256MB 

Festplatte 

Prozessor 


Intel Pentium 3, CPU 800 MHz 


Betriebsystem: Linux 

Web Browser 

Mozilla Firefox 

Windows 2000 oder Windows XP 

Mozilla Firefox oder 

Microsoft Intenet Explorer mit MathML Plugin 

4.5.2.3 Netz 

Übertragungskapazität 128 kb 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

4.5.3 Entwicklungsumgebung 


Arbeitsspeicher 256MB 

Bildschirmauflösung 1024 x 748 Pixel 

Festplatte 


Prozessor 

Intel Pentium 3, CPU 800MHz 


Betriebsystem 

Windows 2000 oder Windows XP Home 

Entwicklungsumgebung Eclipse 3.1 

http://www.eclipse.org/platform/ 

Programmiersprache JavaTM 2 Platform Standard Edition 5.0 Development Kit (JDK 

5.0) 

Microsoft Word 

Dokumentation Microsoft Project 

Microsoft Visio 

Web Browser 

Mozilla Firefox, Microsoft Internet Explorer 

Web Server Apache Tomcat 5.5 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

5 Technische Anforderungen 

5.1 Allgemeine Funktionen 

5.1.1 Installation 

Eine Installation des Editors ist nicht nötig, da er als Applet in beliebige Webapplikationen 

eingebunden wird. Wie der Editor in Web Applikationen eingebaut werden kann ist der 

Installationsanweisung zu beschreiben. Es sind keine Hilfsmittel oder spezielle 

Installationsroutinen vorgesehen. Die Endanwender des Editors sind gehalten entweder 

mit dem Firefox Browser oder mit dem Microsoft Internet Explorer zu arbeiten. Die 

Anwender die den Editor in ihre Web Seiten einbauen sind Softwareentwickler, welche 

über das nötige Know How verfügen. 

5.1.2 Selbsttest und Funktionsnachweis 

Ein Selbsttest oder ein Funktionsnachweis des Editors wird nicht benötigt. 

5.1.3 Dokumentation 

In der Diplomarbeit ist folgendes enthalten: 

• Entwicklerunterlagen und Funktionsbeschreibung der Applikation (in Form des 

Diplomberichts) 

• Sourcecode Dokumentation 

• Sourcecode auf CD 

• Der Editor als Applet auf CD 

• Eine kleine Web Applikation zum Testen auf CD 

• Installationsanweisung 

5.1.4 Hilfesystem 

Es wird kein spezielles Hilfesystem eingesetzt werden, der Editor sollte mit Hilfe von 

Tooltipps selbsterklärend gestaltet werden können. 

5.1.5 Systemstart und Shutdown 

Theoretisch können beliebig viele Editoren in einer Web Seite gestartet werden. Der 

Webbrowser lädt das Applet vom Server und startet es. Falls das Applet keine Verbindung 

zu dem Server hat wird eine Fehlermeldung angezeigt. Woher die Daten geladen und 

wohin sie gespeichert werden können ist dem Editor mittels Parametern mitzuteilen. 

Beim Herunterfahren ist zu beachten, dass die geänderten Daten aktiv vom Benutzer auf 

dem Server gespeichert werden müssen. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

5.1.6 Verhalten bei Stromausfall oder bei 

Verbindungsunterbruch 

Bei einem Stromausfall oder wenn die Verbindung zum Server nicht wieder hergestellt 

werden kann, dürfen alle bisher bearbeiteten und nicht gespeicherten Daten verloren 

gehen. Das Selbe gilt auch für den Fall, dass der Benutzer den Webbrowser ohne 

vorherige Datensicherung schliesst. 

5.1.7 Verbindungsüberwachung 

Es ist keine automatische Verbindungsüberwachung vorgesehen. Der Benutzer ist selbst 

gehalten seine Arbeit in regelmässigen Abständen auf dem Server sicher zu stellen. 

5.1.8 Sprachen 

• Die Benutzersprache des Editors ist Deutsch. Alle Meldungen und Beschriftungen 

der GUI Komponenten werden in Deutsch ausgegeben. Mehrsprachigkeit wird 

vorgesehen. 

• Die Diplomarbeit und alle dazu gehörenden Unterlagen werden in Deutsch erfasst. 

Treffende Fachbegriffe werden in englischer Sprache beibehalten. 

• Alle Programmkommentare werden in Deutsch gehalten. 

5.2 Systemfunktionen 

5.2.1 Prioritäten der Funktionen 

Die nachfolgend aufgeführten Funktionen sind bezüglich ihrer Realisation in drei 

Prioritätsstufen unterteilt: 

Priorität Beschreibung 

1 Basisfunktion 

Diese Funktion muss implementiert werden um zu zeigen, dass der Editor 

Prototype funktioniert. 

2 Erweiterte Funktion 

Das System erfüllt auch ohne diese Funktion seinen Zweck. Die 

Implementation dieser Funktion ist optional, aber aus Sicht des Benutzers 

wichtig. Diese Funktion sollte implementiert werden. 


Das System erfüllt auch ohne diese Funktion seinen Zweck. Die 

Implementation dieser Funktion ist optional und ohne besondere Wichtigkeit. 

Nice to have. 


Eine Funktion die sehr eng mit dem Fachgebiet zusammenhängt, die aber vom 

Kunden nicht eingesetzt wird. Das System erfüllt auch ohne diese Funktion 

seinen Zweck. Die Implementation dieser Funktion kann für den Verkauf der 

Applikation an andere Kunden interessant sein. 

Nice to sell. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

5.2.2 Editor Applet 

5.2.2.1 Allgemeine Anforderungen 

Funktion Priorität Beschreibung 

Dokument laden 1 Der Name des Dokumentes wird dem Applet als Parameter 

übergeben und es muss mindestens ein leeres Dokument 

vorhanden sein. 

Dokument 

speichern 

1 Ein bearbeitetes Dokument wird auf dem Webserver 

abgespeichert. Der Name des Dokumentes wird dem Applet 

als Parameter übergeben. Es muss mindestens ein leeres 

Dokument vorhanden sein. 

Haupt Fenster 1 Hauptfenster in Webseite eingebettet. 

Menuleiste oben, Informationsanzeige (Status Bar) unten. 

Tool Bar ist nicht vorgesehen. 

Hier kann der Text erfasst und mit Formeln ergänzt werden. 

Die Formeln werden nur in der editierbaren Form angezeigt, 

diese weicht von dem Rendering im Webbrowser wegen des 

leicht grösseren Platzbedarfs etwas ab. 

Mathematische 

Formelzeichen 

Neues 

Dokument 

erstellen 

Dokument 

drucken 

Dokument 

löschen 

Dokument 

suchen 

1 Das Menü, mit dem die Formelzeichen in die MathML Token 

eingefügt werden können, soll über Konfigurationsfiles frei 

zusammengestellt werden können. Es wird immer eine 

Zeichengruppe unter einem Pushbutton eingefügt. 

1 Es soll ein leeres neues Dokument erstellt werden. 

2 Es wird mit den Bordmitteln der Browsers gedruckt und keine 

Spezielle Druckfunktion vorgesehen. Eventuell kann die 

Webseite so gestaltet werden, dass das abgespeicherte 

Dokument in ein eigenes Browserfenster geladen und dort 

gedruckt werden kann. 

3 Es wird ein neues leeres Dokument erzeugt. Wurden vorher 

bereits Änderungen abgespeichert, so kann das Dokument 

vom Editor auf dem Webserver nicht mehr gelöscht werden. 

Es ist höchstens möglich ein leeres Dokument 

abzuspeichern. Das endgültige Löschen von Dokumenten ist 

eine Aufgabe der Webapplikation. 

3 Ist eine Aufgabe der Webapplikation und wird nicht 

implementiert. 

5.2.2.2 Mathml Root Element 

Element Priorität Inhalt 

math 1 Root Element für jede Formel. Dieses Element darf nur einmal pro 

Formel vorkommen. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

5.2.2.3 Token Elements 


mi 1 Bezeichner entspricht einem beliebigen 

Identifier. 

mn 1 Zahlen in allen gängigen Schreibweisen 

mo 1 mathematischer Operator, Klammer oder 

Trennzeichen wie Kommas etc. 

mtext 2 Texte 

mspace 3 Leerschlag, Space, Blank geht auch mit mtext 

ms 3 Zeichenkette, Literal 

mglyph 3 Zugriff auf neue bisher noch nicht 

standardisierte Zeichensätze um neu erfundene 

Formelzeichen darstellen zu können. 

5.2.2.4 General Layout Schemata 


mrow 1 Beschreibt eine Grundlinie (Zeile) in MathML auf der sich die Formel 

oder ein Teil davon befindet, kann auch als leeres Element vor 

kommen. Je weiter weg von der Grundlinie, desto kleiner werden die 

Zeichen gerendert. 

mfrac 1 Brüche mit Bruchstrich (-), ohne Bruchstrich ( ) oder mit schräg 

gestelltem Bruchstrich (/) 

msqrt 1 Reine Quadratwurzel ohne die Möglichkeit einen Wurzelexponenten 

anzugeben. 

mroot 2 Beliebige Wurzel, der Wurzelexponenten ist anzugeben. 

mstyle 2 Text Formatierungs-Element. Hat eher etwas damit zu tun, wie ein 

Zeichen dargestellt wird (bold, italic etc.) und nicht welche Zeichen 

dargestellt werden (aus normalen Buchstaben können damit keine 

griechischen Buchstaben gemacht werden.). 

merror 3 Text Formatierungs-Element um Fehlertexte anzuzeigen 

mpadded 3 Text Formatierungs-Element. Bewirkt, dass mehr Freiraum um die 

Zeichen gerendert wird. 

mphantom 3 Formatierungs-Element um Inhalte unsichtbar zu Rendern, anstelle 

der Formelzeichen werden Spaces gerendert. Der Platz bleibt 

erhalten. 

mfenced 3 Element um Ausdrücke zu klammen, die einzelnen Ausdrücke 

können mit einem Trennzeichen z.B. Komma getrennt werden. 

menclose 3 Zeichnet Elemente mit Linien dazwischen, kann auch zur 

Darstellung eines Bruchstriches oder einer Wurzel verwendet 

werden. Wird von Mozilla Firefox nicht sauber gerendert. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

5.2.2.5 Script and Limit Schemata 


msub 2 Basis Element mit Subscript (x 1 nach unten gesetzt) 

msup 1 Basis Element mit Superscript (x y nach oben gesetzt) 

msubsup 2 Basis Element sowohl mit Subscript als auch mit Superscript (so 

ähnlich x y 1 der y sollte über der 1 stehen) 

munder 2 Basis Element mit einem weiteren Element, das direkt darunter 

geschrieben wird, wie ein Bruch ohne Bruchstrich 

mover 2 Basis Element mit einem weiteren Element, das direkt darüber 

geschrieben wird, wie ein Bruch ohne Bruchstrich 

munderover 2 Basis Element, das sowohl Text über sich als auch unter sich 

enthält. 

mmultiscripts 3 Basis Element das beliebig viele geschachtelte Subscripts als 

auch Superscripts enthalten kann, die sowohl vor als auch nach 

dem Basiselement stehen können. Kann fast vollständig durch 

msub, msup und msubsup ersetzt werden, ausser wenn die 

Subscripts oder die Superscripts vor dem Zeichen stehen 

müssen. 

5.2.2.6 Tables and Matrices 

Element 

Priorität Inhalt 

mtable 4 Tabelle oder Matrix, enthält 0-n mlabeledtr oder mtr 

Elemente 

mlabeledtr 4 Tabellezeile mit Label und 1-n mtd Elementen. 

mtr 4 Tabellen Zeile mit 0-n mtd Elementen 

mtd 4 Ein Eintrag in einer Tabelle oder Matrix 

maligngroup and 

malignmark 

4 alignment markers 

5.2.2.7 Dynamisches Element 


maction 4 Element, mit dem man dynamische Aktionen mit Unterausdrücken 

verknüpfen könnte z.B. auf und zu klappen von Fomelteilen. Da aber 

die Implementationen reiner Wildwuchs sind, muss vorerst eine 

Standardisierung abgewartet werden. 

5.2.3 Webapplikation 

Für das Testen des Editor Applets und zur Demonstration wie es in eine Webseite 

eingebaut werden kann wird eine kleine Webapplikation gebraucht. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

Diese Webapplikation wird auf Windows erstellt und auf den Webserver Apache Tomcat 

laufen gelassen. 

Wieso nicht Linux 

1. Ich hatte bisher nur im Verlauf des Studiums mit Linux und Webapplikationen zu 

tun. 

2. Ich musste dabei feststellen, dass selbst ausgewachsenen Profis mühe haben 

innert vernünftiger Zeit von Grund auf eine lauffähige Infrastruktur mit Linux 

und/oder Webapplikationen aufzubauen. 

3. Ich habe weder zu Hause noch im Geschäft eine Linux-Infrastruktur zur Verfügung. 

4. Der Zeitrahmen dieses Projektes würde gesprengt, wenn ich mich noch intensiv mit 

Linux und mit Webapplikationen beschäftigen müsste. 

5. Der Kunde betreibt Webapplikationen auf einem Webserver mit Linux- 

Betriebssystem. Er ist also Experte und wird den Editor leicht in seine 

Webapplikationen einbauen können. 

Unten steht eine Liste welche Funktionen die Webapplikation in etwa abdecken sollte. Für 

die Dokumentation verweise ich auf den Diplombericht. 

Funktion Priorität Beschreibung 

Dokument 

1 Ein vorhandenes Dokument wird in das Applet geladen 

Editieren 

Dokumente 1 Eine Liste der vorhandenen Dokumente wird angezeigt 

Listen 

Neues 

1 Öffnet eine leere Seite mit dem Editor Applet 

Dokument 

Persistenz 1 Es wird ausschliesslich mit Files gearbeitet 

Print 2 Ein Dokument aus der Liste wird in den Webbrowser geladen 

und kann dann gedruckt werden. 

Session handling 3 Nur so weit in Tomcat automatisch vorhanden. 

Benutzer 

3 Keine Benutzeranmeldung vorgesehen. 

Anmeldung 

Benutzer- 

3 Nicht vorgesehen 

Verwaltung 

Dokument 

3 Ein vorhandenes Dokument wird gelöscht 

löschen 

Multiuser 3 Es wird ist kein Multiuser Betrieb vorgesehen. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

6 Schnittstellen 

6.1 Benutzeroberfläche 

Das Erscheinungsbild der Benutzeroberfläche (GUI) wird im Detaildesign spezifiziert. Das 

Erscheinungsbild sollte sich an den bekannten Windows-Applikationen anlehnen. Der 

Editor sollte so weit als möglich über die Tastatur bedienbar sein. 

6.2 Softwareschnittstellen 

6.2.1 Parameterübergabe 

Dem Editor werden die Informationen, woher er sich bereits bearbeitete Daten laden kann 

und der Speicherort für die bearbeiteten Daten, in Form von geeigneten Parametern auf 

der Webseite mit gegeben. 

6.2.2 Export von Texten 

Ein Export von Texten ist nicht vorgesehen. Es ist denkbar eine Funktion ein zu bauen, die 

den MathML Text in einem GUI Fenster anzeigt, von dem er dann in die Zwischenablage 

kopiert werden könnte. 

6.3 Drucker 

Es wird nur mit den Bordmitteln des jeweiligen Browsers gedruckt. Damit sollte der Editor 

noch unabhängiger vom Betriebssystem werden. 




Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

7 Tests und Abnahme 

7.1 Modultest 

Alle entwickelten Komponenten werden einem Modultest unterzogen. Der Modultest wird 

in Form eines Black-Box Tests von dem Entwickler durchgeführt und protokolliert. Er soll 

die korrekte Funktion der einzelnen Module sicherstellen. 

Das Erstellen des Testkonzepts und des Testberichtes ist Teil der Diplomarbeit. 

7.2 Abnahmetest 

Der fertige Editor Prototype wird einem Abnahmetest unterzogen. Der Besteller führt den 

Abnahmetest durch. Der Abnahmetest soll über folgendes Aufschluss geben: 

• Erfüllung der im Pflichtenheft geforderten Funktionalität 

• Korrekte Funktion des Editors Prototyps 


7.3 Usability Test 

Der fertige Editor Prototype wird einem Usability Test unterzogen. Der Entwickler wird 

einige Personen aus seinem Umfeld mit dem Editor bekannt machen und deren Meinung 

dazu festhalten. 





Datum: 21.08.06 

Zeit: 17:48 

Martin Rüfli 

8 Anhang 

8.1 Terminplan

Pflichtenheft

Sie wollen auch ein ePaper? Erhöhen Sie die Reichweite Ihrer Titel.

Template löschen?

Als Template speichern?