Project talk:Data Dictionary: Difference between revisions

Revision as of 06:38, July 16, 2013

Archive

/Archive 1

Proposed Mod Attributes (Discussion Page)[edit source]

Below is a work-in-progress list of attributes that can be associated with mod pages. Feel free to add anything you might think is useful. Let's try to keep it organized, so group similar or related properties as best you can. Note that Baseline has been removed from this list on purpose, that should be a Pack attribute based on the Pack's guidelines. ~Farlo Talk 19:56, July 15, 2013 (MDT)

Mod Info[edit source]

Author (string) - The author(s) of the mod.
FullName (string) - Full name of the mod according to source.
SourceName (string) - Supported mod source. Specifies a URL created from "Steam" or "Nexus" mod ID. "Other" prompts for user input of a full URL string.
SourceID (string) - "Steam" or "Nexus" mod SourceID if either is specified in SourceName.
SourceURL (URL) - Full URL if SourceName is specified as "Other".
Section (string) - STEP installation "blocks" specified using "allows value" declarations.

Proposed by Farlo: Change to broad categorization of the mod (NOT the STEP section, similar idea to the Nexus categories)

SectionLabel (string) - A human-meaningful label associated with Section. This is not passed into the template, only referenced.
Baseline (string) - Specifies the recommended mod option when more than one are available.
ForumTID (string) - Specifies a URL created using the thread ID of the mod on the STEP forums.

External URL (object) - Multiple-instance template containing:
- ExternalURL (URL) - URL string specifying a page associated with the mod; other hosts, Facebook, etc. (URL)
- ExternalLabel (string) - A human-meaningful label associated with ExternalURL (string)

Mod Flags[edit source]

QualityItems - multiple instances of a QualityValue.
- QualityValue - Available graphical tiers or options available (2048, 1024, High, Low, etc.) (string).
HasPlugin - Indicates that the mod has a plugin file (select: ESP, ESM, None).
- CleanPlugin - Indicates that the mod's plugin is clean (boolean). Dependent on HasPlugin.
Notes - Mod-specific information or special notes (string).

DLCRequired (string) - Indicates which DLC's are required by the mod.
DLCSupported (string) - Indicates which DLC's are supported by the mod via an addon.
DocDescription (Boolean) - Indicates that the mod includes a description of what the mod does.

DocInstall (Boolean) - Indicates that the mod includes installation instructions.
DocUninstall (Boolean) - Indicates that the mod includes un-installation instructions.
HasScript (Boolean) - Indicates that the mod uses scripts.

CompatibleBAIN (Boolean) - Indicates that the mod package has BAIN support.
CompatibleFOMOD (Boolean) - Indicates that the mod package has FOMOD support.
IsOptimized (Boolean) - Indicates that the mod has MCM functionality and depends on SkyUI.
HasSkyProc (Boolean) - Indicates that the mod contains a SkyProc patcher.
LoreFriendly (Boolean) - Indicates that the mod is considered lore friendly.
CleanUninstall (Boolean) - Indicates that mod can be deactivated without corrupting save games.
LoreFriendly (Boolean) - Indicates if a mod is considered lore friendly.
IsCore (Boolean) - Indicates if a mod is CORE to the STEP experience.
AffectsFPS (Boolean) - Indicates if a mod has a noticeable FPS impact.
AffectsVRAM (Boolean) - Indicates if a mod has a noticeable VRAM impact.
PerformanceAvailable (Boolean) - Indicates if a mod has a performance version available.
QualityAvailable (Boolean) - Indicates if a mod has a quality version available.

@@ Line 6: / Line 6: @@
 Below is a work-in-progress list of attributes that can be associated with mod pages.  Feel free to add anything you might think is useful.  Let's try to keep it organized, so group similar or related properties as best you can. Note that Baseline has been removed from this list on purpose, that should be a Pack attribute based on the Pack's guidelines. ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 19:56, July 15, 2013 (MDT)
-===== Primary Mod Info =====
+===== Mod Info =====
-* {{Fc|#e6b69e|'''''Author'''''}} (String) - The author(s) of the mod.
+* {{Fc|#e6b69e|'''''Author'''''}} (string) - The author(s) of the mod.
-* {{Fc|#e6b69e|'''''FullName'''''}} (String) - Full name of the mod according to source.
+* {{Fc|#e6b69e|'''''FullName'''''}} (string) - Full name of the mod according to source.
-* {{Fc|#e6b69e|'''''SourceName'''''}} (String) - List of supported sites that uses an ID. Other specifies the download location is a full URL.
+* {{Fc|#e6b69e|'''''SourceName'''''}} (string) - Supported mod source. Specifies a URL created from "Steam" or "Nexus" mod ID. "Other" prompts for user input of a full URL string.
-* {{Fc|#e6b69e|'''''SourceID'''''}} (String) - The ID of the Mod from the download source. Associated with a valid SourceName.
+* {{Fc|#e6b69e|'''''SourceID'''''}} (string) - "Steam" or "Nexus" mod SourceID if either is specified in SourceName.
-* {{Fc|#e6b69e|'''''SourceURL'''''}} (URL) - The full URL to a Mod source. Associated with the choice of Other from SourceName.
+* {{Fc|#e6b69e|'''''SourceURL'''''}} (URL) - Full URL if SourceName is specified as "Other".
-* {{Fc|#e6b69e|'''''Section'''''}} (String) - Contains "allows value" declarations.
+* {{Fc|#e6b69e|'''''Section'''''}} (string) - STEP installation "blocks" specified using "allows value" declarations.
 :: Proposed by Farlo: Change to broad categorization of the mod (<u>'''NOT''' the STEP section</u>, similar idea to the [http://skyrim.nexusmods.com/mods/categories/ Nexus categories])
-* {{Fc|#e6b69e|'''''SectionLabel'''''}} (String) - This is not passed into the template, only referenced.
+* {{Fc|#e6b69e|'''''SectionLabel'''''}} (string) - A human-meaningful label associated with Section. This is not passed into the template, only referenced.
-* {{Fc|#e6b69e|'''''Baseline'''''}} (String) - Short note to specify resource selection when multiple are available.
+* {{Fc|#e6b69e|'''''Baseline'''''}} (string) - Specifies the recommended mod option when more than one are available.
-* {{Fc|#e6b69e|'''''ForumTID'''''}} (String) - URL created using the thread ID of the mod on the STEP forums.
+* {{Fc|#e6b69e|'''''ForumTID'''''}} (string) - Specifies a URL created using the thread ID of the mod on the STEP forums.
-* ''ExternalItems'' - multiple instances of an ''ExternalURL'' and ''ExternalLabel''. (object)
+<br />
-** ''ExternalURL'' - URL to a page related to the mod; other hosts, Facebook, etc. (URL)
-** ''ExternalLabel'' - Label to be displayed for the above ExternalURL (string)
-===== Secondary Mod Info =====
+* {{Fc|white|'''''External URL'''''}} (object) - Multiple-instance template containing:
-* ''SourceName'' - List of supported sites that uses an ID (Nexus, Steam, Other). Other specifies the download location is a full URL.
+** {{Fc|#e6b69e|'''''ExternalURL'''''}} (URL)  - URL string specifying a page associated with the mod; other hosts, Facebook, etc. (URL)
-* ''SourceID'' - The ID of the mod from the download source. Associated with a valid SourceName (string).
+** {{Fc|#e6b69e|'''''ExternalLabel'''''}} (string)  - A human-meaningful label associated with ExternalURL (string)
-* ''SourceURL'' - The full URL to a mod source. Associated with the choice of Other from SourceName (URL).
-===== Flags =====
+===== Mod Flags =====
 * {{Fc|#e6b69e|'''''QualityItems'''''}} - multiple instances of a ''QualityValue''.
 ** {{Fc|#e6b69e|'''''QualityValue'''''}} - Available graphical tiers or options available (2048, 1024, High, Low, etc.) (string).
@@ Line 32: / Line 29: @@
 ** {{Fc|#e6b69e|'''''CleanPlugin'''''}} - Indicates that the mod's plugin is clean (boolean). Dependent on ''HasPlugin''.
 * {{Fc|#e6b69e|'''''Notes'''''}} - Mod-specific information or special notes (string).
+<br />
-* {{Fc|#e6b69e|'''''DLCRequired'''''}} (String) - Indicates which DLC's are required by the mod.
+* {{Fc|#e6b69e|'''''DLCRequired'''''}} (string) - Indicates which DLC's are required by the mod.
-* {{Fc|#e6b69e|'''''DLCSupported'''''}} (String) - Indicates which DLC's are supported by the mod via an addon.
+* {{Fc|#e6b69e|'''''DLCSupported'''''}} (string) - Indicates which DLC's are supported by the mod via an addon.
 * {{Fc|#e6b69e|'''''DocDescription'''''}} (Boolean) - Indicates that the mod includes a description of what the mod does.
+<br />
 * {{Fc|#e6b69e|'''''DocInstall'''''}} (Boolean) - Indicates that the mod includes installation instructions.
 * {{Fc|#e6b69e|'''''DocUninstall'''''}} (Boolean) - Indicates that the mod includes un-installation instructions.
 * {{Fc|#e6b69e|'''''HasScript'''''}} (Boolean) - Indicates that the mod uses scripts.
+<br />
 * {{Fc|#e6b69e|'''''CompatibleBAIN'''''}} (Boolean) - Indicates that the mod package has BAIN support.