MCIT - MCs Index Generator & Tag-Checker

Präprozessor für HTML-Dateien

MCIT dient als Präprozessor für HTML-Dateien. Er besteht aus einen Tag-Checker, den Index-Generator und einen HTML-Converter, die in dieser Reihenfolge auf die Eingabedateien angewendet werden.

Gehe zu Kommandozeilenoptionen
Gehe zu Download

Der Tag-Checker dient dazu, bestimmte Textstellen auszutauschen oder einzufügen. Die Steuerung erfolgt über ein Tag-Control-File, in dem die vorgegebenen Textstellen, nach Blöcken unterteilt, aufgeführt sind. Die zu verarbeitende Datei wird nach den definierten Blöcken durchsucht. Für jeden Block werden alle definierten Aktionen gesucht und, falls gefunden, angewendet. Aktionen, die nicht gefunden wurden, werden am Ende des Blockes ausgeführt.

Die Steuerdatei und die Verarbeitung unterliegen dabei folgenden Regeln:

Die Tag-Control-Datei ist zeilenorientiert aufgebaut - jede Zeile steht für einen abgeschlossenen Eintrag
Zeilen, die mit # oder // beginnen, werden ignoriert
Leerzeilen werden ebenfalls ignoriert
Verschachtelte Blöcke sind nicht erlaubt und führen zu fehlerhafter Verarbeitung. Das bedeutet auch, daß vor Abschluß eines Blockes kein anderer verarbeitet werden kann.
Die Patterns (=Zeichenmuster) aller Blöcke und innerhalb eines Blockes sollten disjunkt sein - sich also eindeutig voneinander unterscheiden.
der Pattern-Vergleich ignoriert Groß-/Kleinschreibung
Für Aktions-Muster ist maximal ein Wildcard * erlaubt, es steht für eine beliebige Anzahl von Buchstaben
Jede Regel besteht aus der Angabe der Aktion und dazu notwendigen Parameter in der ersten und der Spezifikation des neuen (ersetzenden oder eingefügten) Textes in der unmittelbar darauffolgenden Zeile.
block-begin: <Blockanfang-Pattern>
markiert den Beginn eines Blockes. Diese Regel enthält keine weitere Zeile!
block-end: <Blockende-Pattern>
markiert das Ende eines Blockes. Diese Regel enthält keine weitere Zeile!
replace: <zu ersetzende Zeichenfolge>
die zu ersetzende Zeichenfolge wird durch den neuen Text ersetzt oder der neue Text wird, falls nicht vorhanden, am Ende des Blockes eingefügt
unique: <einmalige Zeichenfolge>
die Zeichenfolge wird sie, falls gefunden, durch den spezifizierten neuen Text ersetzt. Alle weiteren Vorkommen der Zeichenfolge werden gelöscht. Wird die Zeichenfolge nicht gefunden, wird der neue Text am Ende des Blockes hinzugefügt.
insert-after: <Zeichenfolge>
nach der Zeichenfolge wird der spezifizierte neue Text eingefügt
insert-before: <Zeichenfolge>
vor der Zeichenfolge wird der spezifizierte neue Text eingefügt
text: <Text>
der ersetzende oder einzufügende Text (abh. von Aktionsart)
file: <Text>
Datei, die den ersetzenden oder einzufügenden Text (abh. von Aktionsart) enthält
Aktionen, die zu keinem Block gehören, sind generelle Aktionen
nicht gefundene generelle Aktionen werden nicht ausgeführt
Blöcke werden vor generellen Aktionen ausgeführt.
generelle Aktionen werden über die gesamte Datei - also auch in den Blöcken - angewendet.

Zur Verdeutlichung ein Beispiel einer Tag-Control-Datei.

Der Index-Generator generiert mit Hilfe eines Index-Control-File für jede verarbeitete Datei eine Indextabelle, die an einer spezifizierten Stelle eingefügt wird.

Derzeit ist nur ein horizontaler Tabellen-Index verfügbar, für den die nachfolgenden globalen Tags gültig sind:

actnode-color: <Farbangabe>: Textfarbe für aktiven Index-Eintrag
actnode-background: <Farbangabe>: Hintergrundfarbe für aktiven Index-Eintrag
subnode-color: <Farbangabe>: Textfarbe für Unterknoten des aktuellen Knotens
subnode-background: <Farbangabe>: Hintergrundfarbe für Unterknoten
default-color: <Farbangabe>: die Standardfarbe für alle anderen Zellen
default-background: <Farbangabe>: Standard-Hintergrundfarbe
activelinke-color: <Farbangabe>: Farbe für aktive Links (alink-Attribut)
index-tag: <Indexkennung>: Kennung, an welcher Stelle der Index eingefügt werden soll. Der Text wird dabei ersetzt.

Nicht angegebene Werte wirken dabei nicht auf das Ergebnis aus, die entsprechenden Attribute/Tags entfallen dann.

Die Index-Einträge selbst sind nach folgendem Schema aufgebaut:

   <Index-Level>: <Index-Text> = <Dateiname>

Index-Level bezeichnet die Stufe des Index-Eintrages, Sprünge größer als 1 sind nicht erlaubt. Der Index-Text ist der Text, der den Index-Knopf/Button/*wasauchimmer* beschriftet und Dateiname bezeichnet den Namen der Datei, für der betreffende Index-Eintrag steht. Der Dateiname ist dabei in der Form anzugeben, wie er auch bei der Verarbeitung in der Kommandozeile angegeben wird.

Ein Beispiel einer Index-Datei.

Der HTML-Converter wird zum Schluß auf jede verarbeitete HTML-Datei angewendet und wandelt alle Umlaute und Sonderzeichen in die entsprechenden HTML-Ausdrücke um.

MCIT ist ein reines Kommandozeilen-Tool mit folgenden Kommandozeile:

   java mcit.MCIT [-s sourcepath] [-d destination_path] [-c controlfile] [--newer] file1 file2 file3 ...

Parameter:

--sourcepath

Verzeichnis der Quelldateien
Standard-Wert: .

--destpath

Verzeichnis für Zieldateien
Standard-Wert: ../public_html

--treefile

Datei mit Index-Informationen
Standard-Wert: tree.txt

--indexformat TableFormatter|ButtonFormatter|ImageFormatter

Auswahl des Index-Darstellungsformates:

als Tabelle mit Rahmen für jedes Element
mit JavaScript-Buttons
mit Bild für jeden Button

--tagfile

Datei mit Tag-Steuer-Informationen
Standard-Wert: tags.txt

--newer

verarbeitet nur Dateien, die geändert wurden
(wenn die Originaldatei neueren Datums als die entsprechende Zieldatei ist)

MCIT gibt es hier zum Download:

JAR-Datei (18 kByte) mit allen Klassendateien ( Hinweis zum Abspeichern)

Das Starten des Programmes erfolgt einfach mit java mcit.MCIT, wobei die entsprechenden Voraussetzungen zum Start von Java-Klassen erfüllt sein müssen.

Wer eigene Weiterentwicklungen oder Erweiterungen (z.B. regular expressions) einbringen möchte, kann sich gerne mit mir in Verbindung setzen.