Difference between revisions of "Template:Infobox dot-com company/doc"

From blackwiki
Jump to navigation Jump to search
imported>Czarkoff
m (→‎Usage: fixed parameter name)
imported>Czarkoff
(Updated, attempted to describe parameters)
Line 5: Line 5:
  
 
==Usage==
 
==Usage==
{{update}}
 
Copy a blank version to use.  All parameters '''''must''''' be [[lower case]]. Some parameter use a space while others use an underscore as shown. All fields are optional except the location of the company's headquarters.  To specify the location specify either {{para|location_city}} and {{para|location_country}} or {{para|location}}.
 
 
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
{{Infobox dot-com company
 
{{Infobox dot-com company
| company_name    =  
+
|name                =
| company_logo    =  
+
|logo                =
| screenshot      =  
+
|logo size            = <!-- width in pixels, with "px" suffix -->
| company_type    =  
+
|logo alt            =
| traded_as        =  
+
|collapsible          = <!-- "yes" or "no" -->
| foundation      =  
+
|screenshot          =  
| dissolved       =
+
|screenshot size      = <!-- width in pixels, with "px" suffix -->
| location         =  
+
|screenshot alt       =  
| locations        =  
+
|caption              =  
| incorporated    =
+
|type                =  
| area_served      =  
+
|traded as            =  
| founder         =  
+
|founded              = <!-- {{start date and age|year|month|day}} -->
| chairman         =  
+
|dissolved           = <!-- {{start date and age|year|month|day}} -->
| chairperson     =  
+
|predecessor          =
| president       =  
+
|successor            =  
| CEO             =  
+
|location             =
| MD               =  
+
|country              =  
| GM               =  
+
|country of origin    =  
| key_people      =  
+
|locations            =  
| industry         =  
+
|area served          =  
| products         =  
+
|founder             =  
| services         =  
+
|chairman             =  
| revenue         =  
+
|chairperson         =  
| operating_income =  
+
|president           =  
| net_income      =  
+
|CEO                 =  
| assets           =  
+
|MD                   =  
| equity           =  
+
|GM                   =  
| owner           =  
+
|key people          =  
| num_employees    =  
+
|industry             =  
| parent           =  
+
|products             =  
| divisions       =  
+
|services             =  
| subsid          =  
+
|revenue             =
| company_slogan  =  
+
|operating income    =  
| url             =  
+
|international        = <!-- "yes" or "no" -->
| programming_language =  
+
|net income          =  
| ipv6             =
+
|assets               =  
| alexa           =  
+
|equity               =  
| website_type    =
+
|owner               =  
| advertising     =  
+
|employees            =  
| registration     =  
+
|parent               =  
| num_users        =
+
|divisions           =  
| language         =
+
|subsidiaries        =  
| launch_date      =  
+
|slogan              =  
| current_status  =
+
|url                 =  
| screenshot      =
+
|programming language =  
| collapsible      =
+
|ipv6                 =  
| collapsetext    =  
+
|alexa               =  
| caption          =  
+
|website type        =  
| footnotes       =
+
|advertising         =  
| intl            =
+
|registration         =  
| native_clients  =
+
|users                =  
}}
+
|language             =  
</pre>
+
|launched            = <!-- {{start date and age|year|month|day}} -->
 +
|current status      =  
 +
|native clients      =  
 +
|footnotes           =  
 +
}}</pre>
  
 
==Parameters==
 
==Parameters==
;alexa: The website's current [[Alexa Internet|Alexa]] ranking (find on [http://www.alexa.com/ Alexa.com]; make sure to cite Alexa's page for this info.)
+
{{TemplateDataHeader}}
*Put {{tl|Increase}} ({{Increase}}) OR {{tl|Steady}} ({{Steady}}) OR {{tl|Decrease}} ({{Decrease}}) BEFORE the ranking number to indicate the change of ranking compared with the previous month.
+
<templatedata>
*Mention the date of putting the ranking number AFTER the ranking number. Put the date in parenthesis, for example: (July 2012). If you update the ranking number, update the date as well.
+
{
*At [[User talk:Riley Huntley/AlexaBot.js]] you can request that a bot will monthly update the rank.
+
"description": "This template can be used to provide a summary for articles describing a dotcom and its website (for example: YouTube, eBay, Facebook). If the two entities do not share the same name and/or have their own article, use {{Infobox company}} and {{Infobox website}} instead.",
 +
"params": {
 +
"name": {
 +
"label": "Name",
 +
"description": "The name of the company and service.",
 +
"type": "string",
 +
"aliases": [
 +
"company name",
 +
"company_name"
 +
],
 +
"required": true,
 +
"default": "page title"
 +
},
 +
"logo": {
 +
"label": "Logo",
 +
"description": "Filename of logo of the company and service.",
 +
"type": "string/wiki-file-name",
 +
"aliases": [
 +
"company logo",
 +
"company_logo"
 +
],
 +
"required": false
 +
},
 +
"logo size": {
 +
"label": "Logo size",
 +
"description": "Size of logo in pixels. The value should be valid CSS width value ending with \"px\" suffix.",
 +
"type": "string",
 +
"aliases": [
 +
"logo_size"
 +
],
 +
"required": false
 +
},
 +
"logo alt": {
 +
"label": "Alternative text for logo",
 +
"description": "Textual description of logo that would be displayed in tooltip when pointer hovers over logo. This text (instead of logo file name) would be used by screen readers and text browsers. This parameter is required if logo is provided.",
 +
"type": "string",
 +
"aliases": [
 +
"logo_alt"
 +
],
 +
"required": false
 +
},
 +
"collapsible": {
 +
"label": "Collapsible screenshot?",
 +
"description": "If set to \"yes\", screenshot will start out collapsed.",
 +
"type": "string",
 +
"default": "no"
 +
},
 +
"screenshot": {
 +
"label": "Screenshot",
 +
"description": "File name of screenshot image. Images not showing web browser user interface are strongly prefered.",
 +
"type": "string/wiki-file-name"
 +
},
 +
"screenshot size": {
 +
"aliases": [
 +
"screenshot_size"
 +
],
 +
"label": "Screenshot size",
 +
"description": "Size of screenshot in pixels. The value should be valid CSS width value ending with \"px\" suffix.",
 +
"type": "string"
 +
},
 +
"screenshot alt": {
 +
"aliases": [
 +
"screenshot_alt"
 +
],
 +
"label": "Alternative text for screenshot",
 +
"description": "Textual description of screenshot. Will be displayed in tooltip when pointer hovers over screenshot. This text (instead of screenshot file name) would be used by screen readers and text browsers. This parameter is required if screenshot is provided.",
 +
"type": "string"
 +
},
 +
"caption": {
 +
"label": "Caption for the screenshot",
 +
"description": "Short explanatory text about the page on screenshot.",
 +
"type": "string"
 +
},
 +
"type": {
 +
"aliases": [
 +
"company type",
 +
"company_type"
 +
],
 +
"label": "Type of business entity",
 +
"description": "Type of business entity operating under this name. Examples include \"[[Limited liability company]]\" or \"[[Joint stock company]]\"",
 +
"type": "string"
 +
},
 +
"traded as": {
 +
"aliases": [
 +
"traded_as"
 +
],
 +
"label": "Traded as",
 +
"description": "Company's ticker symbol",
 +
"type": "string"
 +
},
 +
"founded": {
 +
"aliases": [
 +
"foundation"
 +
],
 +
"label": "Date of foundation",
 +
"description": "Date of foundation of the company. Use {{start date and age|year|month|day}} template.",
 +
"type": "date"
 +
},
 +
"dissolved": {
 +
"label": "Date of dissolution",
 +
"description": "Date of dissolution of the company. Use {{start date and age|year|month|day}} template.",
 +
"type": "date"
 +
},
 +
"predecessor": {
 +
"label": "Predecessor",
 +
"description": "Predeceding company or service if unambiguous legal connection exists.",
 +
"type": "string"
 +
},
 +
"successor": {
 +
"label": "Successor",
 +
"description": "Siccessing company or service if unambiguous legal connection exists.",
 +
"type": "string"
 +
},
 +
"location": {
 +
"aliases": [
 +
"location city",
 +
"location_city"
 +
],
 +
"label": "Location",
 +
"description": "City or place where company's headquoters are located.",
 +
"type": "string"
 +
},
 +
"country": {
 +
"aliases": [
 +
"location country",
 +
"location_country"
 +
],
 +
"label": "Country",
 +
"description": "Country where company's headquoters are located.",
 +
"type": "string/wiki-page-name"
 +
},
 +
"country of origin": {
 +
"aliases": [
 +
"country_of_origin"
 +
],
 +
"label": "Country of origin",
 +
"description": "Country where company was originally situated (if different from current country).",
 +
"type": "string/wiki-page-name"
 +
},
 +
"locations": {
 +
"label": "Number of locations",
 +
"description": "Number of offices the company has.",
 +
"type": "number"
 +
},
 +
"area served": {
 +
"aliases": [
 +
"area_served"
 +
],
 +
"label": "Area served",
 +
"description": "Area where the service is available in its entirety.",
 +
"type": "string"
 +
},
 +
"founder": {
 +
"label": "Founder",
 +
"description": "Founder(s) of company.",
 +
"type": "string"
 +
},
 +
"chairman": {
 +
"label": "Chairman",
 +
"description": "Chairman of the company.",
 +
"type": "string"
 +
},
 +
"chairperson": {
 +
"label": "Chairperson",
 +
"description": "Chairperson of the company.",
 +
"type": "string"
 +
},
 +
"president": {
 +
"label": "President",
 +
"description": "President of the company.",
 +
"type": "string"
 +
},
 +
"CEO": {
 +
"label": "CEO",
 +
"description": "CEO of the company.",
 +
"type": "string"
 +
},
 +
"MD": {
 +
"label": "Managing director",
 +
"description": "Managing director of the company.",
 +
"type": "string"
 +
},
 +
"GM": {
 +
"label": "General manager",
 +
"description": "General manager of the company.",
 +
"type": "string"
 +
},
 +
"key people": {
 +
"aliases": [
 +
"key_people"
 +
],
 +
"label": "Key people",
 +
"description": "Key people of the company. Consider using \"president\", \"CEO\", \"MD\" and \"GM\" fields instead.",
 +
"type": "string"
 +
},
 +
"industry": {
 +
"label": "Industry",
 +
"description": "Industry of the service.",
 +
"type": "string"
 +
},
 +
"products": {
 +
"label": "Products",
 +
"description": "Products of the company. Don't list company services here.",
 +
"type": "string"
 +
},
 +
"services": {
 +
"label": "Services",
 +
"description": "Services of the company. Don't list the service that is subject of the article – it's name is already stated in \"name\" parameter.",
 +
"type": "string"
 +
},
 +
"revenue": {
 +
"label": "Revenue",
 +
"description": "Last known annual revenue of the company. For dissolved companies: most significant known revenue. Both figures and year must be stated; reference supporting the figures is required.",
 +
"type": "string"
 +
},
 +
"operating income": {
 +
"aliases": [
 +
"operating_income"
 +
],
 +
"label": "Operating income",
 +
"description": "Earnings before interest payment and taxes examption. Both figures and year must be stated; reference supporting the figures is required.",
 +
"type": "string"
 +
},
 +
"international": {
 +
"aliases": [
 +
"intl"
 +
],
 +
"label": "International?",
 +
"description": "If set to \"yes\", will display label \"Profit\" instead of \"Net income\".",
 +
"type": "string"
 +
},
 +
"net income": {
 +
"aliases": [
 +
"net_income"
 +
],
 +
"label": "Net income",
 +
"description": "Net income of the company. Both figures andyear must be stated; reference supporting the figures is required.",
 +
"type": "string"
 +
},
 +
"assets": {
 +
"label": "Assets",
 +
"description": "Total value of company's assets. Both figure and year must be stated; reference supporting the figures is required.",
 +
"type": "string"
 +
},
 +
"equity": {
 +
"label": "Equity",
 +
"description": "Total equity of company. Both figure and year must be stated; reference supporting the figures is required.",
 +
"type": "string"
 +
},
 +
"owner": {
 +
"label": "Owner",
 +
"description": "Owner(s) of company.",
 +
"type": "string"
 +
},
 +
"employees": {
 +
"aliases": [
 +
"num employees",
 +
"num_employees"
 +
],
 +
"label": "Employees",
 +
"description": "Total number of employees.",
 +
"type": "number"
 +
},
 +
"parent": {
 +
"label": "parent",
 +
"description": "Holding company.",
 +
"type": "string"
 +
},
 +
"divisions": {
 +
"label": "Divisions",
 +
"description": "Significant business divisions of the company.",
 +
"type": "string"
 +
},
 +
"subsidiaries": {
 +
"aliases": [
 +
"subsid"
 +
],
 +
"label": "Subsidiaries",
 +
"description": "Subsidiary companies.",
 +
"type": "string"
 +
},
 +
"slogan": {
 +
"aliases": [
 +
"company slogan",
 +
"company_slogan"
 +
],
 +
"label": "Slogan",
 +
"description": "Slogan of the company and service.",
 +
"type": "string"
 +
},
 +
"url": {
 +
"aliases": [
 +
"website",
 +
"homepage"
 +
],
 +
"label": "Website",
 +
"description": "Website of the service. Use {{URL|link}} template.",
 +
"type": "string",
 +
"required": true
 +
},
 +
"programming language": {
 +
"aliases": [
 +
"programming_language"
 +
],
 +
"label": "Programming language",
 +
"description": "List of programming languages the service is implemented in.",
 +
"type": "string"
 +
},
 +
"ipv6": {
 +
"label": "IPv6",
 +
"description": "Status of IPv6 support in the service.",
 +
"type": "string"
 +
},
 +
"alexa": {
 +
"label": "Alexa rank",
 +
"description": "This field consists of three parts: (1) either of {{IncreaseNegative}}, {{DecreasePositive}} or {{Steady}} templates, (2) absolute value of rating and (3) date the rating was retrieved in parentheses.",
 +
"type": "string"
 +
},
 +
"website type": {
 +
"aliases": [
 +
"website_type"
 +
],
 +
"label": "Type of website",
 +
"description": "Type (genre) of service.",
 +
"type": "string"
 +
},
 +
"advertising": {
 +
"label": "Advertising",
 +
"description": "Does the service use advertising?",
 +
"type": "string"
 +
},
 +
"registration": {
 +
"label": "Registration",
 +
"description": "Does the site require registration?",
 +
"type": "string"
 +
},
 +
"users": {
 +
"aliases": [
 +
"num users",
 +
"num_users"
 +
],
 +
"label": "Number of users",
 +
"description": "Total number of service users. Both figure and year must be stated; reference supporting the figures is required.",
 +
"type": "string"
 +
},
 +
"language": {
 +
"label": "Language",
 +
"description": "Language(s) the service is available in. Don't use wikilinks in this field.",
 +
"type": "string"
 +
},
 +
"launched": {
 +
"aliases": [
 +
"launch date",
 +
"launch_date"
 +
],
 +
"label": "Launched",
 +
"description": "Date the service became publicly available. Use {{start date and age|year|month|day}} template.",
 +
"type": "date"
 +
},
 +
"current status": {
 +
"aliases": [
 +
"current_status"
 +
],
 +
"label": "Current status",
 +
"description": "One of \"Online\", \"Suspended\", \"Discontinued\". Use \"Unavailable\" if service is offline but no official statement was issued.",
 +
"type": "string"
 +
},
 +
"native clients": {
 +
"aliases": [
 +
"native_clients"
 +
],
 +
"label": "Native clients",
 +
"description": "List of operating systems which are supported by native applications for the service. Examples may include \"[[iOS]]\", \"[[Android (operating system)|]\", \"[[Microsoft Windows|Windows]]\", \"[[Unix-like]]\", etc.",
 +
"type": "string"
 +
},
 +
"footnotes": {
 +
"label": "Footnotes",
 +
"description": "Footnotes (if article lacks corresponding section)",
 +
"type": "string"
 +
}
 +
}
 +
}
 +
</templatedata>
 +
;Note:At [[User talk:Riley Huntley/AlexaBot.js]] you can request that a bot will monthly update the rank in {{para|alexa}} field.
  
 
==Microformat==
 
==Microformat==

Revision as of 18:43, 7 August 2014

This template should be used on articles describing a dotcom and its website (for example: YouTube, eBay, Facebook). If the two entities do not share the same name and/or have their own article, use {{Infobox company}} and {{Infobox website}} instead on the appropriate article (example: Google (company) and Google search (website), Yahoo! (company) and Yahoo! Search (website)).

Usage

{{Infobox dot-com company
|name                 = 
|logo                 = 
|logo size            = <!-- width in pixels, with "px" suffix -->
|logo alt             = 
|collapsible          = <!-- "yes" or "no" -->
|screenshot           = 
|screenshot size      = <!-- width in pixels, with "px" suffix -->
|screenshot alt       = 
|caption              = 
|type                 = 
|traded as            = 
|founded              = <!-- {{start date and age|year|month|day}} -->
|dissolved            = <!-- {{start date and age|year|month|day}} -->
|predecessor          = 
|successor            = 
|location             = 
|country              = 
|country of origin    = 
|locations            = 
|area served          = 
|founder              = 
|chairman             = 
|chairperson          = 
|president            = 
|CEO                  = 
|MD                   = 
|GM                   = 
|key people           = 
|industry             = 
|products             = 
|services             = 
|revenue              = 
|operating income     = 
|international        = <!-- "yes" or "no" -->
|net income           = 
|assets               = 
|equity               = 
|owner                = 
|employees            = 
|parent               = 
|divisions            = 
|subsidiaries         = 
|slogan               = 
|url                  = 
|programming language = 
|ipv6                 = 
|alexa                = 
|website type         = 
|advertising          = 
|registration         = 
|users                = 
|language             = 
|launched             = <!-- {{start date and age|year|month|day}} -->
|current status       = 
|native clients       = 
|footnotes            = 
}}

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox dot-com company

This template can be used to provide a summary for articles describing a dotcom and its website (for example: YouTube, eBay, Facebook). If the two entities do not share the same name and/or have their own article, use {{Infobox company}} and {{Infobox website}} instead.

Template parameters

ParameterDescriptionTypeStatus
Namename company name company_name

The name of the company and service.

Default
page title
Stringrequired
Logologo company logo company_logo

Filename of logo of the company and service.

Fileoptional
Logo sizelogo size logo_size

Size of logo in pixels. The value should be valid CSS width value ending with "px" suffix.

Stringoptional
Alternative text for logologo alt logo_alt

Textual description of logo that would be displayed in tooltip when pointer hovers over logo. This text (instead of logo file name) would be used by screen readers and text browsers. This parameter is required if logo is provided.

Stringoptional
Collapsible screenshot?collapsible

If set to "yes", screenshot will start out collapsed.

Default
no
Stringoptional
Screenshotscreenshot

File name of screenshot image. Images not showing web browser user interface are strongly prefered.

Fileoptional
Screenshot sizescreenshot size screenshot_size

Size of screenshot in pixels. The value should be valid CSS width value ending with "px" suffix.

Stringoptional
Alternative text for screenshotscreenshot alt screenshot_alt

Textual description of screenshot. Will be displayed in tooltip when pointer hovers over screenshot. This text (instead of screenshot file name) would be used by screen readers and text browsers. This parameter is required if screenshot is provided.

Stringoptional
Caption for the screenshotcaption

Short explanatory text about the page on screenshot.

Stringoptional
Type of business entitytype company type company_type

Type of business entity operating under this name. Examples include "[[Limited liability company]]" or "[[Joint stock company]]"

Stringoptional
Traded astraded as traded_as

Company's ticker symbol

Stringoptional
Date of foundationfounded foundation

Date of foundation of the company. Use {{start date and age|year|month|day}} template.

Dateoptional
Date of dissolutiondissolved

Date of dissolution of the company. Use {{start date and age|year|month|day}} template.

Dateoptional
Predecessorpredecessor

Predeceding company or service if unambiguous legal connection exists.

Stringoptional
Successorsuccessor

Siccessing company or service if unambiguous legal connection exists.

Stringoptional
Locationlocation location city location_city

City or place where company's headquoters are located.

Stringoptional
Countrycountry location country location_country

Country where company's headquoters are located.

Pageoptional
Country of origincountry of origin country_of_origin

Country where company was originally situated (if different from current country).

Pageoptional
Number of locationslocations

Number of offices the company has.

Numberoptional
Area servedarea served area_served

Area where the service is available in its entirety.

Stringoptional
Founderfounder

Founder(s) of company.

Stringoptional
Chairmanchairman

Chairman of the company.

Stringoptional
Chairpersonchairperson

Chairperson of the company.

Stringoptional
Presidentpresident

President of the company.

Stringoptional
CEOCEO

CEO of the company.

Stringoptional
Managing directorMD

Managing director of the company.

Stringoptional
General managerGM

General manager of the company.

Stringoptional
Key peoplekey people key_people

Key people of the company. Consider using "president", "CEO", "MD" and "GM" fields instead.

Stringoptional
Industryindustry

Industry of the service.

Stringoptional
Productsproducts

Products of the company. Don't list company services here.

Stringoptional
Servicesservices

Services of the company. Don't list the service that is subject of the article – it's name is already stated in "name" parameter.

Stringoptional
Revenuerevenue

Last known annual revenue of the company. For dissolved companies: most significant known revenue. Both figures and year must be stated; reference supporting the figures is required.

Stringoptional
Operating incomeoperating income operating_income

Earnings before interest payment and taxes examption. Both figures and year must be stated; reference supporting the figures is required.

Stringoptional
International?international intl

If set to "yes", will display label "Profit" instead of "Net income".

Stringoptional
Net incomenet income net_income

Net income of the company. Both figures andyear must be stated; reference supporting the figures is required.

Stringoptional
Assetsassets

Total value of company's assets. Both figure and year must be stated; reference supporting the figures is required.

Stringoptional
Equityequity

Total equity of company. Both figure and year must be stated; reference supporting the figures is required.

Stringoptional
Ownerowner

Owner(s) of company.

Stringoptional
Employeesemployees num employees num_employees

Total number of employees.

Numberoptional
parentparent

Holding company.

Stringoptional
Divisionsdivisions

Significant business divisions of the company.

Stringoptional
Subsidiariessubsidiaries subsid

Subsidiary companies.

Stringoptional
Sloganslogan company slogan company_slogan

Slogan of the company and service.

Stringoptional
Websiteurl website homepage

Website of the service. Use {{URL|link}} template.

Stringrequired
Programming languageprogramming language programming_language

List of programming languages the service is implemented in.

Stringoptional
IPv6ipv6

Status of IPv6 support in the service.

Stringoptional
Alexa rankalexa

This field consists of three parts: (1) either of {{IncreaseNegative}}, {{DecreasePositive}} or {{Steady}} templates, (2) absolute value of rating and (3) date the rating was retrieved in parentheses.

Stringoptional
Type of websitewebsite type website_type

Type (genre) of service.

Stringoptional
Advertisingadvertising

Does the service use advertising?

Stringoptional
Registrationregistration

Does the site require registration?

Stringoptional
Number of usersusers num users num_users

Total number of service users. Both figure and year must be stated; reference supporting the figures is required.

Stringoptional
Languagelanguage

Language(s) the service is available in. Don't use wikilinks in this field.

Stringoptional
Launchedlaunched launch date launch_date

Date the service became publicly available. Use {{start date and age|year|month|day}} template.

Dateoptional
Current statuscurrent status current_status

One of "Online", "Suspended", "Discontinued". Use "Unavailable" if service is offline but no official statement was issued.

Stringoptional
Native clientsnative clients native_clients

List of operating systems which are supported by native applications for the service. Examples may include "[[iOS]]", "[[Android (operating system)|]", "[[Microsoft Windows|Windows]]", "[[Unix-like]]", etc.

Stringoptional
Footnotesfootnotes

Footnotes (if article lacks corresponding section)

Stringoptional
Note
At User talk:Riley Huntley/AlexaBot.js you can request that a bot will monthly update the rank in |alexa= field.

Microformat

Template:UF-hcard-org

See also

Template:Organization infoboxes