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.

Sign up for GitHub

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

Update template descriptions for clarity and humanity. #29531

Merged
merged 3 commits into from
Mar 4, 2021
Merged

Update template descriptions for clarity and humanity. #29531

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac62bd6
Update template descriptions for clarity and humanity.
mtias Mar 3, 2021
2df82f0
Further text tweaks and fix tests.
mtias Mar 4, 2021
0a5218b
Fix more tests.
mtias Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions lib/full-site-editing/default-template-types.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,71 +15,71 @@ function gutenberg_get_default_template_types() {
$default_template_types = array(
'index' => array(
'title' => _x( 'Index', 'Template name', 'gutenberg' ),
'description' => __( 'The default template which is used when no other template can be found', 'gutenberg' ),
'description' => __( 'The default template used when no other template is available. This is a required template in WordPress.', 'gutenberg' ),
),
'home' => array(
'title' => _x( 'Home', 'Template name', 'gutenberg' ),
'description' => __( 'The home page template, which is the front page by default. If you use a static front page this is the template for the page with the latest posts', 'gutenberg' ),
'description' => __( 'Template used for the main page that displays blog posts. This is the front page by default in WordPress. If a static front page is set, this is the template used for the page that contains the latest blog posts.', 'gutenberg' ),
),
'front-page' => array(
'title' => _x( 'Front Page', 'Template name', 'gutenberg' ),
'description' => __( 'Used when the site home page is queried', 'gutenberg' ),
'description' => __( 'Template used to render the front page of the site, whether it displays blog posts or a static page. The front page template takes precedence over the "Home" template.', 'gutenberg' ),
),
'singular' => array(
'title' => _x( 'Singular', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a single entry is queried. This template will be overridden by the Single, Post, and Page templates where appropriate', 'gutenberg' ),
'description' => __( 'Template used for displaying single views of the content. This template is a fallback for the Single, Post, and Page templates, which take precedence when they exist.', 'gutenberg' ),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

),
'single' => array(
'title' => _x( 'Single', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a single entry that is not a Page is queried', 'gutenberg' ),
'description' => __( 'Template used to display a single post or entry.', 'gutenberg' ),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the term "entry" valuable here? We might be able to do without that word entirely.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's to somehow differentiate from the single-post case.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove the single-post from the default set, actually.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is also important to clarify that the template can display post types other than post, which comes in to play whenever a CPT is registered.

In fact this is the reason that single-post was included as well. It's explicit nature means we can enable folks to intuitively add a template just for posts which will likely be a common use case. There is a dedicated template for Pages, it makes sense for there to be a dedicated template for Posts as well, imo.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that would be very intuitive. Pages are a special case when it comes to templates in WP. I don't think I have seen major themes that use single-post. Almost always you want to capture as many single post type entities as possible with it, and discriminate pages, which are not chronological.

If a custom post type requires a special treatment, it makes sense for that to be created specifically.

),
'single-post' => array(
'title' => _x( 'Post', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a single Post is queried', 'gutenberg' ),
'description' => __( 'Template used to display a single post type.', 'gutenberg' ),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"single post type" suggests some CPT action going on. I wonder if we can do without "type"?

),
'page' => array(
'title' => _x( 'Page', 'Template name', 'gutenberg' ),
'description' => __( 'Used when an individual Page is queried', 'gutenberg' ),
'description' => __( 'Template used to render static pages.', 'gutenberg' ),
mtias marked this conversation as resolved.
Show resolved Hide resolved
),
'archive' => array(
'title' => _x( 'Archive', 'Template name', 'gutenberg' ),
'description' => __( 'Used when multiple entries are queried. This template will be overridden by the Category, Author, and Date templates where appropriate', 'gutenberg' ),
'description' => __( 'The archive template displays multiple entries at once. It is used as a fallback for the Category, Author, and Date templates, which take precedence when they are available.', 'gutenberg' ),
),
'author' => array(
'title' => _x( 'Author Archive', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a list of Posts from a single author is queried', 'gutenberg' ),
'title' => _x( 'Author', 'Template name', 'gutenberg' ),
'description' => __( 'Archive template used to display a list of posts from a single author.', 'gutenberg' ),
),
'category' => array(
'title' => _x( 'Post Category Archive', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a list of Posts from a category is queried', 'gutenberg' ),
'title' => _x( 'Category', 'Template name', 'gutenberg' ),
'description' => __( 'Archive template used to display a list of posts from the same category.', 'gutenberg' ),
),
'taxonomy' => array(
'title' => _x( 'Taxonomy Archive', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a list of posts from a taxonomy is queried', 'gutenberg' ),
'title' => _x( 'Taxonomy', 'Template name', 'gutenberg' ),
'description' => __( 'Archive template used to display a list of posts from the same taxonomy.', 'gutenberg' ),
),
'date' => array(
'title' => _x( 'Date Archive', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a list of Posts from a certain date are queried', 'gutenberg' ),
'title' => _x( 'Date', 'Template name', 'gutenberg' ),
'description' => __( 'Archive template used to display a list of posts from a specific date.', 'gutenberg' ),
),
'tag' => array(
'title' => _x( 'Tag Archive', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a list of Posts with a certain tag is queried', 'gutenberg' ),
'title' => _x( 'Tag', 'Template name', 'gutenberg' ),
'description' => __( 'Archive template used to display a list of posts with a given tag.', 'gutenberg' ),
),
'attachment' => array(
'title' => __( 'Media', 'gutenberg' ),
'description' => __( 'Used when a Media entry is queried', 'gutenberg' ),
'description' => __( 'Used to display individual media items or attachements.', 'gutenberg' ),
mtias marked this conversation as resolved.
Show resolved Hide resolved
),
'search' => array(
'title' => _x( 'Search Results', 'Template name', 'gutenberg' ),
'description' => __( 'Used when a visitor searches the site', 'gutenberg' ),
'title' => _x( 'Search', 'Template name', 'gutenberg' ),
'description' => __( 'Used to display search results.', 'gutenberg' ),
mtias marked this conversation as resolved.
Show resolved Hide resolved
),
'privacy-policy' => array(
'title' => __( 'Privacy Policy', 'gutenberg' ),
'description' => '',
),
'404' => array(
'title' => _x( '404', 'Template name', 'gutenberg' ),
'description' => __( 'Used when the queried content cannot be found', 'gutenberg' ),
'description' => __( 'Template shown when no content is found.', 'gutenberg' ),
),
);

Expand Down