phetsims / brand Goto Github PK

The 'master' and 'adapted-from' branches of phetsims/brand are currently very broken. Opening the AboutDialog prints numerous errors to the console.

From #11:

• Revisit the readme.md in https://github.com/phetsims/brand
• Maybe put a note that PhET is trademarked and can only be used with the expressed written consent.
• Put a comment in the phet brand that this is “hands off” federal trademarked one.

Identified by print-branches.sh. Please describe.

It makes sense for us to suggest (and possibly even enforce) the logo height since it will appear in the navbar, but we should lift the restriction of the required width as well.

See phetsims/joist#382

This branch contains the "PhET" brand. It was migrated from phetbrand/brand 'master' branch.

'phet' and 'interoperable' branches use this URL for licensing in Brand.js:

url: 'http://phet.colorado.edu/en/html-terms-privacy-and-licensing'

When the website is updated, this should be change to the new URL.

8/6/15 dev meeting:
The public-facing logo for interoperable brands will be something like "PhET IO" or "PhET.io". And it would be nice to have "phet" in the names of brands that are for exclusive use by PhET. So we'll rename the 'interoperable' brand to 'phet-io'.

In #33 @amanda-phet converted the logos to use TM. Kathy said:

We will do a maintenance release. To be scheduled - we were waiting until past the January deadline, but now that is the time. It should be brought up in dev meeting tomorrow.

Some questions:

1. Timeline, priority and assignee (see also phetsims/perennial#110 )
2. Will this be for PhET-iO simulations as well, or can they be skipped?

@kathy-phet requested that we have an intermediate option for branding that says something like "adapted from" and the PhET logo in black and white (slightly different than shown in the email below)

We also want to make clearer for users when and how they show brand our sims when they for them.

Kathy's email is copied below for reference:

Hi Sam,

I just got off Skype with ----.

He is largely using our sims as is, and is planning to make only very small changes from the original design. In build an atom for instance his publisher wants to add another ring to the atom so their are 3 levels instead of just 2. He changed the brand based off of our text in the "Brand" repo. He recommended we add some text there describing in more detail about when changing the brand was appropriate, and when it was not.

My recommendation is that we provide folks like him with an intermediate that says something like this ...

And we make some change in what the "About" dialog says something similar.

He is working for a company called ------------- in Spain. --------- seemed to very much want to do what ever we would prefer and then present that to his company.

So we should discuss how to proceed.

He is interested in using all of the simulations we already have ... he even mentioned some that are not done. I mentioned that we would really want him to hold off on publishing sims that have not fully gone through our testing process. He seemed interested in helping out in terms of fixing bugs and such. I'm not sure of his skill level, but he says he has learned so much by looking at how we do our "magic".

He has forked everything, I believe. You can find his git hub account below in the chat feed.

He also made a translation utility below for his publisher ... he would be happy to share with us, if helpful at all. He has several languages he needs these to be in.

Best,
Kathy

This branch is created for managing changes in the About Dialog required for together simulations. See https://github.com/phetsims/together/issues/60

@amanda-phet and @arouinfar - we should discuss some options for branding sims that have been outfitted with data collection.

@kathy-phet has suggested some modification of the PhET logo that includes the word "data" -- something that implies "PhET + data collection". If we come up with a preliminary idea, we can ask @mariahphet to implement it.

Brand.js has a {boolean} adaptedFromPhET field that indicates whether the brand is adapted from PhET. That fields is explictly present in the "adapted-from" branch (adaptedFromPhET: true), but is missing from master and phetbrand/brand/js/Brand.js. It should be explicitly set (adaptedFromPhET: false), so that we know that the property exists.

See phetsims/joist#348

@samreid or @jbphet Can you please document this branch?

@ariel-phet @amanda-phet and I discussed having some sort of animation on the loading screen. I'm thinking about something simple like rotating between "Loading" "Loading." "Loading.." and "Loading..."

Assigning to myself.

Found while testing builds for review of phetsims/joist#163. Logo images have the error "missing-license.json". For phetsims/chipper#181, I notice that only the phet branch received the txt -> json conversion.

@samreid should interoperable and adapted-from-phet branches have the same (or similar) txt -> json license conversion?

Decide what to call this brand.

Missing are:

README.md
.gitignore
LICENSE
package.json
Gruntfile.js

I realize that some of these moved into subdirs. But we should still have these at top-level.

7/16/15 dev meeting: phet and interoperable brands should have both PhET team credits and Translation Credits.

PhET team credits will be done via logic in AboutDialog.js, `if ( Brand.id === 'phet' || Brand.id === 'interoperable' )

Translation Credits will be done via "links" field in Brand.js.

The PhET says ® on it in the 'About' screen. We still want to indicate that this is our trademark so change that line to read ...

PhET™ Interactive Simulations

I also reviewed the link to Terms, Privacy, and Licensing, and while that says we are a registered trademark, I think it is fine. We are registered, and people should know that. The main issue is that our sims our used in so many places we don't want the R symbol to be viewed as a marketing piece in these countries, and violate local laws. This webpage lives on our website, served from our country.

After moving things out of branches into master, we broke convention of having the "js" directory at the top level. This means lint won't work out of the box. We should find a way to lint the brand things.

As reported in the Google Group, the transpiler doesn't visit unknown brands: https://groups.google.com/g/developing-interactive-simulations-in-html5/c/m8VAhpZsC90

This makes it difficult for 3rd parties to add their own branding.

I'm on macbook air using a full size (but not full screen) chrome, with the dock showing, and the circle-r is very very tiny! Looks indecipherable at this size.

@kathy-phet requested that all instances of the registered logo be replaced with a trademarked logo.

I will update the asset files in this repo (phet and adapted from phet, since phet-io already uses TM) and png files and commit.

After publishing Unit Rates 1.0.0, I noticed that the copyright in the About dialog is out of date. It still says "Copyright 2004-2016". This will be wrong for any sims published so far in 2017 (Make A Ten, States Of Matter, States Of Matter: Basics,...) The copyright currently lives in the brand repository, so adding this issue here.

There are 2 problems:

(1) How to keep the copyright up-to-date in brand. For now I will update the files.

(2) How to get the correct copyright date in maintenance releases. Maintenance releases will currently be using some snapshot of the brand repository. If that repository is earlier than the current year, then the copyright shown in the About dialog of the maintenance release will be incorrect. For example, see Arithmetic 1.0.7 currently live on the PhET website. It's About dialog shows that it was built on 2017-03-07, but the copyright is "2004-2015" (from its version of brand).

Both of the above problems could be solved by having the build process insert the current year in the copyright.

Assigning to @ariel-phet to assign and prioritize. Also labeling for discussion at developer meeting.

As noted in phetsims/joist#258 (comment), the logos for the 'interoperable' brand are currently the same as the 'phet' brand. According to @ariel-phet this should be changed.

It has been difficult to develop within the brand repository with everything in different branches. As @pixelzoom put it, branches are an inappropriate technology to use to solve this problem. At our recent developer meeting, we decided to move the brand branches all to master and use query parameters to specify the brand in requirejs mode, and build-local.json + grunt options (latter overrides former) for builds. Here are our notes from the developer meeting (sorry formatting was lost):

SR: How can we move all brands into master? Chris has been moving into a single repo, it also seem like getting things into master would also be a good move, but we just aren’t sure how it can technically be done (defaulting to empty brand, easy for phet developers to use phet brand, but somewhat more difficult for 3rd parties to use phet brand. We can picture how this would be easy for builds, but not for the requirejs mode.
CM: phetsims/tasks#256
JO: grunt checkout-master(?), does it do brand?
CM: what is checkout-master?
How about a gitignored (template) file in brand? And a sensible default if that file is not there.
var b = require(‘BRAND/brand’);
That would error out.
just do XHR to get the file.
what about preload?
That would error out too.
SR: imagine a new repo “brand-choice”, that only has a single file with a single word selecting the desired brand.
brand-choice/
brand.json
brand/
phet/
unbranded/
interoperable/
adapted-from-phet/
my-company-name/
splash.png
…
CM: We could use a query parameter for requirejs mode.
We could put ?brand=phet in phetmarks
JO: We would want to make sure to strip that out for builds, so people can’t substitute phet brand at runtime in built sims.
JO: Should we only check for updates if running the phet brand?
SR: I think so.
CM: Can we make the PhET the default brand?
JO: I don’t think so.
SR: I don’t think so either.
SR: What about “Adapted from PhET” as the default brand?
JB: Let’s ask on Thursday what the default brand should be

Here's what doc looks like for Brand.js fields in 'master':

  return {
    name: null, // {string} For example: 'My Company'
    copyright: null, // {string} For example: 'Copyright © 2014, My Company'
    links: null, // {Object[]} For example: { text: 'My Company Support', url: 'https://www.mycompany.com/support' }
    adaptedFromPhET: false // {boolean} is this brand adapted from PhET?
  };

This tells us nothing about where these strings and links will actually appear, what happens when adaptedFromPhET is true, etc. One must resort to searching the code for occurrences of these fields. For example, only by searching for "links" did I discover that the links are added to the bottom of the About dialog.

Running in RequireJS without specifying brand still shows the PhET splash screen. The navbar shows "Adapted from PhET". What logo would a built version have? Did this break recently? Assigned to developer-meeting unless some brave soul volunteers before then.

After moving things out of branches into master, we broke convention of having the "js" directory at the top level. This means lint won't work out of the box. We should find a way to lint the brand things.

See phetsims/tasks#378

Broke this issue out of #13.

Until all brands are in master, this means moving the 'adapted-from-phet' branch to master.

JB (Requires KP): What should the default brand be for someone that just checks out our sim? Right now it is blank.
SR: An alternative would be “adapted from PhET”
Everyone agreed “adapted from PhET” would be a good new default
Revisit the README.md in https://github.com/phetsims/brand
Maybe put a note that PhET is trademarked and can only be used with the expressed written consent.
Put a comment in the phet brand that this is “hands off” federal trademarked one.

The "together" branch contains the brand for interoperable PhET sims. It was migrated from phetbrand/brand 'together' branch.

Should version number?

Should we append sim title with (adapted)

Other changes?

Link to the phet website?