Adding documents to the help system

Cross-reference URLs

SCO-supplied HTML topic files use absolute pathnames for cross-reference URLs:

   HREF=/topicID/file.html
topicID is the topic's installed directory under /usr/lib/scohelp/LANG/ (the DocumentRoot of the server).

HTML manual page references are made through a CGI program and are coded as:

   HREF=/cgi-bin/man/man?name+section
name is the name of the man page as listed in the man index file, and section is the name of the man page section. Going through a CGI program permits the manual page reference to function in a manner similar to the man(1) command line and deliver references to alias names as well as the original command name.

Using paths that begin with ``/'' permits the HTTP server to insert the appropriate language into the pathname for the documentation on a per-user basis.


NOTE: The language portion of the path is not inserted for relative-path URLs. This means that relative URLs will work, but only within the same language; there is no fallback to another language if the target of the URL is not in the current language. For this reason, you should generally only use relative URLs to point to files within the same topic directory. (Relative URLs do not work when viewing a node through search results, regardless of language fallback.)


Next topic: <IMG> tags
Previous topic: Tables of contents targets

© 1999 The Santa Cruz Operation, Inc. All rights reserved.
UnixWare 7 Release 7.1.1 - 5 November 1999