35da3377961e8105b4856884a2a1373fcb96c3b4 jcasper Fri May 31 13:14:00 2013 -0700 Added lines for making static files to makefile, and updated the README accordingly diff --git src/hg/js/README src/hg/js/README index 88a704b..4da035c 100644 --- src/hg/js/README +++ src/hg/js/README @@ -1,27 +1,31 @@ The js directory should hold all refereenced javascript files for normal browser CGIs. The contents includes the versions of jQuery package files mostly unmodified by UCSC, as well as several that are specific tothe browser. Files should be named for the CGI or the library that uses them: hgTracks.js included by hgTracks CGI. hui.js included by hui.c library code. utils.js common utilities included by multiple CGIs. -The "make alpha" command should place all *.js files in apache/htdocs/js/", -while "make" will places js files in apache/htdocs-{user}/js if it exists, -and otherwise in apache/htdocs/js/{user}. +The "make alpha" command should place all files in JS_FILES in apache/htdocs/js/, +while "make" will place them in apache/htdocs-{user}/js if it exists, and otherwise +in apache/htdocs/js/{user}. The one exception is that "make" will place any files +listed in STATIC_FILES in apache/htdocs-{user}/js if it exists (with everything else), +and otherwise in apache/htdocs/js. This is because static documents are hard-coded to +look in /js. Files listed in both STATIC_FILES and JS_FILES will be placed in both +locations. In order to avoid caching errors by client browsers, the CGIs reference these files by a symlink that contains the timestamp of the file. The symlink is created by the CGIs if not found. IMPORTANT: In for a user to test changes to javascript files on a named browser a setting must be added to the hg.conf file of that browser. For example for the browser "hgwdev-larrym", if apache/htdocs-larrym/ exists then the following line should appear in apache/cgi-bin-larrym/hg.conf: browser.documentRoot=/usr/local/apache/htdocs-larrym If that directory does not exist, then the following line must appear in apache/cgi-bin-larrym/hg.conf instead: browser.javaScriptDir=js/larrym