Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.22 KB

0000-example-extension.md

File metadata and controls

36 lines (28 loc) · 1.22 KB

OCFL Community Extension 0000: Example Extension

  • Extension Name: 0000-example-extension
  • Authors: A Person, Other Person
  • Minimum OCFL Version: 1.0
  • OCFL Community Extensions Version: 1.0
  • Obsoletes: n/a
  • Obsoleted by: n/a

Note: This is not a real extension, merely an example.

Overview

This extension is but an example and has no content, but if it did the content would be summarized in a paragraph here.

Parameters

  • Name: firstExampleParameter
    • Description: A mandatory 8 bit unsigned value
    • Type: number
    • Constraints: Must be an integer between 0 and 255 inclusive
    • Default:
  • Name: secondExampleParameter
    • Description: An optional 64 character long string, defaulting to "Not applicable", if omitted.
    • Type: string
    • Constraints: Must be less than or equal to 64 characters long
    • Default: "Not applicable"
  • Name: thirdExampleParameter
    • Description: An example enumerated parameter
    • Type: string
    • Constraints: Must be one of the following: "Red","Yellow","Orange","Green","Blue","Indigo","Violet"
    • Default: "Green"

Other Sections Providing Details, Examples, etc.

... more in here ...