Skip to content

New placeholder macro that uses italics or slanted type depending on the context - #2245

Open
godbyk wants to merge 2 commits into
cplusplus:mainfrom
godbyk:smart-placeholder
Open

godbyk wants to merge 2 commits into
cplusplus:mainfrom
godbyk:smart-placeholder

Conversation

@godbyk

@godbyk godbyk commented Jul 4, 2018

Copy link
Copy Markdown
Contributor

This PR demonstrates an option outlined in issue #1060: a smarter \placeholder macro that typesets the placeholder either italics or slanted depending on whether it's code or roman text.

  • In roman text, it sets the placeholder in italics.
  • In monospaced text, it sets the placeholder in slanted type.
  • In sans serif text, it sets the placeholder in italics.

A diff of the PDFs is available here. A sample of pages that differ include 29, 30, 433–435, 880–890.

@zygoloid
zygoloid force-pushed the master branch 2 times, most recently from e3dbfe2 to 1a21a65 Compare July 7, 2018 23:19
@jensmaurer

Copy link
Copy Markdown
Member

"All checks have failed".

@jensmaurer jensmaurer added the needs rebase The pull request needs a git rebase to resolve merge conflicts. label Jul 9, 2018
@godbyk

godbyk commented Jul 9, 2018

Copy link
Copy Markdown
Contributor Author

@jensmaurer That's due to

Overfull \hbox (0.85309pt too wide) in paragraph at lines 3965--3971
Overfull \hbox (0.85309pt too wide) in paragraph at lines 4260--4267
Overfull \hbox (6.936pt too wide) in paragraph at lines 539--558

@godbyk
godbyk force-pushed the smart-placeholder branch from 7b6a708 to fc8103f Compare July 11, 2018 14:51
@godbyk

godbyk commented Jul 11, 2018

Copy link
Copy Markdown
Contributor Author

I rebased and quelled the overfull line warnings with the use of \sloppy.

@jensmaurer jensmaurer removed the needs rebase The pull request needs a git rebase to resolve merge conflicts. label Oct 25, 2018
@zygoloid zygoloid added the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 26, 2018
@zygoloid

Copy link
Copy Markdown
Member

(In the diffs, the cyan is the new formatting and the red is the current formatting.)

Initial reaction: I think I somewhat prefer the current formatting for teletype placeholders. Use of a different typeface makes the placeholders stand out more clearly; the difference between slanted and unslanted teletype is easier to overlook, precisely because it's more visually consistent (which I think is the goal here).

Let's discuss this in person. We should also consider how to format things like @\seebelow@ (which is unaffected by the current patch).

@jensmaurer

Copy link
Copy Markdown
Member

Editorial meeting:

  • Slanted font makes the placeholders stand out less in the library; we don't want them to be confused with identifiers. No change for that.
  • Consider changing "see below" etc. to roman italics (same as comments). -> new issue with samples attached
  • Use slanted font for definition for "contextually converted to bool".

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

Copy link
Copy Markdown
Member

Before:

before

After:

after

I think this confirms:

Slanted font makes the placeholders stand out less in the library; we don't want them to be confused with identifiers. No change for that.

(The difference between the slanted and non-slanted text has become too subtle.)

@zygoloid zygoloid added changes requested Changes to the wording or approach have been requested and not yet applied. needs rebase The pull request needs a git rebase to resolve merge conflicts. labels Jun 12, 2019
@AlisdairM

Copy link
Copy Markdown
Contributor

Are we still planning to land some part of this PR? Should we consider closing? It has been (mostly) dormant for almost 5 years now.

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

Labels

changes requested Changes to the wording or approach have been requested and not yet applied. needs rebase The pull request needs a git rebase to resolve merge conflicts.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants