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

Table names should be present as stable names #2674

Closed
PeterSommerlad opened this issue Feb 20, 2019 · 11 comments · Fixed by #2896
Closed

Table names should be present as stable names #2674

PeterSommerlad opened this issue Feb 20, 2019 · 11 comments · Fixed by #2896
Assignees

Comments

@PeterSommerlad
Copy link

The latex sources of the standard have "stable" table identifications as their \label{tablename}. However, in contrast to regular sections, these names are never rendered in the text. This leads to tedious updates of table numbers in any paper referring to any of the tables. It would be great if the table labels would be printed with the standard like the stable names are printed in the header sections.

This would ease the work of the paper authors as well as the editors (i guess).

@tkoeppe
Copy link
Contributor

tkoeppe commented Feb 20, 2019

(I feel like this issue has been raised before.)

@cpplearner
Copy link
Contributor

#824

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Feb 22, 2019
@jensmaurer
Copy link
Member

Editorial meeting:

  • Review all table labels.
  • Expose label as "tab:blah".

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Feb 22, 2019
@jensmaurer
Copy link
Member

jensmaurer commented May 10, 2019

This needs substantial work. Almost all labels seem to be overly long or nondescript. Suggested rules:

  • If a subclause consists predominantly of a table, use the same label as the subclause label (plus tab: prefix). Example: tab:lex.key, tab:lex.digraph.
  • For concepts tables, just use the flat name as-is. Example: tab:copyconstructible.
  • Otherwise, use at least some parts in common with the subclause label. Example: tab:temp.fold.empty.

What's the desired formatting of the table label? I currently have "bold", but I feel I need a bit more space separating it from the prose caption text:

tablelabel

Should the label be repeated for continued captions of longtables?

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label May 10, 2019
@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Jun 5, 2019
@jensmaurer
Copy link
Member

jensmaurer commented Jun 5, 2019

Editorial meeting:

  • Second rule: Use cpp17.conceptname. DONE
  • Do not make the label bold. DONE
  • Separate label from caption text by \quad. DONE
  • Separate table number from caption text by \quad or colon (show screenshots of both options). Remove mdash. Try to be consistent with subclause titles. SEE BELOW
  • Make figure captions the same as table captions, except for before/after placement. DONE
  • Check linebreaks in captions. SEE BELOW
  • Do not repeat the label in continued captions of longtables. DONE

@jensmaurer
Copy link
Member

Sample 1: separate table number from caption text by colon
caption-colon

Sample 2: separate table number from caption text by \quad
caption-quad

@jensmaurer jensmaurer self-assigned this Jun 8, 2019
@jensmaurer
Copy link
Member

Sample figure:

caption-figure

Sample linebreak:

caption-linebreak

@hubert-reinterpretcast
Copy link
Contributor

My preference is for the colon between the number and the caption.

@W-E-Brown
Copy link
Contributor

W-E-Brown commented Jun 8, 2019 via email

@zygoloid
Copy link
Member

(I also prefer the colon.) Thanks Jens!

@jensmaurer
Copy link
Member

Added a "labels" section to the wiki style guidelines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants