Make General settings page extensible

[MikeAlhayek]

Currently, the General settings page does not allow us to add more settings to it. With this simple change, anyone that wants to add settings to the general settings is able to using drivers. The UI itself did not change.

To extend these views, create a new display driver using "general" as the group id. Then place your custom settings into one of the 3 existing tabs or a new custom tab. Here is an example to inject a custom settings from MyCustomSettings class into a new tab on the general settings called "New Tab"

public class MyCustomSettingsDisplayDriver : SectionDisplayDriver<ISite, MyCustomSettings>
  {
      public override IDisplayResult Async(MyCustomSettings settings)
      {
          Initialize<SiteSettingsViewModel>("MyCustomSettings_Edit", model => {
              //...
          }).Location("Content:1#New Tab;40")
          .OnGroup(DefaultSiteSettingsDisplayDriver.GroupId); // Or "general" if you prefer a string
      }
  }

[jtkech]

For info we already have the OC.CustomSettings module.

[MikeAlhayek]

yes we do. But there are times when a users want to add ISite settings directly to the general settings. The settings menu is super long and this could help.

[hishamco]

We need to change settings views to react to the code suggestion

[hishamco]

Suggested change

	Initialize<SiteSettingsViewModel>("SettingsResources_Edit", model => PopulateProperties(site, model))
	Initialize<SiteSettingsViewModel>("Settings_Resources_Edit", model => PopulateProperties(site, model))

[MikeAlhayek]

not sure what would the file name be if we changed it as suggested. SettingsResources_Edit > SettingsResources.Edit.cshtml.

[jtkech]

As I remember _ becomes a dot . and a double underscores __ becomes a dash -.

So Settings__Resources_Edit with double underscores would have been resolved to Settings-Resources.Edit.

But I think that here _Edit is considered as the display type, if so the convention is to place the display type just after the shape base type, this because the display type is discovered as the first element separated with a _, this allows to add other elements separated with a _, then when converted to a file name it is moved to the end.

So Settings_Edit__Resources would have been the right template name and still resolved to Settings-Resources.Edit.

[MikeAlhayek]

Thanks you! I'll try it

[MikeAlhayek]

@jtkech Indeed that worked!

What about the wrapper name? Would we change GeneralSettingsWrapper? How can we generate GeneralSettings.Wrapper.cshtml?

[jtkech]

Only from memory so should be tried.

GeneralSettings_Wrapper => GeneralSettings.Wrapper

GeneralSettings_Wrapper__OtherTerm => GeneralSettings-OtherTerm.Wrapper

Hmm, maybe in TheBlogTheme there is a wrong file name Widget.Wrapper-Zone-HeadMeta.liquid, maybe it should be Widget-Zone-HeadMeta.Wrapper.liquid.

[MikeAlhayek]

not sure what that shape is or does. maybe a separate PR.

[jtkech]

Yes, was just for info when I saw it

[sebastienros]

Demo (discussion) on Tuesday