source: VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/HelpPage.html @ 5594

Last change on this file since 5594 was 5594, checked in by Twan Goosen, 10 years ago

Added REST service information to the help page. Moved the documentation into a separate 'doc' directory in the project.
Refs #614

  • Property svn:eol-style set to native
File size: 6.3 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml"
5      xmlns:wicket="http://wicket.apache.org/">
6    <head />
7    <body>
8        <wicket:extend>
9            <div id="help">
10                <h1>Glossary</h1>
11                <h2>Collection types</h2>
12                <dl>
13                    <dt>extensional</dt>
14                    <dd>
15                        Type of virtual collection that explicitly enumerates the references to resources or metadata documents that make up the collection
16                        <dl>
17                            <dt>resources</dt>
18                            <dd>
19                                The members that make up an extensional virtual collection by means of a persistent reference.
20                                These members may be of type <em>metadata</em> for referencing metadata, or <em>resource</em> for directly referencing a resource.
21                            </dd>
22                        </dl>
23                    </dd>
24
25                    <dt>intensional</dt>
26                    <dd>
27                        Type of virtual collection that defines a query by which the items of the collection can be retrieved ad-hoc from a secondary service <em>(experimental, use at own risk!)</em>
28                        <dl>
29                            <dt>query description</dt>
30                            <dd>
31                                A prose description of the procedure by which the collection items can be retrieved from the external service.
32                            </dd>
33                            <dt>query URI</dt>
34                            <dd>
35                                The location of the service from which the items should be retrieved. This value may be a persistent identifier, but could also be a plain URI although this is advised against for published collections.
36                            </dd>
37                            <dt>query profile</dt>
38                            <dd>
39                                Identifier of the mechanism, i.e. the protocol to be used, by which the members of the virtual collection should be retrieved. A application exploiting the query can use this to use a proper driver to talk to the service. Example: In case of CLARIN-FCS access the endpoint by FCS-compatible means.
40                            </dd>
41                            <dt>query value</dt>
42                            <dd>
43                                The query that should be passed on to the service by which it can look up the items that are part of this collection. This value should be in the query language supported by the service. Example: In case of CLARIN-FCS, this value is the CQL query to be send to the endpoint.
44                            </dd>
45                        </dl>
46                    </dd>
47                </dl>
48
49                <h2>General collection properties</h2>
50                <dl>                   
51                    <dt>purpose</dt>
52                    <dd>
53                        An indication of the intended usage of the present virtual collection:
54                        <dl>
55                            <dt>research</dt>
56                            <dd>
57                                The virtual collection bundles resources that are relevant to a specific research (question).
58                            </dd>
59                            <dt>reference</dt>
60                            <dd>
61                                The virtual collection bundles resources, that are to be cited in a publication.
62                            </dd>
63                            <dt>sample</dt>
64                            <dd>
65                                This virtual collection bundles is intended to serve as an sample for research data
66                            </dd>
67                            <dt>future-use</dt>
68                            <dd>
69                                The purpose of this virtual collection is not specified yet. Used in published collection is advised against.
70                            </dd>
71                        </dl>
72                    </dd>
73
74                    <dt>reproducibility</dt>
75                    <dd>
76                        An indication of the degree to which results obtained from processing of the present collection can be expected to be stable:
77                        <dl>
78                            <dt>intended reproducibility</dt>
79                            <dd>
80                                Processing results can be expected to remain stable
81                            </dd>
82                            <dt>fluctuating reproducibility</dt>
83                            <dd>
84                                Processing results may vary
85                            </dd>
86                            <dt>untended reproducibility</dt>
87                            <dd>
88                                No claims with respect to the stability of the processing results are made
89                            </dd>
90                            <dt>reproducibility note</dt>
91                            <dd>
92                                Optional notes describing the expected reproducibility of processing results in more detail
93                            </dd>
94                        </dl>
95                    </dd>
96
97                    <dt>keyword</dt>
98                    <dd>
99                        A word or short phrase signifying a salient facet of the present virtual collection
100                    </dd>
101
102                    <dt>creators</dt>
103                    <dd>
104                        One or more persons, who created this virtual collection.
105                    </dd>
106                </dl>
107
108                <h2>REST service</h2>
109                <p>
110                    The Virtual Collection Registry REST service is accessible
111                    at <a wicket:id="restLink"><wicket:container wicket:id="restUrl">[url]</wicket:container></a> (base URL).
112                </p>
113                <p>
114                    Documentation can be found <a href="Protocol.txt">here</a>.
115                    You can also consult the <a wicket:id="wadlLink">WADL</a> file.
116                </p>
117            </div>
118        </wicket:extend>
119    </body>
120</html>
Note: See TracBrowser for help on using the repository browser.