neos / neos-seo

A package to bundle SEO-related functionality for Neos.
GNU General Public License v3.0
13 stars 36 forks source link

ENHANCEMENT: Improve confusing UX for title and titleOverride #185

Open rolandschuetz opened 5 months ago

rolandschuetz commented 5 months ago

Current Behavior

I have interviewed several editors, and the behavior of "Title" vs. "Title Override" is for non-developers completely unclear. This makes sense, since it's not explained and an integration detail. SEO experts I talked to recommend to set both with different namens, but "override" sounds like you are doing something dangerous.

Bildschirmfoto 2024-03-29 um 20 52 08

Recommended Behavior

Let's change the labels and also use the same placeholder logic as in the open graph data:

Bildschirmfoto 2024-03-29 um 20 56 13

The title placeholder generation might need to be adjusted, see https://github.com/neos/neos-seo/issues/186

Code override to test

'Neos.Neos:Document':
  properties:
    title:
      ui:
        label: 'Title in menus'

'Neos.Seo:TitleTagMixin':
  properties:
    titleOverride:
      ui:
        label: 'Title in the browser window'
        help:
          message: 'This title is displayed in the browser window and in search engines. It is set as the <title> tag in the HTML.'
        inspector:
          editorOptions:
            placeholder: 'ClientEval: node.properties.title'
'Neos.Neos:Document':
  properties:
    title:
      ui:
        label: 'Seitentitel im Menü'

'Neos.Seo:TitleTagMixin':
  properties:
    titleOverride:
      ui:
        label: 'Seitentitel im Browserfenster'
        help:
          message: 'Dieser Titel wird im Browserfenster und in Suchmaschinen angezeigt. Dazu wird er im HTML als <title> Tag gesetzt.'
        inspector:
          editorOptions:
            placeholder: 'ClientEval: node.properties.title'

Open questions

Should we override the document title in the SEO package or where to put this change?

mficzel commented 5 months ago

I agree that „title override“ is confusing but would prefer to only adjust the label of the title override field.

How about: „Special Title for Browserwindow“

Sebobo commented 5 months ago

When I discuss with editors what labels they want to have adjusted we usually chose "SEO Title" for this. Because that's what they care about. In a small tab you anyway cannot read anything beside the hostname. I think in WP it's the same label.

rolandschuetz commented 5 months ago

I think SEO-Title would be a big improvement. The point of "Title" it then still unclear, which is not optimal.