******************************************** ***** SCHEMA DEVELOPMENT ***** ******************************************** Created: 2011-01-10 Author: Katy Ginger, University Corporation for Atmospheric Research (UCAR), ginger@ucar.edu Purpose: support the exchange of summative paradata (information about resource use) Copyright for this file: See LICENSE AND COPYRIGHT at the end of this file. **************************************************** ***** HISTORY of IMPORTANT CHANGES ***** **************************************************** 2011-04-15: added language and catalog attributes, broke the audience attribute into 3 attributes (audience, edLevel, subject), added usageDataResourceIdentifier element There is an older version 0.1. This version 1.00 came into effect 2001-01-10. 2011-02-23: Design notes: 1) removed record date because each paradata element now has its own date which should be used in all processing. 2) removed urlType because if one wants to add/correlate a standard or say the resource is featured in another resource, an annotation record (not this paradata record) should be used. 3) did not really account for language 4) removed usageDataProvidedForId because not sure if anyone was going to use it. It was required and occurred once. 5) made usageDataReferenceURL optional instead of required 5) added an audience (with a controlled vocab) to each element. ****************************************************** ***** INCLUDED/ IMPORTED SCHEMAS ***** ****************************************************** See individual schemas for documentation *************************************************** ***** COMPLEX TYPES (alpha order) ***** *************************************************** floatType - is part of usageDataSummaryType integerType - is part of usageDataSummaryType languageStringType - is part of paradataRecordType langStringType - is part of paradataRecordType moreInfoType - is part of paradataRecordType paradataRecordType - is the ROOT type rankType - is part of usageDataSummaryType ratingType - is part of usageDataSummaryType stringType - is part of usageDataSummaryType usageDataSummaryType - is part of paradataRecordType voteType - is part of usageDataSummaryType ********************************* ***** ROOT ELEMENT ***** ********************************* commParadata - the root element of the community paradata record ********************************* ***** ATTRIBUTE GROUPS ***** ********************************* timeAudience - tracks start and end time, audience and language for the usage data dateTimeStart - the beginning valid date and time for the usage data dateTimeStart - the ending valid date and time for the usage data audience - the audience providing the usage data ***** integerType ***** type - the kind of integer data being summarized ***** languageStringType ***** string content for paradataTitle, paradataDescription and usageDataProvidedForName elements so that information can be provided in multiple languages ***** langStringType ***** the two-letter abbreviation for the language of the contents of the string element ***** moreInfoType ***** moreInfoType - allows any additional XML elements (not plain text) to be in the paradata record ***** paradataRecordType ***** paradataRecordType - the root element type for the community paradata record recordId - a unique identification number used to identify an individual paradata record (not the resource) recordDate - calendar date for the creation or modification of the paradata record paradataTitle - the title of the paradata/annotation if one exists or is appropriate paradataDescription - a narrative of the paradata/annotation if one exists or is appropriate usageDataReferenceURL - a URL to a landing page that has the summary of paradata information from a particular provider usageDataResourceURL - a URL to the resource to which the paradata applies usageDataResourceIdentifier - a number, handle, code to the resource to which the paradata applies (for use in local applications; do not expect others to know how to process the content usageDataProvidedForName - the title of the resource to which the paradata applies usageDataSummary - a set of several usage statistics/information about a resource moreInfo - an element for any additional well-formed XML to be placed in the paradata record ***** rankType ***** the content value for the rank element is the position of the resource in a hierarchy type - the kind of ranking information (position in a hierarchy) being summarized name - the title of the ranking performed (popular, easiest, of something) best - the best value in the ranking worst- the worst value in the ranking ***** ratingType ***** the content value for the rating element is the average rating for the resource type - the kind of rating information being summarized min - the minimal allowable rating value max - the maximum allowable rating value total - the number of ratings used in the average calculation ***** recordIdType ***** catalog - the name, code or indentifying information for the recordID number of the paradata record (not resource metadata record) ***** stringType ***** type - the kind of string or textual data being summarized total - the number of times the string or textual data has been associated with the resource langugae - the language of the usage data ***** usageDataSummaryType ***** integer - an integer value representing the number of times certain actions (viewed, favorited, featured) have been performed on the resource float - a float value representing the number of times certain actions () have been performed on the resource string - a textual value that has been associated to the resource; can also indicate the number of times the textual value has been associated with the resource rating - a numerical average that represents the judging of a resource on a numerical scale; includes: 1) the minimum and maximum numerical values of the scale used, 2) the type of rating performed (e.g. star, usability) and 3) the total number of ratings performed voting - the numerical values representing the number of positive and negative responses to a resource; includes the type of voting performed (accurate, useful) rank - the numerical value representing the standing of a resource in a hierarchy; includes 1) the numerical minimum and maximum ranking values, 2) the type of ranking performed (best, most) and the 3) the name of the ranking (e.g. of 2010, popular, used, easiest) ***** voteType ***** there is no content value for the vote element; content only appears in attributes type - the kind of voting information being summarized positive - the minimal allowable rating value expressed as a decimal negative - the maximum allowable rating value expressed as a decimal