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

Emoji support #6517

Closed
reavessm opened this issue Sep 16, 2018 · 17 comments
Closed

Emoji support #6517

reavessm opened this issue Sep 16, 2018 · 17 comments
Assignees
Labels
enhancement a request to enhance doxygen, not a bug

Comments

@reavessm
Copy link

Doxygen does a great job creating webpages based on markdown files, could it also render the emojis in the files?

I have some files where I would like :smiley: to show up as 😃, for example.

@albert-github albert-github added the enhancement a request to enhance doxygen, not a bug label Sep 16, 2018
@albert-github
Copy link
Collaborator

Is there anywhere a, free, translation table between the :smiley: syntax and the corresponding Unicode character 😀 ?
Analogous also for other formats, especially LaTeX?

There is a nice Unicode list (https://unicode.org/emoji/charts/full-emoji-list.html) with all Emoji characters.
There are also tables with the :smiley: syntax (e.g. https://www.webpagefx.com/tools/emoji-cheat-sheet/ or https://gist.github.com/rxaviers/7360908)

@albert-github albert-github added the needinfo reported bug is incomplete, please add additional info label Sep 17, 2018
@reavessm
Copy link
Author

Like this?

@albert-github
Copy link
Collaborator

That is the same list as the first list I mentioned in my comment.

I'm looking for a table that translates the e.g. :smiley: to &#x1F600 or U+1F600

@reavessm
Copy link
Author

Wow, I can't read today. Sorry about that. Apparently GitHub has a REST API to download the emojis as pngs. I tested by running wget https://github.global.ssl.fastly.net/images/icons/emoji/smiley.png. They also have a Table view. The Table view has the unicode in the url. I can work on making a table as a text file (json, markdown, etc) if that would help

@albert-github
Copy link
Collaborator

That table (https://api.github.com/emojis) looks very interesting, it is not 100% complete (but that is probably a minor detail. missing at least Scotland, England, Wales but they are easily added).
There are a few culprits in the table like :man-wrestling: pointing to https://assets-cdn.github.com/images/icons/emoji/unicode/1f93c-2642.png?v8 so it looks lake 2 codes but in fact it are 4: U+1F93C U+200D U+2642 U+FE0F but comparing this table with the https://unicode.org/emoji/charts/full-emoji-list.html table should do the trick.
This gives a good starting point, translation of this table should not be a big issue for me.

@reavessm
Copy link
Author

Yeah there definitely are some holes, but here is a json with the unicodes from the table
emojis.json.txt

@t-b
Copy link
Contributor

t-b commented Sep 17, 2018

Aren't the github names just the unicode "CLDR Short Name" names all lower case and with _ instead of spaces? Standardzing on some arbitrary github names does not sound like a good solution.

@lrineau
Copy link
Contributor

lrineau commented Sep 17, 2018

@t-b commented on Sep 17, 2018, 4:48 PM GMT+2:

Aren't the github names just the unicode "CLDR Short Name" names all lower case and with _ instead of spaces? Standardzing on some arbitrary github names does not sound like a good solution.

No. For example, :grin: gives 😁, that is U+1F601 with the short name "beaming face with smiling eyes".

@albert-github
Copy link
Collaborator

albert-github commented Sep 17, 2018

@reavessm thanks for the table, looks like besides the 3 countries there are some more items missing (in the latest file I see 1508 items and the unicode table has 1644 items), not a big issue I'll have to look into it.

@t-b / @lrineau I was already typing, but you found it as well. No the names are not just the "CLDR Short Name" names all lower case and with _" e.g. code U-1F604 has :smile: as "github name" and "grinning face with smiling eyes" as "CLDR Short Name"

@t-b
Copy link
Contributor

t-b commented Sep 17, 2018

@lrineau @albert-github Thanks for the correction.

@albert-github albert-github removed the needinfo reported bug is incomplete, please add additional info label Sep 18, 2018
@albert-github albert-github self-assigned this Sep 19, 2018
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #6534

@albert-github
Copy link
Collaborator

When integrating pay attention to #6608 as here also a new command is added (multiple numbers in cmdmapper.h).

@albert-github
Copy link
Collaborator

Code has been integrated in master on github.

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Nov 11, 2018
@sloriot
Copy link

sloriot commented Nov 12, 2018

@albert-github Looks like there are some regression introduced (not sure if I should open a new issue).
For example I got this warning:

models:2: warning: Unsupported emoji ':Surface_mesh_approximation:' found while handling command \ref

And this output:
screenshot from 2018-11-12 11-02-55

Let me know if you need more details.

@albert-github
Copy link
Collaborator

albert-github commented Nov 12, 2018

@sloriot Thanks for bringing this to our attention.

At first I thought:
In the new update there is the possibilities for emoji, and :Surface_mesh_approximation: is not an emoji so the message is correct. For cases like these the command \: has been introduced: the way to specify this is \:Surface_mesh_approximation\:.

But I see in the image I see that in some cases it looks like the :: part is not handled properly.

So I do think it is a regression, please file a new issue.
I can build the full documentation but this takes some time, please add to the issue:

  • a name of output file where you see the problem
  • how to generate documentation of 1 subdirectory (make doc generates all), when easily possible of course)

@sloriot
Copy link

sloriot commented Nov 12, 2018

Thanks, see #6612

@doxygen
Copy link
Owner

doxygen commented Dec 27, 2018

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.8.15.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 27, 2018
@doxygen doxygen closed this as completed Dec 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug
Projects
None yet
Development

No branches or pull requests

6 participants