GUI zum Editieren von POD

28/09/2009 - 20:09 von K. Wittrock | Report spam
Hallo POD-Schreiber,

zur Zeit schreibe ich ein Perl/Tk-Programm, welches mir ein GUI zum
Editieren von POD bereitstellt. Um ein Gefühl dafür zu bekommen, ob
dieses Programm von allgemeinem Interesse sein könnte, liste ich im
Folgenden dessen wesentliche Fàhigkeiten auf und bitte um eure
Meinungen, Kritiken und Anregungen.

* Die zu editierende Datei wird in einem scrollbaren TextUndo-Widget
angezeigt. Dabei werden Perl-Kode-Blöcke hellgelb unterlegt oder in
dunkelblau geschrieben. Perl-Kode kann aus- und eingeblendet werden.

* Ein Button für jeden formatting code (z. B. B<>). Wenn beim
Anklicken eines dieser Buttons Text selektiert ist, befindet sich dieser
anschließend zwischen den Klammern. Sonst wird der Eingabecursor
zwischen die Klammern gesetzt. Der Bracketlevel kann voreingestellt
werden.

* Zusàtzliche Buttons für Escape-Formatierungen mit festem Inhalt, z.
B. E<lt>.

* Eine Auswahlliste für alle POD-Kommandos. Das Kommando wird vor die
Zeile mit dem Eingabecursor gesetzt. Dahinter wird der Platz für den 1.
Textblock vorbereitet. Um Leerzeilen über und unter dem Kommando braucht
man sich nicht zu kümmern. Bei head1 wird der eingegebene Text
automatisch in Großbuchstaben umgewandelt (Kode von Christoph
Lamprecht). Bei Kommandopaaren wird die gesamte Gruppe eingefügt:
=over => =over | =item | =back
=begin => =begin | =end
POD-Kommando vor Perl-Kode => POD-Kommando | =cut
Bei =begin | =end braucht der Formatname (z. B. html, text, comment) nur
einmal eingegeben zu werden.

* Eine Auswahlliste für die am hàufigsten verwendeten =head1-Texte,
ev. getrennt nach Allgemein, Module, OO-Kode, Perl/Tk, Perl-Programme.
Die Texte werden in einer Textdatei abgelegt, die lokal angepasst werden
kann.

* Zur Kontrolle kann podchecker für die editierte Datei aufgerufen
werden, außerdem verschiedene POD-Formatierer (pod2man, pod2text,
pod2html) zur Begutachtung des Resultats.

* Ein Hilfe-Button blendet das zum POD-Editierprogramm gehörige POD
ein.

Gruß

Klaus

Persönliche Antwort bitte nur an
K<ohne_Punkt_und_Komma>Wittrock<Klammeraffe>web.de
 

Lesen sie die antworten

#1 Frank Seitz
29/09/2009 - 20:27 | Warnen spam
K. Wittrock wrote:
Hallo POD-Schreiber,

zur Zeit schreibe ich ein Perl/Tk-Programm, welches mir ein GUI zum
Editieren von POD bereitstellt. Um ein Gefühl dafür zu bekommen, ob
dieses Programm von allgemeinem Interesse sein könnte, liste ich im
Folgenden dessen wesentliche Fàhigkeiten auf und bitte um eure
Meinungen, Kritiken und Anregungen.

* Die zu editierende Datei wird in einem scrollbaren TextUndo-Widget
angezeigt. Dabei werden Perl-Kode-Blöcke hellgelb unterlegt oder in
dunkelblau geschrieben. Perl-Kode kann aus- und eingeblendet werden.

* Ein Button für jeden formatting code (z. B. B<>). Wenn beim
Anklicken eines dieser Buttons Text selektiert ist, befindet sich dieser
anschließend zwischen den Klammern. Sonst wird der Eingabecursor
zwischen die Klammern gesetzt. Der Bracketlevel kann voreingestellt
werden.

* Zusàtzliche Buttons für Escape-Formatierungen mit festem Inhalt, z.
B. E<lt>.

* Eine Auswahlliste für alle POD-Kommandos. Das Kommando wird vor die
Zeile mit dem Eingabecursor gesetzt. Dahinter wird der Platz für den 1.
Textblock vorbereitet. Um Leerzeilen über und unter dem Kommando braucht
man sich nicht zu kümmern. Bei head1 wird der eingegebene Text
automatisch in Großbuchstaben umgewandelt (Kode von Christoph
Lamprecht). Bei Kommandopaaren wird die gesamte Gruppe eingefügt:
=over => =over | =item | =back
=begin => =begin | =end
POD-Kommando vor Perl-Kode => POD-Kommando | =cut
Bei =begin | =end braucht der Formatname (z. B. html, text, comment) nur
einmal eingegeben zu werden.

* Eine Auswahlliste für die am hàufigsten verwendeten =head1-Texte,
ev. getrennt nach Allgemein, Module, OO-Kode, Perl/Tk, Perl-Programme.
Die Texte werden in einer Textdatei abgelegt, die lokal angepasst werden
kann.

* Zur Kontrolle kann podchecker für die editierte Datei aufgerufen
werden, außerdem verschiedene POD-Formatierer (pod2man, pod2text,
pod2html) zur Begutachtung des Resultats.

* Ein Hilfe-Button blendet das zum POD-Editierprogramm gehörige POD
ein.



Da POD sehr einfach ist, braucht allenfalls ein Anfànger diese
Art von Unterstützung, wobei auch der Anfànger schnell Ansprüche an deinen
Editor stellen wird, die du nicht erfüllen kannst. Sinnvoller
würde es mir daher erscheinen, sowas in einen existierenden Editor
(z.B. Emacs, vi, Eclipse) zu integrieren. Sowas mit Perl/Tk zu bauen,
ist aber sicherlich ein nettes Übungsprojekt.

Grüße
Frank
Dipl.-Inform. Frank Seitz; http://www.fseitz.de/
Anwendungen für Ihr Internet und Intranet
Tel: 04103/180301; Fax: -02; Industriestr. 31, 22880 Wedel

Ähnliche fragen