Wiki Testing/ServerInstallationGuide7: Difference between revisions
| Line 25: | Line 25: | ||
those files they will be concatenated with the default information | those files they will be concatenated with the default information | ||
returned by the usage server. | returned by the usage server. | ||
If you would like to provide more information about a dataset than is | If you would like to provide more information about a dataset than is | ||
| Line 33: | Line 34: | ||
example, the dataset <font color='green'>fnoc1.nc</font> might be documented with a file | example, the dataset <font color='green'>fnoc1.nc</font> might be documented with a file | ||
called <font color='green'>fnoc1.html</font>. | called <font color='green'>fnoc1.html</font>. | ||
You can also provide documentation for a class of files that may have | You can also provide documentation for a class of files that may have | ||
| Line 40: | Line 42: | ||
this case). This file should be located in the directory where the | this case). This file should be located in the directory where the | ||
data is located. | data is located. | ||
If you'd like to append information to the <font color='green'>info</font> message for all | If you'd like to append information to the <font color='green'>info</font> message for all | ||
| Line 45: | Line 48: | ||
\var{servername}<font color='green'>.html</font>, where \var{servername} is one of | \var{servername}<font color='green'>.html</font>, where \var{servername} is one of | ||
<font color='green'>nc</font>, <font color='green'>ff</font>, <font color='green'>hdf</font>, <font color='green'>jg</font>, and so on. | <font color='green'>nc</font>, <font color='green'>ff</font>, <font color='green'>hdf</font>, <font color='green'>jg</font>, and so on. | ||
You may prefer to override this method of creating documentation and | You may prefer to override this method of creating documentation and | ||
| Line 52: | Line 56: | ||
and will not get the text generated by the dataset DAS and DDS, or the | and will not get the text generated by the dataset DAS and DDS, or the | ||
\var{servername}<font color='green'>.html</font> file. | \var{servername}<font color='green'>.html</font> file. | ||
More information about providing user information, including sample | More information about providing user information, including sample | ||
HTML files, and a complete description of the search procedure for | HTML files, and a complete description of the search procedure for | ||
finding the dataset documentation, may be found in \DODSapi . | finding the dataset documentation, may be found in \DODSapi . | ||
==Special Instructions for the OPeNDAP/JGOFS Handler== | ==Special Instructions for the OPeNDAP/JGOFS Handler== | ||
The JGOFS handler provides usage data in almost the same way as the | The JGOFS handler provides usage data in almost the same way as the | ||
| Line 68: | Line 75: | ||
handler and save that document in a file named <font color='green'>jg.html</font> in the | handler and save that document in a file named <font color='green'>jg.html</font> in the | ||
cgi-bin directory that holds the server programs. | cgi-bin directory that holds the server programs. | ||
<blockquote>[Tip]The <font color='green'>jg.html</font> file could be used to provide descriptive information, including the names, for all the data objects served at your site.<blockquote> | <blockquote>[Tip]The <font color='green'>jg.html</font> file could be used to provide descriptive information, including the names, for all the data objects served at your site.<blockquote> | ||
Revision as of 04:18, 4 October 2007
Documenting Your Data
OPeNDAP's version 3.5 server
contains provisions for supplying documentation to users about a server, and also about the data that server provides. When a server receives an information request (through the info service that invokes the dap_usage program), it returns to the client an HTML document created from the DAS and DDS of the referenced data. It may also return information about the server, and more detail about the dataset. \subj{Documenting your data will make it useful to more
people.}
Users access this information by appending .info to a DAP URL. For example to get the HTML info page for an netCDF file, you might type something like this:
http://test.opendap.org/opendap/nph-dods/data/nc/fnoc1.nc.info
The Info service will return important information about your dataset even if you do not write custom HTML files for it. If you do write those files they will be concatenated with the default information returned by the usage server.
If you would like to provide more information about a dataset than is
contained in the DAS and DDS, simply create an HTML document (without
the <html> and <body> tags, which are supplied by the
info service), and store it in the same directory as the
dataset, with a name corresponding to the dataset filename. For
example, the dataset fnoc1.nc might be documented with a file
called fnoc1.html.
You can also provide documentation for a class of files that may have
a common root in their names. For example, a file that would be used
for data files called S00443.nc, S00444.nc and
S00445.nc could be called S.html (or S00.html in
this case). This file should be located in the directory where the
data is located.
If you'd like to append information to the info message for all
the files on a server, you can write a file called
\var{servername}.html, where \var{servername} is one of
nc, ff, hdf, jg, and so on.
You may prefer to override this method of creating documentation and
simply provide a single, complete HTML document that contains general
information for a dataset. If you call your documentation file
fnoc2.ovr, the client will see only the contents of that file,
and will not get the text generated by the dataset DAS and DDS, or the
\var{servername}.html file.
More information about providing user information, including sample
HTML files, and a complete description of the search procedure for
finding the dataset documentation, may be found in \DODSapi .
Special Instructions for the OPeNDAP/JGOFS Handler
The JGOFS handler provides usage data in almost the same way as the other servers, but the dap_usage helper program is called usage-jg, and it functions slightly differently. For the general JGOFS handler and for each data object it serves, you can write a HTML document which the usage server will return when requested by users. You can write a HTML document that describes any special \subj{Yes,
this is different for JGOFS, too.} features of your particular JGOFS
handler and save that document in a file named jg.html in the cgi-bin directory that holds the server programs.
[Tip]The jg.html file could be used to provide descriptive information, including the names, for all the data objects served at your site.
The only special thing about this file is that you should include only those HTML tags that would fall between the <body> and </body> tags. Thus it should not contain the <html>, <head>, <body> or their matching counterparts.To provide HTML for each JGOFS data object you serve, create a file whose name is based on the names of the data object you want to describe. For example, a file that would be used for all the s87_xbt data object used in the previous section's example would be s87_xbt.html. This file must be located in the directory where the top-level datafile is located, as defined in the data objects dictionary.
Users access this information by appending .info to a DAP URL. For example to get the HTML page for the URL used in the previous section, you'd type:
http://dods.gso.uri.edu/cgi-bin/nph-dods/s87_xbt.info
