RiceEmpress at 20:43, 4 December 2025

2025-12-04T20:43:14Z

← Older revision		Revision as of 16:43, 4 December 2025
Line 1:		Line 1:
			For full documentation, see [https://www.mediawiki.org/wiki/Extension:WikiSEO the extension page].

	The WikiSEO extension allows you to replace, append or prepend the HTML title tag content. It also allows you to add common SEO (Search Engine Optimisation) meta elements such as "keywords" and "description".		The WikiSEO extension allows you to replace, append or prepend the HTML title tag content. It also allows you to add common SEO (Search Engine Optimisation) meta elements such as "keywords" and "description".

RiceEmpress: Created page with "The WikiSEO extension allows you to replace, append or prepend the HTML title tag content. It also allows you to add common SEO (Search Engine Optimisation) meta elements such as "keywords" and "description". == Usage == The extension can be used via the `{{#seo}}` parser function or in Lua modules by using `mw.ext.seo.set()`. It accepts the following named parameters in any order. ===Paramete..."

2025-12-04T20:42:38Z

Created page with "The WikiSEO extension allows you to replace, append or prepend the HTML title tag content. It also allows you to add common SEO (Search Engine Optimisation) meta elements such as "keywords" and "description". == Usage ==   The extension can be used via the <code><nowiki>{{#seo}}</nowiki></code> parser function or in Lua modules by using <code>mw.ext.seo.set()</code>.  It accepts the following named parameters in any order. ===Paramete..."

New page

The WikiSEO extension allows you to replace, append or prepend the HTML title tag content. It also allows you to add common SEO (Search Engine Optimisation) meta elements such as "keywords" and "description".

== Usage == 

 The extension can be used via the <code><nowiki>{{#seo}}</nowiki></code> parser function or in Lua modules by using <code>mw.ext.seo.set()</code>.
 It accepts the following named parameters in any order.

===Parameters supported by all generators=== 

{| class="wikitable"
!  Name
!  Default
!  Description
!  Example
|-
| title || <code>(empty)</code>
|  The title you want to appear in the html title tag. Will also be used for OpenGraph, Schema.org and Twitter metadata.
| <pre><nowiki>{{#seo:|title=This is the title of the page}}</nowiki></pre>
|-
| title_mode || replace
|  Set to append, prepend, or replace (default) to define how the title will be amended. Further examples can be found [[Special:MyLanguage/Extension:WikiSEO#Title_Modes|here]].
| <pre><nowiki>{{#seo:|title=This replaces the Title of the Page|title_mode=replace}}</nowiki></pre>
|-
| title_separator || <code> - </code>
|  The separator in case <code>title_mode</code> was set to append or prepend.
| <pre><nowiki>{{#seo:|title=This gets prepended to the page name separated by the separator|title_mode=prepend|title_separator=<<}}</nowiki></pre>
|-
| keywords || <code>(empty)</code>
|  A comma separated list of keywords describing the page content. Will also be used for OpenGraph, Schema.org and Twitter metadata.
| <pre><nowiki>{{#seo:|keywords=Apple, Pears, Oranges}}</nowiki></pre>
|-
| description || <code>(empty)</code>
|  A short text describing the page topic. Will also be used for OpenGraph, Schema.org and Twitter metadata.
| <pre><nowiki>{{#seo:|description=This page contains information about...}}</nowiki></pre>
|}

== Examples == 

=== Adding static values === 

<pre>
{{#seo:
|title=Your page title
|title_mode=append
|keywords=these,are,your,keywords
|description=Your meta description
|image=Uploaded_file.png
|image_alt=Wiki Logo
}}
</pre>

=== Adding dynamic values === 

 If you need to include variables or templates you should use the parser function to ensure they are properly parsed.
 This allows you to use Cargo or Semantic MediaWiki, with Page Forms, for data entry, or for programmatic creation of a page title from existing variables or content...

<nowiki>{{#seo:
|title={{#if: {{{page_title|}}} | {{{page_title}}} | Welcome to WikiSEO}}
|title_mode={{{title_mode|}}}
|keywords={{{keywords|}}}
|description={{{description|}}}
|published_time={{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
}}</nowiki>

<nowiki>{{#seo:
|title_mode=append
|title=Example SEO Wiki
|keywords=WikiSEO, SEO, MediaWiki
|description=An example description for this wiki
|image=Wiki_Logo.png
|image_alt=Wiki Logo
|site_name=Example SEO Wiki
|locale=en_EN
|type=website
|modified_time={{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
|published_time=2020-11-01
}}</nowiki>

=== Hreflang Attributes === 

<pre>
{{#seo:
|hreflang_de-de=https://example.de/page
|hreflang_nl-nl=https://example.nl/page-nl
|hreflang_en-us=https://website.com/
}}
</pre>
 Will generate the following tag elements:
<code lang="html">
<link rel="alternate" href="https://example.de/page" hreflang="de-de">
<link rel="alternate" href="https://example.nl/page-nl" hreflang="nl-nl">
<link rel="alternate" href="https://website.com/" hreflang="en-us">
</code>

=== Title Modes === 


Example: Page with title <code>Example Page</code>

==== Append ====
<pre>
{{#seo:
|title_mode=append
|title=Appended Title
}}
</pre>

 HTML Title result:
<code>Example Page - Appended Title</code>

==== Prepend ====
<pre>
{{#seo:
|title_mode=prepend
|title=Prepended Title
}}
</pre>

 HTML Title result:
<code>Prepended Title - Example Page</code>

==== Prepend (changed separator) ==== 

<pre>
{{#seo:
|title_mode=prepend
|title=Prepended Title
|title_separator=<nowiki> >> </nowiki>
}}
</pre>

 HTML Title result:
<code>Prepended Title >> Example Page</code>

==== Replace (default) ==== 

<pre>
{{#seo:
|title_mode=replace
|title=Replaced Title
}}
</pre>

 HTML Title result:
<code>Replaced Title</code>

Module:SEO/doc - Revision history

RiceEmpress at 20:43, 4 December 2025