Show TOC

HintergrundHilfetexte in und für Web-Dynpro-Applikationen Dieses Dokument in der Navigationsstruktur finden

 

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 aus dem Knowledge Warehouse anzuzeigen.

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

Hilfetexte für Endbenutzer
Hilfetexte für UI-Elemente

Für Oberflächenelemente gibt es die folgenden Möglichkeiten, Hilfetexte zu hinterlegen:

Hilfetexte für eine Applikation oder ein Window (Help Center)

Für eine Web-Dynpro-Applikation oder ein Window können Sie einen im Knowledge Warehouse erstellten Hilfetext (Info-Objekt) als Hilfe hinterlegen.

Hinweis Hinweis

Dazu benötigen Sie eine gepflegte RFC-Verbindung AIO_FOR_HELP_LINKS zu Ihrem Knowledge-Warehouse-System. Siehe auch SAP Hinweis 1180737.

Ende des Hinweises.

  1. Verzweigen Sie im Web-Dynpro-Explorer zu den Eigenschaften der Anwendung bzw. des Windows, für das Sie den Hilfe-Link hinterlegen möchten.

  2. Wählen Sie Hilfe-Links.

    Sie erhalten eine Übersicht aller bereits existierender Hilfe-Links, die Sie über das entsprechende Symbol anzeigen lassen können (Hilfe-Link testen). Im Änderungsmodus können Sie zusätzlich bei Bedarf die Hilfe-Links ändern oder löschen oder den Text, der als Titel im Hilfe-Browser-Fenster angezeigt wird, abändern.

  3. Um einen zusätzlichen Hilfe-Link anzulegen, wählen Sie Zeile anhängen.

    Sie verzweigen automatisch in das Knowledge-Warehouse-System, in dem Sie den Kontext, den Bereich, die Struktur sowie das darin enthaltene von Ihnen gewünschte Info-Objekt auswählen.

    Beachten Sie, dass sowohl Topic als auch Struktur im Knowledge Warehouse freigegeben sein müssen.

    Der Titel des Topics aus dem Knowledge Warehouse wird im FeldText (OTR) automatisch als Titel für das Browser-Fenster vorgeschlagen und als OTR-Text angelegt. Sie können diesen Text auch ändern, indem Sie ihn überschreiben oder durch einen OTR-Alias in der Notation $OTR:Aliasname ersetzen. Alternativ können Sie den Titel auch über den Web Dynpro Text Browser einfügen.

    Hinweis Hinweis

    Wenn Sie einen OTR-Alias verwenden, steht ein Verwendungsnachweis für den Aliastext im Feld Verwendung zur Verfügung.

    Ende des Hinweises.

  4. Wählen Sie Weiter (Enter).

    Ihr neuer Hilfe-Link wurde in der Liste der existierenden Hilfe-Links eingefügt.

  5. Sichern Sie Ihre Eingaben.

Hinweis Hinweis

Sie können einen Hilfe-Link für eine Applikation oder ein Window auch über den Web Dynpro Text Browser erstellen.

Ende des Hinweises.
Aufruf der Hilfe

Als Endanwender rufen Sie die Hilfe in Ihrer Anwendung über die F1–Taste auf oder wählen Sie den entsprechenden Hilfe-Link, falls vorhanden. Dann erscheint, je nachdem, wie das Help Center konfiguriert ist, das Help Center neben Ihrer Anwendung im Sidepanel oder in einem neuen Browser-Fenster (siehe Applikationsparameter WDHELPCENTERDISPLAY). Unter dem Abschnitt Wissenswertes finden Sie die Hilfe-Links auf die Knowledge-Warehouse-Dokumentation.

Aktivieren des Help-Centers

Um die Anzeige des Help-Centers zu aktivieren, gehen Sie vor wie unter Help Center für SAP-Anwendungen aktivieren und einstellen beschrieben.

Weitere Informationen: Informationen für Benutzer im Help Center bereitstellen und Help Center für Web-Dynpro-ABAP-Anwendungen

Dynamisches Übersteuern des Applikations-Hilfe-Links

Wenn Sie in Ihrer Web-Dynpro-Applikation nicht den an der Anwendung definierten Hilfe-Link im Help-Center angezeigt bekommen möchten, sondern auswahlweise einen Link auf ein spezielles Hilfe-Topic, können Sie dynamisch den Applikations-Link übersteuern. Dazu verwenden Sie die Methode SET_HELP_LINK des Interface IF_WD_RR_APPLICATION und geben die APPLICATION_INFO an.

Syntax Syntax

Beispiel:

  1. method onactionchange_appl_helplink .

  data api_main2        type ref to if_wd_view_controller.
  data component        type ref to if_wd_component.
  data application      type ref to if_wd_application.
  data application_info type ref to if_wd_rr_application.

  api_main2 = wd_this->wd_get_api( ).
  component = api_main2->get_component( ).
  application = component->get_application( ).
  application_info = application->get_application_info( ).

  application_info->set_help_link( 'HELPTYPE=SAPHELP&_LOIO=452C8201E9EF48D882BD10244D085661&_CLASS=BIC_OOO' ).

endmethod.
Coding-Ende
Titel im Business Client

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

Hilfetexte für Entwickler

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.

Beispiel für Hilfe (Beispiel für Hilfe )

Weitere Informationen

Weitere Informationen zur Pflege von Hilfe-Links und zur Hilfe-Anzeige finden Sie in den Hinweisen 1338118 und 1253360.

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.