workflow-swift icon indicating copy to clipboard operation
workflow-swift copied to clipboard

Rename the split pane machinery to Overview / Detail

Open rjrjr opened this issue 5 years ago • 14 comments

Master / Detail is not great terminology.

rjrjr avatar Jun 04 '20 20:06 rjrjr

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.

bencochran avatar Jun 04 '20 20:06 bencochran

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 avatar Jun 04 '20 20:06 rjrjr

Parent / Child?

rjrjr avatar Jun 04 '20 20:06 rjrjr

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.

rjrjr avatar Jun 04 '20 21:06 rjrjr

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."

zach-klippenstein avatar Jun 04 '20 21:06 zach-klippenstein

Yeah, nonstarter.

Well so far I think I like Main better than Index

rjrjr avatar Jun 04 '20 21:06 rjrjr

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

zach-klippenstein avatar Jun 04 '20 21:06 zach-klippenstein

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

zach-klippenstein avatar Jun 04 '20 22:06 zach-klippenstein

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

rjrjr avatar Jun 05 '20 17:06 rjrjr

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 avatar Jun 05 '20 18:06 zach-klippenstein

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.

zach-klippenstein avatar Jun 05 '20 22:06 zach-klippenstein

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.

rjrjr avatar Jun 08 '20 17:06 rjrjr

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

bencochran avatar Jun 08 '20 17:06 bencochran

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

zach-klippenstein avatar Jun 08 '20 18:06 zach-klippenstein