Materials Algorithms Project

CREATING A NEW WEB PAGE FOR MAP

Please read and follow the notes below when writing your web page, particularly the notes on the header section. These notes are intended to be comprehensive enough to enable even those with little or no knowledge of HTML to edit the templates to produce a suitable file which can be submitted to the MAP Administrator for inclusion in MAP. For those with no knowledge of HTML, minor corrections and edits can be made by the MAP Administrator.

In the template files, those sections of the file which need to be edited are identified by a comment line containing the characters ####n, where n is an integer and refers to the number of the notes below.

PLEASE DELETE THESE COMMENT LINES and insert the required information.

N.B. No comment lines have been inserted into the header sections of the template files. The changes which need to be made to this section are considered in detail below. If in doubt, leave the editing of this section to the MAP Administrator.

The data template files contain fewer sections than the routine template files. Sections 7-9, 12, 15-18 & 20-23 are not applicable to data template files.

N.B. Please use the same pattern of capital and small letters as that used in the template file, especially in the header section.

Summary of useful HTML commands

HTML commands consist of text enclosed by the brackets < and >. Please do not delete these commands when inserting text into the templates (apart from the comment lines and any redundant lines). Any text inserted into the template.html file may contain as many HTML commands as desired. (Note - that these commands must conform to the HTML3.2 standard.) Some simple, but very useful, commands are given here.

To write words in a different format, such as in italics or boldface, the words should be enclosed by two HTML commands. For example, to write the words 'hello world'

in italics - type hello world e.g. hello world
in boldface - type hello world e.g. hello world
in monospaced font - type <tt>hello world</tt> e.g. hello world
as a superscript - type hello world e.g. ^{hello world}
as a subscript - type hello world e.g. _{hello world}
underlined - type hello world e.g. hello world

The characters < and > are used to define HTML commands. To create the corresponding mathematical symbols in the text it is necessary to type

< for <
> for >
° will produce the degree sign °
  creates a new line (carriage return).
 and  indicate the beginning and end of a paragraph.

The header section

At the top of each web page is a header section. This section contains information about the authors and title of the program/routine/data, as well as keywords and a short description of the page contents. Although this section is not seen when the page is viewed using a web browser, it is read by search engines and in particular by the MAP Search Engine. It is therefore very important that you modify the contents of this section appropriately.

The format of the header section in these files is as follows:

<head>
  <title>MAP Routine MAP_LIBRARY-NAME_ROUTINE-NAME</title>
  <meta name="author"   content="Surname1, Surname2, Surname3, etc">
  <meta name="keywords" content="keyword1, keyword2, keyword3, etc">
  <meta name="description" content="Short description of subroutine.">
  <meta name="reply-to" content="map@msm.cam.ac.uk">
  <meta http-equiv="Last-Modified" content="Fri, 3 Sept 1999 9:45 GMT">
</head>

In the data library the header has a similar format to that given above, except for the title which is of the form:

  <title>MAP Data Library - MAP_DATA_NAME</title>

Changing the header

Below are detailed instructions for changing the contents of the title and meta tags. In general, the same pattern of capital and small letters should be used to that given in the templates. N.B. The contents of the title and meta tags must be written in PLAIN TEXT only; they must not contain any HTML commands or special characters.

<title>

Program Library only:
The word 'LIB' should be changed to the name of the library in which the code is to be included. Currently this is either COMP, CRYSTAL, KINETIC, METALL, NEURAL, NICKEL, POLY, STEEL or UTIL.
Both Program and Data Libraries:
The word 'NAME' should be changed to your name for the routine or data (use capital letters).
e.g.
MAP Subroutine MAP_STEEL_BAINCA
MAP Data Library - MAP_DATA_AUSTENMAT

(Please choose a unique, one-word name for your routine or data set.)

<meta name="author"

Change "Surname1, Surname2" to the surnames of the contributing authors.
e.g. "Smith, Jones, Dupont, Schmidt" or "Lloyd" or "Laurel, Hardy".

<meta name="keywords"

Within reason any number of keywords can be given which describe the contents of the web page. Each word or group of words shoud be separated by a comma and a space. In general it is better to use single words. Only give groups of words which are well known. The keywords should generally be written in small letters; use capital letters only when absolutely necessary.
e.g. "steel, weld, volume fraction, MMA".

<meta name="description"

Give a short description of the program/code/data (1-2 sentances). This should be similar to that given in the section entitled 'Purpose' (see below).

<meta name="reply-to"

DO NOT CHANGE THE CONTENTS OF THIS META TAG!

<meta http-equiv="Last-Modified"

The data and time can be changed appropriately to reflect when the file was last modified. Please maintain the format given.

e.g.

  <title>MAP Data Library - MAP_AUSTENMAT</title>
  <meta name="author"   content="Gavard, Suzuki, Bhadeshia">
  <meta name="keywords" content="materials, data, austenite, steel, composition, Ac1, Ac3, temperature, heating rate">
  <meta name="description" content="Provides data on the formation of austenite in steels.">
  <meta name="reply-to" content="map@msm.cam.ac.uk">
  <meta http-equiv="Last-Modified" content="Wed, 8 Sept 1999 11:30 GMT">

Inserting information about the routine/data.

The numbers of the sections below refer to the integer in the comment line at the insertion point in the template.html file (####n).

1 - Routine type and name

The routine type is one of Program, Subroutine, Function, Module or Data Library. Check that the routine type specified here is the appropriate one for your routine/data. If not, then you are using the wrong template.html file. Please download and use the correct file now! The word 'LIB' should be changed to the name of the library in which the code is to be included. Currently this is either COMP, CRYSTAL, KINETIC, METALL, NEURAL, NICKEL, POLY, STEEL or UTIL.

The word 'NAME' should be changed to your name for the routine or data (use capital letters).

e.g.
Program MAP_STEEL_WELDSOFT
Data Library MAP_DATA_AUSTENMAT

2 - Names of authors

Give the name(s) of the person(s) who provided the source code or data and who should be approached if further information is required.

3 - Addresses of authors

Give the address(es) of the person(s) who provided the source code or data and who should be approached if further information is required. The HTML command should be placed at the end of each line of the address.

4 - E-mail addresses of authors

If desired, an e-mail address for contacting the authors may be given by replacing ****** with the relevant e-mail address (it occurs twice). If not desired, please delete this line.

5 - Date of addition to MAP

Change month and year to show the date and year when the routine/data will first appear on the MAP web site.

6 - Purpose of code / Purpose of data

Give a brief statement outlining the broad purpose of the code or data (1-2 sentences).

7 - Language (not applicable to data template files)

Replace ****** with the computer language in which the code is written (FORTRAN/C/C++ etc.).

8 - Product Form (not applicable to data template files)

Replace ****** with the form in which the code is supplied i.e. Source code or Executable file or both. If an executable file is beng provided, the following information should, if possible, also be supplied: Compiler used; Computer type (e.g. IBM-PC, Macintosh, Sun etc.); Operating system (e.g. WINDOWS95, DOS, Mac OS, UNIX, LINUX etc.); any particular hardware requirements or memory requirements etc.

9 - Specification of routine and variables (not applicable to data template files)

Give a clear statement of the routine name, the input and output arguments used by the routine, the order in which they must be passed and their type. If the routine is a complete program, the statement 'Complete program.' is sufficient.

10-13 - Description of routine / data

Computer code Give a more detailed explanation of the purpose and operation of the code, perhaps including some background theory and any limitations on values of input arguments. A clear indication of the equation or equations being evaluated by the code would be useful, either by including the equation here or by giving a precise reference to the equation in a journal or other publication. Give details of any files included in the name.tar file, other than the usual MAP files.

Data Give a detailed description of the data, the names and format of the data files and each column of data in the data files. Specify the units of the data.

12 - Including an equation or diagram (not applicable to data template files)

Simple equations can be included using text and simple HTML commands. More complicated equations or any diagrams can be included only as image files (*.gif or *.jpg files). Any image files for inclusion on the web page should be given names of the form name-eq1.jpg, name-eq2.jpg etc. or name-eq1.gif, name-eq2.gif etc., where name is your name for the routine. The following HTML command is required for the inclusion of an image file:
<img src="../equations/subs/name-eq1.jpg" ALT="alternative text" height=height_pixels width=width_pixels>
Replace name-eq1.jpg with the name of your image file. Replace alternative text with a short phrase; this will be displayed if the image file cannot be displayed. Replace height_pixels and width_pixels with the pixel dimensions of the image. Please delete this line if no image file is to be included.

14 - References

Give a list of references where more detailed background information and the theoretical basis of the code (where appropriate) can be found. These need not be published works. Include any publications involving the use of the code.

15 & 16 - Parameter descriptions (not applicable to data template files)

For each input and output parameter a description must be given in the form
<dt>Variable_name - Variable type</dt>
<dd>Description (units).</dd>
<dd> </dd>
Replace Variable_name with the name of the variable. Replace Variable type with a statement of its type (e.g. real/integer/double precision/character/integer array of dimension 3). Replace Description (units) with a description of the variable and specify its units.

17 - Error indicators (not applicable to data template files)

Describe any error-trapping procedures that may be implemented in the code (e.g. input arguments outside specified limits) or any flags used to indicate errors encountered during the calculations. If there are no error indicators, type None.

18 - Accuracy (not applicable to data template files)

Give a statement of known limits to the accuracy of the results generated by the code, and/or a description of the circumstances within which a specified accuracy is maintained.

19 - Further Comments

Give any additional information which does not fit into another category.

20-22 - Example (not applicable to data template files)

Give a simple program which illustrates the use of the routine and the output which is generated.

21 - Give a set of typical input data for the sample program.

22 - Show the output obtained from the sample program with the input data given above.

23 - Auxiliary Routines (not applicable to data template files)

Give the names of any MAP routines which are called by this code. For each auxiliary routine a line of the form
<A HREF = "../../lib/filename.html">MAP_LIB_NAME</A> 
must be inserted. MAP_LIB_NAME is the full name of the auxilliary routine; lib/filename.html is the library and filename name of the webpage for the auxiliary routine (use small letters). If in doubt, ask the MAP Administrator. If there are no auxiliary routines, type None.

24 - Keywords

Give a list of keywords which describe the routine. These should be the same as those given in the header section. (See notes above.)

25 - Download

The tar file for downloading should have a name of the form name.tar, where name is your chosen name for the routine. To download this tar file, a line of the form
<A HREF="../tar/name.tar">Download source code</A>
must be included. Replace name with your name for the routine (use small letters).

26 - Links

The link to the index file needs to be set. Change the letters 'lib' in the command <A HREF = "../lib*.html"> to the library name (small letters).

HTML Validator

Before inclusion of the web page on the MAP website, the file should be checked for errors by the W3C Validation Service at https://validator.w3.org/. This can only be done, however, if the file is on a web server and accessible to the W3C Validation Service!

Return to top of document | Return to Notes for Contributers

MAP originated from a joint project of the National Physical Laboratory and the University of Cambridge.

MAP Website administration / map@msm.cam.ac.uk

MAP Homepage