|
This website is organized using a directory tree structure, which is common to any modern operating system. A website directory must contain at least the following filesAdditionally, the ``website'' must have the following to ``define'' the site.
.levelgives directory related information and references the website macro packageMakefiledrives the m4 to html processindex.htm4,vorindex.htm4the index file for this directory. The.htm4,vfiles are the sources under revision control management (RCS). The name could be different from index, but for consistency it's generally a good idea to not change it.Other web pages can be added, for example
- Every website must have a
.sitefile for site dependent info,- and, of course, the HTML macro package
htm4and associated files.myinfo.htm4,vormyinfo.htm4, which the index file will then reference. This web file will then refer to the index file as its ``up-page'' in the START_HTML macro. The ``this-page'' entry is the basename for this page (i.e. no extensions).The
.levelfileThe.levelfile gives certain directory information and includes the website specific site file.site. A typically looks like the following:divert(-1) # # level information # define(`DIR_LEVEL', 2) define(`THIS_DIR', howto/webpaging/) include(../../.site) include(../../htm4)@[]@_DNL _DEFINE(@[_SUBTITLE]@, Dr.RK's Web Paging ($1))@[]@_DNLThe m4 macrodivert(-1)is a convenient way to eliminate unnecessary text like comments. The rest of the macros either define directory specific info, include m4 macro packages, or define information common to all webpages in this directory for this implementation.Note that the m4 quoting mechanism before & after the
DIR_LEVELgives the level of this directory below this website's ``root''THIS_DIRgives the directory path from the website ``root'' to this directory. This string is pasted on any file names relating to this directory. This is necessarily specific to the operating system.- The first include file includes in the site specific information.
- The next include file is the HTML macro package.
_SUBTITLEis a convenience for ensuring all the web pages in this directory have similar and identifiable titles. The ``@[]@_DNL'' is added to avoid blank lines appearing at the head of the resulting.htmlfile.- Miscellaneous macros may be added at the end to signal special processing for all the webpages in this directory. For example:
_PRESENTATION@[]@_DNLhtm4inclusion changes from `'s to @[]@s, as well as all of the m4 macros have been redefined to avoid accidental consequences. The file inclusions are also operating system specific. However, this is isolated to the.levelfiles of each directory.The
MakefileTheMakefiledrives the process of creating HTML web pages from the.htm4or.htm4,v. TheMakefileis generated semi-automagically by using theSetupmakescript in the webroot and executing it in the current directory. A typicalMakefilelooks like the following:# generated by "setupmake" on Wed Dec 25 12:42:50 PST 1996 SRCS = index.htm4 myinfo.htm4 OBJS = index.html myinfo.html SHELL = /bin/sh HTML_ID = 1 KEY_ID = 3 VER_ID = 4 NULL = /dev/null M4 = mm4 .SUFFIXES: .SUFFIXES: .htm4 .html all: $(OBJS) setupmake: $(WEBROOT)/Setupmake $(M4) master: -if [ $(M4) = mm4 ];then \ for f in $(SRCS) ; \ do $(M4) $(M4FLAGS) $$f $(HTML_ID)> $(NULL) \ $(KEY_ID)>> $(WEBROOT)/.masterkey \ $(VER_ID)>> $(WEBROOT)/.masterver ; \ done; fi .htm4.html: -if [ $(M4) = mm4 ];then \ $(M4) $(M4FLAGS) $< $(HTML_ID)> $@ \ $(KEY_ID)>> $(WEBROOT)/.masterkey \ $(VER_ID)>> $(WEBROOT)/.masterver ; \ else \ $(M4) $(M4FLAGS) $< | $(SHELL) ; \ fi clean: -rm $(OBJS) *.key *.ver 2> $(NULL)One of theMakefile's jobs is to recursively call theMakefiles in any subdirectory. From the webroot the entire website can be cleaned up or pages regenerated (with a possibly new look & feel). The best way to create theMakefileis to invoke the Setupmake script. It will analyze the current working directory and create aMakefiletailored for it. If a Makefile already exists then invokemake setupmakeThe
index.htm4fileThe index file primarily gives the links to the other files within this directory and perhaps some introductory material that explains the goal of the information in this directory.A typical index file may look like the following:
include(.level)_DNL START_HTML(_SUBTITLE(index), _UP(1)index, index, $Date$ ) _C _REVISION( $Revision$ ) _UNC _C _RCSID( $Id$ ) _UNC _KEYWORD(keyword1 keyword2 morekeywords) Some introductory material for this directory of information. The following is an unordered list of links to the pages in this directory (or subdirectories). _UL _LI A page detailing _PAGE(myinfo, my information) _LI A another page detailing _PAGE(myotherinfo, my other information) _LI This points to a _PAGE(subdir1/index, subdirectory of information) _LI This points to another _PAGE(subdir2/index, subdirectory of information) _UNUL END_HTMLThe
.sitefileA typical.sitefile contains the following site-specific type of information and must use ``raw m4'' macros to define certain quantities for later instantiation of thehtm4macro package. For example:divert(-1) # # Site specific information --> myISP.net # # Tailor this to your own site with global definitions # This must be in native m4 # define(`_FTP_SITE_', ftp://ftp.myisp.net/pub/rkowen/) define(`_CGI_SITE_', http://www.myisp.net/cgi-bin/rkowen/) define(`_WWW_SITE_', http://www.myisp.net/~rkowen/) define(`_EXT', .html) define(`_KEY', .key) define(`_VER', .ver) # for security reasons the HTML password file should NOT be within the website define(`_PASSWDFILE', /home/rkowen/.htpasswd)where
_FTP_SITE_is the anonymous ftp site_CGI_SITE_is where the cgi-bin scripts & programs are located._WWW_SITE_is the ``root'' for this website_EXTis the web page file extension_KEYis the keyword file extension for each web page_VERis the version file extension for each web page_PASSWDFILEwhere the.htpasswdpassword file is located. It should not be part of the website tree.
Last Modified:
Brought to you by: R.K. Owen,Ph.D.
This page is http://owen.sj.ca.us/rkowen/howto/webpaging/structure.html
