Project:Data Dictionary

From STEP Modding Wiki

The following sections contain information about Semantic Data usage grouped by primary From. This page is a consolidation of active forms and their associated templates currently in use within the Wiki.

Proposals and work-in-progress should be included in the Proposals page. When finalized, they can be added to the main Data Dictionary page as you see here.

Be sure to also check out the project Talk page for on-going discussions about all things related to the Data Dictionary.

Contents

Form:DataDictionary

Form Form:DataDictionaryP
Templates Template:DataDictionary | Template:DataDictionaryForm |

This form is the starting point that drives the entire DataDictionary page. It is used to add Form names in a list.

Template:DataDictionary

Template Template:DataDictionaryP

This template is the wrapper for the entire DataDictionary page, containing the introductory text, and a list of Forms.

Template Field Semantic Property Semantic Type Notes
intro N/A N/A Introduction text that displays at the top of the DataDictionary.
forms N/A N/A Holds multiple-instance template Template:DataDictionaryForm

Template:DataDictionaryForm

Template Template:DataDictionaryFormP

This template takes a form name and creates a formlink to edit the sub-page that contains template definitions associated with a form.

A Semantic query is also used to embed the contents of the template sub-pages within the form page.

Template Field Semantic Property Semantic Type Notes
name N/A N/A The name of the Form.


Form:DataDictionaryFormItems

Form Form:DataDictionaryFormItemsP
Templates Template:DataDictionaryFormItems | Template:DataDictionaryTemplate |

This form edits a Form sub-page to the DataDictionary for adding associated template names.

Template:DataDictionaryFormItems

Template Template:DataDictionaryFormItemsP
Template Field Semantic Property Semantic Type Notes
intro N/A N/A Introduction text
templates N/A N/A Holds multiple-instance template Template:DataDictionaryTemplate
page N/A N/A Hidden input that stores the page name of the associated form.
N/A DDPageName Page Stores the page name of the form sub-page.

Template:DataDictionaryTemplate

Template Template:DataDictionaryTemplateP
Template Field Semantic Property Semantic Type Notes
name N/A N/A Contains the name of the template.
formname N/A N/A Contains the name of the form a template is associated with.


Form:DataDictionaryTemplateItems

Form Form:DataDictionaryTemplateItemsP
Templates Template:DataDictionaryTable | Template:DataDictionaryTemplateItems |

Template:DataDictionaryTemplateItems

Template Template:DataDictionaryTemplateItemsP
Template Field Semantic Property Semantic Type Notes
intro N/A N/A Introductory text.
table N/A N/A Holds multiple-instance template Template:DataDictionaryTable
page N/A N/A Hidden input that stores the page name of the associated template.

Template:DataDictionaryTable

Template Template:DataDictionaryTableP
Template Field Semantic Property Semantic Type Notes
templateField N/A N/A Contains the template field name.
propertyName N/A N/A Contains the property name.
propertyType N/A N/A Contains the property type.
propertySub N/A N/A Boolean indicating if the property is a sub-property.
propertyNote N/A N/A Contains (these) notes.


Form:Mod

Form Form:ModP
Templates Template:ExternalURL | Template:Gallery | Template:GalleryItems | Template:Mod | Template:ModAttributes | Template:Recommendations |

This form allows for the creation and editing of Mod pages. All Mod pages are added to Category:Mods, which is declared to use Form:Mod.

Template:Mod

Template Template:ModP

Used to populate the Mod InfoBox.

Template Field Semantic Property Semantic Type Notes
author Author String The author.
fullname FullName String Full Name of the Mod.
sourcename SourceName String List of supported sites that uses an ID. Other specifies the download location is a full URL.
sourceurl SourceURL URL The full URL to a Mod source. Associated with the choice of Other from SourceName.
sourceid SourceID String The ID of the Mod from the download source. Associated with a valid SourceName.
section Section String Mod Section assignment. Contains "allows value" declarations.
N/A SectionLabel String This is not passed into the template, only referenced.
baseline Baseline String Short note to specify resource selection when multiple are available.
forumtid ForumTID String URL is formulated in the template from the ID.
externalitems N/A N/A Holds multiple-instance template Template:ExternalURL.

Template:ExternalURL

Template Template:ExternalURLP

This is a multiple-instance template contained in Mod[externalitems].

Template Field Semantic Property Semantic Type Notes
externallabel ExternalLabel String The link text (ex. Facebook).
externalurl ExternalURL URL URL to a site containing additional information (ex. http://www.facebook.com/page).

Template:ModAttributes

Template Template:ModAttributesP

Describes the mod-specific attributes obtained from examining the mod's contents as well as by reaching consensus based on mod tickets and performance reports.

Template Field Semantic Property Semantic Type Notes
resource HasResource String Indicates how a mod's resources files are packaged. (BSA, Loose, None).
dlcrequired DLCRequired String Indicates which DLC's are required by the mod.
dlcsupported DLCSupported String Indicates which DLC's are supported by the mod via an addon.
docdescription DocDescription Boolean Indicates that the mod includes a description of what the mod does.
docinstall DocInstall Boolean Indicates that the mod includes installation instructions.
docuninstall DocUninstall Boolean Indicates that the mod includes un-installation instructions.
script HasScript Boolean Indicates that the mod uses scripts.
bain CompatibleBAIN Boolean Indicates that the mod package has BAIN support.
fomod CompatibleFOMOD Boolean Indicates that the mod package has FOMOD support.
optimized IsOptimized Boolean Indicates that the mod's texture files are optimized.
skse HasSKSE Boolean Indicates that the mod depends on SKSE.
mcm HasMCM Boolean Indicates that the mod has MCM functionality and depends on SkyUI.
skyproc HasSkyProc Boolean Indicates that the mod contains a SkyProc patcher.
clean IsClean Boolean Indicates that the mod's EPS/M files are free of ITM/UDR errors.
lorefriendly LoreFriendly Boolean Indicates that the mod is considered lore friendly.
cleanuninstall CleanUninstall Boolean Indicates that mod can be deactivated without corrupting save games.
core IsCore Boolean Indicates if a mod is CORE to the STEP experience.
merged IsMerged Boolean Indicates if a mod is merged into any of the STEP Patches
lorefriendly LoreFriendly Boolean Indicates if a mod is considered lore friendly.
fps AffectsFPS Boolean Indicates if a mod has a noticeable FPS impact.
vram AffectsVRAM Boolean Indicates if a mod has a noticeable VRAM impact.
performance PerformanceAvailable Boolean Indicates if a mod has a performance version available.
quality QualityAvailable Boolean Indicates if a mod has a quality version available.

Template:Gallery

Template Template:GalleryP
Template Field Semantic Property Semantic Type Notes
enable N/A N/A Allows disabling of the Gallery.
title N/A N/A Title that appears above the gallery (Optional).
galleryitems N/A N/A Holds multiple-instance template Template:GalleryItems.

Template:GalleryItems

Template Template:GalleryItemsP

This is a multiple-instance template contained in Gallery[galleryitems].

Template Field Semantic Property Semantic Type Notes
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 Template:RecommendationsP

Used to associate STEP-specific recommendations. The "notes" section.

Template Field Semantic Property Semantic Type Notes
enabledetailed N/A N/A Allows enabling/disabling of detailed instructions without losing content.
detailed N/A N/A Detailed instructions that are too big to fit in the guide.
short N/A N/A Short note that can fit in the guide.
N/A Recommendations Text Contains either the short note, or a link to the Mod page if detailed instructions are available.


Form:STEP Version

Form Form:STEP VersionP
Templates Template:ModOrderSectionA | Template:ModOrderSectionAItems |

This form is used to propagate the current STEP modlist to the next version.

Only the first set of templates are defined, as multiple are used with the same code for each section within the STEP Guide (currently A-M). The separation is necessary to allow grouping by section within headertabs.

Template:ModOrderSectionA

Template Template:ModOrderSectionAP
Template Field Semantic Property Semantic Type Notes
modOrderItems N/A N/A Holds multiple instance template Template:ModOrderSectionAItems

Template:ModOrderSectionAItems

Template Template:ModOrderSectionAItemsP
Template Field Semantic Property Semantic Type Notes
name N/A N/A Name of the mod.


Form:SystemSpecs

Form Form:SystemSpecsP
Templates Template:SystemSpecs |

Template:SystemSpecs

Template Template:SystemSpecsP

Allows users to enter data for the basic system specs.

Template Field Semantic Property Semantic Type Notes
cpumake CPUMake String Intel or AMD
cpumodel CPUModel String Model of the CPU (i.e. "i5 2500K")
cpuspeed CPUSpeed Number Speed in GHz
cpucores CPUCores Number Number of available cores.
gpumake GPUMake String NVIDIA or AMD
gpumodel GPUModel String Model of the GPU
gpuvram GPUVRAM String List of values (<1024, 1024, 1536, 2048, etc.)
multigpu MultiGPU Number List for number of GPU's (1-4).
storage Storage String List of storage types (currently HDD & SSD)
osarch OSArch String List of OS architectures (32bit or 64bit)
resolution Resolution String Resolution that Skyrim is played at.
dlc DLCInstalled String Multi-select list of DLC's that the user has installed.


Form:ModTest

Form Form:ModTestP
Templates Template:PerformanceImpact |

Template:PerformanceImpact

Template Template:PerformanceImpactP

Used to submit performance impact data about a mod.

Template Field Semantic Property Semantic Type Notes
fpsimpact FPSImpact Number Approximate FPS impact (integer).
vramimpact VRAMImpact Number Approximate VRAMimpact (integer).


Form:ModTicket

Form Form:ModTicketP
Templates Template:ModTicket |

Template:ModTicket

Template Template:ModTicketP

Used to submit a ticket regarding a problem in a mod.

Template Field Semantic Property Semantic Type Notes
issue Issue String List of issues: Start New Game, Load Save Game, CTD, Papyrus Errors, Save Game Bloat, Clean Uninstall
title Title String Short description of the issue.
modname ModName Page The affected mod.
assignee Assignee Page User the issue is assigned to.
priority Priority String List of priorities; High, Medium, Low
status Status String Status of the ticket; Open, In progress, Hold, Closed
N/A SkyrimVersion String Pulled from the STEP:Main page upon ticket submission. Used for historical purposes.
N/A STEPVersion String Pulled from the STEP:Main page upon ticket submission. Used for historical purposes.
details Details Text Extended details of the issue.