Template:Infobox subreddit/doc

From Irony Wiki
Revision as of 10:14, 18 December 2023 by Saucy (talk | contribs) (→‎TemplateData: Correct semantics)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This infobox is for use on articles about subreddits.

Configuration

Here is a blank instance of this template with all of the most common parameters:

{{Infobox subreddit
| name        = <!-- If this field is not provided, the page name will be used. -->
| image       = <!-- Just enter the file name. Do not include "File:" or any brackets. For example: Sillytime space.svg -->
| image_size  = <!-- Override the size of the image, in pixels -->
| caption     = 
| status      = <!-- Usually one of the following: active, inactive, quarantined, banned, closed, archived -->
| subscribers = 
| owner       =
| founded     = 
| defunct     = 
| founder     =
| discord     = <!-- A link to the page about the Discord server associated with this subreddit, if any -->
| link        =
}}

Example

Here is an example. The configured parameters are also listed.

r/okbuddyretard
The okbuddyretard logo (though not the actual icon for the subreddit)
Status Active
Subscribers1.1 million+
OwnerGrantVsZombies
FoundedDecember 10, 2017
FounderKirbizia
DiscordOkBuddyRetard
Linkhttps://www.reddit.com/r/okbuddyretard/
{{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/
}}

"status" parameter

The |status = parameter has a special output that provides special formatting when given certain inputs.

Status Explanation Appearance
active The subreddit is alive and well. Active
inactive The subreddit is accessible, but sees very little activity. Inactive
quarantined 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. Quarantined
banned The subreddit has been banned by Reddit and can no longer be accessed. Banned
closed The subreddit has made itself private and is no longer accessible to the public. Closed
archived The subreddit is read-only. No new posts can be made, but you can still view existing ones. Archived
(anything else) text

TemplateData

Infobox for use on articles about subreddits. None of the parameters are required.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

The r/ name of the subreddit. Defaults to the page name.

Default
{{PAGENAME}}
Stringsuggested
imageimage

An image to represent this subreddit, such as its icon

Filesuggested
landscapelandscape

no description

Unknownoptional
image sizeimage size imagesize

Override the size of the image, in pixels

Numberoptional
image_uprightimage_upright

no description

Unknownoptional
altalt

Alt text of the image, for use by screenreaders or if the image cannot be loaded.

Stringoptional
captioncaption image caption

A caption for the image

Stringoptional
statusstatus

The status of the subreddit. Additional info can be found on the template documentation page.

Suggested values
active inactive quarantined banned closed archived
Stringsuggested
subscriberssubscribers

The number of subscribers the subreddit has.

Example
50,000+
Numbersuggested
ownerowner

The current owner of the subreddit.

Example
[[GrantVsZombies]]
Stringsuggested
foundedfounded

The date that the subreddit was created.

Example
December 10, 2017
Datesuggested
defunctdefunct

The date the subreddit was banned, shut down, etc. if applicable.

Dateoptional
founderfounder

The person who originally created the subreddit.

Example
[[Kirbizia]]
Stringsuggested
discorddiscord

A link to the page about the Discord server associated with this subreddit, if any.

Example
[[Whenthe]]
Contentsuggested
linklink

The URL to this subreddit.

Example
https://www.reddit.com/r/okbuddyretard/
URLsuggested
nocatnocat

Set this to "yes" to prevent the infobox from automatically adding the page to the Subreddits category.

Booleanoptional
nocargonocargo

Set this to "yes" to prevent the infobox from adding to the Cargo database.

Booleanoptional