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

Move the Streamability chapter? #1588

Closed
ndw opened this issue Nov 18, 2024 · 7 comments
Closed

Move the Streamability chapter? #1588

ndw opened this issue Nov 18, 2024 · 7 comments
Labels
Editorial Minor typos, wording clarifications, example fixes, etc. Propose Closing with No Action The WG should consider closing this issue with no action XSLT An issue related to XSLT

Comments

@ndw
Copy link
Contributor

ndw commented Nov 18, 2024

This is a minor thing, but it annoys me every single time. Open up the XSLT spec and search for any instruction and the first hit in the ToC is always 19.8.4.x "Streamability of [instruction]" which has never been the reason I was looking for the instruction.

Seems we could move 19 to 27, putting it before Serialization or we could tinker with the markup so that 19.8.4.x didn't appear in the ToC.

@ndw ndw added XSLT An issue related to XSLT Editorial Minor typos, wording clarifications, example fixes, etc. labels Nov 18, 2024
@michaelhkay
Copy link
Contributor

Yes, it's something I've got used to, but it is a little bit quirky.

We could do something like the function finder in F+O, with a list of XSLT elements that appears before the table of contents.

@ndw
Copy link
Contributor Author

ndw commented Nov 19, 2024

Well, yes, I'd considered that on several occasions. Now I've done it. (#1589 which I'm going to proactively merge as soon as it builds since (a) I can't imagine anyone objecting and (b) it's difficult to stage build changes.)

I still think moving the streamability chapter is a good idea. Or maybe move all of 19.8.4.x into an appendix?

@michaelhkay
Copy link
Contributor

Moving the chapter isn't going to help. The only occurrence of "xsl:copy" (for example) in the table of contents is as a section heading within the streamability chapter, and this will remain the case if the chapter is moved. The only way we might change this is by (a) having a section heading that includes the word "xsl:copy" earlier in the document, or (b) not naming the instruction in a subheading within streamability. Neither seems particularly desirable.

@michaelhkay michaelhkay added the Propose Closing with No Action The WG should consider closing this issue with no action label Dec 6, 2024
@michaelhkay
Copy link
Contributor

Propose closing with no action. Moving the chapter will not achieve the aim that the first "hit" on an element name when searching the HTML is a substantive link to the relevant element.

@ndw
Copy link
Contributor Author

ndw commented Dec 6, 2024

shrug

I didn't suggest that moving it was a perfect solution, simply that it would make some number of things better. I'm not going to die on this hill.

@gimsieke
Copy link
Contributor

gimsieke commented Dec 6, 2024

It doesn't annoy me that much. You click on the first match link 'streamability of xsl:apply-templates' and you can be assured that there's a link to xsl:apply-templates in the heading that you're taken to. You reach your goal much faster than, for instance, in the interactive Saxon documentation where you need to skip many 'changes' sections before you discover the section you were looking for in the first place.

@michaelhkay
Copy link
Contributor

We agreed to close this at meeting 102

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editorial Minor typos, wording clarifications, example fixes, etc. Propose Closing with No Action The WG should consider closing this issue with no action XSLT An issue related to XSLT
Projects
None yet
Development

No branches or pull requests

3 participants