Template:CompanyCargo: Difference between revisions

← Older edit

VisualWikitext

@@ Line 1: / Line 1: @@
 <noinclude>
-{{Important|This is a work in progress}}
+{{Documentation}}
-This is the "Company" template used with Cargo and the Wiki extension.
-; Fields available:
-: '''Description:''' (Optional) Description of a company in 150 characters or less
-: '''Founded:''' (Optional) Date when the company was founded
-: '''Industry:''' (Optional) Industries that this company is part of
-: '''Logo:''' (Optional) Image file of the company's logo
-: '''ParentCompany:''' (Optional) Parent company to the company
-: '''Type:''' (Optional) Refers to if a company is public, private, non-profit, part of the government, or other
-: '''Website:''' (Optional) Links to a company website - only include a website if it represents a separate top level domain (TLD) or regional variation
-{{#template_params:Description (label=Description)
-                  |Founded (label=Founded)
-                  |Industry (label=Industry)
-                  |Logo (label=Logo)
-                  |ParentCompany (label=Parent Company)
-                  |Type (label=Type)
-                  |Website (label=Website)
-}}
 {{#cargo_declare:_table=Company
 | Description   = String
@@ Line 26: / Line 7: @@
 | Logo          = File
 | ParentCompany = Page
-| Type          = String (allowed values=Public,Private,Government,Non-Profit,Other)
+| Type          = String
 | Website       = List (,) of URL
 }}
+<templatedata>
+{
+	"description": "The CompanyCargo template is responsible for creating a structured database for companies for the Wiki extension and rendering an infobox off the data.",
+	"params": {
+		"Founded": {
+			"label": "Founded",
+			"description": "Date when the company was founded",
+			"type": "date",
+			"example": "2013 OR 2013-11 OR 2013-11-23 (YYYY-MM-DD where month and day are optional)",
+			"required": false
+		},
+		"Industry": {
+			"label": "Industry",
+			"description": "Industries that this company is part of",
+			"example": "Electronics,GPUs",
+			"type": "string"
+		},
+		"Logo": {
+			"label": "Logo",
+			"description": "Image file of the company's logo",
+			"example": "Apple.png",
+			"type": "wiki-file-name"
+		},
+		"ParentCompany": {
+			"label": "Parent Company",
+			"description": "Parent company to the company",
+			"example": "John Deere",
+			"type": "wiki-page-name"
+		},
+		"Type": {
+			"label": "Legal structure",
+			"description": "Refers to if a company is public, private, non-profit, part of the government, or other",
+			"example": "Public",
+			"type": "string",
+			"suggestedvalues": [
+				"Public",
+				"Private",
+                "Government",
+                "Non-Profit"
+			]
+		},
+		"Website": {
+			"label": "Official Website",
+			"description": "Links to a company website - only include a website if it represents a separate top level domain (TLD) or regional variation",
+			"example": "https://www.apple.com/",
+			"type": "url"
+		},
+		"Description": {
+			"label": "Description",
+			"description": "Description of a company in 150 characters or less",
+			"type": "string"
+		}
+	},
+	"format": "block"
+}
+</templatedata>
 </noinclude>
-<includeonly>
-{{#cargo_store:_table=Company
+<includeonly>{{#cargo_store:_table=Company
 | Founded       = {{{Founded|}}}
 | Industry      = {{{Industry|}}}
@@ Line 39: / Line 76: @@
 | Website       = {{{Website|}}}
 | Description   = {{{Description|}}}
-}}
+}}<div class="infobox">
-<div class="infobox">
    <div style="display: flex; gap: 8px; flex-direction: column">
      <div class="infobox-title">{{PAGENAME}}</div>
@@ Line 49: / Line 84: @@
          <th colspan="2" class="infobox-table-caption">Basic information</th>
        </tr>
        <tr>
          <th>{{nowrap|Founded}}</th>
          <td>{{{Founded|}}}</td>
        </tr>
        <tr>
-         <th>{{nowrap|Type}}</th>
+         <th>{{nowrap|Legal Structure}}</th>
          <td>{{{Type|}}}</td>
        </tr>
        <tr>
          <th>{{nowrap|Industry}}</th>
          <td>{{{Industry|}}}</td>
        </tr>
        <tr>
          <th>{{nowrap|Official website}}</th>