Loading...
Helix SwarmHelix Swarm
Loading...

README

  • //
  • guest/
  • perforce_software/
  • p4web/
  • main/
  • src/
  • Help/
  • README #1
  • View
  • Commits
  • Open Download .zip Download (2 KB) 
  1. Maintaining P4Web Help
  2. ======================
  3. Before making changes, sync the latest P4Web help files (.../p4web/Help/...)
  4.  
  5. Editing files
  6. -------------
  7. To change existing files, open the files for edit
  8. and enter your changes. Use this format for hypertext links:
  9.  
  10.       For links to HTML files:
  11.          href="filename?help"
  12.       or:
  13.          href="filename?help#anchor"
  14.  
  15.       For links to images:
  16.          src="/filename?icon"
  17.  
  18.  
  19. Adding files
  20. ------------
  21. 1. Open any new HTML files for add. 
  22.  
  23. 2. Add links for the new HTML files to roadmap.html. If the new 
  24.    files incorporate new images, be sure to open the
  25.    image files for add as well. Open new HTML files for add as text+kw.
  26.  
  27. 3. Open //depot/R/p4-web/Help/Jamfile and add entries for your new files.
  28.  
  29. 4. Open /p4-web/Views/p4wHelpView.cpp and add entries for your new files.
  30.  
  31. 5. Regenerate the embedded help content header files from //depot/R/p4-web/Help
  32.    by issuing the following command:
  33.  
  34.       jam
  35.  
  36. Deleting files
  37. --------------
  38. If you are deleting HTML files, open them for delete,
  39. remove links from roadmap.html, and remove any links to
  40. the file from other topics.
  41.  
  42. Remove entries from the jam file and p4wHelpView.cpp.
  43.  
  44. Generating web site files
  45. =========================
  46. The P4Web help files that we supply from our corporate Web site are generated 
  47. from the files you edit in /P4Web/Help. The files are generated into 
  48. p4-doc/manuals/p4web. Your machine must be configured to run jam and python.
  49.  
  50. To generate the web-site help files:
  51.  
  52. 1. Sync the head revision of the p4/Version file.
  53.  
  54. 2. Set the P4WEBMANUALDIR environment variable to the parent directory of
  55.    the target directory in p4-doc. Example: 
  56.  
  57. 	set P4WEBMANUALDIR=E:\myworkspace\depot\main\p4-doc\manuals\p4web\
  58.  
  59. 3. In the P4Web/Help directory, issue the following command:
  60.  
  61.       jam -a manual
  62.  
  63. All help files are regenerated into the directory specified by
  64. P4WEBMANUALDIR. To regenerate only changed files, omit the -a flag.
  65.  
  66. 4. If you have added images or html files, open the newly-generated files
  67.    and images in the p4-doc directory for add. Open new HTML files for add as text+kw.
  68.  
  69. 5. Open  regenerated files for edit by issuing the following command:
  70.  
  71.       p4 diff -se //depot/R/p4-doc/manuals/p4web/help/... | p4 -x - edit
  72.  
  73. 6. Verify your changes by browsing the generated files.
  74.  
  75. 7. Submit the changelist containing the changed and new files.
  76.  
  77.  
# Change User Description Committed
#1 12234 Matt Attaway Rejigger P4Web project in preparation for official sunsetting

The bin directory contain...s the last official builds of P4Web from the
Perforce download site. P4Web is soon to be completely sunsetted; these
builds are here for folks who don't want to build their own.

To better handle the archived builds the source code has been moved into
a separate src directory. «		 10 years ago
//guest/perforce_software/p4web/Help/README
#1 8914 Matt Attaway Initial add of the P4Web source code 11 years ago