From ecf1ebab36d09c7f7c0d2927649aebffe094e6ed Mon Sep 17 00:00:00 2001 From: MattGarrish Date: Wed, 19 Sep 2018 18:11:41 -0300 Subject: [PATCH] add property quick reference table and include mention of names earlier in descriptions --- index.html | 302 +++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 236 insertions(+), 66 deletions(-) diff --git a/index.html b/index.html index 7519397..0adc127 100644 --- a/index.html +++ b/index.html @@ -678,7 +678,7 @@

Introduction

descriptive properties
-

Descriptive properties describe aspects of a Web Publication, such as its Descriptive properties describe aspects of a Web Publication, such as its title, creator, and language. These properties are primarily drawn from Schema.org and its hosted @@ -759,7 +759,7 @@

Requirements

  • reading progression direction
  • resource list
  • table of contents
    • -
  • title
    • +
  • title
    • @@ -769,6 +769,161 @@

    Requirements

    required in the manifest or can be compiled from other information.

    +
    +

    Quick Reference

    + +

    The way that properties are expressed in the manifest and infoset often differs from how they are + referred to using natural language. The following table provides a mapping between property names + and the sections where they are explained to help clarify the differing nomenclature:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameDefined In
    accessModeAccessibility
    accessModeSufficientAccessibility
    accessibilityAPIAccessibility
    accessibilityControlAccessibility
    accessibilityFeatureAccessibility
    accessibilityHazardAccessibility
    accessibilitySummaryAccessibility
    artistCreators
    authorCreators
    contentsTable of Contents
    contributorCreators
    creatorCreators
    dateModifiedLast Modification Date
    datePublishedPublication Date
    editorCreators
    https://www.w3.org/ns/wp#accessibility-reportAccessibility Report
    https://www.w3.org/ns/wp#coverCover
    idCanonical Identifier
    illustratorCreators
    inDirectionDirection
    inkerCreators
    inLanguageLanguage
    lettererCreators
    linkLinks
    nameTitle
    pencilerCreators
    privacy-policyPrivacy Policy
    publisherCreators
    readByCreators
    readingOrderDefault Reading Order
    readingProgressionReading Progression Direction
    resourceListResource List
    translatorCreators
    urlAddress
    +
    +

    Descriptive Properties

    @@ -781,25 +936,25 @@

    Accessibility

    as those provided in [[WCAG20]]. (For linking to a detailed accessibility report, see .)

    -
    -
    Infoset Requirements
    +

    The following are categorized as accessibility properties:

    -

    The following infoset items are categorized as accessibility properties:

    +
      +
    • accessMode
      • +
    • accessModeSufficient
      • +
    • accessibilityAPI
      • +
    • accessibilityControl
      • +
    • accessibilityFeature
      • +
    • accessibilityHazard
      • +
    • accessibilitySummary
      • +
    -
      -
    • accessMode
      • -
    • accessModeSufficient
      • -
    • accessibilityAPI
      • -
    • accessibilityControl
      • -
    • accessibilityFeature
      • -
    • accessibilityHazard
      • -
    • accessibilitySummary
      • -
    +

    The more detailed descriptions of these properties, as well as the possible values, are described + on the WebSchemas Wiki site.

    -

    The more detailed descriptions of these properties, as well as the possible values, are - described on the WebSchemas Wiki - site.

    +
    +
    Infoset Requirements
    +

    TBD

    @@ -939,7 +1094,8 @@

    Address

    A Web Publication's address is a URL [[!url]] that - represents the primary entry page for the Web Publication.

    + represents the primary entry page for the Web Publication. It is expressed using the + url property.

    Infoset Requirements
    @@ -1010,7 +1166,7 @@

    Canonical Identifier

    A Web Publication's canonical identifier is a unique identifier that resolves to the preferred version of - the Web Publication.

    + the Web Publication. It is expressed using the id property.

    Ensuring uniqueness of canonical identifiers is outside the scope of this specification. The actual achievable uniqueness depends on such factors as the conventions of @@ -1096,7 +1252,6 @@

    Manifest Expression

    Creators

    -

    A creator is an individual or entity responsible for the creation of the Web Publication. Creators are represented in one of the following two ways:

    @@ -1111,27 +1266,27 @@

    Creators

    name property is set to that string value. (See also .)

    -
    -
    Infoset Requirements
    +

    The following properties are categorized as creators:

    -

    The following infoset items are categorized as creators:

    +
      +
    • artist
      • +
    • author
      • +
    • contributor
      • +
    • creator
      • +
    • editor
      • +
    • illustrator
      • +
    • inker
      • +
    • letterer
      • +
    • penciler
      • +
    • publisher
      • +
    • readBy
      • +
    • translator
      • +
    -
      -
    • artist
      • -
    • author
      • -
    • contributor
      • -
    • creator
      • -
    • editor
      • -
    • illustrator
      • -
    • inker
      • -
    • letterer
      • -
    • penciler
      • -
    • publisher
      • -
    • readBy
      • -
    • translator
      • -
    +
    +
    Infoset Requirements
    -

    A Web Publication MAY have more than one of each of these types of creators.

    +

    The infoset MAY include more than one of each type of creator.

    @@ -1344,14 +1499,14 @@
    Manifest Expression

    Language and Base Direction

    The Web Publication has a natural language value (e.g., English, French, Chinese), as well - as a natural base writing direction (left-to-right or right-to-left). The infoset has entries to set these values, which can - influence, for example, the behavior of a user agent (e.g., it might place a pop-up for a table - of contents on the right hand side for publications whose natural base direction is - right-to-left).

    + as a natural base writing direction (the display direction, either left-to-right or + right-to-left). The infoset has entries to set these + values, which can influence, for example, the behavior of a user agent (e.g., it might place a + pop-up for a table of contents on the right hand side for publications whose natural base + direction is right-to-left).

    Similarly, each natural language property value in the Web Publication's - infoset (e.g., title, infoset (e.g., title, creators) is localizable [[string-meta]], meaning that the same information is available for @@ -1361,11 +1516,12 @@

    Language and Base Direction

    • the natural language, and
      • -
    • the base direction (the display direction for the value)
      • +
    • the base direction
    -

    of both the Web Publication and the natural language properties values of the infoset.

    +

    of both the Web Publication (inLanguage and inDirection) and the + natural language properties values of the infoset.

    @@ -1547,7 +1703,8 @@

    Last Modification Date

    The last modification date is the date when the Web Publication was last updated (i.e., whenever changes were last made to any of the resources of the Web Publication, - including the manifest).

    + including the manifest). It is expressed using the dateModified + property.

    Infoset Requirements
    @@ -1607,7 +1764,8 @@

    Publication Date

    The publication date is the date on which the Web Publication was originally published. It represents a static event in the lifecycle of a Web Publication and allows - subsequent revisions to be identified and compared.

    + subsequent revisions to be identified and compared. It is expressed using the + datePublished property.

    Infoset Requirements
    @@ -1663,7 +1821,8 @@
    Manifest Expression

    Reading Progression Direction

    The reading progression establishes the - reading direction from one resource to the next within a Web Publication.

    + reading direction from one resource to the next within a Web Publication. It is expressed + using the readingDirection property.

    Infoset Requirements
    @@ -1724,10 +1883,11 @@
    Manifest Expression
    -
    +

    Title

    -

    The title provides the human-readable name of the Web Publication.

    +

    The title provides the human-readable name of the Web Publication. It is expressed using + the name property.

    Infoset Requirements
    @@ -1816,7 +1976,7 @@

    Resource Categorization Properties

    Default Reading Order

    The default reading order is a specific progression through a set of Web - Publication resources.

    + Publication resources. It is expressed using the readingOrder property.

    A user might follow alternative pathways through the content, but in the absence of such interaction the default reading order defines the expected progression from one resource to the @@ -1916,7 +2076,8 @@

    Resource List

    The resource list enumerates any additional resources used in the processing and rendering of a Web Publication that are not already listed in the - default reading order.

    + default reading order. It is expressed using the resourceList + property.

    The union of the resource list and default reading order represents the definitive list of resources that belong to the Web Publication. All other resources are external to the @@ -2019,11 +2180,13 @@

    Manifest Expression