Template:Infobox subreddit/doc: Difference between revisions
No edit summary |
m →TemplateData: Correct semantics |
||
(2 intermediate revisions by the same user not shown) | |||
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", | ||
" | "default": "{{PAGENAME}}", | ||
"suggested": true | "suggested": true | ||
}, | }, | ||
Line 193: | Line 193: | ||
</templatedata> | </templatedata> | ||
<includeonly> | <includeonly> | ||
[[Category:Infobox templates]] | [[Category:Infobox templates|subreddit]] | ||
[[Category:Templates that store Cargo data]] | |||
</includeonly> | </includeonly> |
Latest revision as of 10:14, 18 December 2023
This infobox is for use on articles about subreddits.
Configuration[edit source]
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[edit source]
Here is an example. The configured parameters are also listed.
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/ |
{{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[edit source]
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[edit source]
Infobox for use on articles about subreddits. None of the parameters are required.
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name | The r/ name of the subreddit. Defaults to the page name.
| String | suggested |
image | image | An image to represent this subreddit, such as its icon | File | suggested |
landscape | landscape | no description | Unknown | optional |
image size | image size imagesize | Override the size of the image, in pixels | Number | optional |
image_upright | image_upright | no description | Unknown | optional |
alt | alt | Alt text of the image, for use by screenreaders or if the image cannot be loaded. | String | optional |
caption | caption image caption | A caption for the image | String | optional |
status | status | The status of the subreddit. Additional info can be found on the template documentation page.
| String | suggested |
subscribers | subscribers | The number of subscribers the subreddit has.
| Number | suggested |
owner | owner | The current owner of the subreddit.
| String | suggested |
founded | founded | The date that the subreddit was created.
| Date | suggested |
defunct | defunct | The date the subreddit was banned, shut down, etc. if applicable. | Date | optional |
founder | founder | The person who originally created the subreddit.
| String | suggested |
discord | discord | A link to the page about the Discord server associated with this subreddit, if any.
| Content | suggested |
link | link | The URL to this subreddit.
| URL | suggested |
nocat | nocat | Set this to "yes" to prevent the infobox from automatically adding the page to the Subreddits category. | Boolean | optional |
nocargo | nocargo | Set this to "yes" to prevent the infobox from adding to the Cargo database. | Boolean | optional |