## Readme File for the Geoscience Outreach Website ##

The Geoscience_Outreach folder is organized into sub-folders.  This is a description of what is provided in each, and how to make changes if needed.  At the end of this readme are step by step directions how to generate the websites.


##
## html ##
##

This folder holds all of the html files that are generated and used to create the websites.

%% html_clickable_map:	This contains the html coding for creating the clickable map used on the homepage of the website.  Also included is the hypertext links to all of the states in a table underneith the map to bypass any issues with browser incompatibility.



%% html_footer:	This contains the html coding for the footer of the websites, this does not change in all 51 web pages.



%% html_site_header:	This contains the html coding for the header of the websites.
		## Can be changed ##
			This controls the text within each of the tabs at the top of each page.  Within the last 10 lines of this file, there are lines with [ <li class="TabbedpanelsTab firstTab">Map</li> ].  To edit the text within the tab, just changed the word "Map" to whatever you like.  This works with all four tabs.



%% html_tab2:		This contains the html coding for the second tab on each of the websites.
		## Can be changed ##
			This file controls what is said in the second tab on all 51 of the sites, to edit just replace the currently typed prose with your own.  To create or eliminate paragraphs, you must add or remove the <p>Insert prose here.</p> tags.



%% html_tab3:		This contains the html coding for the third tab on each of the websites.
		## Can be changed ##
			This file does the same as html_tab2 and should be edited similarly.  This file also has links to the Wisconsin map along with an example timeseries of a GPS station in Wisconsin (that is taken from the WISCORS website).
		## NOTE ##
			The link to the sample timeseries is not dynamically flexible within this file.  If the path to the sample timeseries changed (for instance, when all geology.wisc.edu sites transfer to a new geoscience.wisc.edu setup), the pathname after the <image> tag must be changed as well.



%% html_tab4:		This contains the html coding for the fourth tab on each of the websites.
		## Can be changed ##
			This file does the same as html_tab2 and should be edited similarly.



##
## OutreachSiteTools ##
##

This folder holds the main tools to build the website each day.


%% Make_Outreach:	This is the final program that concatenates all of the html files to build the full websites.  Changes should not be necessary.


%% Make_Sites_Table:	This program builds the html file that is unique to each of the individual states.  Changes should not be necessary.  The program takes an input of all of the sites in each state and builds an html table with 10 columns and however rows are needed that links to the timeseries of each site.  The program also makes the html code to display the map of each state.


%% Sites_In_State:	This program gathers the names of the sites that are within the borders of each state's frame in the grid file.  It outputs to files that are read in by the Make_Sites_Table program.  Changes should not be necessary.


##
## StateMaps ##
##

Within this folder is all of the files created by the GMT program.  There is a .grad .grd .jpg .png and .ps file for each and every state.  This folder also holds the NA_col.cpt, na_excluded.gmt, na_site_coords, site_coords and sub1yr_site_text files used and created by the GMT program.


%% OutreachMapGenerator:	This is the program that creates the grid files for each state and places the current GPS position data on each.  This program should not need to be changed.  Currently, the program uses an if..fi loop to check and see if a grid file is present in the directory.  If one is present, a new grid will not be generated and only the updated positions will be plotted, saving runtime.  Runtime with making the maps is approximately 10 minutes.  A potential change to this would occur when higher resolution topography of the United States is ready to be used.  Then the program would need to be changed to point to this new grid file, and the if..fi statement and the bottom of the program would need to be commented out so that the new grids could be created as a one-time event.


##
## StateSites ##
##

This folder houses the files containing the lists of all the sites within each state.  This folder's contents get updated every time the program Sites_In_State is run.  The files are such that each site is represented by it's four letter code in all capital letters.  There is one site to a line, so a linecount on any of these files will reveal the number of sites present within the map borders.


##
## Template ##
##

This folder contains all of the root files needed to generate the websites.  The .gif image of the United States that has been coded is present, as well as all of the java programming that controls the tabbed feature of the websites.


%% Design:		This folder contains most of the visible design elements of the websites, however, changes to any of these images may effect positioning in all of the websites.


%% Publish:		This folder contains subfolders of all of the images used to create the webpage's formatting.  It also contains the javascripting to control the tabbed feature as well as the stylesheet.css which contains some variables that can be changed.  For reference, the website has been designed for the "Horizontal" version.



##
## Websites ##
##

This folder houses all of the built web pages.  It is this pathname that should be used when linking to the web pages or uploading to a server.  Each state's site is named by the two letter postal code, and the homepage is labeled simply that.  The name of the homepage can be changed by editing the "cat" output in the Make_Outreach program found in the OutreachSiteTools folder.



##
## WebTables
##

This folder contains the html coding for the created tables of hypertext links to each site within a state.  This is created by the program Make_Sites_Table and used by the "cat" command in the Make_Outreach program, both of which are found in the OutreachSiteTools folder.



####						####
####	Procedure to generate the Websites	####
####	Runtime approx ~6 minutes		####
####						####

1.) Generate Maps and GPS positions
	a.) Run the program "OutreachMapGenerator" in the folder "StateMaps"

2.) Gather an up to date list of all the GPS Sites in each state's frame
	a.) Run the program "Sites_In_State" in the folder "OutreachSiteTools"

3.) Make the html tables that include hypertext links to all of the sites in each state
	a.) Run the program "Make_Sites_Table" in the folder "OutreachSiteTools"

4.) Concatenate and build all of the websites from their multiple html pieces
	a.) Run the program "Make_Outreach" in the folder "OutreachSiteTools"

## NOTE ##
An improvement to simplicity would be to find a way so that the "OutreachMapGenerator" could sit in the "OutreachSiteTools" folder and still read input and create output to the "StateMaps" folder.  This would allow all four steps to be run from the same directory.




Thanks for reading.
~Kyle W. Fredericks
University of Wisconsin-Madison Geoscience department