source: MILK/trunk/milk_server/helpText.config @ 5198

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/MILK/trunk/milk_server/helpText.config@5867
Revision 5198, 4.7 KB checked in by cbyrom, 11 years ago (diff)

Write README.txt for MILK with basic install and config info +
tidy up config files, removing obsolete data + remove unused help
page + fix proper use of global discovery url to simplify use.

Line 
1#
2# Help text Configuration File
3# - help text available in the MILK stack can be specified here
4# - see toplevel README.txt file for config instructions
5#
6
7[DEFAULT]
8
9[SEARCH]
10
11[ATOM_EDITOR]
12
13granulite_help:Specify a granulite data file to ingest - this will create a granule atom with the contents and link it to any data entities specified.  If a CSML or CDML file is also specified, data from this will also be ingested to the granule.  NB, data in the granulite file takes precedence over the CSML/CDML file contents.
14upload_help:Specify data here to upload.  Note, if the data to upload is of a large size, please be patient as the operation may take some time to complete.
15# NB, the 'HREF' in the text will be replaced, by the server, with a proper link to the example granulite
16example_granulite:The format of a granulite file can be seen from the example file available <a href="HREF">here</a>
17csml_or_csml:NB, if a CDML file is specified, a CSML will be generated using its contents and this will be used to create the granule; both files will be stored in the document repository.
18granulite_time:If uploading CDML data, specify the time axis used by the CDML file - NB, 'time' is taken as the default axis.
19granulite_dataset_id:If uploading CDML data, specify a dataset ID to use for the generated CSML file - otherwise this will be created randomly.
20create_help:Create new atoms by specifying the basic, minimum data.  NB, once the atom has been created, further inputs will be available to add additional data.
21list_help:Search the document repository for atoms matching the specified search filters.
22search_text:Specify text to search for in the atom elements.  NB, multiple words can be specified and only documents containing all of these will be returned.  Additionally, the wildcards, '*' and '?' may be used to specify 'all characters' and 'a single character', respectively - e.g. temp* and temperat??? will both match 'temperature'.
23
24atom_state:The publication state of this metadata: 'old' - for redundant records; 'working' - for new/in progress records; 'published' - for records approaching maturity, which may still change, but should be available via the discovery services; and 'Published' for mature records that are unlikely to change and should be available via the discovery services.
25atom_summary:A brief description of the data.
26atom_provider:The provider of the underlying data described by this metadata document.
27atom_type:The type of the underlying data described by this document.  NB, a deployment is a specialised form of Activity - with sub-type of 'Deployment'.
28atom_content:The actual data being described by this document.  NB, in the case of data granules, this content may just be a reference to an ingested CSML or CDML file.
29atom_quality:Description of the relative quality of the dataset.
30atom_lineage:Summary of the origins of the dataset, e.g.: "Dataset produced from NASA MODIS instrument on Terra and collected at the University of York's groundstation 1999-2003 and a copy provided to NEODC in June 2007".
31atom_author:The principal author of the actual underlying data.  Only one author can be specified per atom; if there are multiple authors, these should be specified as 'contributors'.  NB, an atom MUST have an author specified.
32atom_contributors:Any other authors of the actual underlying data.  NB, the principal author should be specified in the 'Author' input field.  Also, note, three contributors can be added at once; after these are added a further three may be specified - and so on.
33atom_online_refs:Online references with a specific relationship to the data being described here.  NB, if links are supplied they must be valid and include the transport protocol - e.g. 'http://blah.co.uk'.  Also, note, three online references can be added at once; after these are added a further three may be specified - and so on.
34atom_coverage:Summary of the temporal and spatial data coverage for the data.
35atom_other:Other miscellaneous information.  Note, update frequency relates to the update frequency of the underlying data, not the metadata.
36atom_responsible_parties:Parties responsible for the metadata - e.g. data curator.  Responsible parties can have a role specified to make their function clearer.  Multiple responsible parties can be specified.
37atom_associated_data:Data entities associated with this deployment.
38atom_associated_granules:Granule data associated with this data entity.
39atom_associated_deployments:Deployment data associated with this data entity.
40atom_parameters:Parameters to describe the data - with vocab URL and term IDs for further classification.  Note, three parameters can be added at once; after these are added a further three may be specified - and so on.
41
42[WMC_CLIENT]
43
44[NDG_A_SERVICE]
45
46[NDG_B_SERVICE]
47
48[DISCOVERY]
Note: See TracBrowser for help on using the repository browser.