Difference between revisions of "Template:Facebook/doc"

From blackwiki
Jump to navigation Jump to search
imported>Zyxw
(update link)
imported>Zyxw
(note module used, add intro text and usage section, update examples and TemplateData)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
 +
{{Warning|The [[Wikipedia:External links|external links guideline]] recommends [[WP:ELNO|avoiding links to Facebook]] unless the profile is an [[WP:ELOFFICIAL|official account]], "controlled by the subject (organization or individual person) of the Wikipedia article" '''and''' when the links to Facebook "provide the reader with unique content and are not prominently linked from other official websites".  Wikipedia is not a directory for helping Facebook users find pages on Facebook.}}
 
{{Uses Wikidata|P2013}}
 
{{Uses Wikidata|P2013}}
{{warning|The [[Wikipedia:External links|external links guideline]] recommends [[WP:ELNO|avoiding links to Facebook]] unless the profile is an [[WP:ELOFFICIAL|official account]], "controlled by the subject (organization or individual person) of the Wikipedia article" '''and''' when the links to Facebook "provide the reader with unique content and are not prominently linked from other official websites".  Wikipedia is not a directory for helping Facebook users find pages on Facebook.}}
+
{{Lua|Module:EditAtWikidata}}
 +
{{See also|Wikipedia:External links/Perennial websites}}
 +
 
 +
'''{{NAMESPACE}}:{{BASEPAGENAME}}''' displays an external link to a page at [[Facebook]], a [[social networking]] website. It is intended for use in the [[Wikipedia:External links|external links]] section of an article.
 +
__TOC__
 +
{{clear}}
  
 
==Usage==
 
==Usage==
{{See also|Wikipedia:External links/Perennial websites}}
+
; Unnamed parameters
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''username or number'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''username or number'' | ''Displayed Name'' }}</code>
 +
 
 +
; Named parameters
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''username or number'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''username or number'' | name= ''Displayed Name'' }}</code>
 +
 
 +
; Using [[Wikidata]] property {{WPL|id=o|P2013}}
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''Displayed Name'' }}</code>
 +
 
 +
== Examples ==
  
== Linking to a profile or Page ==
+
=== Linking to a profile or page ===
 
In this example, the Facebook user account is ''zuck'' and the description in the link is ''Mark Zuckerberg'':
 
In this example, the Facebook user account is ''zuck'' and the description in the link is ''Mark Zuckerberg'':
  
 
: <code><nowiki>{{Facebook|zuck|Mark Zuckerberg}}</nowiki></code>
 
: <code><nowiki>{{Facebook|zuck|Mark Zuckerberg}}</nowiki></code>
: {{Facebook|zuck|Mark Zuckerberg}}
+
: {{{{BASEPAGENAME}}|zuck|Mark Zuckerberg}}
  
 
In this example, there's an ID instead of user name:
 
In this example, there's an ID instead of user name:
  
: <code><nowiki>{{Facebook |id=4 |name=Mark Zuckerberg}}</nowiki></code>
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |id=4 |name=Mark Zuckerberg}}</code>
: {{Facebook|id=4|name=Mark Zuckerberg}}
+
: {{{{BASEPAGENAME}}|id=4|name=Mark Zuckerberg}}
  
 
On the article about an individual, the display name and the article title will usually be identical and can be omitted. For example, on the article page [[Facebook]], linking to their own Facebook profile could be done with:
 
On the article about an individual, the display name and the article title will usually be identical and can be omitted. For example, on the article page [[Facebook]], linking to their own Facebook profile could be done with:
  
: <code><nowiki>{{Facebook|facebook}}</nowiki></code>
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|facebook}}</code>
: {{Facebook|facebook}}
+
: {{{{BASEPAGENAME}}|facebook}}
 +
 
 +
=== Linking to a specific section ===
 +
Links to specific sections on a Facebook page used to include the '=' symbol in the URL but no longer need to. Because '=' is a special character in Wikipedia template syntax (which separates a parameter's name from its value), it cannot be used directly in the id. If you want the link to arrive at a specific section, use the newer URL syntax, for example to link directly to the Photos section of a profile, add <code>/photos</code> to the username:
 +
 
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|zuck/photos|name=Mark Zuckerberg}}</code>
 +
: {{{{BASEPAGENAME}}|zuck/photos|name=Mark Zuckerberg}}
  
Generally, [[Wikidata]] should contain article subjects' Facebook IDs in property [[d:Property:P2013|P2013]], allowing the ID parameter to be omitted:
+
=== Using Wikidata ===
 +
Generally, [[Wikidata]] should contain article subjects' Facebook IDs in property {{WPL|id=o|P2013}}, allowing the ID parameter to be omitted:
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |name=''NAME'' }}</code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |name=''NAME'' }}</code>
  
=== Linking to a specific section ===
+
If the Wikidata property is not defined, the output is:
Links to specific sections on a Facebook page used to include the '=' symbol in the URL but no longer need to. Because '=' is a special character in Wikipedia template syntax (which separates a parameter's name from its value), it cannot be used directly in the id. If you want the link to arrive at a specific section, use the newer URL syntax, for example to link directly to the Photos section of a profile, add <code>/photos</code> to the username:
+
: {{ {{BASEPAGENAME}} }}
 
 
: <code><nowiki>{{Facebook|zuck/photos|name=Mark Zuckerberg}}</nowiki></code>
 
: {{Facebook|zuck/photos|name=Mark Zuckerberg}}
 
  
 
== TemplateData ==
 
== TemplateData ==
Line 41: Line 63:
 
         "id": {
 
         "id": {
 
             "label": "Account ID",
 
             "label": "Account ID",
             "description": "ID of the Facebook account (part of the web page address, for www.facebook.com/example/ the account id is \"example\").",
+
            "aliases": ["1"],
 +
             "description": "ID of the Facebook account (part of the web page address, for www.facebook.com/example/ the account id is \"example\"). This parameter is optional if Wikidata property P2013 exists, but required if not.",
 
             "type": "string/line",
 
             "type": "string/line",
 
             "required": false,
 
             "required": false,
             "default": "Wikidata property P2013",
+
             "default": "Wikidata property P2013"
            "aliases": ["1"]
 
 
         },
 
         },
 
         "name": {
 
         "name": {
 
             "label": "Display name",
 
             "label": "Display name",
 +
            "aliases": ["2"],
 
             "description": "Display name for the Facebook account",
 
             "description": "Display name for the Facebook account",
 
             "type": "string/line",
 
             "type": "string/line",
 
             "required": false,
 
             "required": false,
             "default": "Name of the page",
+
             "default": "Name of the page"
            "aliases": ["2"]
 
 
         }
 
         }
 
     }
 
     }

Revision as of 16:24, 3 August 2017

Template:Uses Wikidata

Template:Facebook displays an external link to a page at Facebook, a social networking website. It is intended for use in the external links section of an article.

Usage

Unnamed parameters
{{Facebook | username or number }}
{{Facebook | username or number | Displayed Name }}
Named parameters
{{Facebook | id= username or number }}
{{Facebook | id= username or number | name= Displayed Name }}
Using Wikidata property Template:WPL
{{Facebook}}
{{Facebook | name= Displayed Name }}

Examples

Linking to a profile or page

In this example, the Facebook user account is zuck and the description in the link is Mark Zuckerberg:

{{Facebook|zuck|Mark Zuckerberg}}
Mark Zuckerberg on FacebookScript error: No such module "EditAtWikidata".

In this example, there's an ID instead of user name:

{{Facebook |id=4 |name=Mark Zuckerberg}}
Mark Zuckerberg on FacebookScript error: No such module "EditAtWikidata".

On the article about an individual, the display name and the article title will usually be identical and can be omitted. For example, on the article page Facebook, linking to their own Facebook profile could be done with:

{{Facebook|facebook}}
Template:PAGENAMEBASE on FacebookScript error: No such module "EditAtWikidata".

Linking to a specific section

Links to specific sections on a Facebook page used to include the '=' symbol in the URL but no longer need to. Because '=' is a special character in Wikipedia template syntax (which separates a parameter's name from its value), it cannot be used directly in the id. If you want the link to arrive at a specific section, use the newer URL syntax, for example to link directly to the Photos section of a profile, add /photos to the username:

{{Facebook|zuck/photos|name=Mark Zuckerberg}}
Mark Zuckerberg on FacebookScript error: No such module "EditAtWikidata".

Using Wikidata

Generally, Wikidata should contain article subjects' Facebook IDs in property Template:WPL, allowing the ID parameter to be omitted:

{{Facebook}}
{{Facebook |name=NAME }}

If the Wikidata property is not defined, the output is:

Template:PAGENAMEBASE on FacebookScript error: No such module "EditAtWikidata".

TemplateData

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 Facebook

Generate a link to a Facebook profile in a standard format.

Template parameters

ParameterDescriptionTypeStatus
Account IDid 1

ID of the Facebook account (part of the web page address, for www.facebook.com/example/ the account id is "example"). This parameter is optional if Wikidata property P2013 exists, but required if not.

Default
Wikidata property P2013
Lineoptional
Display namename 2

Display name for the Facebook account

Default
Name of the page
Lineoptional

Tracking category

See also