Unity Terms & Capitalization

[greystar93]

I'm questioning that every term in this section is capitalized. From a few quick searches, the Unity documentation seems to be just as inconsistent as Apple for many of these terms.

We need to be both judicious with our use of capitals and consistent with our decision making—for example, if we use lowercase label and image view, we should probably use lowercase scene and animation view. If we use lowercase project navigator, we should probably use lowercase project browser.

Remember, just because something is capitalized in a menu doesn't mean it should be capitalized in text. Generally everything in a menu is in caps.

Re: GameObject, I would style as either GameObject or game object.

Thoughts?

[greystar93]

@crispy8888 @wlinc I'm guessing the iOS Games 3D book involves these Unity terms. Can you guys take the lead on determining the appropriate case of these terms as you edit, and updating the guide?

[VegetarianZombie]

Hey guys, some of the capitalization terms feel natural while others definitely feel forced. The one consistent capitalization was GameObject. The rest tend to be a mixed bag. I'm flexible as to how these should be approached, but we have to be clear with our conclusions so the rest of the team can follow suit.

On Tue, Aug 18, 2015 at 10:45 AM, B.C. Phillips notifications@github.com wrote:

@crispy8888 https://github.com/crispy8888 @wlinc https://github.com/wlinc I'm guessing the iOS Games 3D book involves these Unity terms. Can you guys take the lead on determining the appropriate case of these terms as you edit, and updating the guide?

— Reply to this email directly or view it on GitHub https://github.com/raywenderlich/english-style-guide/issues/7#issuecomment-132236619 .

[greystar93]

@VegetarianZombie @crispy8888 @wlinc

Thanks, Brian—I agree. Also, like I said, I think it's important to be consistent with the way we case non-Unity terms. With that in mind, I suspect the only terms here that should be capitalized are GameObject and possibly Unity Editor (or Unity editor?), and of course UI. But I probably won't be working with these terms this cycle, so you guys decide!

[crispy8888]

I'm still eyeballs-deep in i9t and other pieces of work, but once we ramp up on iGT2 I'm planning to look at the Unity documentation and other major sites that deal with Unity and make my comments then.

[ceo-nada]

Ha! A year later and the struggle is still real.

@crispy8888 @greystar93 @VegetarianZombie

For the sake of posterity, I'm posting what seems to be consensus about capitalization and convention from a Slack group.

1. Component is not capitalized by default
2. The name of the component is capitalized by default, effectively making it a proper noun; common sense would imply we follow the same convention for 'scenes' and anything else that falls into the bucket.
3. Authors should have the reader rename new components to avoid confusion between component names and generic references
4. scene and coroutine are capitalized according to the existing guidelines, but perhaps this should be revisited

Via @BlackDragonBE` I think some conflicts are caused because of the generic names of some components

[8:29]
camera for example

[8:29]
if the unity component was called UnityCamera then it would be clear what to use and when

[8:32]
"The camera can be set to view more of the screen at once by increasing the Field Of View of the UnityCamera component" "The camera can be set to view more of the screen at once by increasing the Field Of View of the Camera component"`

And from earlier in the discussion: So all GameObjects should be given proper names that reflect their purpose, starting with their role then their type e;g. GroundCollider, NextButton, PreviousButton, HeroAnimator

via @abgtan

`1. Capitalization of commonly used terms in Unity like component, scene, camera

2. Give proper names for GameObjects. These names should (1) reflect their purpose and (2) not conflict with component and/or script names

[8:19]
The script for the MainMenu GameObject should not be called MainMenu.cs for example

[8:19]
because then we’d refer to MainMenu as both a GameObject and a component`

[ceo-nada]

I propose that 'view' follow the same capitalization convention as suggested above; correct: Game view, Scene view, incorrect: move the View, switch to the Scene View.

Casual references to views should then be lowercased, like this: The Profiler view allows you to analyze your game while it’s running. Unfortunately, the profiler is also blocking the Game view.