Difference between revisions of "Template:JobDetailsHeader/Documentation"
Jump to navigation
Jump to search
Studenterhue (talk | contribs) (→Parameter Definitions: Add documentation for JobTitle and Img, note default behavior for Additional Roleplay Access Level) |
Studenterhue (talk | contribs) (→Parameter Definitions: Codify some more unwritten rules. Forgot to mention that I also added a note that the difficulty parameter should match the difficulty listed on the Jobs page in the previous summary) |
||
| Line 40: | Line 40: | ||
Any fields left intentionally blank should have "None" placed in them.<br> | Any fields left intentionally blank should have "None" placed in them.<br> | ||
*'''JobTitle''' is, well, the name of the job. Unlike the department title, this is done in title case, e.g. <code>Staff Assistant</code> rather than <code>STAFF ASSISTANT</code> or <code>staff assistant</code>. | *'''JobTitle''' is, well, the name of the job. Unlike the department title, this is done in title case, e.g. <code>Staff Assistant</code> rather than <code>STAFF ASSISTANT</code> or <code>staff assistant</code>. | ||
**There is space for alternate titles if the role has them, though it's often more elegant to mention them in the text following the template. | |||
*'''Img''' is an image of someone from the job this template is documenting. The template automatically adds image markup , so you simply need to provide file name and extension. For example, if you wanted to put an image of the AI in there, you simply put <code>AI64.png</code>, rather than <code><nowiki>[[File:AI64.png]]</nowiki></code>. If you put nothing, it defaults to [[:File:AssistantNew64.png]] (aka, the [[Staff Assistant]] image). | *'''Img''' is an image of someone from the job this template is documenting. The template automatically adds image markup , so you simply need to provide file name and extension. For example, if you wanted to put an image of the AI in there, you simply put <code>AI64.png</code>, rather than <code><nowiki>[[File:AI64.png]]</nowiki></code>. If you put nothing, it defaults to [[:File:AssistantNew64.png]] (aka, the [[Staff Assistant]] image). | ||
*'''Difficulty''' is, well, how difficult a role is for a player to perform in. Whatever it is, it should match what's listed on the [[Jobs]] page.<br> | *'''Difficulty''' is, well, how difficult a role is for a player to perform in. Whatever it is, it should match what's listed on the [[Jobs]] page.<br> | ||
| Line 47: | Line 48: | ||
*'''Supervisors''' are the roles above this one in the chain of command.<br> | *'''Supervisors''' are the roles above this one in the chain of command.<br> | ||
*'''Subordinates''' are the roles below this one in the chain of command.<br> | *'''Subordinates''' are the roles below this one in the chain of command.<br> | ||
*'''Responsibilities''' are the duties and responsibilities expected of the role during a round. | *'''Responsibilities''' are the duties and responsibilities expected of the role during a round. Unlike the [[Jobs]] page, these should be serious and free of humor/sarcasm. | ||
*'''Guides''' are where you can put any additional guides on the wiki for newer players to read through. If there aren't any, it should be made clear that the job article is the only available guide, as shown in the examples below. If you don't define this, it defaults to "This is the guide."<br> | *'''Guides''' are where you can put any additional guides on the wiki for newer players to read through. If there aren't any, it should be made clear that the job article is the only available guide, as shown in the examples below. If you don't define this, it defaults to "This is the guide."<br> | ||
Revision as of 08:13, 14 August 2023
Usage Guide
- The job title and department names should be all upper-case for consistency and appearance.
- Department colours should be standardised across all wiki articles. A provisional colour palette has been left below.
| Department/Role Colour Palette | ||||||||
|---|---|---|---|---|---|---|---|---|
| Dept. Name | Civilian Department | Medical Department | Research Department | Security Department | Antagonist | Engineering Department | Command Staff | Silicon |
| Whole Dept. | #3499FF | #7C7CCA | #B36CB3 | #C66A6A | #FFB051 | #FFFF70 | #42D342 | #888888 |
| Individual Role | #97C3F0 | #A5A5DA | #DDBBDD | #DEA3A3 | #FFD197 | #FFFFC8 | #98D998 | #BBBBBB |
Parameter Definitions
Any fields left intentionally blank should have "None" placed in them.
- JobTitle is, well, the name of the job. Unlike the department title, this is done in title case, e.g.
Staff Assistantrather thanSTAFF ASSISTANTorstaff assistant.- There is space for alternate titles if the role has them, though it's often more elegant to mention them in the text following the template.
- Img is an image of someone from the job this template is documenting. The template automatically adds image markup , so you simply need to provide file name and extension. For example, if you wanted to put an image of the AI in there, you simply put
AI64.png, rather than[[File:AI64.png]]. If you put nothing, it defaults to File:AssistantNew64.png (aka, the Staff Assistant image). - Difficulty is, well, how difficult a role is for a player to perform in. Whatever it is, it should match what's listed on the Jobs page.
- Requirements are any prerequisites that must be acquired before a role can be played. For example, the HoS requires a player to be whitelisted via forum application.
- Access Level denotes the places that a play with the role can go on round start. Brownie points if they're hyperlinks!
- Additional Roleplay Access Level denotes additional levels of access a role gets on the Roleplay servers. If there is no difference, this field can be left blank or omitted entirely; in both cases, they'll default to saying "None".
- Supervisors are the roles above this one in the chain of command.
- Subordinates are the roles below this one in the chain of command.
- Responsibilities are the duties and responsibilities expected of the role during a round. Unlike the Jobs page, these should be serious and free of humor/sarcasm.
- Guides are where you can put any additional guides on the wiki for newer players to read through. If there aren't any, it should be made clear that the job article is the only available guide, as shown in the examples below. If you don't define this, it defaults to "This is the guide."
Examples
Staff Assistant:
| CIVILIAN DEPARTMENT | |
|---|---|
| Staff Assistant | |
 Staff Assistant |
Difficulty: Easy Requirements: None Access Level: Tool Storage, Tech Storage, Maintenance Additional Roleplay Access Level: None Supervisors: Head of Personnel, Captain Subordinates: None Responsibilities: Assisting others when requested, not blowing up the station Guides: Getting Started, Game FAQ |
Captain:
| COMMAND STAFF | |
|---|---|
| Captain | |
 Captain |
Difficulty: All-Access Staff Assistant (Medium to Hard) Requirements: None Access Level: All-access, except for the Head of Security's office Additional Roleplay Access Level: None Supervisors: Central Command Subordinates: All on-station staff and Heads of Department Responsibilities: Make sure your departments are working productively, fill-in for command roles as needed, dying in an honourable duel for your sweet-ass sword Guides: This article |
AI:
| SILICON | |
|---|---|
| AI | |
| 64px AI |
Difficulty: Psychologically devastating Requirements: None Access Level: All-access Additional Roleplay Access Level: None Supervisors: Station crew and silicon laws Subordinates: Cyborgs, anyone listed as such per your laws Responsibilities: Open doors, do chores, and get really bored Guides: Artificial Intelligence, AI's Guide to the Chain of Command, AI Laws, Guide to AI, Humans and Nonhumans, Killing the AI |
Nuclear Operative:
| ANTAGONIST | |
|---|---|
| Nuclear Operative | |
 Nuclear Operative |
Difficulty: Hard Requirements: None Access Level: Maintenance, Listening Post, Syndicate Battlecruiser, anything you can bust apart with explosives or hack open Additional Roleplay Access Level: None Supervisors: Syndicate, Syndicate Commander Subordinates: Anyone you can coerce with your weapons and intimidating armour Responsibilities: Plant the nuclear device in an area where it will not be immediately disarmed, steal the authentication disk, get slipped by the clown and promptly beaten to death Guides: Being A Better Traitor, Guide to Being Robust, Murder |