OHSWG WWW site changes for authors

From: Peter Nuernberg (pnuern_at_daimi.aau.dk)
Date: Fri 07 Nov 1997 - 08:29:23 CST



Hi-

   I made a couple of changes to the OHSWG WWW site which may be of interest to those folks that author pages that appear on the site. People who only read the site can probably delete this letter.

   Those that attended OHS 3.5 may recall that we decided that any documents that the group generates should be "snapshots" of various parts of the WWW site. To facilitate the compiling of these snapshot documents, I have made some changes in the way that material is posted on the site. It used to be the case that people sent me full HTML pages that I then modified slightly to display the OHSWG page header. Now, I strip the header and footer material from all materials to be displayed on the site and store only the "body" of each page, along with another "data" file that provides the title, last date of update, and author list. I have built some shell scripts that I run occasionally that generate full HTML pages by concatenating a standard header file, the "body" part of each page, and a standard footer. This same script can also generate documents suitable for printing that consist of a header, the bodies of several pages, and a footer. You can see an example of one of these documents on the OHSWG WWW site. There is a link to a printable version of the entire site on the home page.

   These scripts do some sed processing on the header and footer templates as well as the page bodies. These sed scripts make sure that each page when displayed and each doument when printed has the correct title, the correct author attributions, etc.

   If you provide content for the WWW site, you need only provide the "body" of HTML files. You can of course continue to simply provide entire pages - I will strip the header and footer myself and store the body unless you explicitly request that the page be stored precisely as is. So, the end result is you can remain largely unaware of the changes that have been made. However, if you wish, you can also take advantage of the fact that all your provided content will be run through these sed scripts.

   I have built a "database" of all the content authors and list subscribers, along with their affiliations, e-mail addresses, and WWW homepages. If you would like the information I have for you changed, just e-mail me. If you are a page author, you can see this information by looking at the footer of any page you authored. Soon, I will build a script that generates the "people" page in the appendix section of the site from this database, but until then, you have to find a page you've authored to see this information. Unfortunately, the database information and the people page data are currently a little out of sync.

   The following table lists the strings that the sed scripts run over your content search for, and what they are replaced with.

   @%AUTHOR1, @%AUTHOR2, @%AUTHOR3

      These are replaced by the names of the first, second, and third
      authors respectively as recorded in the people database.

   @%AFFIL1, @%AFFIL2, @%AFFIL3
      These are replaced by the affiliations of the first, second, and
      third authors respectively as recorded in the people database.

   @%MAILADDR1, @%MAILADDR2, @%MAILADDR3
      These are replaced by the e-mail addrs of the first, second, and
      third authors respectively as recorded in the people database.

   @%WWWADDR1, @%WWWADDR2, @%WWWADDR3
      These are replaced by the WWW addrs of the first, second, and
      third authors respectively as recorded in the people database.

   @%TITLE, @%DATE
      These are replaced by the title and date of the document
      respectively.

   Also, the scripts "uncomment" some sections of the body. If your content contains the strings "<!--WWWONLY" or "WWWONLY-->", these strings will be removed when the WWW pages suitable for browsing that are generated. If your content contains the strings "<!--INLONLY" or "INLONLY-->", these strings are removed when the documents suitable for printing that are generated. An example use of this feature might be the following:

<!--WWWONLY Here are links to some information:<P>
<!--WWWONLY <UL>link1<BR>
<!--WWWONLY link2<BR></UL><P>
WWWONLY-->
<!--INLONLY Here are some references to some information:<P>
<!--INLONLY <UL>Information "link1" can be found at URL "url1".<BR>
<!--INLONLY Information "link2" can be found at URL "url2".<BR></UL><P>
INLONLY-->    You may consider using these features to improve the look of your content in the printable versions of documents we generate.

   The scripts are a little rough, and I may very well change a few things. If you have suggestions, especially if you are willing to help with the coding, or if you have any questions about these scripts, just e-mail.

-Peter



This archive was generated by hypermail 2.1.5 : Tue 13 Aug 2002 - 07:20:52 CDT