Template:Seo/doc
Description[edit source]
This template adds SEO metadata to the page it is added on. These metadata fields are read by search engines and other web crawlers, like the link embed feature on Discord. It uses the WikiSEO MediaWiki extension to work.
Pages using this template are added to Category:Pages using WikiSEO.
Usage[edit source]
{{Seo |keywords = |description = |image = |og-type = |og-image = |og-site_name = |og-locale = |article-author = |article-publisher = |article-tag = |article-section = |fb-admins = |fb-app_id = |twitter-card = |twitter-site = |twitter-domain = |twitter-creator = |twitter-image-src = |twitter-description = |title = |titlemode = |titleseparator = |google-site-verification = }}
Important parameters[edit source]
keywords
- Add search engine keywords here, separated by commas. Example:the sims, sims, wiki
description
- The meta description for the page. Keep it short, concise, and effective. In articles, including the first few lines of the lede often makes for a good description. Defaults toThe Sims Wiki is a website about The Sims that anyone can contribute to. Content includes The Sims, The Sims 2, The Sims 3, The Sims 4, and more.
if left blank.image
- The name of the main image of the page, usually the one that best describes the subject. Do not include the "File:" prefix (so for a file like File:Bella Goth.png, typeBella Goth.png
. If left blank, defaults to the wiki's logo.
Optional parameters[edit source]
Unless you know what you're doing, it's best to leave these parameters alone.
title
- Changes the<title></title>
HTML attribute. This will change the name of the tab, but not the name of the article. Leave blank in most cases.titlemode
- Choose betweenappend
,prepend
, orreplace
(default). Leave blank unless you know what you're doing.google-site-verification
- Only needed for Google Webmaster Tools. Don't use if you don't know what this is for.
Open Graph protocol[edit source]
og-type
- Changes the Open Graph type of the object. If left blank, defaults towebsite
.og-image
- The image to use for the Open Graph protocol. If blank, defaults to whatever is specified inimage
, else defaults to the wiki's logo.og-site_name
- The name of the larger web site the object belongs to. Defaults toThe Sims Wiki
.og-locale
- The locale of the object, in the formatlanguage_TERRITORY
. Defaults toen_US
.
Open Graph type "article"[edit source]
article-author
article-publisher
article-tag
article-section
Facebook Insights[edit source]
fb-admins
fb-app_id
Twitter Cards[edit source]
twitter-card
- Defaults tosummary
. Best to leave it blank.twitter-site
- The username of the associated Twitter account. Defaults to @thesimswiki.twitter-domain
- The name of the website. Technically deprecated. Defaults toThe Sims Wiki
.twitter-creator
- The username of the creator of the content.twitter-image-src
- The image to use for Twitter Cards and link embeds. If blank, defaults to whatever is specified inimage
, else defaults to the wiki's logo.twitter-description
- The meta description of the page. Defaults to whatever is specified indescription
, otherwise defaults toThe Sims Wiki is a website about The Sims that anyone can contribute to. Content includes The Sims, The Sims 2, The Sims 3, The Sims 4, and more.
TemplateData[edit source]
TemplateData for Seo
This template is used to add metadata for use by search engines, such as search engine keywords and a short description. Using this template can help improve search engine rankings and help others find the page.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Keywords | keywords | Add search engine keywords here, separated by commas.
| String | suggested |
Description | description | The meta description for the page. Keep it short, concise, and effective. In articles, including the first few lines of the intro often makes for a good description.
| String | suggested |
Image | image | The name of the main image of the page, usually the one that best describes the subject. Do not include the "File:" prefix. If left blank, defaults to the wiki's logo.
| String | suggested |
Open Graph Type | og-type | Changes the Open Graph type of the object. Don't touch unless you know what you're doing. | String | optional |
Open Graph Image | og-image | The image to use for the Open Graph protocol. Leave blank to use whatever you specified in the "Image" parameter. | String | optional |
Open Graph Site Name | og-site_name | The name of the larger web site the object belongs to.
| String | optional |
Open Graph Locale | og-locale | The locale of the object, in the format language_TERRITORY.
| String | optional |
Twitter Description | twitter-description | The meta description of the page. Keep it simple, clear, and concise. | String | optional |
Twitter Card | twitter-card | Defaults to "summary". Best to leave this blank, unless you know what you're doing. | String | optional |
Twitter Site | twitter-site | The username of the associated Twitter account. Defaults to @thesimswiki. | String | optional |
Twitter Domain | twitter-domain | Deprecated. Points to the name of the website. | String | deprecated |
Twitter Creator | twitter-creator | The username of the creator of the content. | String | optional |
Twitter Image Source | twitter-image-src | The image used for Twitter Cards and link embeds. Leave blank to use whatever you specified in the "Image" parameter. | String | optional |
Open Graph Article Author | article-author | no description | String | optional |
Open Graph Article Publisher | article-publisher | no description | String | optional |
Open Graph Article Section | article-section | no description | String | optional |
Open Graph Article Tag | article-tag | no description | String | optional |
Facebook Admins | fb-admins | no description | String | optional |
Facebook App ID | fb-app_id | no description | String | optional |
Title | title | Changes the <title></title> HTML attribute. Leave blank unless you know what you're doing. | String | optional |
Title Mode | titlemode | Choose between append, prepend, or replace (default). Leave blank unless you know what you're doing. | String | optional |
Google Site Verification | google-site-verification | The Google Site Verification Tag from Google Webmaster Tools goes here. Don't use if you don't know what this is for. | String | optional |