Template:Seo/doc: Difference between revisions

4,043 bytes added ,  5 years ago
no edit summary
(Created page with " ==Description== 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 l...")
 
No edit summary
Line 65:
* <code>twitter-site</code> - The username of the associated Twitter account. Defaults to [https://twitter.com/thesimswiki @thesimswiki].
* <code>twitter-domain</code> - The name of the website. Technically deprecated. Defaults to <code>The Sims Wiki</code>.
* <code>twitter-creator</code> - UnknownThe username of the creator of the content.
* <code>twitter-image-src</code> - Unknown, but defaults to https://static.miraheze.org/simswiki/c/cc/TSW_logo_with_white.png. Seems to also be deprecated.
* <code>twitter-description</code> - The meta description of the page. Defaults to whatever is specified in <code>description</code>, otherwise defaults to <code>The 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.</code>
 
<includeonly>[[Category:Experimental templates|{{PAGENAME}}]]</includeonly>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<templatedata>
{
"params": {
"title": {
"label": "Title",
"description": "Changes the <title></title> HTML attribute. Leave blank unless you know what you're doing.",
"type": "string"
},
"titlemode": {
"label": "Title Mode",
"description": "Choose between append, prepend, or replace (default). Leave blank unless you know what you're doing.",
"type": "string"
},
"keywords": {
"label": "Keywords",
"description": "Add search engine keywords here, separated by commas.",
"example": "the sims, sims, wiki",
"type": "string",
"suggested": true
},
"description": {
"label": "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.",
"example": "John Doe is a Sim who appears in all games in The Sims series. He lives with his wife Jane and his two children Janie and Johnny.",
"type": "string",
"suggested": true
},
"google-site-verification": {
"label": "Google Site Verification",
"description": "The Google Site Verification Tag from Google Webmaster Tools goes here. Don't use if you don't know what this is for.",
"type": "string"
},
"og-type": {
"label": "Open Graph Type",
"description": "Changes the Open Graph type of the object. Don't touch unless you know what you're doing.",
"type": "string"
},
"og-image": {
"label": "Open Graph Image",
"description": "The image to use for the Open Graph protocol. Use a direct link to the image.",
"example": "https://static.miraheze.org/simswiki/c/cc/TSW_logo_with_white.png",
"type": "string"
},
"og-site_name": {
"label": "Open Graph Site Name",
"description": "The name of the larger web site the object belongs to.",
"type": "string",
"default": "The Sims Wiki"
},
"og-locale": {
"label": "Open Graph Locale",
"description": "The locale of the object, in the format language_TERRITORY.",
"type": "string",
"default": "en_US"
},
"article-author": {
"label": "Open Graph Article Author",
"type": "string"
},
"article-publisher": {
"label": "Open Graph Article Publisher",
"type": "string"
},
"article-tag": {
"label": "Open Graph Article Tag",
"type": "string"
},
"article-section": {
"label": "Open Graph Article Section",
"type": "string"
},
"fb-admins": {
"label": "Facebook Admins",
"type": "string"
},
"fb-app_id": {
"label": "Facebook App ID",
"type": "string"
},
"twitter-card": {
"label": "Twitter Card",
"description": "Defaults to \"summary\". Best to leave this blank, unless you know what you're doing.",
"type": "string"
},
"twitter-site": {
"label": "Twitter Site",
"description": "The username of the associated Twitter account. Defaults to @thesimswiki.",
"type": "string"
},
"twitter-domain": {
"label": "Twitter Domain",
"description": "Deprecated. Points to the name of the website.",
"type": "string",
"deprecated": true
},
"twitter-creator": {
"label": "Twitter Creator",
"description": "The username of the creator of the content.",
"type": "string"
},
"twitter-image-src": {
"label": "Twitter Image Source",
"description": "Unknown.",
"type": "string"
},
"twitter-description": {
"label": "Twitter Description",
"description": "The meta description of the page. Keep it simple, clear, and concise.",
"type": "string"
}
},
"paramOrder": [
"keywords",
"description",
"og-type",
"og-image",
"og-site_name",
"og-locale",
"twitter-description",
"twitter-card",
"twitter-site",
"twitter-domain",
"twitter-creator",
"twitter-image-src",
"article-author",
"article-publisher",
"article-section",
"article-tag",
"fb-admins",
"fb-app_id",
"title",
"titlemode",
"google-site-verification"
]
}
</templatedata>