Template:WikiSEO helper/doc

From SlyMods
Jump to navigation Jump to search

Use this template to easily add SEO tags to a page on the wiki.

Usage

{{WikiSEO helper
| title= Example
| description= A short description of the article for search results and embed cards.
| image= File:Name_of_image.png
| keywords= comma, separated, keywords
}}

It will not render anything on the page, but it will invoke the {{#seo}} function to insert the meta tags into the page HTML.

Title

If no title is provided, it will use the {{FULLPAGENAME}} as the default.

Description

If no description is provided, it will use a default description such as "A template page on SlyMods.."

Image

If no image is provided, it will use the site logo as the default.

Keywords

Some keywords are automatically added to every page, and any keywords you provide are inserted after those.

Template data

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

TemplateData for WikiSEO helper

A helper template for adding SEO tags to articles.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
titletitle

The title that the article should display (i.e. on the browser tab and in search results)

Stringsuggested
descriptiondescription

The description to be shown in search results and embeds.

Stringsuggested
imageimage

The name of an image file for embed cards (include the File: prefix)

Example
File:SlyMods logo.png
Fileoptional
keywordskeywords

Keywords to help with search ranking (separate with commas)

Example
lorem, ipsum, dolor, sit amet
Stringoptional