From b187519d72ed8d77fa85bc3c44abc1b81ad5d93a Mon Sep 17 00:00:00 2001 From: Robert Gieseke Date: Tue, 30 Mar 2021 11:10:08 +0200 Subject: [PATCH] feat(Note): Draft Note specification WIP, based on discussions in https://github.com/stencila/encoda/issues/880 --- schema/Note.md | 17 +++++++++++++++++ schema/Note.schema.yaml | 25 +++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 schema/Note.md create mode 100644 schema/Note.schema.yaml diff --git a/schema/Note.md b/schema/Note.md new file mode 100644 index 00000000..2c3adf0c --- /dev/null +++ b/schema/Note.md @@ -0,0 +1,17 @@ +--- +title: Note +--- + +include: ../public/Note.schema.md ::: + +Additional text related to a word or paragraph which is not part of the main text and usually marked with a number or other symbol. It can be displayed as a footnote, endnote, as side or margin note, or in interactive elements. + +## Properties + +# Examples + +# Encoding + +```latex +An example of some details\footnote{Here is some background information.}. +``` diff --git a/schema/Note.schema.yaml b/schema/Note.schema.yaml new file mode 100644 index 00000000..8b386f8b --- /dev/null +++ b/schema/Note.schema.yaml @@ -0,0 +1,25 @@ +title: Note +'@id': stencila:Note +extends: Entity +role: secondary +status: unstable +description: . +properties: + noteType: + '@id': stencila:noteType + description: Determines where the note content is displayed within document. + type: string + enum: + - Footnote + - Endnote + content: + '@id': stencila:content + description: Content of the note, usually a paragraph. + type: array + items: + $ref: BlockContent + $comment: | + Most notes will have a single paragraph but could have multiple + paragraphs, tables and even figures. +required: + - content