Template:Transcript blurb: Difference between revisions

Latest revision as of 16:58, 22 June 2021

This template is for media pages with an edited transcript. It automatically adds the "Transcript" category and generates a description of the Portal Transcripts project with editor credits.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Blog Link	`bloglink`	Link to the blog post containing the transcript. Example https://theportal.group/the-portal-episode-002-what-is-the-portal/	String	suggested
AI Source	`ai`	Specify the AI used to generate the transcript. Default Otter.ai Example Otter.ai	String	suggested
madeby	`madeby`	Specify who generated the AI transcript. Example Brooke (pyrope#5830)	String	suggested
Transcript Source Platform	`source`	Specify and link to the platform where the content used to generate the transcript was retrieved. Example [https://www.youtube.com/watch?v=Z7rd04KzLcg YouTube]	String	suggested
First Editors	`firsteditors`	For a transcript that underwent major revisions by different editors, list who edited the first version. Example Brooke (pyrope#5830)	String	suggested
Later Revisor	`laterrevisor`	For a transcript that underwent major revisions by different editors, list who revised it. Example Brooke (pyrope#5830)	String	suggested
Editors	`editors`	Who edited the transcript. Unnecessary if First Editors are specified.	String	suggested
Additional Contributors	`furthercontributors`	List of those who made minor contributions before or after the transcript was posted. Example Brooke (pyrope#5830)	String	suggested

@@ Line 1: / Line 1: @@
-<noinclude>
+<includeonly>[[The Portal Group]]'s [[The Portal Transcripts|Transcript Completion Project]] generates and edits transcripts for content related to [[Eric Weinstein]] and [[The Portal Podcast]]. Completed transcripts are available to read on [{{{bloglink|}}} The Portal Blog] and [[:Category:Transcript|The Portal Wiki]]. If you would like to contribute, you can make direct edits to the wiki, or you can contact Aardvark or Brooke on [https://discord.gg/TDbpwzz The Portal Group Discord Server].
-Template for generating transcript blurbs.
-'''Usage: Copy paste the code below, filling in relevant fields after the = sign. Fields that are removed will not show up in the generated blurb or will display placeholder text.'''
+This transcript was generated with {{{ai|(No AI specified)}}} by {{{madeby|(No maker specified)}}} from this content's {{{source|(No source specified)}}} version. {{#if: {{{firsteditors|}}}|It was first edited by {{{firsteditors}}}, and later underwent major revision by {{{laterrevisor}}}.|It was edited by {{{editors|(No editors specified)}}}.}} {{#if: {{{furthercontributors|}}}|Further corrections and contributions were provided by {{{furthercontributors}}}.|}}
+[[Category:Transcript]]</includeonly><noinclude>
-<syntaxhighlight lang="html+handlebars">{{transcript blurb
+<templatedata>
-|bloglink=Link to The Portal Blog post for this transcript
+{
-|ai=What was used to generate the transcript
+	"params": {
-|source=Link to the content used to generate the transcript, in format [Link Platform] (for example: [https://www.youtube.com/watch?v=Z7rd04KzLcg YouTube])
+		"bloglink": {
-|madeby=Who generated the transcript
+			"label": "Blog Link",
-|firsteditors=If the transcript is old and was revised, who first edited it
+			"description": "Link to the blog post containing the transcript.",
-|laterrevisor=If the transcript is old and was revised, who revised it
+			"example": "https://theportal.group/the-portal-episode-002-what-is-the-portal/",
-|editors=If the transcript didn't undergo major revision, who edited it
+			"type": "string",
-|furthercontributors=Who contributed in ways that weren't major editing
+			"suggested": true
-}}</syntaxhighlight>
+		},
-</noinclude><includeonly>[[The Portal Group]]'s [[Transcript Completion Project]] generates and edits transcripts for content related to [[Eric Weinstein]] and [[The Portal Podcast]]. Completed transcripts are available to read on [{{{bloglink|}}} The Portal Blog] and [[:Category:Transcript|The Portal Wiki]]. If you would like to contribute, you can make direct edits to the wiki, or you can contact Aardvark or Brooke on [https://discord.gg/TDbpwzz The Portal Group Discord Server].
+		"ai": {
+			"label": "AI Source",
-This transcript was generated with {{{ai|(No AI specified)}}} by {{{madeby|(No maker specified)}}} from this content's {{{source|(No source specified)}}} version. {{#if: {{{firsteditors|}}}|It was first edited by {{{firsteditors}}}, and later underwent major revision by {{{laterrevisor}}}.|It was edited by {{{editors|(No editors specified)}}}.}} {{#if: {{{furthercontributors|}}}|Further corrections and contributions were provided by {{{furthercontributors}}}.|}}</includeonly>
+			"description": "Specify the AI used to generate the transcript.",
+			"example": "Otter.ai",
+			"type": "string",
+			"default": "Otter.ai",
+			"suggested": true
+		},
+		"madeby": {
+			"description": "Specify who generated the AI transcript.",
+			"example": "Brooke (pyrope#5830)",
+			"type": "string",
+			"suggested": true
+		},
+		"source": {
+			"label": "Transcript Source Platform",
+			"description": "Specify and link to the platform where the content used to generate the transcript was retrieved.",
+			"example": "[https://www.youtube.com/watch?v=Z7rd04KzLcg YouTube]",
+			"type": "string",
+			"suggested": true
+		},
+		"firsteditors": {
+			"label": "First Editors",
+			"description": "For a transcript that underwent major revisions by different editors, list who edited the first version.",
+			"example": "Brooke (pyrope#5830)",
+			"type": "string",
+			"suggested": true
+		},
+		"laterrevisor": {
+			"label": "Later Revisor",
+			"description": "For a transcript that underwent major revisions by different editors, list who revised it.",
+			"example": "Brooke (pyrope#5830)",
+			"type": "string",
+			"suggested": true
+		},
+		"editors": {
+			"label": "Editors",
+			"description": "Who edited the transcript. Unnecessary if First Editors are specified.",
+			"type": "string",
+			"suggested": true
+		},
+		"furthercontributors": {
+			"label": "Additional Contributors",
+			"description": "List of those who made minor contributions before or after the transcript was posted.",
+			"example": "Brooke (pyrope#5830)",
+			"type": "string",
+			"suggested": true
+		}
+	},
+	"description": "This template is for media pages with an edited transcript. It automatically adds the \"Transcript\" category and generates a description of the Portal Transcripts project with editor credits. ",
+	"format": "inline"
+}
+</templatedata>
+</noinclude>
+<noinclude>[[Category:Transcript templates]]</noinclude>