forked from stencila/schema
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Note): Draft Note specification
WIP, based on discussions in stencila/encoda#880
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.}. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |