| 1 |
# Twemojis |
| 2 |
|
| 3 |
Simple wrapper that allows to use Twitter's emojis through LaTeX commands. |
| 4 |
As this package works with graphics and not with fonts to achieve its goal, it *should* work on every machine with any LaTeX version without problems. |
| 5 |
|
| 6 |
In comparison, the `emoji` package on CTAN <https://www.ctan.org/pkg/emoji> works on fonts and requires lualatex. |
| 7 |
It is lighter and probably compiles faster if you use thousands of emojis, but it also has stricter requirements and is not as flexible. |
| 8 |
|
| 9 |
This package really is intended to be used within Ti*k*Z images. |
| 10 |
|
| 11 |
## Usage |
| 12 |
|
| 13 |
This package in on [CTAN](https://www.ctan.org) as [twemojis](https://ctan.org/pkg/twemojis), so you should be able to use it like any other package, with |
| 14 |
|
| 15 |
```latex |
| 16 |
\usepackage{twemojis} |
| 17 |
``` |
| 18 |
|
| 19 |
An emoji can be used via `\twemoji{...}`. |
| 20 |
There is the alternative `\texttwemoji{...}` command which scales and sets the emoji to fit the text line. |
| 21 |
More information can be found in the [package's documentation](https://ftp.gwdg.de/pub/ctan/macros/latex/contrib/twemojis/twemojis.pdf). |
| 22 |
|
| 23 |
## Installation |
| 24 |
|
| 25 |
If the package is not in you TeX distribution try [these install steps](https://tex.stackexchange.com/questions/73016/how-do-i-install-an-individual-package-on-a-linux-system). |
| 26 |
The TL;DR for the manual installation (if everything else fails) is: |
| 27 |
- Run `kpsewhich -var-value TEXMFLOCAL` and `kpsewhich -var-value TEXMFHOME` and check which of the resulting directories is populated. |
| 28 |
Lets call the resulting directory `<base dir>`. |
| 29 |
- Create the directory `<base dir>/tex/latex/twemojis` and move the `.sty` file and the folder `pdf-twemojis` there. |
| 30 |
- Run `mktexlsr` (you probably need root for that). |
| 31 |
- If something doesn't work, read the long version linked above (Method 3). |
| 32 |
|
| 33 |
## Problems/TODOs |
| 34 |
|
| 35 |
- Currently the emojis are not text-selectable, that might change in future versions. |
| 36 |
- Remove duplicate SVG files and point all names to the same generated PDF. |
| 37 |
|
| 38 |
# Implementation Notice |
| 39 |
|
| 40 |
As the emojis are PDF-based and use transparency, they include groups. |
| 41 |
I was not able to change the `inkscape` export so that that does not happen. |
| 42 |
Hence, `pdflatex` throws a warning about multiple groups on one PDF page. |
| 43 |
This package disables said warning: `\pdfsuppresswarningpagegroup=1` as it is of no concern for the inputted emojis. |
| 44 |
It **could** happen, that a PDF you input is faulty and you don't notice due to said suppression. |
| 45 |
You can enable the warning with `\pdfsuppresswarningpagegroup=0`. |
| 46 |
|
| 47 |
# Licenses |
| 48 |
|
| 49 |
## Emojis |
| 50 |
|
| 51 |
The emojis and all derived graphics belong to Twitter, Inc and other contributors (Copyright 2019). |
| 52 |
They are licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/. |
| 53 |
|
| 54 |
Hence, attribution of the original work is needed. |
| 55 |
|
| 56 |
### Attribution |
| 57 |
|
| 58 |
**I'm no lawyer, so take this section with a grain of salt.** |
| 59 |
|
| 60 |
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). |
| 61 |
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). |
| 62 |
|
| 63 |
So, I see two different possibilities to attribute the emojis in a compiled document: |
| 64 |
|
| 65 |
1. Add attribution to the metadata of the document. |
| 66 |
For example with <https://www.ctan.org/pkg/hyperxmp> in PDF files. |
| 67 |
2. Add attribution in the document directly (e.g. on the last page of a presentation). |
| 68 |
For example: |
| 69 |
``` |
| 70 |
Emoji graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/ |
| 71 |
Copyright 2019 Twitter, Inc and other contributors |
| 72 |
``` |
| 73 |
I consider this option to be the safest. |
| 74 |
|
| 75 |
## LaTeX Package |
| 76 |
|
| 77 |
The LaTeX packages are licensed under the LPPL 1.3 or later License. |
| 78 |
|
| 79 |
> Copyright (c) 2021 Jost Rossel |
| 80 |
> This file may be distributed and/or modified under the |
| 81 |
> conditions of the LaTeX Project Public License, either |
| 82 |
> version 1.3 of this license or (at your option) any later |
| 83 |
> version. The latest version of this license is in: |
| 84 |
> |
| 85 |
> http://www.latex-project.org/lppl.txt |
| 86 |
> |
| 87 |
> and version 1.3 or later is part of all distributions of |
| 88 |
> LaTeX version 2005/12/01 or later. |