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

Template:Mod

Template:Mod is used to populate the mod InfoBox.

Template Field	Semantic Property	Semantic Type	Notes
author	Author	String	The author.
ModName	ModName	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.
ModGroup	ModGroup	String	Contains Allows value declarations.
N/A	ModGroupName	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.
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

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>).
externalLabel	ExternalLabel	String	Becomes the external link text (ex. Facebook).

Template:Gallery

No Symantic Properties are used with Template:Gallery.

Template Field	Semantic Property	Semantic Type	Notes
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 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.
caption	N/A	N/A	Caption description that appears below the thumbnail.

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.
overwritesItems	N/A	N/A	Holds multiple-instance template Template:Overwrites

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.

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.

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
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}}).*

Notes

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