Annotating episodes: Difference between revisions
(Created page with "There are two types of annotations: * Notes: plain text comments. * Resources: links, images, and videos. You can annotate an episode by going to an episode's wiki page and i...") Â |
No edit summary  |
||
| (7 intermediate revisions by 3 users not shown) | |||
| 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 8: | Line 9: | ||
<code> | <code> | ||
<div data-type="<span style="background: #ff9d9d;">resource</span>" data-timestamp="<span style="background: # | <div data-type="<span style="background: #ff9d9d;">resource</span>" data-timestamp="<span style="background: #aaff90;">00:14:00-00:14:53</span>"><span style="background: #90e0ff;">Content</span></div> | ||
</code> | </code> | ||
* <span style="background: #ff9d9d;">Type</span>: can be either <code>resource</code> or <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>: | * <span style="background: #90e0ff;">Content</span>: Use recognizable, solid, understandable & meaningful texts for resources, timestamps & notes. | ||
== What is this for? == | == What is this for? == | ||
Annotations are currently being used in [https://player.theportal.dev/ the Portal Player], and are also visible in the wiki. | Annotations are currently being used in [https://player.theportal.dev/ the Portal Player], and are also visible in the wiki. | ||
== Where do I start? == | |||
* [[Transcripts to be Made]] | |||
[[category:guides]] | |||
Latest revision as of 09:45, 17 May 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[edit]
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?[edit]
Annotations are currently being used in the Portal Player, and are also visible in the wiki.