Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 1.17 KB

File metadata and controls

33 lines (17 loc) · 1.17 KB

Welcome to SchemaExamples

A module in the schemaorg repository for the accessing and processing of Example entries designed for use with User Interfaces displaying descriptions of terms in the Schema.org vocabulary.

An 'Example' entry is of the following text format:

TYPES: #eg-0000 Type/property, Type/property, etc.

PRE-MARKUP:

MICRODATA:

RDFA:

JSON:

#eg-0000 - a unique example id Type/Property - The label of terms associated with the example Text contained following PRE-MARKUP, MICRODATA, RDFA, & JSON headings is to be reproduced in as example contents in the UI.

One or more Examples are useually stored in a single file, by convention, with the '-examples.txt' suffix.

The schemaexamples.py module contains two significant classes:

  • Example - Class for representing, modifying and serialising an example entry
  • SchemaExamples - A utility class for reading examples from file(s) and providing mappings between Schema.org terms and associated examples.

Checkout the example-code directory for usage, and the util directory for functionality implemented within schemorg.