Skip to content

Fix a lot of keyword-related issues with some PDF search impact#4

Merged
mkinsner merged 5 commits intoKhronosGroup:masterfrom
keryell:PDF-fixes
Jun 12, 2019
Merged

Fix a lot of keyword-related issues with some PDF search impact#4
mkinsner merged 5 commits intoKhronosGroup:masterfrom
keryell:PDF-fixes

Conversation

@keryell
Copy link
Member

@keryell keryell commented Jun 11, 2019

This is a try to fix #3

Replace most of the \keyword by \codeinline or \gls-like glossaries

This fix some wrong typing in the sense of computer programming.
It fixes also a lot of typesetting problems, such as PDF search due to
wrong "_" rendering.
The remaining \keyword is some technical debt about creating new
glossary entries in the specification.

Do not use \textbf for keywords.

The "_" are replaced by space in the PDF search otherwise...
Use \codeinline as expected instead.

Remove useless \_ and fix some typesetting

A lot of escaping of _ were actually useless and might cause some
trouble in the PDF output.

Use correct typesetting of async_handler in the glossary.

This makes the "_" to be searchable.

Now there are 43 instances of async_handler found.

Improve async_handler glossary encoding for MacOS X Preview search.

On the crazy part on Mac OS X:

  • MacOS X Preview 10.1 (944.6.16.1) finds the 43 instances, but when I change the PDF in its back, it just crashes;
  • Safari 12.1.1 (14607.2.6.1.1) can somehow find all the 43 occurrences, but actually 33 are found while searching forward while 10 are found while searching backward... :-( I find this... awkward :-) I would like to program this bug, I would not know how to do it... :-(

If there are people using Mac OS X who want to open some bug reports, go for it.

keryell added 4 commits June 11, 2019 11:32
This makes the "_" to be searchable.
A lot of escaping of _ were actually useless and might cause some
trouble in the PDF output.
The "_" are replaced by space in the PDF search otherwise...
Use \codeinline as expected instead.
This fix some wrong typing in the sense of computer programming.
It fixes also a lot of typesetting problems, such as PDF search due to
wrong "_" rendering.
The remaining \keyword is some technical debt about creating new
glossary entries in the specification.
@keryell keryell requested a review from mkinsner June 11, 2019 18:40
@CLAassistant
Copy link

CLAassistant commented Jun 11, 2019

CLA assistant check
All committers have signed the CLA.

Copy link

@mkinsner mkinsner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a significant effort - thanks Ronan! I don't notice any bugs, and I've verified that I can build your branch locally. cl_command_queue_info is now found in my PDF viewer under Windows.

It seems to work with MacOS X Preview 10.1 (944.6.16.1)

Safari 12.1.1 (14607.2.6.1.1) has still some problems to find all the
43 occurrences.
Actually 33 are found forward and 10 found backward... I find
this... awkward :-(
@keryell keryell changed the title [WIP] Fix a lot of keyword-related issues with some PDF search impact Fix a lot of keyword-related issues with some PDF search impact Jun 11, 2019
Copy link
Member Author

@keryell keryell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I am done on my side.

@mkinsner mkinsner merged commit eb14724 into KhronosGroup:master Jun 12, 2019
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 this pull request may close these issues.

Searching broken within spec PDF output

3 participants