CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/twemojis

README.md

Twemojis

Simple wrapper that allows to use Twitter's emojis through commands. As this package works with graphics and not with fonts to achieve its goal, it should work on every machine with any version without problems.

In comparison, the emoji package on CTAN https://www.ctan.org/pkg/emoji works on fonts and requires lualatex. It is lighter and probably compiles faster if you use thousands of emojis, but it also has stricter requirements and is not as flexible.

This package really is intended to be used within TikZ images.

Usage

This package in on CTAN as twemojis, so you should be able to use it like any other package, with

\usepackage{twemojis}

An emoji can be used via \twemoji{...}. There is the alternative \texttwemoji{...} command which scales and sets the emoji to fit the text line. More information can be found in the package's documentation.

Installation

If the package is not in you distribution try these install steps. The TL;DR for the manual installation (if everything else fails) is:

  • Run kpsewhich -var-value TEXMFLOCAL and kpsewhich -var-value TEXMFHOME and check which of the resulting directories is populated. Lets call the resulting directory <base dir>.
  • Create the directory <base dir>/tex/latex/twemojis and move the .sty file and the folder pdf-twemojis there.
  • Run mktexlsr (you probably need root for that).
  • If something doesn't work, read the long version linked above (Method 3).

Problems/TODOs

  • Currently the emojis are not text-selectable, that might change in future versions.
  • Remove duplicate SVG files and point all names to the same generated PDF.

Implementation Notice

As the emojis are PDF-based and use transparency, they include groups. I was not able to change the inkscape export so that that does not happen. Hence, pdflatex throws a warning about multiple groups on one PDF page. This package disables said warning: \pdfsuppresswarningpagegroup=1 as it is of no concern for the inputted emojis. It could happen, that a PDF you input is faulty and you don't notice due to said suppression. You can enable the warning with \pdfsuppresswarningpagegroup=0.

Licenses

Emojis

The emojis and all derived graphics belong to Twitter, Inc and other contributors (Copyright 2019). They are licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/.

Hence, attribution of the original work is needed.

Attribution

I'm no lawyer, so take this section with a grain of salt.

As the emojis themselves are licensed under CC-BY they require attribution but are open to be distributed and modified anyway you like (which makes these packages possible). I'm not sure whether the attribution in the package's source code and in this repository is enough for a file (e.g. PDF) generated with this package to be covered as well (doubt it, really).

So, I see two different possibilities to attribute the emojis in a compiled document:

  1. Add attribution to the metadata of the document. For example with https://www.ctan.org/pkg/hyperxmp in PDF files.
  2. Add attribution in the document directly (e.g. on the last page of a presentation). For example:
  3. Emoji graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/
    Copyright 2019 Twitter, Inc and other contributors
  4. I consider this option to be the safest.

Package

The packages are licensed under the LPPL 1.3 or later License.

Copyright (c) 2021 Jost Rossel
This file may be distributed and/or modified under the
conditions of the Project Public License, either
version 1.3 of this license or (at your option) any later
version. The latest version of this license is in:

>

http://www.latex-project.org/lppl.txt

>

and version 1.3 or later is part of all distributions of
version 2005/12/01 or later.

Download the contents of this package in one zip archive (9.6M).

twemojis – Use Twitter’s open source emojis through commands

This package provides a simple wrapper which allows to use Twitter’s open source emojis through commands. This relies on images, so no fancy unicode-font stuff is needed and it should work on every installation.

Packagetwemojis
Bug trackerhttps://gitlab.com/rossel.jost/latex-twemojis/-/issues
Repositoryhttps://gitlab.com/rossel.jost/latex-twemojis
Version1.3.1 (twemoji v14.0.1) 2022-03-30
LicensesCC BY 4.0
The Project Public License 1.3
Copyright2019 Twitter, Inc and other contributors
2021–2022 Jost Rossel
MaintainerJost Rossel
Contained inTeX Live as twemojis
MiKTeX as twemojis
TopicsGraphics
Text symbol
...
Guest Book Sitemap Contact Contact Author