Skip to content

Commit

Permalink
feat(Comment): Add comment aspect
Browse files Browse the repository at this point in the history
  • Loading branch information
nokome committed Nov 15, 2020
1 parent b9bad70 commit 3c06245
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion schema/Comment.schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ status: stable
category: metadata
description: A comment on an item, e.g on a Article, or SoftwareSourceCode.
$comment: |
Use the `about` property to define the item that a comment is on.
Use the `about` property to define the item that a comment is on and
`commentAspect` to point to a specific part of aspect of that item.
The `content` property should be used for the structured content of the
comment, in preference to the schema.org `text` property (which is expected to
be plain text). Replies to a comment can be added to its `comments` property
Expand All @@ -16,3 +17,12 @@ properties:
'@id': schema:parentItem
description: The parent comment of this comment.
$ref: Comment
commentAspect:
'@id': stencila:commentAspect
description: The part or facet of the item that is being commented on.
$comment: |
This propery is analagous to the `reviewAspect` property of the `reviewAspect`
type. It is a string to allow flexibility in how the aspect is expressed
depending on the item e.g "technique", for a comment on a painting, or
"some_code.py#L10-L20" for a comment on a software code repository.
type: string

0 comments on commit 3c06245

Please sign in to comment.