Closed chrisklus closed 3 years ago
Changes that I made to the spreadsheet:
(1) I added "JavaScript file" column, where you should indicate the name of the .js file containing the sim-specific query parameters.
(2) I deleted the "Private Query Parameters" column. Some of my sims have dozens of private query parameters, they change relatively frequently, and I don't think it's necessary or desirable to reproduce them here. If anyone is interested in the private query parameters, see the JavaSript file -- any query parameters not marked public: true
are private.
I've completed my sims. I'm responsible for 28 sims, and there are only 12 unique sim-specific query parameters. All public common-code query parameters are applicable to all of my sims (with the exception of single-screen sims where homeScreen
is irrelevant) so I did not duplicate them if the rows for my sims.
In the spreadsheet "Javascript file" column, I linked the filenames to the source files in GitHub, so you can quickly navigate to see the complete set of query parameters in a file. Any that are not marked public: true
are private by default.
I followed the precedents established by @pixelzoom, and have entered the sims for which I'm the responsible developer into the spreadsheet.
Are all phet-io customization query parameters public? Not sure how to handle the ?switch
query parameter in https://github.com/phetsims/capacitor-lab-basics/blob/master/js/common/CLBQueryParameters.js.
I'm not sure if this is correct, but I thought that public
query parameters were those which we would feel comfortable releasing for general consumption, and not just for a single client's request for customizations. For example ?standford
for Balancing Act isn't marked as public.
As for switch
in particular, I'd ask a designer. My guess is that it is general, and not just for a single customization, but I'm not sure.
Sounds good! I'm mainly running into query parameters where I don't know if they should be public or not. My remaining items are:
switch
in capacitor-lab-basicsexploreNumbers
in make-a-tenscene
in proportion-playgroundshowOuterLonePairs
in molecule-shapes (+basics)I've asked designers for input.
I'm not familiar with the make-a-ten query parameter.
For Capacitor Lab: Basics, it may be generally useful as public, but I would recommend to be conservative--leave it marked as private until we know more or have a specific client request or design discussion.
For Proportion Playground, I think that was designed for debugging.
I'm not sure about molecule shapes.
@samreid I wasn't sure about ?showItemToolboxes
in FAMB, should that be public? https://github.com/phetsims/forces-and-motion-basics/issues/215
Reviewed my sims and updated spreadsheet. Only public param was in energy-skate-park which @samreid marked in https://github.com/phetsims/energy-skate-park/commit/e4fb9273b8162a21e27ba59549493f7963457c7e, thanks!
@jessegreenberg There are no entries in the spreadsheet for FAMB, GAO, and MAL.
@jessegreenberg Oh, I see for GAO and MAL that you just didn't fill in the "JavaScript file" column. I've done that. But FAMB row is totally empty, and it does have ForcesAndMotionBasicsQueryParameters.js.
Thanks! For FAMB I wasn't sure, see https://github.com/phetsims/tasks/issues/1076#issuecomment-769280157.
@jessegreenberg OK. But ForcesAndMotionBasicsQueryParameters.js exists and should be in the spreadsheet, so I've added it.
I didn't see anything for chains
and Optics Lab so I crossed those off
@samreid I wasn't sure about ?showItemToolboxes in FAMB, should that be public? phetsims/forces-and-motion-basics#215
That seems like it should remain private. It has a very specific use when combined with other PhET-iO customizations.
The fractions suite is checked off above but empty in the spreadsheet. I didn't see any files matching "fmquer" so perhaps it doesn't have query parameters, and I didn't see anything in the fractions-common repo. So I'll mark "none" for those on the spreadsheet.
Therefore it seems like this issue can be closed, and we will continue in https://github.com/phetsims/chipper/issues/1002
From https://github.com/phetsims/chipper/issues/1002.
Please go through and verify any public query parameters for your sims by marking them as
public: true
. Then, please update your sims in this spreadsheet: https://docs.google.com/spreadsheets/d/1TddeTtD8zAayJzs02g0fL7dR1iWYczs1CMFdYd3SBNc/edit#gid=0