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

Jump to bottom

Don't abuse \xref #1561

Closed
tkoeppe opened this issue Mar 20, 2017 · 3 comments
Closed

Don't abuse \xref #1561

tkoeppe opened this issue Mar 20, 2017 · 3 comments
Assignees
@jensmaurer

Comments

@tkoeppe
Copy link
Contributor

tkoeppe commented Mar 20, 2017

The \xref "see also" annotation is only meant for references to The Other Standard, not for simple cross-references within our own document. Such cross-references should simply say "See also" in ordinary text.

I have not yet surveyed the entire text for occurrences of this problem, but I fixed it in [library] and it's still rampant in [language.support].
@tkoeppe
Copy link
Contributor Author

tkoeppe commented Mar 20, 2017

The remaining cases all seem to be in support.tex.

What makes this issue non-trivial is that some use cases look like

\xref Local section A (x.y), Another local section (z.w), and ISO C 8.1.

We could split this into two paragraphs:

\pnum
See also Local section A (x.y) and Another local section (z.w).

\xref ISO C 8.1.

But that would result in two consecutive "See also" paragraphs, slightly differently styled.

Suggestions?

@jensmaurer
Copy link
Member

jensmaurer commented Mar 20, 2017 •
edited

Looking at [support.types.layout] as an example, I think we should make sure that the running text already has all mentioned internal cross-references; then we can just drop them from \xref.
For this particular case, the text talking about "size of an object" should have the cross-reference to sizeof, for example.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Mar 20, 2017

Yes, that sounds like the right solution - move the local references to better places and then keep the \xref for the C reference.

@jensmaurer jensmaurer self-assigned this Mar 20, 2017
jensmaurer added a commit to jensmaurer/draft that referenced this issue Mar 20, 2017
@jensmaurer
[language.support] Reserve \xref for references to the C standard.
8fbea4e 
Fixes cplusplus#1561.
@jensmaurer jensmaurer mentioned this issue Mar 20, 2017
Merged
jensmaurer added a commit to jensmaurer/draft that referenced this issue Mar 20, 2017
@jensmaurer
[language.support] Reserve \xref for references to the C standard.
9535150 
Also remove full stops and non-breaking spaces in \xref lines.

Fixes cplusplus#1561.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Mar 25, 2017
@jensmaurer
[language.support] Reserve \xref for references to the C standard.
f562c2f 
Also remove full stops and non-breaking spaces in \xref lines.

Fixes cplusplus#1561.
zygoloid pushed a commit that referenced this issue Apr 8, 2017
@jensmaurer @zygoloid
[language.support] Reserve \xref for references to the C standard.
2f118eb 
Also remove full stops and non-breaking spaces in \xref lines.

Fixes #1561.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jensmaurer jensmaurer

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tkoeppe @jensmaurer