Kate-Textbausteine

Martin Gergov

T.C. Hollingsworth

Einleitung

Kate-Textbausteine ist eine Erweiterung, mit dem Sie sogenannte Bausteine (wiederverwendbarer Quelltext oder beliebiger Text) benutzen und sich damit die Eingabe von Text erleichtern können. Die Erweiterung unterstützt außerdem Quelltextvervollständigung und JavaScript.

Menüstruktur

AnsichtWerkzeugansichtenTextbausteine anzeigen

Zeigt die Textbaustein-Seitenleiste mit allen Bausteinen aus Ihrem Archiv für den gerade geöffnete Dateityp.

ExtrasTextbaustein erstellen

Erstellt einen neuen Textbaustein, der als wieder verwendbarer Text in jeden Bereich von beliebigen Dokumenten eingefügt werden kann.

Textbaustein-Seitenleiste

Die Textbaustein-Seitenleiste für Kate.

Die Seitenleiste für Kate-Textbausteine.

In der Seitenleiste wird eine Liste der Textbaustein-Archive angezeigt. Außerdem können Sie eigene Archive erstellen, aus dem Internet oder von lokalen Dateien laden. Jedes Archiv hat ein Ankreuzfeld, um es zu aktivieren oder zu deaktivieren. Mit den Knöpfen unter der Archivliste können Sie vorhandene Archive bearbeiten oder löschen.

Textbaustein-Archivdateien laden

Sie können Textbaustein-Archive aus dem Internet herunterladen. Drücken Sie dazu auf Neue Textbausteine herunterladen, um eine Liste aller verfügbaren Archive anzuzeigen. Nachdem Sie das gewünschte Archiv heruntergeladen haben, müssen Sie es noch aktivieren.

Textbausteinarchive erstellen und bearbeiten

Um ein neues Textbausteinarchiv anzulegen, drücken Sie auf Archiv hinzufügen. Geben Sie im nächsten Dialog dann den Namen der Textbausteindatei und die Autoren ein und wählen eine Lizenz. Nach Eingabe aller Daten drücken Sie auf OK.

Der Archiv-Editor.

Die Benutzerschnittstelle des Archiv-Editors.

Der Editor für Textbausteinarchive enthält die folgenden Einstellmöglichkeiten:

Name

Erscheint in der Liste der Textbausteine in der Werkzeugansicht und danach wird außerdem bei der Benutzung der Quelltextvervollständigung gesucht.

Namensraum

Präfix, das für die Quelltextvervollständigung verwendet wird.

Lizenz

Wählen Sie die Lizenz für Ihr Textbausteinarchiv.

Autoren

Geben Sie hier den Namen der Autoren der Textbausteindatei ein.

Dateitypen

Wählen Sie einen oder mehrere Dateitypen für dieses Textbaustein-Archiv. Als Voreinstellung wird hier verwendet, dann wird das Archiv für alle Dateitypen benutzt. Sie können den Typ zum Beispiel auf C++ ändern oder aus einer Liste von Dateitypen auswählen, Benutzen Sie die Umschalt-taste, um mehrere Dateitypen hinzuzufügen.

Textbausteine erstellen und bearbeiten

Der Textbaustein-Editor.

Die Benutzerschnittstelle des Textbaustein-Editors.

Name

Der Name wird in der Vervollständigungsliste angezeigt.

Kurzbefehl

Drücken Sie diesen Kurzbefehl, um den Textbaustein in das Dokument einzufügen.

Textbausteine

Der Text, der mit Ihrem Textbaustein in das Dokument eingefügt wird.

Ein Textbaustein kann editierbare Felder enthalten. Zwischen diesen Feldern können Sie mit der Tabtaste wechseln. Folgende Ausdrücke können in Vorlagentexten benutzt werden, um Felder zu erstellen:

Mit ${field_name} erstellen Sie ein einfaches Feld, dessen Wert editiert werden kann. Alle weiteren Vorkommen desgleichen field_name sind Felder, die den Wert des ersten Felds beim Editieren erhalten.

Mit ${field_name=default} können Sie einen Standardwert für ein Feld angeben. Als Standardwert default kann ein beliebiger JavaScript-Ausdruck verwendet werden.

Mit ${field_name=text} können Sie einen Text als Vorgabewert angeben.

Mit ${func(other_field1, other_field2, ...)} können Sie ein Feld erstellen, das eine JavaScript-Funktion bei jeder Bearbeitung evaluiert und den Wert des Felds enthält. Auf der Karteikarte Skripte finden Sie weitere Informationen.

Mit ${cursor} können Sie die Endposition des Cursors angeben, nachdem alle Felder ausgefüllt wurden.

Skripte

JavaScript-Hilfsfunktionen, die Sie in Ihren Textbausteinen verwenden können.

Alle JavaScript-Funktionen sollten den Inhalt für ein Vorlagenfeld als Zeichenkette zurückgeben.

Funktionen werden in einem Gültigkeitsbereich aufgerufen, der den Inhalt aller editierbaren Vorlagenfelder als lokale Variablen enthält. Gibt es zum Beispiel in einem Textbaustein ${Feld}, dann gibt es eine Variable mit dem Namen field, die den aktuellen Wert des Vorlagenfelds enthält.Diese Variablen können entweder statisch in der Funktion verwendet oder als Argument übergeben werden, indem Sie .${func(field)} oder ${field2=func(field)} in der Zeichenkette des Textbausteins verwenden.

Mit der Programmierschnittstelle (Skript-API) von Kate haben Sie Zugriff auf ausgewählten Text, den gesamten Text, den Dateinamen und weitere Informationen mit den zugehörigen Methoden der Objekte document und view. Weitere Informationen finden Sie in der Programmierschnittstelle von Kate.

Textbausteine benutzen

Zugriff auf Kate-Textbausteine in der Werkzeugansicht und im Auswahlfeld.

Auswahl aus einer Liste von Textbausteinen.

Sie können Textbausteine auf zwei Arten aufrufen:

  • Wählen Sie einen Textbaustein aus der Werkzeugansicht.

  • Drücken Sie beim Schreiben die Tastenkombination Strg+Leerzeichen, dann wird eine Liste aller Textbausteine in einem Auswahlfeld angezeigt. Dann erscheinen ähnlich wie bei der Quelltextvervollständigung nur die passenden Textbausteine im Auswahlfeld.

Wenn der Textbaustein zudem die Variable ${cursor} enthält, geht der Cursor automatisch zur ersten Postion der Variablen und erlaubt Ihnen dann, hier einen Text einzugeben. Nach der Eingabe drücken Sie die Tab-taste, um zur nächsten Variablen zu springen usw.

Danksagungen

Die Kate-Textbausteine wurden von Joseph Wenninger geschrieben.

Besonderer Dank geht an den „Google Code-In 2011“-Teilnehmer Martin Gergov, der den Hauptteil diese Abschnitts geschrieben hat.