Web API titles: some sample interfaces #21810

wbamberg · 2022-10-25T04:24:31Z

This draft PR is to show what page titles based on https://github.com/orgs/mdn/discussions/248#discussioncomment-3797416 would look like. It updates the title and adds short-title for three interfaces:

https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement
https://developer.mozilla.org/en-US/docs/Web/API/Response
https://developer.mozilla.org/en-US/docs/Web/API/XRWebGLBinding

I chose Response because it's very commonly referenced and has some statics, the other two because they contain some quite long titles.

Note that the sidebars will look a bit silly unless you run this with the Yari from https://github.com/wbamberg/yari/tree/apiref-short-title, which contains the update to make APIRef use short-title if it's available.

github-actions · 2022-10-25T04:27:49Z

Preview URLs (50 pages)

Flaws (12)

Note! 44 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/HTMLVideoElement/videoHeight
Title: HTMLVideoElement: videoHeight property
Flaw count: 2

macros:
- /en-US/docs/Web/API/HTMLMediaElement/resize does not exist
- /en-US/docs/Web/API/HTMLVideoElement/resize does not exist

URL: /en-US/docs/Web/API/XRWebGLBinding/createCylinderLayer
Title: XRWebGLBinding: createCylinderLayer() method
Flaw count: 2

macros:
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types

URL: /en-US/docs/Web/API/XRWebGLBinding/createEquirectLayer
Title: XRWebGLBinding: createEquirectLayer() method
Flaw count: 2

macros:
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types

URL: /en-US/docs/Web/API/XRWebGLBinding/createProjectionLayer
Title: XRWebGLBinding: createProjectionLayer() method
Flaw count: 2

macros:
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types

URL: /en-US/docs/Web/API/XRWebGLBinding/createCubeLayer
Title: XRWebGLBinding: createCubeLayer() method
Flaw count: 2

macros:
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types

URL: /en-US/docs/Web/API/XRWebGLBinding/createQuadLayer
Title: XRWebGLBinding: createQuadLayer() method
Flaw count: 2

macros:
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
- /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types

Elchi3 · 2022-11-02T15:25:04Z

files/en-us/web/api/xrwebglbinding/xrwebglbinding/index.md

@@ -1,5 +1,6 @@
 ---
-title: XRWebGLBinding()
+title: "XRWebGLBinding: XRWebGLBinding() constructor"


Currently, we special case constructors to avoid having the same word twice. I wonder if it would be nicer to continue to do that, like so:

Suggested change

title: "XRWebGLBinding: XRWebGLBinding() constructor"

title: "XRWebGLBinding() constructor"

I'm weakly -1 on this, because I like the consistency of always having the InterfaceName: prefix for everything associated with that interface (and maybe because of some vague folk memory of working with C++ a long time ago!). But I do take your point about repetition and am happy to accept this change if it's the consensus and unblocks this work.

I'm happy either way. Unless @Rumyra has a strong opinion we should decide and go ahead :)

estelle · 2022-11-02T19:22:14Z

With the sidebar, i prefer a shorter title. The header says the API and that the are instance properties, so I think we can leave the API and the word property off.

My favorite:

With the word property:

As is:

We do need to align the icon. With the short version, it would look better after the term.

wbamberg · 2022-11-02T20:17:41Z

Thanks for looking!

With the sidebar, i prefer a shorter title. The header says the API and that the are instance properties, so I think we can leave the API and the word property off.

Yes. This PR also adds a short-title key that can be used in contexts where things like "property" are clear. This needs an update in the sidebar code, to make use of the short-title. I've made a separate Yari PR that contains this update, at https://github.com/wbamberg/yari/tree/apiref-short-title. So if you want to see what titles will look like you'll need to run this PR with that Yari PR:

clone wbamberg/yari and check out https://github.com/wbamberg/yari/tree/apiref-short-title
clone wbamberg/content and check out the branch in this PR
point wbamberg/yari's CONTENT_ROOT at your local copy of wbamberg/content
run yarn dev from the wbamberg/yari clone

We do need to align the icon. With the short version, it would look better after the term.

Yes, I agree about this. But I think it is a different issue.

github-actions · 2022-12-11T06:45:44Z

This pull request has merge conflicts that must be resolved before it can be merged.

tomasz13nocon · 2022-12-27T12:48:35Z

Some other issues caused by long titles on mobile screens are:

Featured articles on the homepage expand beyond the viewport:
Breadcrumbs with long names overflow the page and make it horizontally scrollable:

After scrolling right:

wbamberg · 2022-12-27T19:25:59Z

Some other issues caused by long titles on mobile screens are:

Thanks for highlighting these!

I think the "Featured articles" should be improved by this change, because it will give more line breaking opportunities, and as for breadcrumbs, the PR to use short titles in sidebars will also use them in breadcrumbs, so that should help there.

github-actions · 2023-03-03T11:53:59Z

This pull request has merge conflicts that must be resolved before it can be merged.

Update title and add short-title for selected interfaces

6c50e36

github-actions bot added the Content:WebAPI Web API docs label Oct 25, 2022

wbamberg changed the title ~~Update title and add short-title for selected interfaces~~ Web API titles: some sample interfaces Oct 25, 2022

wbamberg mentioned this pull request Oct 26, 2022

Page titles should not wrap mdn/yari#6440

Closed

Elchi3 reviewed Nov 2, 2022

View reviewed changes

github-actions bot added the rebase needed 🚧 label Dec 11, 2022

Josh-Cena mentioned this pull request Dec 15, 2022

Title doesn't match with function call #22966

Closed

wbamberg mentioned this pull request Dec 16, 2022

feat(macros): support short-title frontmatter + use it in APIRef mdn/yari#7825

Merged

github-actions bot added the merge conflicts 🚧 [PR only] label Mar 3, 2023

bsmth removed the rebase needed 🚧 label Mar 3, 2023

wbamberg closed this Apr 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Web API titles: some sample interfaces #21810

Web API titles: some sample interfaces #21810

wbamberg commented Oct 25, 2022 •

edited

Loading

github-actions bot commented Oct 25, 2022

Elchi3 Nov 2, 2022

wbamberg Nov 10, 2022

Elchi3 Nov 10, 2022

estelle commented Nov 2, 2022 •

edited

Loading

wbamberg commented Nov 2, 2022

github-actions bot commented Dec 11, 2022

tomasz13nocon commented Dec 27, 2022

wbamberg commented Dec 27, 2022

github-actions bot commented Mar 3, 2023

	title: "XRWebGLBinding: XRWebGLBinding() constructor"
	title: "XRWebGLBinding() constructor"

Web API titles: some sample interfaces #21810

Web API titles: some sample interfaces #21810

Conversation

wbamberg commented Oct 25, 2022 • edited Loading

github-actions bot commented Oct 25, 2022

Elchi3 Nov 2, 2022

Choose a reason for hiding this comment

wbamberg Nov 10, 2022

Choose a reason for hiding this comment

Elchi3 Nov 10, 2022

Choose a reason for hiding this comment

estelle commented Nov 2, 2022 • edited Loading

wbamberg commented Nov 2, 2022

github-actions bot commented Dec 11, 2022

tomasz13nocon commented Dec 27, 2022

wbamberg commented Dec 27, 2022

github-actions bot commented Mar 3, 2023

wbamberg commented Oct 25, 2022 •

edited

Loading

estelle commented Nov 2, 2022 •

edited

Loading