Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the split pane machinery to Overview / Detail #14

Open
rjrjr opened this issue Jun 4, 2020 · 14 comments
Open

Rename the split pane machinery to Overview / Detail #14

rjrjr opened this issue Jun 4, 2020 · 14 comments

Comments

@rjrjr
Copy link
Collaborator

rjrjr commented Jun 4, 2020

Master / Detail is not great terminology.

@bencochran
Copy link
Collaborator

Agreed.

We’ve used “leading” and “trailing” for this in our Swift sample version. That has a bit of layout-y-ness to it though.

@rjrjr
Copy link
Collaborator Author

rjrjr commented Jun 4, 2020

Main / Detail? Works a bit better with Kotlin's MasterDetailScreen, where the master slot is the non-optional one:

class MasterDetailScreen private constructor(
  val masterRendering: BackStackScreen<Any>,
  val detailRendering: BackStackScreen<Any>? = null,
  val selectDefault: (() -> Unit)? = null
) {

Still not great. :/

@rjrjr
Copy link
Collaborator Author

rjrjr commented Jun 4, 2020

Parent / Child?

@rjrjr
Copy link
Collaborator Author

rjrjr commented Jun 4, 2020

Found this in Learning Programming Using Visual Basic .NET:

As an alternative to the terms master and detail, we sometimes use the terms parent and child.

@zach-klippenstein
Copy link
Collaborator

Parent/child are so overloaded, that seems like it could be more confusing than anything. Especially in a sentence like "The ParentChildContainer has two child screens – one is the parent screen, and the other is the child screen."

@rjrjr
Copy link
Collaborator Author

rjrjr commented Jun 4, 2020

Yeah, nonstarter.

Well so far I think I like Main better than Index

@zach-klippenstein
Copy link
Collaborator

The main screen is almost always a navigation screen, but there are probably too many exceptions to name it something navigation-related.

@zach-klippenstein
Copy link
Collaborator

Some ideas in this thread: https://twitter.com/zachklipp/status/1268646364625293312?s=20

@rjrjr
Copy link
Collaborator Author

rjrjr commented Jun 5, 2020

From the Twitter thread, I like Overview / Detail a lot.

@zach-klippenstein
Copy link
Collaborator

zach-klippenstein commented Jun 5, 2020

I think the Detail terminology is pretty settled. So let's vote on the other one:

  • 👍 Main
  • 👎 Overview
  • 😄 List
  • 🎉 Summary
  • 😕 Topic
  • ❤️ Root
  • 🚀 Primary (with Secondary for detail)
  • 👀 Index

Please react on this message with your vote!

@zach-klippenstein
Copy link
Collaborator

One of the arguments for Primary/Secondary is that it opens the possibility for other screens, like Tertiary, etc. I personally am not a huge fan, since it's using very generic words to refer to a very specific layout pattern.

@rjrjr rjrjr changed the title Rename the split pane machinery to Index / Detail Rename the split pane machinery to ??? / Detail Jun 8, 2020
@rjrjr
Copy link
Collaborator Author

rjrjr commented Jun 8, 2020

I strongly dislike Primary / Secondary. It implies a genericness that is misleading — there's a reason we didn't call this SplitPaneContainer. And WRT to a theoretical Tertiary in our future, YAGNI applies to naming as much as anything else.

@bencochran
Copy link
Collaborator

I like Overview/Detail over Main/Detail since one many contexts the detail screen is the “main” thing I’m interacting with.

@zach-klippenstein
Copy link
Collaborator

We've discussed offline, and reached a majority agreement on the terms Overview/Detail.

@zach-klippenstein zach-klippenstein changed the title Rename the split pane machinery to ??? / Detail Rename the split pane machinery to Overview / Detail Jun 8, 2020
zach-klippenstein referenced this issue in square/workflow Jun 8, 2020
@zach-klippenstein zach-klippenstein transferred this issue from square/workflow Jun 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants