Template talk:Config

From Dolphin Emulator Wiki
Revision as of 22:40, 12 April 2013 by Mbc07 (talk | contribs) (Recent Updates)
Jump to: navigation, search

To Do

  • Add "Resolution" setting for titles like Mega Man, which are sensitive to particular resolutions.
  • Fix alternate row shading. Unfortunately the nested if's/tables make this complex.
  • Add pop-up descriptions to config settings
  • Address bolding of sections beyond first shown /wo including excessive white-space
    • The wiki will apparently only appropriately parse "===" enclosed titles as titles if line feeds occur between each section outside of the if's. This unfortunately inserts excess white-space in cases where no sections are shown. Attempted corrections that fail include:
      • Adding white-space to the beginning/ends of sections within ifs
      • Adding white-space between sections via a secondary set of ifs
  • Generate error category for non-compliant settings: Most settings have limited valid values (i.e. On/Off,RAM/Texture/"Texture/RAM";etc.). it would be good to parse for such and output error categories for non-complaint pages.

Is "fix alternate row shading" still an issue? Looks okay to me.
The table rows aren't alternately shaded, so yes, but it's a minor issue. Possible fix described at Wikipedia:Template:Alternating_rows_table_section. Kolano 04:37, 17 August 2011 (CEST)
Can you provide more detail for 'Address bolding of sections beyond first shown w/o including excessive white-space'?
I've updated the sandbox test page to show the problem. It's related to the spaces between config sections. I was able to resolve this by purging the whitespace but doing so resulted in the alternate issue of section titles not being styled as headings (i.e. bolded/font-size increased).Kolano 04:37, 17 August 2011 (CEST)
I've create Template:Config/sandbox-todo, Template:Config/sandbox-todo/testing specifically for work on ToDo list issues

--Keller999 02:35, 16 August 2011 (CEST)

19121 rollback

I understand a desire to not impact current pages, but we will need to deal with ongoing config changes. We probably need to address such in a manner that preserves old options as input, but displays new options as output.Kolano 04:01, 21 June 2011 (CEST)

I absolutely 100% agree that we will need to add new parameters to this template over time -- but simply removing and breaking existing parameters that are still in use on many articles is poor practice. This is why I reverted it (for now). The change also broke the feature I added that categorizes articles in need of some parameter updates (see Category:Pages with deprecated config template parameters). LobStoR (talk | contribs) 18:20, 21 June 2011 (CEST)
Sorry for the troubles that was caused, the 19121 edit wasn't intended to cause problems, but a merge error in my text editor broke many things... I'll commit it again when I figure out what is going on on my editor, and after this the template will be as was on 19121 but without the compatibility issues and without breaking any new introduced features... Jhonn 21:18, 21 June 2011 (CEST)

Further improvements

I've been working on this template a good bit. I've already committed the documentation page update, but I wanted to get your thoughts before making a big change to something as serious as Template:Config. Here's what already been commited:

  • Documentation page re-write. Only current variables are listed, the sample copy-paste block contains all current variables and is broken out so that the list at the bottom is no longer needed.

Here's what I've got teed up, if no one objects.

  • Reformatted Template:Config to be considerably more readable, with one variable per line and consistent tabbing
  • Put variables in the same order as shown in Template:Config/doc, with spacing to show General, Graphics, etc.
  • Verified and altered the if checks to see if a box needs to be displayed. They will only display if non-outdated variables are being used.

Proposed template: Template:Config/sandbox
Implementation: Template:Config/sandbox/testing
--Keller999 07:26, 14 August 2011 (CEST)

I merged my re-formatted template into the recent changes that Kolano made. The function should be the same, but please feel free to correct any errors I may have made. Also, I added the following note to the template:
A full list of available options is available at Template:Config/doc
I know that Kolano has been doing a lot of work to remove non-used variables from wiki articles, which I think is great for cleaning up the source for each page. However, I am concerned that newbie editors won't have any idea what variables can be used for the Config template. I know when I first started editing, I was actually picking random game pages trying to find one that used the parameter that I needed so I could copy their variable! Template:Config/doc has a very accessible listing of all parameters, and should be quickly available to anyone who wants to add config information to a game, especially users who might not know enough about wikis to search for the appropriate template. I think the other viable option would be to list all config parameters in each game, and let the user fill out the 'form', but that would cause major headaches whenever the list changed. I think that a small note is a good solution. --Keller999 22:15, 15 August 2011 (CEST)
I agree with your sentiment, which is why the full lists of options were originally included on each game page. The issue with such is that the options change more frequently than one might expect, which results in extensive effort to clean-up the out of date pages when they change. The solution we've used for other template complexities is to include a commented note pointing users to the Template/doc pages for details. BTW, thanks for your recent efforts to assist here, they are appreciated.Kolano 22:41, 15 August 2011 (CEST)

In the Graphics field where it says OpenCL texture decoder, perhaps it'd be better to include OpenMP texture decoder instead as that one is not (and quoting dolphin's description) "Experimental" and "known to cause texture defects on various games". Or maybe it's wiser to include both?? Otomo 18:52, 15 August 2011 (CEST)

Both should be included for as long as both exist within the Dolphin config options. Kolano 21:40, 15 August 2011 (CEST)

Okay, ready with another update for Template:Config. Here's what my proposed update does:

  • added a box for 3.0-Only Settings, which includes a note that they are only applicable to 3.0. Since newer users are told to use release 3.0 over the latest SVNs, I think it's important that we not remove 3.0-only settings until 4.0 comes out. This also separates them in a way that lets svn users know that they're not applicable to them.
  • efbscaledcopy, accuratetexturecache, and fastmipmaps (settings that are in 3.0 but not latest svn) have been removed from Category:Pages with deprecated config template parameters and placed instead in a new Category:Pages with 3.0-only config template parameters
  • updated documentation to have a new section for the 3.0 variables
  • fixed a bug that was preventing pages from being added to Category:Pages with deprecated config template parameters (already pushed to live, sorry for the CPU usage on the recalc)
  • added a link to Template:Config/doc so that users have an easy reference to available variables (already pushed to live)


Anyone have any objections to these changes? If not, I'll likely push them out tomorrow. Please check/mess with the pages to ensure that I'm not missing any bugs, please!

Template:Config/sandbox Template:Config/sandbox/doc Template:Config/sandbox/testing

--Keller999 01:55, 16 August 2011 (CEST)

I agree with all of the current changes of sandbox, but I think that the link to Template:Config/doc wouldn't be in the Game Pages (or on pages that use the template)... Clicking on Help on the Navigation sidebar or using the editing help link when editing pages redirect to the Help:Contents, that already have a link to the template documentation... Jhonn 03:24, 17 August 2011 (CEST)
Ah, perfect -- I had no idea the help page existed. It looks like it's a bit outdated too. I'll see if I can work on it to make it more user-friendly for wiki newbies. When I first started contributing to the wiki, the place I looked for information like that was the front page. Right now, it just has the generic Getting Started section that does not really say how to contribute. I may see if I can improve that too.
Once those section are a little more helpful, I'm fine not having the link to Template:Config/doc on every game page. It WOULD be nice to have a "New to the Dolphin Wiki? Visit our Getting Started page to learn how you can contribute!" on the very top/bottom of each page in a non-intrusive way, but that's a project for another day. Since there is some disagreement about the Template:Config/doc link, I will remove it for now. ((EDIT: Strike that, I just saw where Kolano put the link, and I think that's a good solution for now. I'll still work on getting the documentation to be more accessible. --Keller999))
Yeah, The duplicate content in the template had bothered me. I'd actually prefer if it wasn't shown that way though, as the config template doc isn't really a good config reference (i.e. for end users), but I was also too lazy to add it as a comment to every game page. If we can improve the Help documentation and etc., I'm happy as that being an alternate plan.Kolano 04:48, 17 August 2011 (CEST)
Let's plan on doing a good "Getting Started" or "How to Contribute" guide and having that replace all the comments and links that have to be manually managed per-game page. For now, I'll leave the link in place, but will start working on better guides ASAP. --Keller999 04:57, 17 August 2011 (CEST)
Thanks! --Keller999 04:08, 17 August 2011 (CEST)

Skip EFB Access from CPU

This option was renamed from "EFB Access from CPU" to "Skip EFB Access from CPU", but the current config wasn't changed to align with such. I just got done aligning pages using the option as best I could, but we should rename the option here to prevent confusion and add it to the deprecated list.Kolano 21:25, 16 August 2011 (CEST)

It seems to be a performance option, at the expense of compatibility, it can be mentioned it in the performance guide and nowhere else.Otomo 21:49, 16 August 2011 (CEST)

Game Config

This list doesn't have all game config options. Specifically, I'm looking for "Alternate Wiimote Timings" for Metroid Prime 3. I would add it myself, but uh, not really my thing, and that looks quite intimidating... MaJoR 07:41, 7 August 2012 (CEST)

Recent Updates

The recent changes are causing every page on the wiki to be categorized into "Pages with deprecated config template parameters". Also seems like it may be time to purge some of the out of date discussion here. Kolano (talk) 00:14, 12 April 2013 (CEST)

The last commit addressed this issue... Maybe the server take some time to update the categories again? Jhonn (talk)

Just edited a page to force it to refresh and it still has the "Pages with deprecated config template parameters" tag, so I don't think the fixed worked. Kolano (talk) 04:08, 12 April 2013 (CEST)

Ok, I checked again, the "if" statement that evaluate the pages that should go to this category haven't errors apparently, this will need more investigating. Jhonn (talk)

Hey uh, the recent updates aren't quite working properly.

|enablespeakerdata = Disabled |enablespeakernotes = Fixes wiimote disconnects

Shows: Enable Speaker Data | Disabled | Disabled

Have a look at Metroid Prime 2: Echoes (Metroid Prime: Trilogy). I suppose wiimote motor might be similarly screwed up. We need to test these. - MaJoR (talk) 18:17, 12 April 2013 (CEST)

Hopefully, it's fixed now. Jhonn (talk)