Ignore:
Timestamp:
02/10/14 13:56:41 (10 years ago)
Author:
oschonef
Message:
  • some documentation tweaks
File:
1 edited

Legend:

Unmodified
Added
Removed

  • FederatedSearch/schema/Endpoint-Description.xsd

    r4486 r4489  
    1515                </h:p>
    1616            <h:p>
    17                 An CLARIN-FCS endpoint MUST provide this
    18                 information in the <h:code>&lt;extraResponseData&gt;</h:code>
    19                 element of the result to an <h:em>explain</h:em> operation,
    20                 if a CLRAIN-FCS client performed the request with the
     17                An Endpoint MUST provide this information in the
     18                <h:code>&lt;extraResponseData&gt;</h:code> element of the result
     19                to an <h:em>explain</h:em> operation, if (and only if) a
     20                CLARIN-FCS client performed the request with the
    2121                <h:code>x-clarin-fcs-endpoint-description</h:code> extra
    2222                request parameter with a value of <h:code>true</h:code>. 
    … …  
    2929            <xs:documentation>
    3030                <h:p>
    31                     The root element of the endpoint description extension for
     31                    The root element of the Endpoint description extension for
    3232                    CLARIN-FCS extension.
    3333                </h:p>
    3434                <h:p>
    35                     An CLARIN-FCS endpoint MUST provide this
    36                     information in the <h:code>&lt;extraResponseData&gt;</h:code>
     35                    An Endpoint MUST provide this information in the
     36                    <h:code>&lt;extraResponseData&gt;</h:code>
    3737                    element of the result to an <h:em>explain</h:em> operation,
    38                     if a CLRAIN-FCS client performed the request with the
    39                     <h:code>x-clarin-fcs-endpoint-description</h:code> extra
    40                     request parameter with a value of <h:code>true</h:code>.
     38                    if (and only if) a CLARIN-FCS client performed the request
     39                    with the <h:code>x-clarin-fcs-endpoint-description</h:code>
     40                    extra request parameter with a value of <h:code>true</h:code>.
    4141                </h:p>
    4242            </xs:documentation>
    … …  
    4949                        <xs:documentation>
    5050                            <h:p> The CLARIN-FCS profile, that is supported
    51                                 by an endpoint. </h:p>
     51                                by an Endpoint. </h:p>
    5252                        </xs:documentation>
    5353                    </xs:annotation>
    … …  
    5757                                <xs:annotation>
    5858                                    <xs:documentation>
    59                                         <h:p> The endpoint supports the
     59                                        <h:p> The Endpoint supports the
    6060                                            <h:em>basic</h:em>
    6161                                            CLARIN-FCS profile. </h:p>
    … …  
    6868                                <xs:annotation>
    6969                                    <xs:documentation>
    70                                         <h:p> The endpoint supports the
     70                                        <h:p> The Endpoint supports the
    7171                                            <h:em>extended</h:em>
    7272                                            CLARIN-FCS profile. </h:p>
    … …  
    8282                    <xs:annotation>
    8383                        <xs:documentation>
    84                             <h:p> A list of DataViews, that are supported
    85                                 by an endpoint. </h:p>
     84                            <h:p> A list of Data Views, that are supported
     85                                by this Endpoint. </h:p>
    8686                        </xs:documentation>
    8787                    </xs:annotation>
    … …  
    109109                            <h:p>
    110110                                A list of collections, that are available
    111                                 at an CLARIN-FCS endpoint. An endpoint MUST
     111                                at an Endpoint. An Endpoint MUST
    112112                                declare at least one collection.
    113113                            </h:p>
    … …  
    129129                <h:p>
    130130                    Detailed description of a collection that is available at an
    131                     CLARIN-FCS endpoint. A collection is a searchable
    132                     entity at an endpoint, e.g. a single corpus.
     131                    Endpoint. A collection is a searchable
     132                    entity at an Endpoint, e.g. a single corpus.
    133133                </h:p>
    134134            </xs:documentation>
    … …  
    200200                            <h:p>
    201201                                If a collection has searchable sub-collections
    202                                 the endpoint MUST supply additional finer grained
     202                                the Endpoint MUST supply additional finer grained
    203203                                collection elements. A sub-collection is a
    204204                                searchable entity within a collection, e.g. a sub-corpus.
Note: See TracChangeset for help on using the changeset viewer.