Show TOC

Hilfetexte in und für Web-Dynpro-ApplikationenLocate this document in the navigation structure

Verwendung

Es gibt verschiedene Möglichkeiten, für Endbenutzer kürzere Hilfetexte sowohl innerhalb von Web-Dynpro-Applikationen, also auf den verschiedenen Views für UI-Elemente, zu platzieren, als auch für eine komplette Anwendung bzw. ein Window längere Dokumentationstexte zu verlinken.

Zusätzlich können Sie für Entwickler im System Hilfetexte für Web-Dynpro-Components und Controller hinterlegen.

Ausnahme

Für das S4Hana-System werden Soforthilfe, Feldhilfe und Hilfe-Links im Help Center nicht im Kontext-Menü angeboten. Das API steht ausserdem nicht zur Verfügung mit dem die Anwendung Quick-Help und Help Center aufrufen kann. Langtexte zu T100 Meldungen werden nicht ausgegeben, weder in den Meldungen der Message Area, noch in der Message Log.

Vorgehensweise

Hilfe für Benutzer bereitstellen

  • Soforthilfe

    Sie stellen Hilfe-Texte direkt auf dem User Interface zur Verfügung, die der Benutzer über den Eintrag Soforthilfe einblenden im Kontextmenü sichtbar macht.

    Sie stellen diese Hilfe-Texte zur Verfügung:

    • Als eigenes UI-Element auf Ihrer View mit dem UI-Element Explanation. Der Text, den Sie für dieses UI-Element definieren, wird dann nur angezeigt, wenn der Benutzer die Soforthilfe eingeblendet hat.

      Weitere Informationen: UI-Element Explanation

    • Als zusätzlichen Text zu einem UI-Element, der über die Eigenschaft explanation des jeweiligen UI-Elements gepflegt wird. Das UI-Element wird dann mit einem grünen Unterstrich dargestellt und zeigt, wenn der Cursor darauf platziert ist, den entsprechenden Text an.

      Weitere Informationen: Eigenschaft explanation

  • Mehr Feldhilfe

    Sie verwenden die klassische F1-Hilfe, die der Benutzer über den Eintrag Mehr Feldhilfe im Kontextmenü aufrufen kann.

    Weitere Informationen: Klassische F1-Hilfe

  • Hilfe-Links im Help Center

    Sie stellen in Ihrer Web-Dynpro-Anwendung das Help Center zur Verfügung und setzen dort Links auf Hilfs-Texte im Knowledge Warehouse

    Weitere Informationen: Hilfe-Links im Help Center setzen

Hilfe für Entwickler bereitstellen

Im System können Sie für Web-Dynpro-Components und -Controller Entwicklerdokumentation anlegen. Verwenden Sie dazu in der Entwicklungsumgebung in der jeweiligen Component bzw. Controller die Funktion Component-Dokumentation bzw. Controller-Dokumentation.

Diese beiden Dokumentationsklassen sind auch in der Dokumentationspflegetransaktion ( SE61) über die Einzelobjektbearbeitung erreichbar:

  • WD

    Kürzel für die Dokumentation für Components/Component Interfaces.

  • WC

    Kürzel für die Dokumentation für Controller (sowohl Component-/Custom-/View-/Window-Controller).

Diese Dokumentationsobjekte sind, genauso wie die anderen im System befindlichen Dokumentationsobjekte auch, an das Transport- und Korrekturwesen angeschlossen und ebenfalls an die Übersetzung.

Beispiel

Sie finden ein Beispiel für die Hilfe-Anbindung im System in der Component WDR_TEST_HELP.

Weitere Informationen

Weitere Informationen zur Pflege von Hilfe-Links und zur Hilfe-Anzeige finden Sie in den Hinweisen 1338118 Auf SAP-Site veröffentlichte Informationen und 1253360 Auf SAP-Site veröffentlichte Informationen.

Informationen über die Web-Dynpro-Autorenumgebung finden Sie unter Web-Dynpro-Text-Browser.

Informationen über die Aspekte, die für die Übersetzung zu berücksichtigen sind, finden Sie unter Internationalisierung und Übersetzung.

Informationen über den Titel im Business Client finden Sie unter PageHeader.