Gswiki:Style guide/Verb pages
Verb pages are articles displaying information about commands used inside GemStone IV to navigate and manipulate the world. These commands are colloquially called verbs. A verb form is available with instructions and easy input for parameters to create or edit a verb page. This page offers instruction on how to manually create or edit a page with the GSWiki editor.
Article Title
There are two ways to create a verb page. For instructions on manually creating a new wiki page, see the GSWiki Editing Guide. Alternatively, utilize the Verb form. The article title for the page should make use of the namespace Verb: followed by the name of the verb in all capital letters. There should be no space before or after the colon (ex. Verb:SNEEZE).
Page Setup
Verbinfo Template
The verbinfo template should be entered into the code editor first to ensure it appears in the top right corner of the article. This creates an informational sidebar for verb pages that details verb type (limited to Roleplaying, System, and Special case), as well as other information. By entering it in first, it eliminates weird spacing errors. Based on entries, the template will automatically categorize the verb and additionally assigns properties to values to assist with semantic query searches. The verb form allows editors an interface to enter parameters based on the template. If the form is used to edit a page that already exists with the verbinfo template, many of the parameters automatically populate.
- Copy/Paste Code
Below is the copy and paste code to be entered for the sidebar template.
{{Verbinfo
|verb = VERB <!--Name of the verb. This should always be capitalized. -->
|type = TYPE <!--Type of verb: Roleplaying, System, Special Case. Additional slots can be added with type2, type3 -->
|demeanor = YES <!-- Simply answer "Yes" or "No"-->
|wedding = WEDDING <!--Simply answer "Yes" or "No" -->
|citizen = CITIZEN <!--If there is a citizen version of the verb. Additional slots can be added with citizen2, citizen3 -->
|race = RACE <!--If there is a racial version of the verb. Additional slots can be added with race2, race3, race4 -->
|culture = CULTURE <!--If there is a cultural version of the verb. Additional slots can be added with culture2, culture3 -->
|profession = PROFESSION<!--If there is a profession version of the verb. Additional slots can be added with profession2 - profession10 -->
|system = SYSTEM <!--If this verb is specific to a system. Additional slots can be added with system2 - system5-->
|special = SPECIAL <!--If this verb is due to a special case and does not work otherwise. Additional slots can be added with special2, special3 -->
}}
Verbpage Template
PLEASE NOTE: The Verb:Form makes use of an additional template ({{Verbpage}}) due to how the form is coded. This template is fully optional and not required for use, however is does set up the areas for Introduction, Help (if applicable), Verb Info (if applicable), and Usage (if applicable). The verbpage template does not play nicely with section transclusion. If intending to transclude information, please follow instructions below to manually set up page.
- Copy/Paste Code
Below is the copy and paste code to be entered for the verbpage template.
{{Verbpage
|introduction = INTRODUCTION <!-- Introductory sentence or paragraph for the verb. This may include the definition of the verb, as well as notate what messaging may apply, such as racial or cultural styles. This is a required field.
|help = <!-- Verb's help menu. This may display by typing the verb by itself, or by typing (verb name) help. Please see Help for additional formatting instructions. -->
|verbinfo = VERB INFO <!-- Verb's info menu. This may display by typing the VERB INFO (verb), and is limited to roleplaying verbs. Please see Verb Info for additional formatting instructions.
|usage = YES <!-- Only enter YES, if no, leave blank. This populates the subheader for Usage section, nothing entered will display.-->
Introduction
An introductory sentence or paragraph should follow the template. This may include the definition of the verb, as well as notate what messaging may apply, which system it supports, or various other quick bits of information.
- Example from Verb:ARMOR
ARMOR is a system verb that is part of the Player System Manager for Armor Specializations. It is only available to Warriors, Rogues, and Paladins.
Help
The first subsection that should be setup, if available, is "Help." Most verbs will have a help menu which may be accessed by entering (VERB) by itself, with (VERB) HELP, or with HELP (VERB) (this is the least likely used of the three options due to the HELP verb). When creating the section, ==Subheader 2== should be utilized, ex. ==Help==. Prior to entering the help menu information, while not required, please consider noting how the menu is accessed, and format it as: <small>'''''Note''' (how the help menu is accessed)''</small>. The help menu itself should be surrounded by <pre{{log2}}></pre> to retain formatting and indicate it is pulled directly from the game window, ex. <pre{{log2}}>Help menu</pre>. Additionally, some roleplaying verbs will display additional styles dependent on race, culture, or other variables that would be specific to the character who is viewing the information. This information should be captured on the verb page, but placed below the standard help text, separated based on type using ===Subheader 3===, using the same <pre{{log2}}></pre> formatting. For roleplaying verbs that may have an abundance of help styles based on the additional parameters of race, culture, etc., please consider utilizing collapsed section as more detailed information can be found in the Verb Info section of the verb page.
Verb Info
The second subsection that should be setup, if available, is "Verb Info." This subsection is primarily used with roleplaying verbs and is populated with VERB INFO (VERB). This section of the verb page details a breakdown of the verb's variables and offers first person messaging. In some cases, it will also display additional second or third person messaging if there is a substantial difference in the returned text from the first person messaging.
When creating the section, ==Subheader 2== should be utilized, ex. ==Verb Info==, and the contents should be formatted using <pre{{log2}}>, similar to Help. While not required by the style guide, please consider utilizing the {{blue}} template and bold items that are "monsterbold" in game to ensure they stand out, ex. {{blue|People targets:}}. This small bit of formatting helps readers with understanding what is happening in the displayed text. Additionally, some roleplaying verbs will display additional styles dependent on race, culture, or other variables that would be specific to the character who is viewing the information. This should be included separately based on those variables with the same formatting.
Usage
The second subsection that should be setup, if available, is "Usage." When creating the section, ==Subheader 2== should be utilized, ex. ==Usage==. This subsection may be used for all verb types, and what is entered, along with formatting, is dependent on the verb type.
Roleplaying Verbs
Roleplaying verbs are verbs that are used to enhance the roleplaying environment, and may also be known as "emotes." They may have additional special messaging based on: demeanor, citizenship, race or culture, profession, and if two characters are married from a wedding package.
If the verb has variables that may be set, ie. separate messaging that may be set as the default instead of the standard messaging, it will be indicated in the help menu as (Verb) SET. This should be the first entry under Usage as a ===Subheader 3===, as well as use {{boldmono}} to indicate it is a command in game, ex. ==={{boldmono|SET}}===. There is no need to repeat the verb in the subheader as its use is already implied.
If a verb does not have "(Verb) SET" as an option, tables for messaging can be entered immediately following the Usage subheader. Otherwise, the tables will require a Messaging as a ===Subheader 3===, ex. ===Messaging===. The tables themselves should be broken up based on any variables that may apply, such as standard messaging, targeted, untargeted, racial styles, cultural styles, etc., under their own ====Subheader 4====, ex. ====Erithian====. The below code is a general use formatting for the table, but may have certain parameters altered based on the various messaging options.
Example:
{| {{verbtable|80}} |- {{verbtableheader|80}} ! scope="col" | Style ! scope="col" style="width: 45%" | First ! scope="col" style="width: 45%" | Third |- ! scope="row" role="rowheader"|Style | First Person View | Third Person View |}
Style First Third Style First Person View Third Person View
For an example of how a roleplaying verb should be set up, please see: Verb:BOW.
System Verbs
System verbs are verbs with specific tie ins to the various systems within GS. While not entirely mechanical in nature, many of them tie into game or character mechanics. Most will have a HELP menu with information. Verb pages should not house mechanics information, and should only focus on the verb itself. A separate article should be created for mechanics pertaining the verb, if necessary.
Unlike roleplaying verbs, most system verbs will not require a verb table to display messaging. However, each option should be set up under Usage with a breakdown of their use, and if warranted, an example. These should be done as ===Subheader 3===, as well as use {{boldmono}} to indicate it is a command in game, ex. ==={{boldmono|(VARIABLE)}}===. There is no need to repeat the verb in the subheader as its use is already implied.
For an example of how a system verb should be set up, please see: Verb:ARMOR.
Special Case Verbs
Special case verbs are verbs that are not directly tied to roleplaying or a system. In most cases, a special case verb is a verb that requires interaction with a target and will not work otherwise. They will not always have a full article, and should note in the verbinfo template what the particular case may be, if known. Unless otherwise noted, page setup will be similar to system verbs.
Additional Information
The Additional Information subsection, if applicable, offers additional information to supplement the verb article and should be entered as ==Subheader 2==, ex. ==Additional Information==. If there are external links, they should be listed under ==Resources==, and would include links to definitions. If there are internal links, they should be listed under ==See Also==, and may include links to other similar verbs articles that pertain to certain variables of the verb.
Form & Templates
Form for verb page creation or editing:
Primary templates used with verbs are: