web-ui-ap-admin-help package
Information on this package is covered here.
|
Package
|
Description
|
License
|
|
web-ui-ap-admin-help
|
Online Help files for Access Point Web UI
|
Devicescape Software, Inc.
|
Summary
The web-ui-ap-admin-help package is the context-sensitive "popup" Online Help for the target Devicescape Reference AP.
The Popup Help source is provided as *.html files in web-ui-ap-admin/help/.
On a deployed Access Point (AP), these HTML Help files (and associated images and scripts) are located in /home/httpd/help/.
On a deployed AP, these HTML Help files are displayed to the users when they click the "?" button at the top of the Help panel, or the "More" link at the bottom. Help URIs defined in the "features" section of web-ui-ap-admin/src/admin-config.hdf map each tab to a Help file.
Online Help associated with Web pages for basic functionality of the Reference AP is provided by the web-ui-ap-admin-help package. This package includes most of the Online Help pages (and maps to the Web pages provided in the web-ui-ap-admin package).
Online Help for optional Web UI packages is implemented separately as part of associated Web UI extension packages to make it easy to exclude or include standard functionality (along with the associated Web UIs) during development.
For example, the Online Help for the Local Authentication Server (LAS) is included as part of the web-ui-las package. When you want LAS functionality on the AP, you build both the las package and the web-ui-las package into your root file system (RFS) image. This will provide LAS functionality on the AP and an associated Web UI page, along with its Online Help.
|
Notes
|
- The source files for the On-screen Panel Help for the Devicescape Reference AP Web UI text for the Panel Help is located in the file web-ui-ap-admin
/resources/Help.hdf. For more information, see web-ui-ap-admin package. - Online Help associated with Web UI extension packages is included in those packages. For more information, see the summary information in web-ui-ap-admin package and also the Web UI Framework topic in the Developer Guide.
|
Usage
To modify this Popup Help for your AP, update or replace the HTML Help files, images and so forth in the web-ui-ap-admin/help/ directory. HelpURIs defined in the "features" section of web-ui-ap-admin/src/admin-config.hdf map to these Help files.
For a detailed explanation on rebranding or modifying the Devicescape Reference AP Online Help files, please refer to the Web UI Framework topic in the Developer Guide; and in particular, the Help subtopics "Online Help and Administrator Guide for the AP Web UI" and "Rebranding the AP Web UI and Online Help".
Building the Package
The web-ui-admin-help is produced from a build of the web-ui-ap-admin package.
To build the Popup Help, build the web-ui-ap-admin package per the standard instructions for building userspace packages in the Devicescape Developer Guide topic on "Building the Packages", see subtopic: "Building a Userspace Package from a Source RPM"
When you rebuild the web-ui-ap-admin package the Help files are produced as a web-ui-ap-admin-help binary RPM which you can then choose to include (or not) as a separate help package along with the web-ui-ap-admin runtime package as part of a new root file system (RFS) for the AP.
Licensing
Devicescape Software, Inc.
Related Packages
Required
web-ui-ap-admin package
web-ui-framework package (development host package only; not a target package)
web-ui-services package (development host package only; not a target package)
Suggested
web-ui-ntp (The source package for this binary package is web-ui-ap-admin-ext)
web-ui-clustering
web-ui-las
web-ui-snmp
