MAP Logo

Materials Algorithms Project



NOTES FOR CONTRIBUTORS

Any code or data for inclusion on the MAP website should be accompanied by the following documentation:

  1. An ASCII text file containing the following information:
    Computer code
    • Provenance of code - name, address and e-mail address of code providers.
    • Date of inclusion of code in MAP
    • Brief description of the purpose of the code.
    • Detailed specification of the code/program.
    • Description of routine's operation.
    • References.
    • Detailed descriptions of the input and output parameters.
    • Descriptions of any error indicators.
    • An estimate of the accuracy of the results.
    • Any additional information.
    • Short example program showing the use of the routine.
    • A list of any auxiliary routines required.
    • Keywords.
    Data
    • Provenance of code - name, address and e-mail address of code providers.
    • Date of inclusion of code in MAP
    • Brief description of the purpose of the data.
    • Detailed description of the data.
    • References.
    • Any additional information.
    • Keywords.
  2. A TEX file containing the above information.
  3. A web page file written in HTML3.2 containing the above information.
These files should be given names of the form:
name-b.* - the code or executable program (where * is f, c, for, exe etc.)
name-b.tex - the TEX file
name-b.ps - the postscript file produced from the TEX file
name-b.txt - the ASCII text file
name.tar
name.zip
- a tar or zip file containing all of the above files
name-b.html - the web page written in HTML

where name is your chosen name for the routine/program/data. Please choose a unique, one-word name for your code or data! Standard templates for producing the HTML file and the TEX file are now available and can be viewed and downloaded from the table below. The text file can best be produced by saving the web page, when viewed in a web browser, as a text file.


Templates

It is important, when creating a new web page for the MAP website, to use the appropriate template file from the table below. This ensures that links to other files on the website are correctly set. These files should be edited and saved as pure text files.

Complete programs: View HTML template Download HTML template
Subroutines: View HTML template Download HTML template
Functions: View HTML template Download HTML template
Modules: View HTML template Download HTML template
Data: View HTML template Download HTML template

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


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 http://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

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 Valid HTML 3.2!