Orchard.Framework - Using GroupInfo() class generates urls with spaces in it

[rtpHarry]

The GroupInfo class is used to represent a settings part in the menu.

If the settings part has a space in the name then the url does too:

context.Metadata.EditorGroupInfo.Add(new GroupInfo(T("Audit Trail")));

Results in /Admin/Settings/Audit Trail/ which works but isn't correct.

From my simple testing .HtmlClassify() seems to create a better url.

Is there a more appropriate helper method tucked away somewhere in Orchard? If not I will create a PR.

[sebastienros]

Question is whatever the encoding is, how will the route be matched back.

[rtpHarry]

I didn't understand this comment in the triage. Under the hood the class uses the .Id but just gets it from the supplied Name, which can have spaces:

    public GroupInfo(LocalizedString name) {
        Id = name.TextHint;
        Name = name;
    }

In my shape tracing modification I do this to combat the space in the url:

        var groupInfo = new GroupInfo(T("Shape Tracing"));
        groupInfo.Id = "ShapeTracing";

And the url is just /Admin/Settings/ShapeTracing.

However, to automate it I'm suggesting:

    public GroupInfo(LocalizedString name) {
        Id = name.Text.HtmlClassify();
        Name = name;
    }

Which makes the Name "Shape Tracing" into /Admin/Settings/shape-tracing.

So all of the other admin settings urls will go lower case and dashes, etc, but they will be valid css class format so therefore valid urls. Nobody should be linking directly to the settings pages anyway, they should be using url helpers but even if they do any single words will still work as windows urls aren't case sensitive.

So the question is - does anyone know of a better helper method in Orchard that will url-ify a string or should I create the PR with .HtmlClassify()?

[rtpHarry]

Side question - Whats the reason for this?

It seems that modules use two different ways to add their entries to the settings menu:

1. Creating a GroupInfo class instance and registering it as part of a SettingsPartHandler in the GetItemMetadata() for example:

   protected override void GetItemMetadata(GetContentItemMetadataContext context) {
       if (context.ContentItem.ContentType != "Site")
           return;
       base.GetItemMetadata(context);
       context.Metadata.EditorGroupInfo.Add(new GroupInfo(T("Search")));
   }
   

2. Using the AdminMenu.cs method:

   public void GetNavigation(NavigationBuilder builder) {
       builder.Add(T("Settings"),
           menu => menu.Add(T("Indexes"), "5", item => item.Action("Index", "Admin", new {area = "Orchard.Indexing"})
                   .Permission(StandardPermissions.SiteOwner)));
   }
   

The menu is technically being managed by the Orchard.Settings module with the GroupInfo mechanism but then other modules are pushing their way in with the AdminMenu.cs approach.

It seems the GroupInfo solution is redundant as you cannot add sub menus and localnav with it but AdminMenu you can.