-
Notifications
You must be signed in to change notification settings - Fork 0
/
emojicite-doc.tex
180 lines (143 loc) · 8.21 KB
/
emojicite-doc.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
\documentclass{l3doc}
\usepackage{fontspec}
\usepackage{emojicite}
\usepackage{listings}
\usepackage{float}
\usepackage{array,booktabs,fontspec,geometry,graphicx,longtable,xcolor}
\setcitestyle{authoryear, round}
\bibliographystyle{plainnat}
\hypersetup{citecolor=black}
\definecolor{mygreen}{rgb}{0,0.6,0}
\definecolor{mygray}{rgb}{0.5,0.5,0.5}
\definecolor{mymauve}{rgb}{0.58,0,0.82}
\lstset{
backgroundcolor=\color{white}, % choose the background color; you must add \usepackage{color} or \usepackage{xcolor}; should come as last argument
basicstyle=\small, % the size of the fonts that are used for the code
breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace
breaklines=true, % sets automatic line breaking
captionpos=b, % sets the caption-position to bottom
commentstyle=\color{mygreen}, % comment style
deletekeywords={...}, % if you want to delete keywords from the given language
escapeinside={\%*}{*)}, % if you want to add LaTeX within your code
extendedchars=true, % lets you use non-ASCII characters; for 8-bits encodings only, does not work with UTF-8
firstnumber=1, % start line enumeration with line 1000
frame=single, % adds a frame around the code
keepspaces=true, % keeps spaces in text, useful for keeping indentation of code (possibly needs columns=flexible)
keywordstyle=\color{blue}, % keyword style
language=Octave, % the language of the code
morekeywords={*,...}, % if you want to add more keywords to the set
numbers=left, % where to put the line-numbers; possible values are (none, left, right)
numbersep=5pt, % how far the line-numbers are from the code
numberstyle=\tiny\color{mygray}, % the style that is used for the line-numbers
rulecolor=\color{black}, % if not set, the frame-color may be changed on line-breaks within not-black text (e.g. comments (green here))
showspaces=false, % show spaces everywhere adding particular underscores; it overrides 'showstringspaces'
showstringspaces=false, % underline spaces within strings only
showtabs=false, % show tabs within strings adding particular underscores
stepnumber=1, % the step between two line-numbers. If it's 1, each line will be numbered
stringstyle=\color{mymauve}, % string literal style
tabsize=2, % sets default tabsize to 2 spaces
title=\lstname % show the filename of files included with \lstinputlisting; also try caption instead of title
}
\setlength{\parskip}{0.0em}
\setlength\parindent{0pt}
\makeatletter
\ExplSyntaxOn
\def\@fnsymbol#1{
\ensuremath{
\ifcase #1
\or \text{\emoji{globe-with-meridians}}
\or \text{\emoji{email}}
\fi}}
\ExplSyntaxOff
\makeatother
\title{The \pkg{emojicite} package \thanks{\url{https://github.com/berleon/emojicite}} \\
Adds Emojis to Citations \\
\normalsize (requires Lua\LaTeX)}
\author{Leon Sixt \thanks{\url{mail@leon-sixt.de}}}
\date{\emoji{date} 2020/05/13\quad v0.3}
\begin{document}
\maketitle
\tableofcontents
\setlength{\parskip}{0.5em}
\section{Introduction}
Scientific publications are too dry. Too much math, too little emotions. Science
needs emojis!
Leave a small heart to value the hard work gone into a paper \emojicitep{smith2014honey, heart}.
Finally, you can express what you truly think as in \emojicitep{wakefield1998retracted, facepalm}.
We could also indicate, how thoroughly we read papers \emojicitep{van2014difference, see-no-evil}.
\begin{verbatim}
\emojicitep{van2014difference, see-no-evil}.
\end{verbatim}
The package is based on the \pkg{emoji} package\footnote{\url{https://ctan.org/pkg/emoji}}.
See their documentation for the emoji codes\footnote{\url{http://mirrors.ctan.org/macros/luatex/latex/emoji/emoji-doc.pdf}}. You can also use \texttt{\textbackslash setemojifont\{\dots\}} to select a different emoji font.
%\emojicitep{wakefield1998retracted, facepalm, see-no-evil}
You can use up to two emojis \emojicitep{shannon1948, bow, thinking}. The package also supports
to cite multiple works as in \emojicitep{sixt2019explanations, selfie; adebayo2018sanity, +1}.
\pkg{emojicite} does not support more than two emojis.
\texttt{\textbackslash emojicitep\{wakefield1998retracted, facepalm, roll-eyes, shrug\}}
renders as \emojicitep{wakefield1998retracted, facepalm, roll-eyes, shrug}.
Let's ensure science does not get to emotional \emoji{point-up-2}\emoji{neutral-face}.
\newpage
\subsection{Example}
\lstinputlisting[language=Tex,caption={Output of the example is: \emojicitep{einstein, kissing-heart} }]{example.tex}
\subsection{Requirements}
The package works with the Tex Live 2020 distributon and you need to use \texttt{lualatex}.
If you use the \texttt{latexmk} tool, use it with this flag: \texttt{latexmk -pdflua}.
See the \pkg{emoji} package for are an in-depth description of the requirements.
\section{Examplary Usage}
\begin{table}[H]
\centering
\caption{How did you liked the cited work?}
\begin{tabular}{l l l}
%\hline \hline
\textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline
\emojicitep{einstein, kissing-heart} & \texttt{kissing-heart} & I like this work. Here is a kiss. \\
\emojicitep{shannon1948, bow} &\texttt{bow} & Wow, I can only bow to this work. \\
\emojicitep{kim2017interpretability, +1} &\texttt{+1} & Good work! \\
\emojicitep{zhang20167kissing, confused} &\texttt{confused} & I am confused by this work. \\
\emojicitep{le1989gemini, yawning-face} & \texttt{yawning-face} & Boring work.\\
\emojicitep{tishby2015deep, raised-eyebrow} &\texttt{raised-eyebrow}& I have some serious questions...\\
\emojicitep{wakefield1998retracted, facepalm} &\texttt{facepalm}& omg, this work sucks! \\
\end{tabular}
\end{table}
\begin{table}[H]
\centering
\caption{How thoroughly have you read the work?}
\begin{tabular}{l l l}
\textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline
\emojicitep{kingma2013auto, nerd-face} & \texttt{nerd-face}& I know everything about this work. \\
\emojicitep{kim2017interpretability, graduation-cap} & \texttt{graduation-cap}& I know this work well. \\
\emojicitep{shannon1948, thinking} &\texttt{thinking}& I read it but I still have questions. \\
\emojicitep{jones1972statistical, see-no-evil} &\texttt{see-no-evil}& Ups, I did not read this work in-depth. \\
\emojicitep{einstein, shrug} &\texttt{shrug}& too long; did not read \\
\end{tabular}
\end{table}
\begin{table}[H]
\centering
\caption{Special emojis}
\begin{tabular}{l l l}
\textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline
\emojicitep{sixt2019explanations, selfie} & \texttt{selfie} & Citing myself. It just fits perfectly.\\
\emojicitep{blei2003latent, writing-hand, +1} & \texttt{writing-hand, +1} & Well written work.\\
\end{tabular}
\end{table}
\begin{table}[H]
\centering
\caption{Short summary of papers}
\begin{tabular}{l l l}
\textbf{Citation} & \textbf{Emoji} & \textbf{Description} \\ \hline
\emojicitep{watson1953molecular, dna} & \texttt{dna} & Helix structure of DNA.\\
\emojicitep{smith2014honey, grimacing, bee} & \texttt{grimacing, bee} & Getting sting by honey bees. \\
\emojicitep{zhang20167kissing, kissing-heart, robot} & \texttt{kissing-heart, robot} & Kissing machine. \\
\emojicitep{nakanishi2014remote, handshake, mechanical-arm} & \texttt{handshake, mechanical-arm} & Handshake machine. \\
\end{tabular}
\end{table}
\section{Limitations}
Currently, only the name-year format is supported but using a number format is also simple wrong.
Unfortunatly, the Tex Live package required by this verison is not yet available
on ArXiv. If you want to publish on ArXiv, you probably would have to upload the PDF.
Another problem could be that scientific journals and conferences might not see
the same great value in emojis \emoji{roll-eyes}. Every revolution requires
a bit of time.
\bibliography{bibliography}
\end{document}