[ New Inline Format ] Introduce Inline Time Format for improved SEO and accessibility by sarthaknagoshe2002 · Pull Request #67751 · WordPress/gutenberg

sarthaknagoshe2002 · 2024-12-09T16:05:07Z

Partial Fix for : #54488

What?

This PR introduces a Time Inline Format to display time or date information with machine-readable formatting using the <time> element.

Why?

The <time> element with the datetime attribute improves machine-readability, providing better SEO and more accurate metadata for search engines.
While similar functionality exists in core blocks like Post Date or Latest Comments, these options are tied to specific content. This new feature allows inline time representation without creating additional content types.

How?

Enables inline application of <time> formatting within text, like in a Paragraph block.
Cleans & adds the selected value in the datetime attribute.

Testing Instructions

Add text in a Paragraph block.
Apply the Time Inline Format to a portion of the text and configure the datetime attribute.
Verify the inline time is applied with accurate attributes.
Confirm output improves metadata and accessibility in SEO-related tools.

Screenshots or screencast

Inline.time.format.mov

github-actions · 2024-12-09T16:05:20Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: sarthaknagoshe2002 <sarthaknagoshe2002@git.wordpress.org>
Co-authored-by: ellatrix <ellatrix@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

packages/format-library/src/time/index.js

packages/format-library/package.json

t-hamano

@sarthaknagoshe2002 Thanks for the PR!

The important point here is that generating the datetime attribute from a selected string can be difficult:

The user won't necessarily enter the correct date and time according to the ISO format.
The text won't necessarily be in English. For example, 14:00 UTC +5:30 15th December 2024 will become 2024年12月15日 14時（UTC+5:30） in Japanese.

Given that, I think it would be better for the user to explicitly select the date and time, like so:

sarthaknagoshe2002 · 2024-12-11T10:16:02Z

The important point here is that generating the datetime attribute from a selected string can be difficult:

The user won't necessarily enter the correct date and time according to the ISO format.

The text won't necessarily be in English. For example, 14:00 UTC +5:30 15th December 2024 will become 2024年12月15日 14時（UTC+5:30） in Japanese.

Given that, I think it would be better for the user to explicitly select the date and time, like so:

@t-hamano Noted, on it!

sarthaknagoshe2002 · 2024-12-12T21:29:38Z

@t-hamano I’ve implemented the picker as advised. Could you please take a look?

sarthaknagoshe2002 · 2025-02-04T16:12:58Z

Hey @ellatrix & @t-hamano, could you please review the changes made after your feedback?

Also, this PR now has conflicts, and I’m facing a permission issue that’s preventing me from resolving them. Could someone help with that as well?

feat: Introduce Inline Time Format for Machine-Readable Dates and Time

bf9093e

sarthaknagoshe2002 requested a review from ellatrix as a code owner December 9, 2024 16:05

ellatrix added the [Type] Enhancement A suggestion for improvement. label Dec 10, 2024