Project:Data Dictionary/backup: Difference between revisions

From Step Mods | Change The Game
No edit summary
 
(33 intermediate revisions by 3 users not shown)
Line 3: Line 3:
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.
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 [http://wiki.step-project.com/Project_talk:Data_Dictionary Talk] page for on-going discussions about all things related to the Data Dictionary.
Be sure to also check out the [https://stepmodifications.org/wiki/Project_talk:Data_Dictionary Talk] page for on-going discussions about all things related to the Data Dictionary.


== [[Form:Mod]] ==
== 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]].
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]], and [[Template:Overwrites]].


==== [[Template:Mod]] ====
==== Template:Mod ====
[[Template:Mod]] is used to populate the mod InfoBox.
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 20: Line 21:
| String
| String
| ''The author.''
| ''The author.''
| align="right" | {{Yes}}
| {{icon|type=yes}}
|-
|-
| '''fullName'''  
| '''ModName'''  
| '''[[Property:FullName|FullName]]'''  
| '''[[Property:ModName|ModName]]'''  
| String  
| String  
| ''Full Name of the Mod.''
| ''Full Name of the Mod.''
| -
| {{icon|type=yes}}
|-
|-
| '''quote'''
| '''quote'''
Line 32: Line 33:
| class="na" | N/A
| class="na" | N/A
| ''Quote about the Mod.''
| ''Quote about the Mod.''
| -
| {{icon|type=yes}}
|-
|-
| '''quoteAuthor'''
| '''quoteAuthor'''
Line 38: Line 39:
| class="na" | N/A
| class="na" | N/A
| ''Author of the quote.''
| ''Author of the quote.''
| -
| {{icon|type=yes}}
|-
|-
| '''logo'''
| '''logo'''
Line 44: Line 45:
| class="na" | N/A
| class="na" | N/A
| ''URL to a logo.''
| ''URL to a logo.''
| -
| {{icon|type=yes}}
|-
|-
| '''section'''
| '''ModGroup'''
| '''[[Property:Section|Section]]'''
| '''[[Property:ModGroup|ModGroup]]'''
| String
| String
| ''Contains Allows value declarations.''
| ''Contains Allows value declarations.''
| -
| {{icon|type=yes}}
|-
|-
| class="na" | N/A
| class="na" | N/A
| '''[[Property:SectionLabel|SectionLabel]]'''
| '''[[Property:ModGroupName|ModGroupName]]'''
| String
| String
| ''This is not passed into the template, only referenced.''
| ''This is not passed into the template, only referenced.''
| -
| {{icon|type=yes}}
|-
|-
| '''sourceName'''
| '''sourceName'''
Line 62: Line 63:
| String
| String
| ''List of supported sites that uses an ID.  '''Other''' specifies the download location is a full URL.''
| ''List of supported sites that uses an ID.  '''Other''' specifies the download location is a full URL.''
| -
| {{icon|type=yes}}
|-
|-
| '''sourceID'''
| '''sourceID'''
Line 68: Line 69:
| Number
| Number
| ''The ID of the Mod from the download source.  Associated with a valid '''SourceName'''.''
| ''The ID of the Mod from the download source.  Associated with a valid '''SourceName'''.''
| -
| {{icon|type=yes}}
|-
|-
| '''sourceURL'''
| '''sourceURL'''
Line 74: Line 75:
| URL
| URL
| ''The full URL to a Mod source.  Associated with the choice of '''Other''' from '''SourceName'''''.
| ''The full URL to a Mod source.  Associated with the choice of '''Other''' from '''SourceName'''''.
| -
| {{icon|type=yes}}
|-
|-
| '''forumtid'''
| '''forumtid'''
Line 80: Line 81:
| Number
| Number
| ''URL is formulated in the template from the ID.''
| ''URL is formulated in the template from the ID.''
| -
| {{icon|type=yes}}
|-
|-
| '''core'''
| '''core'''
Line 86: Line 87:
| Boolean
| Boolean
| ''Indicates that the Mod is considered essential to the STEP experience.''
| ''Indicates that the Mod is considered essential to the STEP experience.''
| -
| {{icon|type=yes}}
|-
| '''tpc'''
| '''[[Property:TPC|TPC]]'''
| Boolean
| ''Indicates that the Mod is part of the TPC process for cherry picking visual resources.''
| -
|-
|-
| '''baseline'''
| '''baseline'''
Line 98: Line 93:
| String
| String
| ''Short note to specify resource selection when multiple are available.''
| ''Short note to specify resource selection when multiple are available.''
| -
| {{icon|type=yes}}
|-
|-
| '''fps'''
| '''fps'''
Line 104: Line 99:
| Boolean
| Boolean
| ''Indicates that the Mod will noticeably affect FPS (in relation to the '''Baseline''').''
| ''Indicates that the Mod will noticeably affect FPS (in relation to the '''Baseline''').''
| -
| {{icon|type=yes}}
|-
|-
| '''vram'''
| '''vram'''
Line 110: Line 105:
| Boolean
| Boolean
| ''Indicates that the Mod will noticeably affect VRAM use (in relation to the '''Baseline''').''
| ''Indicates that the Mod will noticeably affect VRAM use (in relation to the '''Baseline''').''
| -
| {{icon|type=yes}}
|-
|-
| '''performance'''
| '''performance'''
Line 116: Line 111:
| Boolean
| Boolean
| ''Indicates that a performance version is available (in relation to the '''Baseline''').''
| ''Indicates that a performance version is available (in relation to the '''Baseline''').''
| -
| {{icon|type=yes}}
|-
|-
| '''quality'''
| '''quality'''
Line 122: Line 117:
| Boolean
| Boolean
| ''Indicates that a higher quality version is available (in relation to the '''Baseline''').''
| ''Indicates that a higher quality version is available (in relation to the '''Baseline''').''
| -
| {{icon|type=yes}}
|-
|-
| '''externalItems'''
| '''externalItems'''
Line 128: Line 123:
| class="na" | N/A
| class="na" | N/A
| ''Holds multiple-instance template '''[[Template:External URL]]'''.''
| ''Holds multiple-instance template '''[[Template:External URL]]'''.''
| -
| {{icon|type=yes}}
|}
|}


==== [[Template:External URL]] ====
==== Template:External URL ====
This is a multiple-instance template contained in Mod[externalItems].
[[Template:External URL]] is a multiple-instance template contained in Mod[externalItems].
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 143: Line 138:
| '''[[Property:ExternalURL|ExternalURL]]'''
| '''[[Property:ExternalURL|ExternalURL]]'''
| URL
| URL
| ''URL to a site containing additional information (ex. <nowiki>http://www.facebook.com/<pageinfo></nowiki>).''
| ''URL to a site containing additional information (ex. <nowiki>https://www.facebook.com/<pageinfo></nowiki>).''
| -
| {{icon|type=yes}}
|-
|-
| '''externalLabel'''
| '''externalLabel'''
Line 150: Line 145:
| String
| String
| ''Becomes the external link text (ex. Facebook).''
| ''Becomes the external link text (ex. Facebook).''
| -
| {{icon|type=yes}}
|}
|}


==== [[Template:Gallery]] ====
==== Template:Gallery ====
No Symantic Properties are used with this template.
No Symantic Properties are used with [[Template:Gallery]].
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 166: Line 161:
| class="na" | N/A
| class="na" | N/A
| ''Allows disabling the Gallery without losing the data specified in the template call.''
| ''Allows disabling the Gallery without losing the data specified in the template call.''
| -
| {{icon|type=yes}}
|-
|-
| '''title'''
| '''title'''
Line 172: Line 167:
| class="na" | N/A
| class="na" | N/A
| ''Title that appears above the gallery (Optional).''
| ''Title that appears above the gallery (Optional).''
| -
| {{icon|type=yes}}
|-
|-
| '''galleryItems'''
| '''galleryItems'''
Line 178: Line 173:
| class="na" | N/A
| class="na" | N/A
| ''Holds multiple-instance template '''[[Template:Gallery Items]]'''.''
| ''Holds multiple-instance template '''[[Template:Gallery Items]]'''.''
| -
| {{icon|type=yes}}
|}
|}


==== [[Template:Gallery Items]] ====
==== Template:Gallery Items ====
No Symantic Properties are used with this template. This is a multiple-instance template contained in Gallery[galleryItems].
No Symantic Properties are used with [[Template:Gallery Items]]. This is a multiple-instance template contained in Gallery[galleryItems].
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 194: Line 189:
| class="na" | N/A
| class="na" | N/A
| ''URL to the screenshot image.''
| ''URL to the screenshot image.''
| -
| {{icon|type=yes}}
|-
|-
| '''caption'''
| '''caption'''
Line 200: Line 195:
| class="na" | N/A
| class="na" | N/A
| ''Caption description that appears below the thumbnail.''
| ''Caption description that appears below the thumbnail.''
| -
| {{icon|type=yes}}
|}
|}


==== [[Template:Recommendations]] ====
==== Template:Recommendations ====
[[Template:Recommendations]] is used to associate STEP-specific recommendation with a corresponding mod.
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 215: Line 211:
| Text
| Text
| ''Contains STEP specific notes and recommendations.''
| ''Contains STEP specific notes and recommendations.''
| -
| {{icon|type=yes}}
|-
|-
| '''overwritesItems'''
| '''overwritesItems'''
Line 221: Line 217:
| class="na" | N/A
| class="na" | N/A
| ''Holds multiple-instance template '''[[Template:Overwrites]]'''''
| ''Holds multiple-instance template '''[[Template:Overwrites]]'''''
| -
| {{icon|type=yes}}
|}
|}


==== [[Template:Overwrites]] ====
==== Template:Overwrites ====
This is a multiple-instance template contained in Recommendations[overwritesItems].
[[Template:Overwrites]] is a multiple-instance template contained in Recommendations[overwritesItems].
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 237: Line 233:
| String
| String
| ''Contains the Mod name that it overwrites.''
| ''Contains the Mod name that it overwrites.''
| -
| {{icon|type=yes}}
|}
|}


==== [[Template:Revision History]] ====
== Form:STEP Version ==
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:STEP Version]] 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:ModOrderItem]].
 
==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]] ====
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Semantic Property
! style="width: 15%;" | Semantic Type
! Notes
! style="width: 40px;" | Ready
|-
| '''releaseDate'''
| '''[[Property:ReleaseDate|ReleaseDate]]'''
| Date
| ''The version release date.''
| -
|}


== [[Form:STEP Version]] ==
==== Template:ModOrder ====
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]].
No semantic properties are currently used in [[Template:ModOrder]].
==== [[Template:ModOrder]] ====
No semantic properties are currently used in this template.
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 275: Line 251:
| class="na" | N/A
| class="na" | N/A
| class="na" | N/A
| class="na" | N/A
| ''Contains a multiple-instance template [[Template:ModList]].''
| ''Contains a multiple-instance template [[Template:ModOrderItem]].''
| -
| {{icon|type=yesyellow}}
|}
|}


==== ]]Template:ModList]] ====
==== Template:ModOrderItem ====
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:ModOrderItem]] 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].
{| class="propertytable"
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Template Field
Line 292: Line 268:
| Page
| Page
| ''Property associated with an Internal Object.''
| ''Property associated with an Internal Object.''
| -
| {{icon|type=yesyellow}}
|-
|-
| class="na" | N/A
| class="na" | N/A
Line 298: Line 274:
| Number
| Number
| ''Sub property to '''ModOrder''' containing a Mod's installation order.''
| ''Sub property to '''ModOrder''' containing a Mod's installation order.''
| -
| {{icon|type=yesyellow}}
|-
|-
| '''modname'''
| '''modname'''
Line 304: Line 280:
| Page
| Page
| ''Sub Property to '''ModOrder''' referencing a Mod to be ordered.''
| ''Sub Property to '''ModOrder''' referencing a Mod to be ordered.''
| -
| {{icon|type=yesyellow}}
|-
|-
| class="na" | N/A
| class="na" | N/A
Line 310: Line 286:
| String
| String
| ''Sub Property to '''ModOrder''' containing the STEP Version (Pulled from '''<nowiki>{{SUBPAGENAME}}</nowiki>''').''
| ''Sub Property to '''ModOrder''' containing the STEP Version (Pulled from '''<nowiki>{{SUBPAGENAME}}</nowiki>''').''
| -
| {{icon|type=yesyellow}}
|}
 
== [[Form:ModTest]] ==
==== [[Template:SystemSpecs]] ====
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Semantic Property
! style="width: 15%;" | Semantic Type
! Notes
! style="width: 40px;" | Ready
|-
| '''CPUSpecs'''
| '''[[Property:CPUSpecs|CPUSpecs]]'''
| String
| (values: Multi core >= 3GHz, 2GHz <= Multi core < 3GHz, Single core OR Multi core < 2GHz)
| {{yes|yellow}}
|-
| '''GPUSpecs'''
| '''[[Property: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)
| {{yes|yellow}}
|-
| '''MultiGPU'''
| '''[[Property:MultiGPU|MultiGPU]]'''
| Boolean
| ''Indicates whether or not the test box uses a multi-GPU configuration.''
| {{yes|yellow}}
|-
| '''SSD'''
| '''[[Property:HDDSpecs|HDDSpecs]]'''
| Boolean
| ''Indicates whether or not the test box utilizes an SSD for OS and Skyrim.''
| {{yes|yellow}}
|-
| '''64bitOS'''
| '''[[Property:64bitOS|64bitOS]]'''
| Boolean
| ''Indicates whether or not the test box is running Skyrim on a 64-but OS.''
| {{yes|yellow}}
|-
|}
 
==== [[Template:PerformanceImpact]] ====
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Semantic Property
! style="width: 15%;" | Semantic Type
! Notes
! style="width: 40px;" | Ready
|-
| '''FPSImpact'''
| '''[[Property:FPSImpact|FPSImpact]]'''
| Numeric
| ''Approximate FPS impact (integer).''
| {{yes|yellow}}
|-
| '''VRAMImpact'''
| '''[[Property:VRAMImpact|VRAMImpact]]'''
| Numeric
| ''Approximate VRAMimpact (integer).''
| {{yes|yellow}}
|}
 
==== [[Template:ModTest]] ====
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Semantic Property
! style="width: 15%;" | Semantic Type
! Notes
! style="width: 40px;" | Ready
|-
| '''Documentation'''
| '''[[Property: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.''
| {{no}}
|-
| '''StartNewGame'''
| '''[[Property:StartNewGame|StartNewGame]]'''
| Boolean
| ''Indicates whether or not the mod performs adequately through new game initialization (through 'tutorial' to avalanch/cave-in under Helgen).''
| {{no}}
|-
| '''LoadSaveGame'''
| '''[[Property:LoadSaveGame|LoadSaveGame]]'''
| Boolean
| ''Indicates whether or not the standard save game can be successfully loaded (Top of stairs, Whiterun).''
| {{no}}
|-
| '''HasScripts'''
| '''[[Property:HasScripts|HasScripts]]'''
| Boolean
| ''Indicates whether or not the mod uses scripts.''
| {{no}}
|-
| '''IsClean'''
| '''[[Property:IsClean|IsClean]]'''
| Boolean
| ''Applies only to mods containing ESP/Ms. Indicates whether or not the mod is clean.''
| {{yes|yellow}}
|-
| '''CleanUninstall'''
| '''[[Property:CleanUninstall|CleanUninstall]]'''
| Boolean
| ''Applies mainly to scipting mods. Indicates whether or not the mod can be cleanly deactivated without leaving behind scripting artifacts.''
| {{no}}
|-
| '''IsLoreFriendly'''
| '''[[Property:IsLoreFriendly|IsLoreFriendly]]'''
| Boolean
| ''A necessarily subjective attribute indicating whether or not the mod is generally lore friendly (according to the STEP mandate).''
| {{yes|yellow}}
|-
| '''BAINFriendly'''
| '''[[Property:BAINFriendly|BAINFriendly]]'''
| Boolean
| ''Indicates whether or not the mod package will be sufficiently recognized by Wrye Bash.''
| {{yes|yellow}}
|-
| '''LooseFiles'''
| '''[[Property: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.''
| {{yes|yellow}}
|-
| '''DataConflicts'''
| '''[[Property:DataConflicts|DataConflicts]]'''
| Page
| ''This specifies any net in-game conflicts as defined by ESP/M and BSA asset loading (i.e., see LooseFiles Property).''
| {{yes|yellow}}
|-
| '''ResourceConflicts'''
| '''[[Property:ResourceConflicts|ResourceConflicts]]'''
| Page
| ''This specifies any direct resource conflicts as indicated in Wrye Bash (i.e., see LooseFiles Property).''
| {{yes|yellow}}
|-
| '''PapyrusErrors'''
| '''[[Property: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).''
| {{yes|yellow}}
|-
| '''CTDs'''
| '''[[Property: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).''
| {{yes|yellow}}
|-
| '''SavegameBloat'''
| '''[[Property: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).''
| {{no}}
|-
| '''QualityImpact'''
| '''[[Property:QualityImpact|QualityImpact]]'''
| String
| ''Indicates whether or not the mod impacts quality.'' (values: noticeable improvement, negligible improvement, negligible decline, noticeable decline).
| {{yes|yellow}}
|-
|}
|}
==== Misc Property ====
{| class="propertytable"
! style="width: 15%;" | Template Field
! style="width: 15%;" | Semantic Property
! style="width: 15%;" | Semantic Type
! Notes
! style="width: 40px;" | Ready
|-
| '''SystemType'''
| '''[[Property:SystemType|SystemType]]'''
| String
| (values: LO, BASELINE, HI)
| {{yes|yellow}}
|-
|}
----


== Notes ==
== Notes ==


: Performance will need to be assessed at each of the pre-defined standard saves
: Performance will need to be assessed at each of the pre-defined standard saves

Latest revision as of 13:27, July 20, 2021

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, and Template:Overwrites.

Template:Mod

Template:Mod is used to populate the mod InfoBox.

Template Field Semantic Property Semantic Type Notes Ready
author Author String The author. Tick green.png
ModName ModName String Full Name of the Mod. Tick green.png
quote N/A N/A Quote about the Mod. Tick green.png
quoteAuthor N/A N/A Author of the quote. Tick green.png
logo N/A N/A URL to a logo. Tick green.png
ModGroup ModGroup String Contains Allows value declarations. Tick green.png
N/A ModGroupName String This is not passed into the template, only referenced. Tick green.png
sourceName SourceName String List of supported sites that uses an ID. Other specifies the download location is a full URL. Tick green.png
sourceID SourceID Number The ID of the Mod from the download source. Associated with a valid SourceName. Tick green.png
sourceURL SourceURL URL The full URL to a Mod source. Associated with the choice of Other from SourceName. Tick green.png
forumtid ForumTID Number URL is formulated in the template from the ID. Tick green.png
core IsCore Boolean Indicates that the Mod is considered essential to the STEP experience. Tick green.png
baseline Baseline String Short note to specify resource selection when multiple are available. Tick green.png
fps AffectsFPS Boolean Indicates that the Mod will noticeably affect FPS (in relation to the Baseline). Tick green.png
vram AffectsVRAM Boolean Indicates that the Mod will noticeably affect VRAM use (in relation to the Baseline). Tick green.png
performance PerformanceAvailable Boolean Indicates that a performance version is available (in relation to the Baseline). Tick green.png
quality QualityAvailable Boolean Indicates that a higher quality version is available (in relation to the Baseline). Tick green.png
externalItems N/A N/A Holds multiple-instance template Template:External URL. Tick green.png

Template:External URL

Template:External URL 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. https://www.facebook.com/<pageinfo>). Tick green.png
externalLabel ExternalLabel String Becomes the external link text (ex. Facebook). Tick green.png

Template:Gallery

No Symantic Properties are used with Template:Gallery.

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. Tick green.png
title N/A N/A Title that appears above the gallery (Optional). Tick green.png
galleryItems N/A N/A Holds multiple-instance template Template:Gallery Items. Tick green.png

Template:Gallery Items

No Symantic Properties are used with Template:Gallery Items. 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. Tick green.png
caption N/A N/A Caption description that appears below the thumbnail. Tick green.png

Template:Recommendations

Template:Recommendations is used to associate STEP-specific recommendation with a corresponding mod.

Template Field Semantic Property Semantic Type Notes Ready
recommendations Recommendations Text Contains STEP specific notes and recommendations. Tick green.png
overwritesItems N/A N/A Holds multiple-instance template Template:Overwrites Tick green.png

Template:Overwrites

Template:Overwrites 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. Tick green.png

Form:STEP Version

Form:STEP Version 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:ModOrderItem.

Template:ModOrder

No semantic properties are currently used in Template:ModOrder.

Template Field Semantic Property Semantic Type Notes Ready
mods N/A N/A Contains a multiple-instance template Template:ModOrderItem. Tick yellow.png

Template:ModOrderItem

Template:ModOrderItem 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. Tick yellow.png
N/A →OrderID Number Sub property to ModOrder containing a Mod's installation order. Tick yellow.png
modname →ModName Page Sub Property to ModOrder referencing a Mod to be ordered. Tick yellow.png
N/A →Version String Sub Property to ModOrder containing the STEP Version (Pulled from {{SUBPAGENAME}}). Tick yellow.png

Notes

Performance will need to be assessed at each of the pre-defined standard saves
Retrieved from "https://stepmodifications.org/wiki/index.php?title=Project:Data_Dictionary/backup&oldid=157959"