Project:Data Dictionary/backup: Difference between revisions

From Step Mods | Change The Game
 
(7 intermediate revisions by 2 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 ==
Line 21: Line 21:
| String
| String
| ''The author.''
| ''The author.''
| {{Yes}}
| {{icon|type=yes}}
|-
|-
| '''fullName'''  
| '''ModName'''  
| '''[[Property:FullName|FullName]]'''  
| '''[[Property:ModName|ModName]]'''  
| String  
| String  
| ''Full Name of the Mod.''
| ''Full Name of the Mod.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''quote'''
| '''quote'''
Line 33: Line 33:
| class="na" | N/A
| class="na" | N/A
| ''Quote about the Mod.''
| ''Quote about the Mod.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''quoteAuthor'''
| '''quoteAuthor'''
Line 39: Line 39:
| class="na" | N/A
| class="na" | N/A
| ''Author of the quote.''
| ''Author of the quote.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''logo'''
| '''logo'''
Line 45: Line 45:
| class="na" | N/A
| class="na" | N/A
| ''URL to a logo.''
| ''URL to a logo.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''section'''
| '''ModGroup'''
| '''[[Property:Section|Section]]'''
| '''[[Property:ModGroup|ModGroup]]'''
| String
| String
| ''Contains Allows value declarations.''
| ''Contains Allows value declarations.''
| {{yes}}
| {{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.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''sourceName'''
| '''sourceName'''
Line 63: 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.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''sourceID'''
| '''sourceID'''
Line 69: 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'''.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''sourceURL'''
| '''sourceURL'''
Line 75: 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'''''.
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''forumtid'''
| '''forumtid'''
Line 81: Line 81:
| Number
| Number
| ''URL is formulated in the template from the ID.''
| ''URL is formulated in the template from the ID.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''core'''
| '''core'''
Line 87: 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.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''baseline'''
| '''baseline'''
Line 93: Line 93:
| String
| String
| ''Short note to specify resource selection when multiple are available.''
| ''Short note to specify resource selection when multiple are available.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''fps'''
| '''fps'''
Line 99: 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''').''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''vram'''
| '''vram'''
Line 105: 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''').''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''performance'''
| '''performance'''
Line 111: 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''').''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''quality'''
| '''quality'''
Line 117: 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''').''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''externalItems'''
| '''externalItems'''
Line 123: Line 123:
| class="na" | N/A
| class="na" | N/A
| ''Holds multiple-instance template '''[[Template:External URL]]'''.''
| ''Holds multiple-instance template '''[[Template:External URL]]'''.''
| {{yes}}
| {{icon|type=yes}}
|}
|}


Line 138: 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>).''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''externalLabel'''
| '''externalLabel'''
Line 145: Line 145:
| String
| String
| ''Becomes the external link text (ex. Facebook).''
| ''Becomes the external link text (ex. Facebook).''
| {{yes}}
| {{icon|type=yes}}
|}
|}


Line 161: 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.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''title'''
| '''title'''
Line 167: Line 167:
| class="na" | N/A
| class="na" | N/A
| ''Title that appears above the gallery (Optional).''
| ''Title that appears above the gallery (Optional).''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''galleryItems'''
| '''galleryItems'''
Line 173: Line 173:
| class="na" | N/A
| class="na" | N/A
| ''Holds multiple-instance template '''[[Template:Gallery Items]]'''.''
| ''Holds multiple-instance template '''[[Template:Gallery Items]]'''.''
| {{yes}}
| {{icon|type=yes}}
|}
|}


Line 189: Line 189:
| class="na" | N/A
| class="na" | N/A
| ''URL to the screenshot image.''
| ''URL to the screenshot image.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''caption'''
| '''caption'''
Line 195: Line 195:
| class="na" | N/A
| class="na" | N/A
| ''Caption description that appears below the thumbnail.''
| ''Caption description that appears below the thumbnail.''
| {{yes}}
| {{icon|type=yes}}
|}
|}


Line 211: Line 211:
| Text
| Text
| ''Contains STEP specific notes and recommendations.''
| ''Contains STEP specific notes and recommendations.''
| {{yes}}
| {{icon|type=yes}}
|-
|-
| '''overwritesItems'''
| '''overwritesItems'''
Line 217: Line 217:
| class="na" | N/A
| class="na" | N/A
| ''Holds multiple-instance template '''[[Template:Overwrites]]'''''
| ''Holds multiple-instance template '''[[Template:Overwrites]]'''''
| {{yes}}
| {{icon|type=yes}}
|}
|}


Line 233: Line 233:
| String
| String
| ''Contains the Mod name that it overwrites.''
| ''Contains the Mod name that it overwrites.''
| {{yes}}
| {{icon|type=yes}}
|}
|}


Line 252: Line 252:
| class="na" | N/A
| class="na" | N/A
| ''Contains a multiple-instance template [[Template:ModOrderItem]].''
| ''Contains a multiple-instance template [[Template:ModOrderItem]].''
| {{yes|yellow}}
| {{icon|type=yesyellow}}
|}
|}


Line 268: Line 268:
| Page
| Page
| ''Property associated with an Internal Object.''
| ''Property associated with an Internal Object.''
| {{yes|yellow}}
| {{icon|type=yesyellow}}
|-
|-
| class="na" | N/A
| class="na" | N/A
Line 274: Line 274:
| Number
| Number
| ''Sub property to '''ModOrder''' containing a Mod's installation order.''
| ''Sub property to '''ModOrder''' containing a Mod's installation order.''
| {{yes|yellow}}
| {{icon|type=yesyellow}}
|-
|-
| '''modname'''
| '''modname'''
Line 280: Line 280:
| Page
| Page
| ''Sub Property to '''ModOrder''' referencing a Mod to be ordered.''
| ''Sub Property to '''ModOrder''' referencing a Mod to be ordered.''
| {{yes|yellow}}
| {{icon|type=yesyellow}}
|-
|-
| class="na" | N/A
| class="na" | N/A
Line 286: 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>''').''
| {{yes|yellow}}
| {{icon|type=yesyellow}}
|}
|}


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"