Changeset 5593


Ignore:
Timestamp:
08/22/14 09:32:30 (10 years ago)
Author:
Twan Goosen
Message:

Created a 'help' page
Fixes #614

Location:
VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main
Files:
1 added
2 edited
1 copied

Legend:

Unmodified
Added
Removed

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/BasePage.java

    r5592 r5593  
    2626        // main navigation menu
    2727        final Menu menu = new Menu("menu");
    28         menu.addMenuItem(new MenuItem<BrowsePublicCollectionsPage>(
    29                 new Model<String>("Virtual Collections"),
     28        menu.addMenuItem(new MenuItem<>(Model.of("Virtual Collections"),
    3029                BrowsePublicCollectionsPage.class));
    31         menu.addMenuItem(new MenuItem<BrowsePrivateCollectionsPage>(
    32                 new Model<String>("My Virtual Collections"),
     30        menu.addMenuItem(new MenuItem<>(Model.of("My Virtual Collections"),
    3331                BrowsePrivateCollectionsPage.class));
    34         menu.addMenuItem(new MenuItem<CreateVirtualCollectionPage>(
    35                 new Model<String>("Create Virtual Collection"),
     32        menu.addMenuItem(new MenuItem<>(Model.of("Create Virtual Collection"),
    3633                CreateVirtualCollectionPage.class));
    37         menu.addMenuItem(new MenuItem<AdminPage>(
    38                 new Model<String>("Admin Page"),
     34        menu.addMenuItem(new MenuItem<>(Model.of("Help"),
     35                HelpPage.class));       
     36        menu.addMenuItem(new MenuItem<>(Model.of("Admin Page"),
    3937                AdminPage.class));
    4038        add(menu);

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/HelpPage.html

    r5592 r5593  
    77    <body>
    88        <wicket:extend>
    9             <h1>About the Virtual Collection Registry</h1>
    10             <p>
    11                 The Virtual Collection Registry (VCR) was developed for
    12                 CLARIN at <a href="http://www.ids-mannheim.de/">The Institute
    13                     for the German Language (IDS)</a> and the
    14                 <a href="http://www.clarin.eu">CLARIN
    15                     <abbr title="European Research Infrastructure Consortium">
    16                         ERIC</abbr>
    17                 </a>.
    18             </p>
    19             <p>
    20                 The VCR was developed by:
    21                 <ul>
    22                     <li>Oliver Schonefeld (IDS)</li>
    23                     <li>Twan Goosen (CLARIN ERIC)</li>
    24                 </ul>
    25             </p>
    26             <h2>Licenses</h2>
    27             <p>
    28                 The VCR is made available under the
    29                 <a href="http://www.gnu.org/licenses/gpl-3.0.html">GPL 3.0</a>
    30                 license.
    31             </p>
    32             <p>
    33                 It uses the following software components:
    34                 <ul>
    35                     <li><a href="http://wicket.apache.org">Apache Wicket</a> (<a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License 2.0</a>)</li>
    36                     <li><a href="https://jersey.java.net/">Jersey</a> (<a href="https://jersey.java.net/license.html#cddl">CCDL 1.1</a>)</li>
    37                     <li><a href="http://projects.spring.io/spring-framework/">Spring Framework</a> (<a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License 2.0</a>)</li>
    38                     <li><a href="http://getbootstrap.com/">Bootstrap</a> (<a href="https://github.com/twbs/bootstrap/blob/master/LICENSE">MIT license</a>)</li>
    39                     <li><a href="http://jquery.org/license/">jQuery</a> (<a href="https://jquery.org/license/">MIT license</a>)</li>
    40                     <li><a href="https://code.google.com/p/wiquery/">WiQuery</a> (<a href="http://opensource.org/licenses/mit-license.php">MIT license</a>)</li>
    41                     <li><a href="http://glyphicons.com/">GLYPHICONS free</a> (<a href="http://glyphicons.com/license/">CC-BY 3.0</a>)</li>
    42                 </ul>
    43             </p>
     9            <div id="help">
     10                <h1>Definitions</h1>
     11                <h3>Collection types</h3>
     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 the 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                <h3>General collection properties</h3>
     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            </div>
    44109        </wicket:extend>
    45110    </body>

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/webapp/css/vcr.scss

    r5586 r5593  
    5656    padding: 6px 4px;
    5757}
     58
     59div#help  {
     60
     61    dd {
     62        /* indent for the definitions on the help page */
     63        margin-left: 2em;
     64    }
     65}
Note: See TracChangeset for help on using the changeset viewer.