EARL Documentation
Classes
- Assertion
- An assertion is a sub class of statement, where the subject
is a TestSubject, the predicate a ResultProperty, and the object a TestCase. (These could be free standing units - used outside of Evaluation(s)
if required. N.B. Assertion is the range of earl:asserts.)
- Assertor
- The class of entities making an assertion in EARL (e.g.
running the test). (This could be anonymous if required. There are two further
sub classes of Assertor defined, but they are basically unused.)
- EquivalenceRelation
- An Equivalence relation
- Evaluation
- The class of all EARL evaluations, as asserted in an EARL
document. A sub class of rdf:Statement. (An Evaluation is the most basic unit of EARL as it stands. An EARL
document will always have at least one Evaluation asserted in it.)
- ResultProperty
- The set of result properties in EARL; they are the range of
rdf:predicate for all EARL Assertions.
- TestCase
- The class of all TestCases. Conceptually, a Test Case is
some resource to which another resource can be validated against - something
for which it can be demonstrated that it passes or fails against (or otherwise).
This may in fact include many things - validation classes, code test cases, or
more subjective guidelines such as WCAG.
Perhaps this is synonymous with "Class", and we're really just testing class
membership? For example, validation is a test of whether a set of characters is
in a particular document class. Testing against WCAG is testing for whether or
not a document is in the class of accessible documents. Testing against a test
file checks whether the code belongs to the "Pass" class created by the test
file. Well, perhaps...
- TestSubject
- The class of things which are being evaluated in an EARL
evaluation - the things that are the subject of every assertion (This needs to be qualified with some type of information in order
to make it unambiguous. You may use an unambiguous property, or unambiguous
constellation of properties.)
- Tool
- This is a tool; a bit of software, perhaps with a desc.
- UserAgent
- A user agent
- Validity
- The class of all EARL validity states.
- WebContent
- WebContent is synonymous with "Document Source" in
UAAG, and "Representation" in RFC 2616. (Anything which is an instance of WebContent must have exactly one
reprOf predicate hanging from it.)
Properties
- asserts
- For earl:asserts(x,y), in general, the assertor (x)
asserts the assertion (y). (EARL has specific classes for the domain/range)
- confidence
- for confidence(x, y), x has the confidence y
- contactInfo
- for contactInfo(x, y), y is some some kind of generic contact
information for y. (This is a sub classable property. A strict domain is used rather
than a restriction so that one may infer that the subject is an Assertor. Not
that that information would actually help.)
- excludes
- for excludes(x, y), TestCriteria x exclude the Exclusion y
- expectedResult
- The expected result of a test case
- format
- The MIME type of the WebContent subject, as a literal.
- id
- A single guideline, checkpoint, etc.
- level
- This is a generic level of test criteria, for example, the
priorities/levels in WCAG. (These shouldn't be a string literal.)
- name
- The common proper name for some earl:Assertor. (This is related to foaf:name.)
- operator
- for operator(x, y), y is the operator of x (This is the operator of a machine (range undefined))
- operatorInstructions
- For operatorInstruction(x, y), y is an operator instruction
for x.
- os
- The Operating System on which an assertion was run, or of
which an Assertor uses.
- platform
- For platform(x, y), y is the platform on which x ran/runs (e.g. the platform on which the test(s) were run, or the general
platform on which something runs)
- purpose
- For purpose(x, y), y is the (literal node) purpose of x
- repairInfo
- for repairInfo(x, y), y is repair information for x
- reprOf
- For reprOf(x, y), read that x is a representation of y,
possibly derived from an HTTP GET transaction.
- snapshot
- Points to a snapshot of a serialization of the resource
when it was evaluated
- suite
- A suite of checkpoints, guidelines, or any other form of
rules that an earl:TestSubject can be evaluated against. e.g. WCAG 1.0
- testCriteria
- The testCriteria for a TestCase
- testMode
- The test mode of some EARL assertion
- validity
- The validity state for an EARL ResultProperty.