Project:Data Dictionary/backup
The following sections contain information about Semantic Data usage grouped by primary Form. A second level heading (==) should label forms being used (Form:xxxx), and describe their purpose and associated templates. A fourth level heading (====) should label templates being used (Template:xxxx) by the form, and contain tables that map template fields to Semantic Properties (use class="propertytable" on the table, and class="na" for cells that contain "N/A"). Refer to the Form:Mod section as an example of what should be expected.
To propose new semantic properties, forms, and/or templates, create a second level heading (==) at the bottom of this page with a descriptive title, and list the proposed additions (names of proposed forms, templates, or properties aren't as important as clearly defining their intended purpose). Just remember the primary focus of this page is is in relation to Semantic use.
Be sure to also check out the Talk page for on-going discussions about all things related to the Data Dictionary.
Form:Mod
The Mod form allows the creation and editing of Mod pages. All Mod pages are added to Category:Mods, which uses Form:Mod. Form:Mod uses the following templates: Template:Mod, Template:External URL, Template:Gallery, Template:Gallery Items, Template:Recommendations, Template:Overwrites, and Template:Revision History. Template:Revision History declares Form:Mod Version, which uses Template:Mod Version.
Template:Mod
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
author | Author | String | The author. | Template:Yes |
fullName | FullName | String | Full Name of the Mod. | - |
quote | N/A | N/A | Quote about the Mod. | - |
quoteAuthor | N/A | N/A | Author of the quote. | - |
logo | N/A | N/A | URL to a logo. | - |
section | Section | String | Contains Allows value declarations. | - |
N/A | SectionLabel | String | This is not passed into the template, only referenced. | - |
sourceName | SourceName | String | List of supported sites that uses an ID. Other specifies the download location is a full URL. | - |
sourceID | SourceID | Number | The ID of the Mod from the download source. Associated with a valid SourceName. | - |
sourceURL | SourceURL | URL | The full URL to a Mod source. Associated with the choice of Other from SourceName. | - |
forumtid | ForumTID | Number | URL is formulated in the template from the ID. | - |
core | IsCore | Boolean | Indicates that the Mod is considered essential to the STEP experience. | - |
tpc | TPC | Boolean | Indicates that the Mod is part of the TPC process for cherry picking visual resources. | - |
baseline | Baseline | String | Short note to specify resource selection when multiple are available. | - |
fps | AffectsFPS | Boolean | Indicates that the Mod will noticeably affect FPS (in relation to the Baseline). | - |
vram | AffectsVRAM | Boolean | Indicates that the Mod will noticeably affect VRAM use (in relation to the Baseline). | - |
performance | PerformanceAvailable | Boolean | Indicates that a performance version is available (in relation to the Baseline). | - |
quality | QualityAvailable | Boolean | Indicates that a higher quality version is available (in relation to the Baseline). | - |
externalItems | N/A | N/A | Holds multiple-instance template Template:External URL. | - |
Template:External URL
This is a multiple-instance template contained in Mod[externalItems].
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
externalURL | ExternalURL | URL | URL to a site containing additional information (ex. http://www.facebook.com/<pageinfo>). | - |
externalLabel | ExternalLabel | String | Becomes the external link text (ex. Facebook). | - |
Template:Gallery
No Symantic Properties are used with this template.
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
enable | N/A | N/A | Allows disabling the Gallery without losing the data specified in the template call. | - |
title | N/A | N/A | Title that appears above the gallery (Optional). | - |
galleryItems | N/A | N/A | Holds multiple-instance template Template:Gallery Items. | - |
Template:Gallery Items
No Symantic Properties are used with this template. This is a multiple-instance template contained in Gallery[galleryItems].
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
url | N/A | N/A | URL to the screenshot image. | - |
caption | N/A | N/A | Caption description that appears below the thumbnail. | - |
Template:Recommendations
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
recommendations | Recommendations | Text | Contains STEP specific notes and recommendations. | - |
overwritesItems | N/A | N/A | Holds multiple-instance template Template:Overwrites | - |
Template:Overwrites
This is a multiple-instance template contained in Recommendations[overwritesItems].
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
modname | Overwrites | String | Contains the Mod name that it overwrites. | - |
Template:Revision History
This template contains a query to pull the latest Update page for inclusion into the Mod page. It also declares a forminput using Form:Mod Version.
Form:Mod Version
This form handles creation of a Mod sub page used to store Version/Update information. Uses Template:Mod Version.
Template:Mod Version
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
releaseDate | ReleaseDate | Date | The version release date. | - |
Form:STEP Version
This form allows for the creation of an overall Mod order list tied to a specific version of STEP. Associated resources are still in development, and names are subject to change. The form currently uses the following templates: Template:ModOrder, and Template:ModList.
Template:ModOrder
No semantic properties are currently used in this template.
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
mods | N/A | N/A | Contains a multiple-instance template Template:ModList. | - |
Template:ModList
This template creates each row of the Mod Order list, and uses an Internal Object to tie the information together. Current implementation uses the Variables extension to create OrderID's for each Mod that are regenerated after a page save. This is a multiple-instance template contained in ModOrder[mods].
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
N/A | ModOrder | Page | Property associated with an Internal Object. | - |
N/A | →OrderID | Number | Sub property to ModOrder containing a Mod's installation order. | - |
modname | →ModName | Page | Sub Property to ModOrder referencing a Mod to be ordered. | - |
N/A | →Version | String | Sub Property to ModOrder containing the STEP Version (Pulled from {{SUBPAGENAME}}). | - |
Form:ModTest
Template:SystemSpecs
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
CPUSpecs | CPUSpecs | String | (values: Multi core >= 3GHz, 2GHz <= Multi core < 3GHz, Single core OR Multi core < 2GHz) | Template:Yes |
GPUSpecs | GPUSpecs | String | (values: Nvidia 570-680 or AMD 5970+; VRAM >= 2GB, Nvidia 570-680 or AMD 5970+; 1GB < VRAM < 2GB, Other GPU; 1GB < VRAM < 1.5GB, VRAM < 1 GB) | Template:Yes |
MultiGPU | MultiGPU | Boolean | Indicates whether or not the test box uses a multi-GPU configuration. | Template:Yes |
SSD | HDDSpecs | Boolean | Indicates whether or not the test box utilizes an SSD for OS and Skyrim. | Template:Yes |
64bitOS | 64bitOS | Boolean | Indicates whether or not the test box is running Skyrim on a 64-but OS. | Template:Yes |
Template:PerformanceImpact
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
FPSImpact | FPSImpact | Numeric | Approximate FPS impact (integer). | Template:Yes |
VRAMImpact | VRAMImpact | Numeric | Approximate VRAMimpact (integer). | Template:Yes |
Template:ModTest
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
Documentation | Documentation | Boolean | Indicates whether or not the mod has adequate documentation. Documentation must state 1) mod's clear purpose/scope, 2) installation instructions and 3) uninstall instructions. | Template:No |
StartNewGame | StartNewGame | Boolean | Indicates whether or not the mod performs adequately through new game initialization (through 'tutorial' to avalanch/cave-in under Helgen). | Template:No |
LoadSaveGame | LoadSaveGame | Boolean | Indicates whether or not the standard save game can be successfully loaded (Top of stairs, Whiterun). | Template:No |
HasScripts | HasScripts | Boolean | Indicates whether or not the mod uses scripts. | Template:No |
IsClean | IsClean | Boolean | Applies only to mods containing ESP/Ms. Indicates whether or not the mod is clean. | Template:Yes |
CleanUninstall | CleanUninstall | Boolean | Applies mainly to scipting mods. Indicates whether or not the mod can be cleanly deactivated without leaving behind scripting artifacts. | Template:No |
IsLoreFriendly | IsLoreFriendly | Boolean | A necessarily subjective attribute indicating whether or not the mod is generally lore friendly (according to the STEP mandate). | Template:Yes |
BAINFriendly | BAINFriendly | Boolean | Indicates whether or not the mod package will be sufficiently recognized by Wrye Bash. | Template:Yes |
LooseFiles | LooseFiles | Boolean | Indicates whether or not mod assets are packaged into a BSA, thus, confering that resource conflicts with be handled as data conflicts. | Template:Yes |
DataConflicts | DataConflicts | Page | This specifies any net in-game conflicts as defined by ESP/M and BSA asset loading (i.e., see LooseFiles Property). | Template:Yes |
ResourceConflicts | ResourceConflicts | Page | This specifies any direct resource conflicts as indicated in Wrye Bash (i.e., see LooseFiles Property). | Template:Yes |
PapyrusErrors | PapyrusErrors | Boolean | This could also be of Type = Page. Indicates whether or not the Papyrus log shows errors (and any potential causes if this is treated as Text or Pate). | Template:Yes |
CTDs | CTDs | Boolean | This could also be of Type = Page. Indicates whether or not the mod causes CTDs (and any potential causes if this is treated as Text or Pate). | Template:Yes |
SavegameBloat | SaveGameBloat | Boolean | This could also be of Type = Page. Indicates whether or not the mod causes bloat (and any potential causes if this is treated as Text or Pate). | Template:No |
QualityImpact | QualityImpact | String | Indicates whether or not the mod impacts quality. (values: noticeable improvement, negligible improvement, negligible decline, noticeable decline). | Template:Yes |
HasDawnguard | HasDawnguard | Boolean | Indicates whether a user has the Dawnguard DLC installed for testing. | Template:No |
HasHearthfire | HasHearthfire | Boolean | Indicates whether a user has the Hearthfire DLC installed for testing. | Template:No |
HasDragonborn | HasDragonborn | Boolean | Indicates whether a user has the Dragonborn DLC installed for testing. | Template:No |
ModVersion | ModVersion | String | Indicates what version of the mod is being tested. | Template:No |
Misc Property
Template Field | Semantic Property | Semantic Type | Notes | Ready |
---|---|---|---|---|
SystemType | SystemType | String | (values: LO, BASELINE, HI) | Template:Yes |
Notes
- Performance will need to be assessed at each of the pre-defined standard saves