Template:Seo/doc

From K6ka's Wiki
Jump to navigation Jump to search

Description[edit]

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.

Usage[edit]

{{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]

  • keywords - Add search engine keywords here, separated by commas. Example: k6ka, blog, 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 to K6ka's Wiki is a wiki about k6ka, for all his essays, stories, thoughts, 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:John Doe.png, type John Doe.png. If left blank, defaults to the wiki's logo.

Optional parameters[edit]

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 between append, prepend, or replace (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]

  • og-type - Changes the Open Graph type of the object. If left blank, defaults to website.
  • og-image - The image to use for the Open Graph protocol. If blank, defaults to whatever is specified in image, else defaults to the wiki's logo.
  • og-site_name - The name of the larger web site the object belongs to. Defaults to K6ka's Wiki.
  • og-locale - The locale of the object, in the format language_TERRITORY. Defaults to en_US.

Open Graph type "article"[edit]

  • article-author
  • article-publisher
  • article-tag
  • article-section

Facebook Insights[edit]

  • fb-admins
  • fb-app_id

Twitter Cards[edit]

  • twitter-card - Defaults to summary. Best to leave it blank.
  • twitter-site - The username of the associated Twitter account.
  • twitter-domain - The name of the website. Technically deprecated. Defaults to K6ka's 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 in image, else defaults to the wiki's logo.
  • twitter-description - The meta description of the page. Defaults to whatever is specified in description, otherwise defaults to K6ka's Wiki is a wiki about k6ka, for all his essays, stories, thoughts, and more!

TemplateData[edit]

This is the TemplateData documentation for this template used by the VisualEditor and other tools.

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.

Template parameters

ParameterDescriptionTypeStatus
Keywordskeywords

Add search engine keywords here, separated by commas.

Example
the sims, sims, wiki
Stringsuggested
Descriptiondescription

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.

Example
John Doe is a businessman who lives at 11 Main Street. He lives with his wife Jane and his two children Janie and Johnny.
Stringsuggested
Imageimage

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.

Example
John Doe.png
Stringsuggested
Open Graph Typeog-type

Changes the Open Graph type of the object. Don't touch unless you know what you're doing.

Stringoptional
Open Graph Imageog-image

The image to use for the Open Graph protocol. Leave blank to use whatever you specified in the "Image" parameter.

Stringoptional
Open Graph Site Nameog-site_name

The name of the larger web site the object belongs to.

Default
The Sims Wiki
Stringoptional
Open Graph Localeog-locale

The locale of the object, in the format language_TERRITORY.

Default
en_US
Stringoptional
Twitter Descriptiontwitter-description

The meta description of the page. Keep it simple, clear, and concise.

Stringoptional
Twitter Cardtwitter-card

Defaults to "summary". Best to leave this blank, unless you know what you're doing.

Stringoptional
Twitter Sitetwitter-site

The username of the associated Twitter account.

Stringoptional
Twitter Domaintwitter-domain

Deprecated. Points to the name of the website.

Stringdeprecated
Twitter Creatortwitter-creator

The username of the creator of the content.

Stringoptional
Twitter Image Sourcetwitter-image-src

The image used for Twitter Cards and link embeds. Leave blank to use whatever you specified in the "Image" parameter.

Stringoptional
Open Graph Article Authorarticle-author

no description

Stringoptional
Open Graph Article Publisherarticle-publisher

no description

Stringoptional
Open Graph Article Sectionarticle-section

no description

Stringoptional
Open Graph Article Tagarticle-tag

no description

Stringoptional
Facebook Adminsfb-admins

no description

Stringoptional
Facebook App IDfb-app_id

no description

Stringoptional
Titletitle

Changes the <title></title> HTML attribute. Leave blank unless you know what you're doing.

Stringoptional
Title Modetitlemode

Choose between append, prepend, or replace (default). Leave blank unless you know what you're doing.

Stringoptional
Google Site Verificationgoogle-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.

Stringoptional