README #1

Maintaining P4Web Help
======================
Before making changes, sync the latest P4Web help files (.../p4web/Help/...)

Editing files
-------------
To change existing files, open the files for edit
and enter your changes. Use this format for hypertext links:

      For links to HTML files:
         href="filename?help"
      or:
         href="filename?help#anchor"

      For links to images:
         src="/filename?icon"


Adding files
------------
1. Open any new HTML files for add. 

2. Add links for the new HTML files to roadmap.html. If the new 
   files incorporate new images, be sure to open the
   image files for add as well. Open new HTML files for add as text+kw.

3. Open //depot/R/p4-web/Help/Jamfile and add entries for your new files.

4. Open /p4-web/Views/p4wHelpView.cpp and add entries for your new files.

5. Regenerate the embedded help content header files from //depot/R/p4-web/Help
   by issuing the following command:

      jam

Deleting files
--------------
If you are deleting HTML files, open them for delete,
remove links from roadmap.html, and remove any links to
the file from other topics.

Remove entries from the jam file and p4wHelpView.cpp.

Generating web site files
=========================
The P4Web help files that we supply from our corporate Web site are generated 
from the files you edit in /P4Web/Help. The files are generated into 
p4-doc/manuals/p4web. Your machine must be configured to run jam and python.

To generate the web-site help files:

1. Sync the head revision of the p4/Version file.

2. Set the P4WEBMANUALDIR environment variable to the parent directory of
   the target directory in p4-doc. Example: 

	set P4WEBMANUALDIR=E:\myworkspace\depot\main\p4-doc\manuals\p4web\

3. In the P4Web/Help directory, issue the following command:

      jam -a manual

All help files are regenerated into the directory specified by
P4WEBMANUALDIR. To regenerate only changed files, omit the -a flag.

4. If you have added images or html files, open the newly-generated files
   and images in the p4-doc directory for add. Open new HTML files for add as text+kw.

5. Open  regenerated files for edit by issuing the following command:

      p4 diff -se //depot/R/p4-doc/manuals/p4web/help/... | p4 -x - edit

6. Verify your changes by browsing the generated files.

7. Submit the changelist containing the changed and new files.