Template:BrandHeader: Difference between revisions

Revision as of 23:10, 7 January 2024

Template documentation

Essential brand/organization information.

Template parameters[Edit template data]
This template has custom formatting.
Parameter		Description	Type	Status
Name	`title`	The common name of the entity/organization.	String	required
Logo Filename	`logo`	The primary logo or lettermark for the brand. SVG or Transparent background highly suggested. Wikipedia likely already has this. Upload fair-use files with /wiki/Special:Upload (Insert>Images>Upload>Default Upload Page). Example brandname-logo.png	File	suggested
Cover Image	`cover`	A decorative/contextual image of the brand's real world presence (e.g. storefront, distincive facilities). Wikimedia Commons likely already has one, which you can link directly by filename, using their "use this image" button. Example example.png	File	suggested
Cover Caption	`coverCaption`	Brief, literal description of the provided cover image.	String	optional
Parent Entity	`parent`	If part of an umbrella organization, the name of the parent company. Example Fandom, Inc. (which owns Metacritic)	Page name	optional
Products/Services	`products`	The consumer-facing offerings of the brand; mainly to aid product-based searches. Example Oreo Cookies, Nutter Butter (for Nabisco)	Page name	optional

The above documentation is transcluded from Template:BrandHeader/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

@@ Line 3: / Line 3: @@
 {{Documentation|content=<templatedata>
 {
-    "description": "Formats a citation to a website using the provided information such as URL and title. Used only for sources that are not correctly described by the specific citation templates for books, journals, news sources, etc.",
+	"description": "Essential brand/organization information.",
-    "params": {
+	"params": {
-        "title": {
+		"title": {
-            "label": "Name",
+			"label": "Name",
-            "description": "The common name of the entity/organization.",
+			"description": "The common name of the entity/organization.",
-            "type": "string",
+			"type": "string",
-            "required": true,
+			"required": true
-            "example": ""
+		},
-        },
+		"logo": {
-        "logo": {
+			"label": "Logo Filename",
-            "label": "Logo",
+			"description": "The primary logo or lettermark for the brand. SVG or Transparent background highly suggested. Wikipedia likely already has this. Upload fair-use files with /wiki/Special:Upload (Insert>Images>Upload>Default Upload Page).",
-            "description": "The primary logo or lettermark for the brand. SVG or Transparent background highly suggested. Wikipedia likely already has this. Upload fair-use files with /wiki/Special:Upload (Insert>Images>Upload>Default Upload Page).",
+			"type": "wiki-file-name",
-            "type": "content",
+			"suggested": true,
-            "suggested": true,
+			"example": "brandname-logo.png"
-            "example": "[[File:example.png]]"
+		},
-        },
+		"cover": {
-        "cover": {
+			"label": "Cover Image",
-            "label": "Cover Image",
+			"description": "A decorative/contextual image of the brand's real world presence (e.g. storefront, distincive facilities). Wikimedia Commons likely already has one, which you can link directly by filename, using their \"use this image\" button.",
-            "description": "A decorative/contextual image of the brand's real world presence (e.g. storefront, distincive facilities). Wikimedia Commons likely already has one which you can link directly here, using their \"use this image\" button. Must be in [[File:image.extension]] format.",
+			"type": "wiki-file-name",
-            "type": "content",
+			"suggested": true,
-            "suggested": true,
+			"example": "example.png"
-            "example": "[[File:example.png]]"
+		},
-        },
+		"coverCaption": {
-        "coverCaption": {
+			"label": "Cover Caption",
-            "label": "Cover Caption",
+			"description": "Brief, literal description of the provided cover image.",
-            "description": "Brief, literal description of the provided cover image.",
+			"type": "string",
-            "type": "string",
+			"suggested": false
-            "suggested": false
+		},
-        },
+		"parent": {
-        "parent": {
+			"label": "Parent Entity",
-            "label": "Parent Entity",
+			"description": "If part of an umbrella organization, the name of the parent company.",
-            "description": "If part of an umbrella organization, the name of the parent company.",
+			"type": "wiki-page-name",
-            "type": "wiki-page-name",
+			"example": "Fandom, Inc. (which owns Metacritic)"
-            "example": "Fandom, Inc. (which owns Metacritic)"
+		},
-        },
+		"products": {
-        "products": {
+			"label": "Products/Services",
-            "label": "Products/Services",
+			"description": "The consumer-facing offerings of the brand; mainly to aid product-based searches.",
-            "description": "The consumer-facing offerings of the brand; mainly to aid product-based searches.",
+			"type": "wiki-page-name",
-            "type": "wiki-page-name",
+			"example": "Oreo Cookies, Nutter Butter (for Nabisco)"
-            "example": "Oreo Cookies, Nutter Butter (for Nabisco)"
+		}
-        }
+	},
-    },
+	"paramOrder": [
-    "paramOrder": [
+		"title",
-        "title",
+		"logo",
-        "logo",
+		"cover",
-        "cover",
+		"coverCaption",
-        "coverCaption",
+		"parent",
-        "parent",
+		"products"
-        "products"
+	],
-    ],
+	"format": "{{_\n| _ = _\n}}"
-    "format": "{{_\n| _ = _\n}}"
 }
 </templatedata>}}
 </noinclude>