Project:Data Dictionary/backup: Difference between revisions
m (→Template:Mod) |
|||
(30 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 [ | 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 == | ||
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 | 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.'' | ||
| {{icon|type=yes}} | |||
|- | |- | ||
| ''' | | '''ModName''' | ||
| '''[[Property: | | '''[[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}} | ||
|- | |- | ||
| ''' | | '''ModGroup''' | ||
| '''[[Property: | | '''[[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: | | '''[[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}} | ||
| | |||
|- | |- | ||
| '''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]] 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> | | ''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 ==== | ||
No Symantic Properties are used with | 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 ==== | ||
No Symantic Properties are used with | 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]] 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}} | ||
|} | |} | ||
== | == 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]]. | |||
== | |||
No semantic properties are currently used in | |||
{| 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: | | ''Contains a multiple-instance template [[Template:ModOrderItem]].'' | ||
| | | {{icon|type=yesyellow}} | ||
|} | |} | ||
==== | ==== 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]. | |||
{| 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}} | ||
|} | |} | ||
== 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. | |
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 | 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 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 | 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}}). |
Notes
- Performance will need to be assessed at each of the pre-defined standard saves