Show TOC

Dokumentation zur VorgehensweiseDokumentation erfassen Dieses Dokument in der Navigationsstruktur finden

 

Sie haben die Möglichkeit eine Langtext-Dokumentation sowohl für eine BSP-Extension als auch für jedes einzelne darin enthaltene BSP-Element im System anzulegen. Dieser Dokumentation kommt bei der produktiven Verwendung der Extension in BSP-Seiten eine hohe Bedeutung zu, da hier auf die Besonderheiten der einzelnen BSP-Elemente eingegangen werden kann.

Wurde die Dokumentation im System abgelegt, dann ist sie über das Kontextmenü im Tag Browser und zusätzlich nach Einfügen der Tags in eine BSP-Seite auch mittels F1 im Layout-Editor verfügbar.

Voraussetzungen

  • Die BSP-Extension und die zu dokumentierenden Elemente wurden bereits angelegt.

  • Es stehen jeweils unterschiedliche Templates für die BSP-Extension und die BSP-Elemente zur Verfügung. Die Vorgehensweise beim Anlegen der Dokumentation ist jedoch analog.

Vorgehensweise

Um eine Dokumentation zu einem BSP-Element in der SE80 anzulegen, gehen Sie wie folgt vor:

  1. Wählen Sie die BSP-Extension im Repository Browser aus.

  2. Doppelklicken Sie auf das gewünschte BSP-Element in der Objektliste.

    Der Element-Editor wird angezeigt.

  3. Wechseln Sie in den Änderungsmodus.

  4. Klicken Sie auf die Drucktaste Dokumentationin der Symbolleiste.

    Der SAPScript-Editor wird aufgerufen und zeigt ein leeres Template mit vordefinierten Absätzen an.

  5. Schreiben Sie den Text in den vorgesehenen Absätzen.

  6. Sichern Sie das SAPScript-Dokument zunächst nur als Rohversion.

  7. Testen Sie die Dokumentation und führen Sie Korrekturen durch, sofern erforderlich.

  8. Sichern Sie das Dokument als aktive Version.

Ergebnis

Sie haben ein SAPScript-Dokument für die Langtext-Dokumentation eines BSP-Elements angelegt und ihm einen Transportauftrag zugeordnet. Falls Sie das Dokument auch in aktiver Fassung gesichert haben, gelangt es in den Arbeitsvorrat der Übersetzung.

Beispiel

Für die BSP-Extension HTMLB steht die Dokumentation für alle BSP-Elemente zur Verfügung.