Saucy: /* TemplateData */ Correct semantics

2023-12-18T10:14:44Z

TemplateData: Correct semantics

← Older revision		Revision as of 10:14, 18 December 2023
Line 98:		Line 98:
	"description": "The r/ name of the subreddit. Defaults to the page name.",		"description": "The r/ name of the subreddit. Defaults to the page name.",
	"type": "string",		"type": "string",
	"~~autovalue~~": "{{PAGENAME}}",		"default": "{{PAGENAME}}",
	"suggested": true		"suggested": true
	},		},

Saucy at 07:48, 18 August 2023

2023-08-18T07:48:23Z

← Older revision		Revision as of 07:48, 18 August 2023
Line 194:		Line 194:
	<includeonly>		<includeonly>
	[[Category:Infobox templates\|subreddit]]		[[Category:Infobox templates\|subreddit]]
			[[Category:Templates that store Cargo data]]
	</includeonly>		</includeonly>

Saucy at 07:47, 18 August 2023

2023-08-18T07:47:35Z

← Older revision		Revision as of 07:47, 18 August 2023
Line 193:		Line 193:
	</templatedata>		</templatedata>
	<includeonly>		<includeonly>
	[[Category:Infobox templates]]		[[Category:Infobox templates\|subreddit]]
	</includeonly>		</includeonly>

Saucy at 07:43, 18 August 2023

2023-08-18T07:43:20Z

← Older revision		Revision as of 07:43, 18 August 2023
Line 192:		Line 192:
	}		}
	</templatedata>		</templatedata>
			<includeonly>
			[[Category:Infobox templates]]
			</includeonly>

Saucy: doc

2023-08-18T07:42:32Z

doc

New page

This infobox is for use on articles about [[:Category:Subreddits|subreddits]].

== Configuration ==
Here is a blank instance of this template with all of the most common parameters:
<pre><nowiki>
{{Infobox subreddit
| name = 
| image = 
| image_size = 
| caption =
| status = 
| subscribers =
| owner =
| founded =
| defunct =
| founder =
| discord = 
| link =
}}
</nowiki></pre>

== Example ==
Here is an example. The configured parameters are also listed.
{{Infobox subreddit
| name = r/okbuddyretard
| image = Okbr.png
| image_size = 120
| caption = The okbuddyretard logo (though not the actual icon for the subreddit)
| status = active
| subscribers = 1.1 million+
| owner = [[GrantVsZombies]]
| founded = December 10, 2017
| founder = [[Kirbizia]]
| discord = [[OkBuddyRetard]]
| link = https://www.reddit.com/r/okbuddyretard/
| nocat = yes
| nocargo = yes
}}
<pre><nowiki>
{{Infobox subreddit
| name = r/okbuddyretard
| image = Okbr.png
| image_size = 120
| caption = The okbuddyretard logo (though not the actual icon for the subreddit)
| status = active
| subscribers = 1.1 million+
| owner = [[GrantVsZombies]]
| founded = December 10, 2017
| founder = [[Kirbizia]]
| discord = [[OkBuddyRetard]]
| link = https://www.reddit.com/r/okbuddyretard/
}}
</nowiki></pre>

== "status" parameter ==
The <code>|status =</code> parameter has a special output that provides special formatting when given certain inputs.

{| class="wikitable"
|+
!Status
!Explanation
!Appearance
|-
|<code>active</code>
|The subreddit is alive and well.
|{{colored dot|#00dd00|Active}}
|-
|<code>inactive</code>
|The subreddit is accessible, but sees very little activity.
|{{colored dot|#ffc000|Inactive}}
|-
|<code>quarantined</code>
|The subreddit has been quarantined by Reddit. The subreddit is not included in recommendations or search results, and you are prompted with a warning when visiting it.
|{{colored dot|#ffc000|Quarantined}}
|-
|<code>banned</code>
|The subreddit has been banned by Reddit and can no longer be accessed.
|{{colored dot|#dc0000|Banned}}
|-
|<code>closed</code>
|The subreddit has made itself private and is no longer accessible to the public.
|{{colored dot|#dc0000|Closed}}
|-
|<code>archived</code>
|The subreddit is read-only. No new posts can be made, but you can still view existing ones.
|{{colored dot|#b9bbbe|Archived}}
|-
|(anything else)
|
|text
|}

== TemplateData ==
<templatedata>
{
"params": {
"name": {
"description": "The r/ name of the subreddit. Defaults to the page name.",
"type": "string",
"autovalue": "{{PAGENAME}}",
"suggested": true
},
"image": {
"description": "An image to represent this subreddit, such as its icon",
"type": "wiki-file-name",
"suggested": true
},
"landscape": {},
"image size": {
"aliases": [
"imagesize"
],
"description": "Override the size of the image, in pixels",
"type": "number"
},
"image_upright": {},
"alt": {
"description": "Alt text of the image, for use by screenreaders or if the image cannot be loaded.",
"type": "string"
},
"caption": {
"aliases": [
"image caption"
],
"description": "A caption for the image",
"type": "string"
},
"status": {
"description": "The status of the subreddit. Additional info can be found on the template documentation page.",
"type": "string",
"suggestedvalues": [
"active",
"inactive",
"quarantined",
"banned",
"closed",
"archived"
],
"suggested": true
},
"subscribers": {
"description": "The number of subscribers the subreddit has.",
"example": "50,000+",
"type": "number",
"suggested": true
},
"owner": {
"description": "The current owner of the subreddit.",
"example": "[[GrantVsZombies]]",
"type": "string",
"suggested": true
},
"founded": {
"description": "The date that the subreddit was created.",
"example": "December 10, 2017",
"type": "date",
"suggested": true
},
"defunct": {
"description": "The date the subreddit was banned, shut down, etc. if applicable.",
"type": "date"
},
"founder": {
"description": "The person who originally created the subreddit.",
"example": "[[Kirbizia]]",
"type": "string",
"suggested": true
},
"discord": {
"description": "A link to the page about the Discord server associated with this subreddit, if any.",
"example": "[[Whenthe]]",
"type": "content",
"suggested": true
},
"link": {
"description": "The URL to this subreddit.",
"example": "https://www.reddit.com/r/okbuddyretard/",
"type": "url",
"suggested": true
},
"nocat": {
"description": "Set this to \"yes\" to prevent the infobox from automatically adding the page to the Subreddits category.",
"type": "boolean"
},
"nocargo": {
"description": "Set this to \"yes\" to prevent the infobox from adding to the Cargo database.",
"type": "boolean"
}
},
"description": "Infobox for use on articles about subreddits. None of the parameters are required.",
"format": "block"
}
</templatedata>

Template:Infobox subreddit/doc - Revision history

Saucy: /* TemplateData */ Correct semantics

Saucy at 07:48, 18 August 2023

Saucy at 07:47, 18 August 2023

Saucy at 07:43, 18 August 2023

Saucy: doc