Annotating episodes - Revision history

Yoav at 09:45, 17 May 2020

2020-05-17T09:45:44Z

← Older revision		Revision as of 09:45, 17 May 2020
Line 21:		Line 21:
	== Where do I start? ==		== Where do I start? ==
	* [[Transcripts to be Made]]		* [[Transcripts to be Made]]

			[[category:guides]]

Demp: Added explanation for adding table of contents

2020-04-29T10:51:09Z

Added explanation for adding table of contents

← Older revision		Revision as of 10:51, 29 April 2020
Line 1:		Line 1:
	There are ~~two~~ types of annotations:		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>~~transcript~~</code>, <code>~~resource~~</code>, or <code>~~note~~</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.

Demp at 16:49, 25 April 2020

2020-04-25T16:49:56Z

← Older revision		Revision as of 16:49, 25 April 2020
Line 8:		Line 8:

	<code>		<code>
	<div data-type="<span style="background: #ff9d9d;">resource</span>" data-timestamp="<span style="background: #aaff90;">00:14:00-00:14:~~(6,7-)~~</span>"><span style="background: #90e0ff;">Content</span></div>		<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>

174.255.203.0: <* Format *>

2020-04-21T21:16:54Z

<* Format *>

← Older revision		Revision as of 21:16, 21 April 2020
Line 13:		Line 13:
	* <span style="background: #ff9d9d;">Type</span>: can be either <code>transcript</code>, <code>resource</code>, or <code>note</code>.		* <span style="background: #ff9d9d;">Type</span>: can be either <code>transcript</code>, <code>resource</code>, or <code>note</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>). '''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 & notes.		* <span style="background: #90e0ff;">Content</span>: Use recognizable, solid, understandable & meaningful texts for resources, timestamps & notes.

	== What is this for? ==		== What is this for? ==

174.255.203.0: /* Format *\

2020-04-21T21:16:01Z

/* Format *\

← Older revision		Revision as of 21:16, 21 April 2020
Line 8:		Line 8:

	<code>		<code>
	<div data-type="<span style="background: #ff9d9d;">resource</span>" data-timestamp="<span style="background: #~~aaff94~~;">00:14:00-00:14:53</span>"><span style="background: #90e0ff;">Content</span></div>		<div data-type="<span style="background: #ff9d9d;">resource</span>" data-timestamp="<span style="background: #aaff90;">00:14:00-00:14:(6,7-)</span>"><span style="background: #90e0ff;">Content</span></div>
	</code>		</code>

	* <span style="background: #ff9d9d;">Type</span>: can be either <code>transcript</code>, <code>resource</code>, or <code>note</code>.		* <span style="background: #ff9d9d;">Type</span>: can be either <code>transcript</code>, <code>resource</code>, or <code>note</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>). '''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>: ~~Plain text for notes~~, ~~anything else~~ for resources.		* <span style="background: #90e0ff;">Content</span>: Use recognizable, solid, understandable & meaningful texts for resources & notes.

	== What is this for? ==		== What is this for? ==

BeefSandwich27 at 18:16, 12 April 2020

2020-04-12T18:16:26Z

← Older revision		Revision as of 18:16, 12 April 2020
Line 11:		Line 11:
	</code>		</code>

	* <span style="background: #ff9d9d;">Type</span>: can be either <code>resource</code> or <code>note</code>.		* <span style="background: #ff9d9d;">Type</span>: can be either <code>transcript</code>, <code>resource</code>, or <code>note</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>). '''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>: Plain text for notes, anything else for resources.		* <span style="background: #90e0ff;">Content</span>: Plain text for notes, anything else for resources.

BeefSandwich27: /* Where do I start? */

2020-04-12T12:48:28Z

Where do I start?

← Older revision		Revision as of 12:48, 12 April 2020
Line 19:		Line 19:

	== Where do I start? ==		== Where do I start? ==
	* [[Transcripts to Be Made]]		* [[Transcripts to be Made]]

BeefSandwich27 at 12:48, 12 April 2020

2020-04-12T12:48:09Z

← Older revision		Revision as of 12:48, 12 April 2020
Line 17:		Line 17:
	== 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]]

Demp: 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..."

2020-04-09T08:38:48Z

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..."

New page

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 inserting annotations to the "annotations" section of the page (can be created if missing).
== Format ==
Annotations require a special markup in the following format:

<code>
<div data-type="resource" data-timestamp="00:14:00-00:14:53">Content</div>
</code>

* Type: can be either <code>resource</code> or <code>note</code>.
* 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: <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.'''
* Content: Plain text for notes, anything else for resources.

== What is this for? ==
Annotations are currently being used in [https://player.theportal.dev/ the Portal Player], and are also visible in the wiki.