Procedures for SAS Workbook Authors

To all SMEs and Web Authors:

On Friday, April 7, 2006, a copy of the entire workbook was checked into CVS and placed under version control. (See CVS Repository --> Workbook.) At that time, I quoted Richard as having said, “the floodgates are now open for updates to the workbook”. Since that time, the following procedures have kept things working relatively smoothly and efficiently.

With that in mind, please review the following:

• New Topics/Files/Folders. -- If creating a new set of files, place all files in a single folder and include all pictures and examples of input files (FT1, FT2, etc.).

Other than that, there are only a few basic rules that should never be violated:

• Maximum page width is 650 pixels. (Remember that most of our readers are using laptops, and their screen real estate is a precious commodity.)

Create a single column, single row table 650 pixels wide, and lay out your page(s) within that table.

• Do not use Hdg 1; it is reserved.

• Do not check new files or folders into CVS. (See Submitting Files.)

Note: It is important that I check all new files into CVS for a number of reasons. One is naming conventions, and once a folder has been added in CVS, it is rather difficult and time consuming to change its name.

• Naming conventions. Please consult with me on the naming of files and folders; also, please avoid using subfolders as, navigationally, it is important to keep a very flat file structure.

• Images. All images or screen captures that you use should be included in the same folder as the html file you are working with. Remember that maximum page width is 650 pixels, so images should be sized accordingly; generally, the maximum image width should be 550 pixels.

Note: PNG files are preferred, but other types are routinely accommodated.

• Updating existing files. All workbook files you are updating can be checked out of CVS. If you are updating an existing file, please notify me when you begin, in case I happen to be working on the same file.

After you have completed your updates and committed the file(s) to CVS, be sure to notify me, so that I can update my master files, and make a quick editorial pass before posting it/them to the web.

Note: Normally, updated files can be posted to the web within hours (sometimes minutes!) of my having received notification.

• Submitting New Files/Folders. When you are ready to submit new files, please zip everything up and make it available to me.

I will then make a very basic editorial pass (i.e., incorporate the individual files into a template, attach the appropriate cascading style sheets, check all links, create any popups, create the print version, etc.) and, most importantly, ensure consistency of naming conventions.

With the exception of example FT1 and FT2 files, I will then check this folder and its associated files (which will have only the basic types of edits listed above) into CVS. The example files will be added to the ftp directory which resides on a different server.

Authoring tools. As most of you know, I am using Dreamweaver and Fireworks as my principle authoring tools and, as far as I know, only a few of you are using these same tools; in fact, most people are using a fairly wide variety of other tools. To date, this has not posed any particular problem, since we employ an iterative process; meaning that once you have committed your updates and notified me, I will update my master files and test them in my local directory, update links as necessary, update the site maps (this also ensures proper indexing), upload the files to the server (from my local directory), then commit any changed files in CVS, and notify you that they have been posted to the web.

Mirror site. The master files on my computer are the official version, and it is from there that files are posted to the web. However, these files are mirrored in CVS and, from time-to-time, the CVS version is tagged. At that time, I notify Berrie Giebels, and he then updates the mirror site at the Laboratoire Leprince-Ringuet (LLR) in France.

Templates and stylesheets. Templates and stylesheets can be made available to those who wish to use them. (Please be aware that the Science Tools section of the workbook uses a different set of templates and stylesheets than are used in the other sections.)

Most importantly, thanks to all of you for your participation and help, both past and future.

-Chuck

workbooklist@glast.stanford.edu