Template:Videobox/doc: Difference between revisions

Latest revision as of 02:31, 12 December 2024

Lets you put an image link to a video on the wiki for faster loading on large pages.

Usage

{{Videobox
|float       =
|video-title =
|thumbnail   =
|size        =
|video-url   =
}}

Example

Default

{{Videobox
}}

produces

Example 1

{{Videobox
|float       = left
|video-title = LOL THIS IS A TEST
|thumbnail   = HasanDestinyFish.png
|size        = x200px
|video-url   = 5/52/Trump_McCain_Not_a_War_Hero.mp4
|caption     = <br>test
}}

produces

Parameters

No description.

Template parameters
Parameter		Description	Type	Status
float	`float`	Which side of the page you want the box to appear on, defaults to the right side. Values are "right", "left" or "center".	Unknown	optional
video-title	`video-title`	Title of the clip/video that you are "embedding". Hides if no title is entered.	Content	required
thumbnail	`thumbnail`	The image you want to use as a thumbnail. Should be no longer than 400 px and no taller than 200 px. Preferably should be in a landscape orientation. Box and portrait orientation are acceptable so long as that is how the clip/content is natively uploaded (i.e. a video recorded on a phone or a tik tok). Do not include the "File:" prefix. Defaults to a placeholder image.	File	required
size	`size`	The size of the image in the event the thumbnail you are using is bigger than the suggested length (400 px wide by 200 px high). For constrained width, type "{number value}px", for constrained height, type "x{number value}px". Avoid using em, rem or percentage-based lengths. Defaults to x150px Example 100px, 200px, x200px, x100px	Unknown	optional
video-url	`video-url`	Link to any video clip on the wiki, include everything in the URL past "https://wikicdn.destiny.gg/". Automatically fills to an Anything Else? clip.	Unknown	required
tooltip	`tooltip`	Adds an optional tooltip that pops up when mousing over the video or hyperlink. Can be used to give a brief description or title if video-title isn't used. No default values.	Content	suggested
caption	`caption`	Add a caption.	Content	suggested

@@ Line 11: / Line 11: @@
 == Example ==
+=== Default ===
+ <nowiki>{{Videobox
+}}</nowiki>
+produces
+{{Videobox
+}}
+<br>
+<br>
+<br>
+<br>
+<br>
+=== Example 1 ===
   <nowiki>{{Videobox
 |float       = left
@@ Line 17: / Line 31: @@
 |size        = x200px
 |video-url   = 5/52/Trump_McCain_Not_a_War_Hero.mp4
+|caption     = <br>test
 }}</nowiki>
@@ Line 27: / Line 42: @@
 |size        = x200px
 |video-url   = 5/52/Trump_McCain_Not_a_War_Hero.mp4
+|caption     = This is an example of a caption!
 }}
 <br>
 <br>
@@ Line 40: / Line 55: @@
 <br>
 <br>
+<br>
 == Parameters ==
@@ Line 49: / Line 66: @@
 		},
 		"video-title": {
-			"description": "Title of the clip/video that you are \"embedding\".",
+			"description": "Title of the clip/video that you are \"embedding\". Hides if no title is entered.",
-			"type": "content"
+			"type": "content",
+			"required": true
 		},
 		"size": {
@@ Line 65: / Line 83: @@
 			"type": "wiki-file-name",
 			"required": true
+		},
+		"tooltip": {
+			"description": "Adds an optional tooltip that pops up when mousing over the video or hyperlink. Can be used to give a brief description or title if video-title isn't used. No default values.",
+			"type": "content",
+			"suggested": true
+		},
+		"caption": {
+			"description": "Add a caption.",
+			"type": "content",
+			"suggested": true
 		}
 	},
@@ Line 72: / Line 100: @@
 		"thumbnail",
 		"size",
-		"video-url"
+		"video-url",
+		"tooltip",
+		"caption"
 	]
 }
 </templatedata>