Werkzeuge I

Schreiben für die Leser

Das Werkzeug des Software-Entwicklers ist... Nun? Die Sprache. Nein: nicht Pascal, C++, Java. Das Werkzeug ist die englische Sprache und (selbstredend) die deutsche Sprache.

Richard Gabriel schreibt: »As computer scientists we are writers, probably half-time writers.« Patterns of Software, p. 139.

Also gilt es die Sprache zu beherrschen, und korrekt zu schreiben. Da mag ein kurzer Crashkurs: Neue deutsche Rechtschreibung behilflich sein.

Claudia Fritsch: Crashkurs: Neue deutsche Rechtschreibung. Version 1.1
Portable Document Format, 105 KB, Stand 9.12.2004

Das bisschen Orthografie ist das elementare Handwerkszeug. Es geht schon um mehr. Lassen wir wiederum Gabriel zu Wort kommen. Er zitiert einen alten Griechen, der vor 2300 Jahren bemerkte:

A man who has the knowledge but lacks the power clearly to express it is no better off than if he never had any ideas at all.

Um klar zu schreiben, muss man genau wissen, was man ausdrücken möchte. Keine Frage: Die Ideen, Konzepte, Gedanken, die Sache selbst muss klar sein, glasklar! Sonst kann man sie nicht sauber formulieren. Freilich garantiert das nicht den treffenden Ausdruck. Da hilft es, die Perspektive des Lesers einzunehmen. So klar schreiben, dass die Mühe des Gedankens den Leser nicht mehr erreicht, sondern nur noch das einfache Ergebnis.

»Schreiben für die Leser« sind Muster für ordentlichen Stil in der deutschen Sprache.

Claudia Fritsch: Schreiben für die Leser.
Portable Document Format, 108 KB, Stand 9.12.2004

Peter Rechenberg zeigt schon auf dem Titelbild seines Buches Technisches Schreiben worauf es ankommt: »Klarheit, Kürze, Klang«. Insbesondere Diplomanden finden in dem Buch gute Hinweise. Lesenswert!

Werkzeuge II

Aus der unendlichen Quelle an Halbwahrheiten mit Namen Internet sammeln sich auf einem Rechner allmählich eine Menge von Dokumenten an. Zum Teil sogar stimmende. Jedenfalls verliert man mit der Zeit den Überblick. Deshalb habe ich ein kleines Werkzeug geschrieben, mit dem man durch ein recht einfache Konvention zum Namen solcher Dokumente fast von alleine ein Verzeichnis bekommt.

Burkhardt Renz: ebooks.pl samt Dokumentation. Version 3.4
Zip Archivdatei, 200 KB, Stand 5.02.2007

Ich würde mich freuen, wenn diejenigen unter Ihnen, die das Werkzeug einsetzen, mir eine E-Mail senden.

Werkzeuge III

vi – der schnellste Editor der Welt

Dass der vi der schnellste Editor der Welt ist, das glaubt einem keiner, der zum ersten Mal versucht, mit dem vi eine Datei zu editieren. Warum: man muss sich erst daran gewöhnen, wie man vom Kommando- in den Editiermodus schaltet, und wie man mit einigen wenigen Tastaturbefehlen den Editor beherrschen kann.

Claudia Fritsch hat einen kurzen interaktiven Tutor für den vi geschrieben. »Learning by doing«: einfach folgende Datei im vi verwenden. Alles andere ist selbsterklärend.

Claudia Fritsch: Interaktiver vi-Tutor.
Datei für MKS Toolkit, 5 KB, Stand 17.10.2000

Noch ein Literaturtipp: Linda Lamb Learning the vi Editor

XML editieren mit dem vi

Besonders benutzerfreundlich ist XML nicht für all diejenigen, die einen landläufigen Editor verwenden: Allzuleicht verheddert man sich mit den vielen Klammern.

Um mir das Leben etwas leichter zu machen, habe ich ein paar Makros für den vi geschrieben.

Makros für vi.
Datei für MKS Toolkit, 1 KB, Stand 7.08.2001
Editing xml with MKS vi: Reference card.
Portable Document Format, 19 KB, Stand 26.10.2001

Gibt es bessere Lösungen?

Nützliche Kommendos für den vim – vi improved

Editieren von Dateien mit der UFT-8-Kodierung:
vim "+set encoding=utf-8" [file]

Absatz formatieren:
gqap

Dateiformat auf DOS bzw, Unix setzen:
set ff=unix bzw. set ff=dos

Werkzeuge IV

Dokumentation von DTDs

dtddoc ist eine XML-Sprache, mit der man Document Type Definitions und ihre Beschreibung erzeugen kann. dtddoc verwende ich für die DTDs für elektronisches Publizieren, wie z.B. für diese Webseiten, und auch für die DTDs, die für den Modulkatalog benötigt werden.

Die Definition der Sprache sowie der XSL Transformationen zum Generieren der DTDs und der Dokumentation ist frei verfügbar. Die aktuelle Version ist 1.14.

Burkhardt Renz: Documentation of DTD dtddoc: A Language for Defining and Documenting DTDs.
Zip Archivdatei, 825 KB, Stand 25.10.2006

Eine Beschreibung von dtddoc ist dtddoc.pdf (Teil des Zip-Archivs). Sollte jemand dtddoc verwenden, würde ich mich über eine E-Mail freuen.

Werkzeuge V

Kleine (Unix-)Helferlein

Finde alle Zeilen mit »pattern« in Dateien mit der Endung ».ext«:

find . -name "*.ext" -exec fgrep pattern "{}" ";"

Zusätzlich gibt die Option -print den Namen der gefundenen Datei aus.

 

Es gibt immer noch Editoren, die nach der Windows-Manier eine Zeile mit linefeed und carriage return abschließen. Die Folge ist: Lädt man eine solche Datei mit vi oder vim, steht an der letzten Stelle einer jeden Zeile Ctrl-M oder ^M. Nicht gerade schön. Was tun?

tr -d '\15\32' < winfile > unixfile

Noch einfacher im vim:

:%s/<Ctrl+V><Enter>//

[Aktuell] [Veranstaltungen] [Projekte & Publikationen] [Literatur & Links] [Impressum] [<][^][>]