Annotating episodes: Difference between revisions
No edit summary |
(Added explanation for adding table of contents) |
||
| Line 1: | Line 1: | ||
There are | There are three types of annotations: | ||
* Notes: plain text comments. | * Notes: plain text comments. | ||
* Resources: links, images, and videos. | * Resources: links, images, and videos. | ||
* Table of contents | |||
You can annotate an episode by going to an episode's wiki page and inserting annotations to the "annotations" section of the page (can be created if missing). | You can annotate an episode by going to an episode's wiki page and inserting annotations to the "annotations" section of the page (can be created if missing). | ||
| Line 11: | Line 12: | ||
</code> | </code> | ||
* <span style="background: #ff9d9d;">Type</span>: can be either <code> | * <span style="background: #ff9d9d;">Type</span>: can be either <code>resource</code>, <code>note</code>, or <code>table-of-contents</code>. | ||
* <span style="background: #aaff94;">Time range</span>: sets of timestamps, start and end, for the annotation, separated by a hyphen. If the annotation is relevant for more than one time range, another range can be included, separated by comma (for example: <code>00:14:00-00:14:53,01:44:12-01:45:02</code>). '''Important: timestamps are not synced between different versions (youtube video, original audio, etc). The timestamps used in annotations must be taken from the audio file of the episode linked in the episode's wiki page, unless specified otherwise.''' | * <span style="background: #aaff94;">Time range</span>: sets of timestamps, start and end, for the annotation, separated by a hyphen. If the annotation is relevant for more than one time range, another range can be included, separated by comma (for example: <code>00:14:00-00:14:53,01:44:12-01:45:02</code>). For table of contents, a single timestamp is required. '''Important: timestamps are not synced between different versions (youtube video, original audio, etc). The timestamps used in annotations must be taken from the audio file of the episode linked in the episode's wiki page, unless specified otherwise.''' | ||
* <span style="background: #90e0ff;">Content</span>: Use recognizable, solid, understandable & meaningful texts for resources, timestamps & notes. | * <span style="background: #90e0ff;">Content</span>: Use recognizable, solid, understandable & meaningful texts for resources, timestamps & notes. | ||
Revision as of 10:51, 29 April 2020
There are three types of annotations:
- Notes: plain text comments.
- Resources: links, images, and videos.
- Table of contents
You can annotate an episode by going to an episode's wiki page and inserting annotations to the "annotations" section of the page (can be created if missing).
Format
Annotations require a special markup in the following format:
<div data-type="resource" data-timestamp="00:14:00-00:14:53">Content</div>
- Type: can be either
resource,note, ortable-of-contents. - Time range: sets of timestamps, start and end, for the annotation, separated by a hyphen. If the annotation is relevant for more than one time range, another range can be included, separated by comma (for example:
00:14:00-00:14:53,01:44:12-01:45:02). For table of contents, a single timestamp is required. Important: timestamps are not synced between different versions (youtube video, original audio, etc). The timestamps used in annotations must be taken from the audio file of the episode linked in the episode's wiki page, unless specified otherwise. - Content: Use recognizable, solid, understandable & meaningful texts for resources, timestamps & notes.
What is this for?
Annotations are currently being used in the Portal Player, and are also visible in the wiki.