Problem/Motivation

- Drupal already has a big problem with hard to understand terminology, lets not add to that with this abstract name but pick something more literal and descriptive
- Lets not confuse the general outside-in design principle with this particular application of it. Turning Drupal outside in is not finished because we committed this module.
- Grammar reasons to do with hyphenation, see below.

Follow-up to #2753941: [Experimental] Create Outside In module MVP to provide block configuration in Off-Canvas tray and expand site edit mode.

Outside-in has little meaning to someone who has not followed the conversation about making Drupal editing more 'outside-in" ie. editable from the front end. The module name needs to clearly describe what the module is and does.

Other problems with outside-in include hyphenation. The module is currently labeled as "Outside-In" in the user interface.

Outside-In label

A compound phrase like this should only be hyphenated when used as an adjective before a noun, but "Outside In" is a title. It's not an "outside-in module" (the module itself is not outside in); it is "the Outside In module".

Compare:
"She turned the shirt inside out."
"Let's turn Drupal outside in!"
vs.
"She put an inside-out shirt in the laundry."

References:

Also, the hyphen makes it so that searching for "outside in" on the modules page gives no results.

Searching for 'outside in' has no results

Proposed resolution

Change the name of the module from Outside in to "Settings tray" which is much simpler and more descriptive of what the module is and does.

Remaining tasks

Signoff from module maintainers and grammar nerds. :P

User interface changes

Label changes from "Outside-In" to "Settings Tray".

API changes

N/A; string change only.

Data model changes

N/A.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

xjm created an issue. See original summary.

xjm’s picture

Issue tags: +Novice

A novice contributor can create this patch if others agree.

xjm’s picture

Status: Active » Postponed

And I guess the patch itself should actually be postponed until Outside In lands. (See there? I used it as a proper noun. "Outside-in lands" would be ambiguous and seem to refer to countries that are inside out.) :)

prestonso’s picture

In my mind, the distinction needs to be made between “the outside-in module” (i.e. the module that is outside-in and can be described as outside-in) vs. “the Outside In module” (i.e. the module that is the Outside In module and is known as Outside In). Since "Outside In" here would be a proper noun, I think we can safely refrain from hyphenation as long as the above style is followed.

cilefen’s picture

Why don't we come up with a real name for it? "Outside-in" is what it means to experienced Drupal developers. Most new folks (who are the target audience) will have no idea what this is supposed to mean to them.

davidhernandez’s picture

Yeah, seriously. Why was it named this? Creating more drupalisms. I would have no idea what this module is if I hadn't been following Dries' blog posts and new what was being referred to. (Actually, I hadn't been following these issue and had to read the linked issue to know what this thing did.)

Is this suppose to fall under quickedit? It looks like the parent is part of toolbar. Or maybe this should be under contextual since it looks like it depends on contextual.

xjm’s picture

Those are... also fair points. :)

xjm’s picture

xjm’s picture

Title: Standardize on "Outside In", not "Outside-In" » Standardize on "Outside In", not "Outside-In"... or name the module something else entirely
Issue tags: -Novice
yoroy’s picture

One more for giving this a more straight forward name. Keep in mind that unfamiliar names and words is basically our number one critical ux issue.

timmillwood’s picture

Component: quickedit.module » outside_in.module
cilefen’s picture

Re #3, while we wait, can we come up with a proper name?

cilefen’s picture

Issue summary: View changes
davidhernandez’s picture

Well ... isn't this essentially some sort of administrative ... overlay?

cilefen’s picture

I see what you did there.

nod_’s picture

Status: Postponed » Active

Outside-in is kind of a backward name, contextual actions or simplified overlay would be better.

It's in, setting active.

xjm’s picture

Other things that came up during the prototype development were how closely related this is to Quick Edit conceptually. Contributors repeatedly suggested "Quick Configure" for the contextual link text, but that was wontfixed by an initiative team member: #2784563: Explore "Quick configure" (in contrast to "Quick edit") for the Outside In contextual link to clarify the difference between editing content and configuration

However, for the module name, we could consider things like:

  • Quick Configure
  • Quick Edit Configuration
  • Quick Configure Tray
  • etc.
David_Rothstein’s picture

I also noticed the similarity to Contextual Links + Overlay. One of the reasons those are good names is that they give you a mental picture that roughly corresponds to what the feature looks like.

So I was thinking "Contextual Sidebar" (and then later came across https://plus.google.com/u/0/+ChrisWeber/posts/7WZdmaEotBs?cfem=1 which uses the term "contextual side panel") but perhaps those won't work if it ever winds up being displayed as something other than a sidebar, e.g. on mobile.

"Quick Configure" is nice but it could be confusing to have the module name half-equal to the link text, but not actually equal.

Frankly, the best name for this would be "Quick Edit" (with the current "Quick Edit" module renamed to "Quick Content Edit"), but that requires renaming an existing module... (Or in the long term, merge them into the same "Quick Edit" module with a configuration option to determine what it should be applied to.)

tkoleary’s picture

Contextual Sidebar or Contextual Side Panel"

Good idea but it is too limiting. There is already an issue to create a bottom tray and there is already a region called 'sidebar' so sidebar should be out on two counts.

Simplified Overlay

I think we should avoid anything with overlay, even apart from historical considerations, because the tray doesn't "overlay" anything, it pushes content to the side. It also may expose forms that are not so 'simple'.

Quick Edit Configuration or Quick Configure

Not everything is configuration, there will also be content.

Contextual configuration or Contextual Actions

Not everything in the tray is an action, and actions already describes a specific column in admin UIs. Also contextual is a bit of a mouthful and also technical jargony, not to mention already in use, thus inviting confusion.

Quick Edit, (with quickedit module renamed to "Quick Content Edit")

That's just confusing.

Of all of the above I like quick configure best, but I think we could go even simpler and more everyday.

Here's a few:

  • In-place Settings
  • Front-end Settings
  • Page Settings
  • Page Tools

Or we could choose something even more metaphorical with fewer Drupal overlaps and connotations, but that speaks more to the users need.

  • Toolbox
  • Controls
  • Adjustments
  • Fine Tuning
  • Visual Settings
  • Calibration
  • Access Panel

I love "Access Panel" because it actually summons up a picture of a technician unscrewing an access panel to adjust a machine from the outside in. It also doesn't skew towards either content or configuration, suggest orientation, or promise simplicity which may or may not be there.

Or perhaps simply:

Quick Fix.

Written as a joke but on second thought it might work. :)

prestonso’s picture

#18: I also noticed the similarity to Contextual Links + Overlay. One of the reasons those are good names is that they give you a mental picture that roughly corresponds to what the feature looks like.

#19: I love "Access Panel" because it actually summons up a picture of a technician unscrewing an access panel to adjust a machine from the outside in. It also doesn't skew towards either content or configuration, suggest orientation, or promise simplicity which may or may not be there.

I agree with the notion of allowing users to have a visual picture. To that end, my suggestion would be for Tray (my own vote is for this one) or Pullout.

I also like Access Panel, but unfortunately, that to me connotes roles and permissions, the oblique reference to Panels notwithstanding. This is also why I'm not a fan of Tool Panel. At the risk of introducing even more new terminology, what about something which demonstrates its structural relationship to Toolbar in relation to the page view, like Tool Tray / Tooltray or Tool Board / Toolboard? Toolbox would also fit this bill.

tkoleary’s picture

@prestonso

Tray is good. Short and simple. There is also menu tray in toolbar, though that would only confuse developers, who should know better.

I see your point about "Access" and "Panel". What about "Admin Tray" or "Settings Tray" those solve both problems.

yoroy’s picture

Glad to see consensus that we actually *do* want to change the name. Outside-in is the general design principle, it should not be the name for a specific application of it.

"something tray" seem the best candidates to me (I had "configuration tray", but "settings" is simpler, thus better). All the variations with "quick" in them come from referring to the current/old slow model, I don't think it's useful to have that reference in the name.

"Settings Tray" leaves a lot of room for what can be in it ("Settings"), and is quite explicit in where you might find it ("Tray")

tedbow’s picture

Keep in mind we are planning on separating the “tray” portion of outside in into a core library(no module needed). #2784443: Move off-canvas functionality from Settings tray module into drupal.dialog.ajax library so that other modules can use it

So then naming the module Tray would only describes the functionality that isn’t actually in the module.

re @yoroy:

"something tray" seem the best candidates to me (I had "configuration tray", but "settings" is simpler, thus better).

I like Settings Tray also Admin Tray.

davidhernandez’s picture

I like the Toolbox/Tooltray direction. Aren't we eventually going to use this for content editing as well, which would not fit with "Admin" or "Settings"?

tkoleary’s picture

I like the Toolbox/Tooltray direction. Aren't we eventually going to use this for content editing as well, which would not fit with "Admin" or "Settings"?

Admin does not necessarily connote config over content, eg. content is one of the items in the administrative menu. Settings is Equally generic I think. Tooltray is a bit hard to read and Tool Tray doesn't exactly roll off the tongue either.

I'm going to nominate Admin Tray as the final candidate. Show of hands?

davidhernandez’s picture

Admin does not necessarily connote config over content

I don't feel strongly about it, but I think it does for a lot of people.

If looking generic, then why not Edit Tray. You can edit anything.

tkoleary’s picture

If looking generic, then why not Edit Tray. You can edit anything.

I see the point about admin, but Edit Tray is not the answer, apart from just sounding awkward, It has the same noun/verb problems Preston mentioned above.

More elegant constructions in the same vein would be:

  • Editorial Tray
  • Editing Tray
  • Revision Tray

But those all go a bit too far towards content and away from configuration. We need something more broadly applicable to all of the potential page-level tasks, from editing text to arranging blocks like:

  • Assembly Tray
  • Composition Tray

Also, keep in mind that the only place this will appear in the UI is at /extend, so the primary audience is site builders, not authors or editors. I don't think we want to have something like "Open [blank] Tray" in the contextual links. For that we need something more direct like "Show settings" or just "Open Tray".

davidhernandez’s picture

Also, keep in mind that the only place this will appear in the UI is at /extend, so the primary audience is site builders, not authors or editors.

That's a really good point.

David_Rothstein’s picture

I found "Admin Tray" a bit confusing because it made me think of the tray that's already in the toolbar. (Also, "Admin" is a jargony abbreviation; normally that wouldn't be used in a module name.)

I still think this is a possible future goal:

(Or in the long term, merge them into the same "Quick Edit" module with a configuration option to determine what it should be applied to.)

and therefore it's worth considering names that are compatible with that.

For example, "Quick Edit Plus".

Or... "Quick Edit Tray"?

tkoleary’s picture

@david_rothstein

(Also, "Admin" is a jargony abbreviation; normally that wouldn't be used in a module name.)

Hmm. What about "admin toolbar", "admin menu", "admin role", and just "admin"? I think that your first argument is the stronger.

Also "Quick edit plus" gives the user no clue as to what the 'plus' is. As for 'quick-edit tray' I think that's going to be confusing since there is no part of outside-in that yet extends quick-edit in any way (though we hope there will be).

I keep going back to 'Settings Tray'. Given that there is now consensus on 'Something tray' and at least three of us for 'Settings Tray' can we cut short the bikeshed and settle on Settings Tray?

cilefen’s picture

I feel a Twitter poll coming on...

tkoleary’s picture

@cilefen

I feel a Twitter poll coming on...

Please no. There are enough cooks already in this kitchen. Broadening the discussion to social media will only open the floodgates of uninformed opinion.

Can someone please RTBC "Settings Tray" so we can avoid that?

tedbow’s picture

Status: Active » Reviewed & tested by the community

Agree a twitter won't be helpful.

It seems nobody is against "Settings Tray" so RTBC.

tstoeckler’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs issue summary update

Let's update the issue summary and title then, please.

tkoleary’s picture

Title: Standardize on "Outside In", not "Outside-In"... or name the module something else entirely » Rename Outside-in module to "Settings Tray"
Issue summary: View changes
Status: Needs work » Reviewed & tested by the community
tkoleary’s picture

Issue summary: View changes
tkoleary’s picture

Issue summary: View changes
tkoleary’s picture

Issue summary: View changes
yoroy’s picture

Lets go for it!

naveenvalecha’s picture

+1 to rename it to Settings Tray

webchick’s picture

Assigned: Unassigned » Dries

This is Dries's baby, so he should probably sign off on this name change.

webchick’s picture

Issue tags: +Usability, +sprint
yoroy’s picture

Issue summary: View changes
yoroy’s picture

Added a short executive summary to the issue summary :-)

tstoeckler’s picture

Thanks @tkoleary amd @yoroy, that's great!

Dries’s picture

I think 'Settings tray' is a good name. We don't typically use titlecase in Drupal so I'd go for 'Settings tray' instead of 'Settings Tray'.

webchick’s picture

Assigned: Dries » Unassigned
Status: Reviewed & tested by the community » Needs work

Great, thanks.

This will need a re-roll in response to recent commits.

tkoleary’s picture

@webchick

This will need a re-roll in response to recent commits.

It will need a 'roll', there's no patch yet. :)

xjm’s picture

Status: Needs work » Active
xjm’s picture

We don't typically use titlecase in Drupal so I'd go for 'Settings tray' instead of 'Settings Tray'.

Actually this is incorrect. We do not title-case headers. We do title-case module names and other proper nouns since 2011 or so. :) All module names in core are title cased, e.g., "The Foo Bar module".

tkoleary’s picture

Status: Active » Needs review
FileSize
7.2 KB

Now there's a patch.

tkoleary’s picture

@xjm

All module names in core are title cased, e.g., "The Foo Bar module".

Rerolling

tkoleary’s picture

No interdiff. it wouldn't look much different from the patch anyway. :)

Also changed 'side tray' to 'slide-out tray' in the same help string since it may not always come from the side.

xjm’s picture

We should eventually rename the module as well (and can do so as long as it is experimental), but I'm undecided about whether it's worth the risk with only a couple weeks left to 8.2.0.

Let's change the module name in all UI strings in this issue, and create a followup to rename the module itself and its classes/APIs/etc. Using the intended label in the keynote, release announcement, etc. will help us communicate about the feature and is low-risk.

Edit:
@tkoleary, Dries already signed off on the other name; let's confirm his signoff before changing that decision?

Edit 2: Ah, I see, this is just referring to words in a code comment and not the module name itself.

xjm’s picture

Also, all #53 changes is code comments, without actually changing the name of the module presented in the UI? Never mind; I see now.

cilefen’s picture

Re #55, #53 changed the name in the .info. Do you mean something else?

The last submitted patch, 51: 2782803-outsidein-49.patch, failed testing.

xjm’s picture

@cilefen, no, just need my eyes checked. ;)

tedbow’s picture

Ok. here is a patch that just made sure there was no occurrences of "Outside-In" or "Outside In" in the module left after patch in #53 unless it was direct commenting on a variable that was using OutsideIn in the variable name.

Also changed @group for a test from "Outside-In" to outside_in b/c that is what all other tests were using and other modules seemed to use machine name.

cilefen’s picture

Title: Rename Outside-in module to "Settings Tray" » Rename Outside-in module to "Settings Tray" in the UI and in comments
Gábor Hojtsy’s picture

Status: Needs review » Reviewed & tested by the community

On first sight, this was strange to me, since Drupal calls the things this tool edits configuration (and not settings). The system managing them is configuration management, the admin area is Manage > Configuration, etc. Not settings. But then I read the above discussion saying that sounds too complicated and then @Dries signed off on this as well. So since otherwise it looks good, let's get this in.

Gábor Hojtsy’s picture

Also btw this does edit things that are not settings/configuration like order and display of menu items already, so its not black and white...

tkoleary’s picture

On first sight, this was strange to me, since Drupal calls the things this tool edits configuration (and not settings). The system managing them is configuration management, the admin area is Manage > Configuration, etc.

Yes, the goal of "settings" was to be less specific than "Configuration" because there may be content level stuff in the tray as well.

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Ok, the remaining uses of "Outside-In" seem to be code related and we're not touching those right now.

Committed and pushed to 8.2.x and 8.3.x. Thanks!

  • webchick committed 1ffb177 on 8.2.x
    Issue #2782803 by tkoleary, tedbow, xjm, cilefen, yoroy, davidhernandez...

  • webchick committed 8fca126 on 8.3.x
    Issue #2782803 by tkoleary, tedbow, xjm, cilefen, yoroy, davidhernandez...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

Gábor Hojtsy’s picture

Issue tags: -sprint
tedbow’s picture

Component: outside_in.module » settings_tray.module

Changing to new settings_tray.module component. @drpal thanks for script help!