Debian Codegraph @

texmf-dist/doc/lualatex/emojicite/emojicite-doc.tex

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