Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template Part details panel: Add semantic descriptions #48777

Closed
jameskoster opened this issue Mar 6, 2023 · 10 comments
Closed

Template Part details panel: Add semantic descriptions #48777

jameskoster opened this issue Mar 6, 2023 · 10 comments
Labels
[Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") [Type] Enhancement A suggestion for improvement.

Comments

@jameskoster
Copy link
Contributor

#48732 will add a basic detail to this panel: The original author of the template part.

We can expand this a lot in the future, and even offer some edit actions (rename, reset, etc).

In the short term it might be nice to add some more flavor by describing semantic areas when appropriate. Here's a rough example:

Screenshot 2023-03-06 at 11 54 29

@jameskoster jameskoster added Needs Design Needs design efforts. [Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") labels Mar 6, 2023
@jameskoster
Copy link
Contributor Author

jameskoster commented Mar 6, 2023

Here are some ideas for descriptions:

Headers
This Template Part is a Header, which typically includes the site title, logo, and main navigation menu. You can have multiple headers; for example, the blog archive template may have a simple header design while the single post template may feature a more elaborate one, including the Post Featured Image.

Footers
This Template Part is a Footer, which typically includes credits, social links, and other contact details. You can have multiple footers; for example, you might want a simpler footer on your Contact page template to avoid repeating page content.

General template parts
This is a generic template part unrelated to any specific area within a page. Generic template parts can have various uses; for example, Displaying a Post summary for use in blog archive templates. Or displaying comments on both the Post and Page templates.

@jameskoster jameskoster added Needs Design Feedback Needs general design feedback. and removed Needs Design Needs design efforts. labels Mar 6, 2023
@ndiego ndiego moved this to ❓ Triage in WordPress 6.2 Editor Tasks Mar 6, 2023
@richtabor
Copy link
Member

richtabor commented Mar 6, 2023

Template Part

Should "Template Part" be capitalized? I don't think so.

single post template

But I do think we should capitalize specific templates/template parts. We should also use terms directly referencing the template names when we call out other templates. In this example, I'd use "Single" template, as that's what we call it in the Site Editor.

the blog archive template

Maybe "the Blog's Archive template" perhaps? Not sure, but I do like connecting Archive with Blog.

@richtabor
Copy link
Member

Perhaps there's an opportunity to detail what template parts are.

Something like:

This template part is a Header, which typically includes the site title, logo, and main navigation menu. Template parts are smaller, reusable parts of your site. Personalize this template part or make a new one.

You can have multiple headers; for example, the Blog template may have a simple header design while the Single template may feature a Post Featured Image block for added imagery.

@jameskoster
Copy link
Contributor Author

Should "Template Part" be capitalized? I don't think so.

I'm never sure on these things. Looking at the copy here, I guess not.

Perhaps there's an opportunity to detail what template parts are.

I thought about that, but we do have the Template part panel itself which already does this to some extent, so I was worried it might be a bit repetitive?

@kathrynwp kathrynwp added the [Type] Enhancement A suggestion for improvement. label Mar 7, 2023
@ndiego ndiego moved this from ❓ Triage to 🐛 Punted to 6.2.1 in WordPress 6.2 Editor Tasks Mar 8, 2023
@jameskoster jameskoster moved this to Needs design in 6.3 Design Mar 22, 2023
@jameskoster jameskoster moved this from Needs design to Needs feedback in 6.3 Design Mar 22, 2023
@jameskoster jameskoster moved this from Needs feedback to Needs dev in 6.3 Design Mar 22, 2023
@jameskoster jameskoster added Needs Dev Ready for, and needs developer efforts and removed Needs Design Feedback Needs general design feedback. labels Mar 22, 2023
@Mamaduka Mamaduka moved this from 🐛 Punted to 6.2.1 to 🦵 Punted to 6.3 in WordPress 6.2 Editor Tasks Apr 13, 2023
@apeatling
Copy link
Contributor

Is the copy finalized for these? I was going to work on adding.

@jameskoster
Copy link
Contributor Author

I think we could start with the suggestions in #48777 (comment) and refine in the PR if required.

@ndiego
Copy link
Member

ndiego commented Jun 12, 2023

Hey @jameskoster, just checking in as this issue is on the 6.3 Project Board, and I do not see any recent activity. Are we still aiming for 6.3 with this? Thanks!

@jameskoster
Copy link
Contributor Author

Ideally, yes. But this is just one small detail among a host of other improvements to be made in this panel, the full details of which can be seen in #50395. So if you'd like to close this issue in favor of that one, please feel free.

@ndiego
Copy link
Member

ndiego commented Jun 13, 2023

Great, thanks @jameskoster. I will close this in favor of #50395. By Beta 1 (6/27), we should consider adding all remaining items on 6.3 Design to the 6.3 Project Board (they can be on both boards) as that will be the main board that the Editor Triage Team, and the Editor Tech Leads will be working off of.

@ndiego ndiego closed this as completed Jun 13, 2023
@github-project-automation github-project-automation bot moved this from ❓ Triage to ✅ Done in WordPress 6.3.x Editor Tasks Jun 13, 2023
@jameskoster
Copy link
Contributor Author

Apologies, I linked to the wrong issue. #50392 is the one I was looking for.

@apeatling apeatling moved this from Needs dev to Done in 6.3 Design Jun 27, 2023
@priethor priethor removed the Needs Dev Ready for, and needs developer efforts label Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") [Type] Enhancement A suggestion for improvement.
Projects
Status: Done
Development

No branches or pull requests

6 participants