Show TOC

Andere Texte einbinden: INCLUDELocate this document in the navigation structure

Vorgehensweise

Mit dem Kommando INCLUDE können Sie den Inhalt eines anderen Textes in Ihren Text einbinden. Der einzubindende Text existiert getrennt von Ihrem und wird erst zum Zeitpunkt der Ausgabeaufbereitung übernommen.

Beim INCLUDE-Kommando erhalten Sie immer die aktuellste Version des gewünschten Textes, da dieser erst bei der Ausgabeaufbereitung gelesen und eingefügt wird.

        
/: INCLUDE name [OBJECT o] [ID i] [LANGUAGE l] [PARAGRAPH p] [NEW-PARAGRAPH np]
         

Der Name des einzufügenden Textes muß angegeben werden und kann maximal 70 Zeichen lang sein. Enthält der Textname Leerzeichen, dann ist er als Literal in Hochkommata zu setzen. Er kann auch über ein Symbol spezifiziert werden. Alle weiteren Parameter des INCLUDE-Kommandos können wahlweise angegeben werden. Fehlen sie, so verwendet SAPscript dafür Standardwerte, die sich aus der jeweiligen Aufrufumgebung ergeben.

Beispiel

/: INCLUDE MYTEXT

Der Text MYTEXT wird in der Sprache des aufrufenden Textes eingebunden.

/: INCLUDE MYTEXT LANGUAGE 'E' PARAGRAPH 'A1'

Der Text mit dem Namen MYTEXT und der Sprache E wird eingebunden, unabhängig davon, in welcher Sprache der rufende Text erstellt ist. Als Standardabsatz soll für diesen Aufruf das Absatzformat A1 gelten.

Optionale Angaben:

  • LANGUAGE

    Fehlt die Angabe einer Sprache, so wird für den einzubindenden Text die Sprache des rufenden Textes bzw. die Formularsprache gesetzt. Ist eine Sprache spezifiziert, so wird der Text immer in dieser Sprache geholt, unabhängig davon, wie die Sprache des rufenden Textes ist.

  • PARAGRAPH

    Der einzubindende Text wird mit dem ihm zugeordneten Stil aufbereitet. Mit diesem Parameter kann der Standardabsatz dieses Stils für den aktuellen Aufruf umdefiniert werden. Alle *-Absätze des eingefügten Textes werden dann mit dem hier angegebenen Absatz formatiert.

  • NEW-PARAGRAPH

    Die erste Zeile des einzubindenden Textes wird (sofern dies keine Kommentar- oder Kommandozeile ist) mit diesem Formatkennzeichen versehen. Ist die optionale Angabe PARAGRAPH (siehe oben) leer, werden dazu noch alle *-Absätze des eingefügten Textes mit dem bei NEW-PARAGRAPH angegebenen Absatz np formatiert.

  • OBJECT

    Um einen Text vollständig zu spezifizieren, sind noch Angaben hinsichtlich des Textobjekts notwendig. Hierzu gibt es verschiedene Regeln und Einschränkungen, die vom Objekttyp des rufenden Textes abhängen:

    • In ein Formular können alle Texte eingebunden werden. Ist hier kein Objekt angegeben, wird TEXT verwendet (Standardtexte).

    • Bei einem Dokutext (Objekt DOKU) dürfen Sie nur Dokutexte inkludieren. Dieses Objekt wird auch angenommen, wenn in dieser Umgebung kein Objekt spezifiziert ist.

    • In einen Hypertext (Objekt DSYS) können nur Hypertexte oder Dokutexte inkludiert werden. Fehlt die OBJECT-Angabe, wird DSYS als Standardwert eingesetzt.

    • In allen anderen Texte dürfen Sie nur Standardtexte (Objekt TEXT), Dokutexte oder Hypertexte übernehmen. Standardobjekt ist TEXT, wenn nichts angegeben ist.

  • ID

    Die Text-Id ist ein weiterer Teil des Textschlüssels, die innerhalb eines Objekts weitere Texttypen zuläßt. Ist die Id nicht angegeben, so wird die Default-Include-Id aus der Tabelle TTXID für den rufenden Text verwendet. Fehlt die Angabe in dieser Tabelle, wird die Text-Id des rufenden Textes verwendet.

Die Id unterliegt nun zusammen mit dem Objekt einer weiteren Konsistenzprüfung:

  • Bei einem Formular sind alle Text-Ids zulässig.

  • In Dokutexte dürfen nur Dokutexte mit den Text-Ids TX (allgemeine Texte), UO (Berechtigungsobjekte) und solche Dokutexte eingebunden werden, die die gleiche Text-Id haben wie der rufende Dokutext.

  • In DSYS-Texte dürfen alle DSYS-Texte unabhängig von ihrer Id inkludiert werden. Einzufügende Dokutexte dürfen nur die Ids TX und UO besitzen.

  • In die anderen Texte dürfen Standardtexte mit allen zulässigen Text-Ids, DSYS-Texte mit allen Ids sowie Dokutexte mit den Ids TX und UO eingebunden werden.

Das INCLUDE-Kommando liefert in dem Symbol SAPSCRIPT-SUBRC einen Statuscode zurück:

  • 0: der gewünschte Text wurde eingebunden.

  • 1: das Kommando wurde nicht ausgeführt, da es syntaktisch fehlerhaft aufgebaut war.

  • 2: die Regeln für einzubindende Texte wurden nicht beachtet (siehe oben).

    Dieser Wert kann nicht auftreten, wenn das Kommando in einem SAPscript-Formular verwendet wird.

  • 4: der gewünschte Text wurde nicht gefunden.