Skip to content

Commit

Permalink
feat(Note): Draft Note specification
Browse files Browse the repository at this point in the history
WIP, based on discussions in
stencila/encoda#880
  • Loading branch information
rgieseke committed Mar 30, 2021
1 parent f3dffef commit b187519
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
17 changes: 17 additions & 0 deletions schema/Note.md
Original file line number Diff line number Diff line change
@@ -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.}.
```
25 changes: 25 additions & 0 deletions schema/Note.schema.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b187519

Please sign in to comment.