From 09287ef491c414f8ad2bda4339aa19ee4c957998 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 14 Apr 2020 21:08:25 +0000 Subject: emojicite (14apr20) git-svn-id: svn://tug.org/texlive/trunk@54741 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/lualatex/emojicite/LICENSE.txt | 416 +++++++++++++++++++++ Master/texmf-dist/doc/lualatex/emojicite/README.md | 72 ++++ .../doc/lualatex/emojicite/emojicite-doc.pdf | Bin 0 -> 175903 bytes .../doc/lualatex/emojicite/emojicite-doc.tex | 182 +++++++++ .../texmf-dist/doc/lualatex/emojicite/example.tex | 12 + .../tex/lualatex/emojicite/emojicite.sty | 101 +++++ Master/tlpkg/bin/tlpkg-ctan-check | 3 +- Master/tlpkg/tlpsrc/collection-luatex.tlpsrc | 1 + Master/tlpkg/tlpsrc/emojicite.tlpsrc | 0 9 files changed, 786 insertions(+), 1 deletion(-) create mode 100644 Master/texmf-dist/doc/lualatex/emojicite/LICENSE.txt create mode 100644 Master/texmf-dist/doc/lualatex/emojicite/README.md create mode 100644 Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.pdf create mode 100644 Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.tex create mode 100644 Master/texmf-dist/doc/lualatex/emojicite/example.tex create mode 100644 Master/texmf-dist/tex/lualatex/emojicite/emojicite.sty create mode 100644 Master/tlpkg/tlpsrc/emojicite.tlpsrc diff --git a/Master/texmf-dist/doc/lualatex/emojicite/LICENSE.txt b/Master/texmf-dist/doc/lualatex/emojicite/LICENSE.txt new file mode 100644 index 00000000000..0d1c9ab323e --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/emojicite/LICENSE.txt @@ -0,0 +1,416 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 2020 Leon Sixt + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX 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 LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. + diff --git a/Master/texmf-dist/doc/lualatex/emojicite/README.md b/Master/texmf-dist/doc/lualatex/emojicite/README.md new file mode 100644 index 00000000000..7c72f2552cc --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/emojicite/README.md @@ -0,0 +1,72 @@ +# emojicite + +[[CTAN](https://www.ctan.org/tex-archive/macros/luatex/latex/emojicite)] | +[[PDF Docu](http://mirrors.ctan.org/macros/luatex/latex/emojicite/emojicite-doc.pdf)] + +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 (Smith, 2014 โค๏ธ ). +Flag self-citations as in (Sixt et al., 2019 ๐Ÿคณ) +Finally, you can express what you truly think directly as in (Wakefield et. al, 1998 ๐Ÿคฆ). +We could also indicate, how thoroughly we read papers (Van Wesel et al., 2014 ๐Ÿ™ˆ) + +## Basic Usage + +``` +\documentclass{article} + +\usepackage{emojicite} +\setcitestyle{authoryear, round} +\bibliographystyle{plainnat} + +\begin{document} + +\emojicitep{einstein, kissing-heart} + +\bibliography{bibliography} +\end{document} +``` + +See [example.tex](./example.tex) for basic usage. + +## Examples + +Table 1: How did you liked the cited work? + +| Citation | Emoji | Description | +|--------------------------------|:--------------:|:---------------------| +| (Einstein, 1905 ๐Ÿ˜˜) | kissing-heart | I like this work. Here is a kiss. +| (Shannon, 1948 ๐Ÿ™‡) | bow | Wow, I can only bow to this work. +| (Kim et al., 2017 ๐Ÿ‘) | +1 | Good work! +| (Zhang and Cheok, 2016 ๐Ÿ˜• ) | confused | I am confused by this work. +| (Le Cun et al., 1989 ๐Ÿฅฑ) | yawning-face | Boring work. +| (Tishby and Zaslavsky, 2015 ๐Ÿคจ)| raised-eyebrow | I have some serious questions... +| (Wakefield et al., 1998 ๐Ÿคฆ) | facepalm | omg, this work sucks! + + +Table 2: How thoroughly have you read the work? + +| Citation | Emoji | Description | +|--------------------------------|:--------------:|:---------------------| +| (Kingma and Welling, 2013 ๐Ÿค“) | nerd-face | I know everything about this work. +| (Kim et al., 2017 ๐ŸŽ“) | graduation-cap | I know this work well. +| (Shannon, 1948 ๐Ÿค”) | thinking | I read it but I still have questions. +| (Jones, 1972 ๐Ÿ™ˆ) | see-no-evil | Ups, I did not read this work in-depth. +| (Einstein, 1905 ๐Ÿคท) | shrug | too long; did not read + +See [PDF Docu](http://mirrors.ctan.org/macros/luatex/latex/emojicite/emojicite-doc.pdf) for more examples. + + +## Requirements + +The package requires the Tex Live 2020 distributon and you need to use lualatex. +If you use the `latexmk` tool, simple use `latexmk -pdflua`. See the +[emoji](https://github.com/stone-zeng/latex-emoji) package for are in-depth +description on the requirements. + + +----- + +Copyright (C) 2020 by Leon Sixt. + +๐Ÿ™ to Xiangdong Zeng creator of [emoji](https://github.com/stone-zeng/latex-emoji) diff --git a/Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.pdf b/Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.pdf new file mode 100644 index 00000000000..4ef79c3566f Binary files /dev/null and b/Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.pdf differ diff --git a/Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.tex b/Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.tex new file mode 100644 index 00000000000..baf37b8991b --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/emojicite/emojicite-doc.tex @@ -0,0 +1,182 @@ +\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.com}}} +\date{\emoji{date} 2020/04/13\quad v0.1} + + +\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} + +Here are some emoji, I found fitting. + +\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} diff --git a/Master/texmf-dist/doc/lualatex/emojicite/example.tex b/Master/texmf-dist/doc/lualatex/emojicite/example.tex new file mode 100644 index 00000000000..5a43430434f --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/emojicite/example.tex @@ -0,0 +1,12 @@ +\documentclass{article} + +\usepackage{emojicite} +\setcitestyle{authoryear, round} +\bibliographystyle{plainnat} + +\begin{document} + +\emojicitep{einstein, kissing-heart} + +\bibliography{bibliography} +\end{document} diff --git a/Master/texmf-dist/tex/lualatex/emojicite/emojicite.sty b/Master/texmf-dist/tex/lualatex/emojicite/emojicite.sty new file mode 100644 index 00000000000..3b459046b37 --- /dev/null +++ b/Master/texmf-dist/tex/lualatex/emojicite/emojicite.sty @@ -0,0 +1,101 @@ +%% +%% Copyright (C) 2020 by Leon Sixt +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3c 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 +%% LaTeX version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Leon Sixt. +%% +\NeedsTeXFormat{LaTeX2e}[2020/02/02] +\ProvidesExplPackage{emoji}{2020/04/14}{0.1}{Add Emojis to Citations (in LuaLaTeX)} + +\usepackage{emoji} +\usepackage{natbib} + +\usepackage{xparse} +\ExplSyntaxOn + +\makeatletter +\NewDocumentCommand{\emojicite}{m} + { + \mjb_multicitep:n { #1 } + } +\makeatother + + +\makeatletter +\NewDocumentCommand{\emojicitep}{m} + { + \NAT@open + \mjb_multicitep:n { #1 } + \NAT@close + } +\makeatother + +\seq_new:N \l_mjb_multicite_in_seq +\seq_new:N \l_mjb_multicite_out_seq +\seq_new:N \l_mjb_cite_seq + +\cs_new_protected:Npn \mjb_multicitep:n #1 + { + \seq_set_split:Nnn \l_mjb_multicite_in_seq { ; } { #1 } + \seq_clear:N \l_mjb_multicite_out_seq + \seq_map_inline:Nn \l_mjb_multicite_in_seq + { + \mjb_cite_process:n { ##1 } + } + \seq_use:Nn \l_mjb_multicite_out_seq { ;~ } + } + +\cs_new_protected:Npn \mjb_cite_process:n #1 +{ + \seq_set_split:Nnn \l_mjb_cite_seq { , } { #1 } + \int_compare:nTF { \seq_count:N \l_mjb_cite_seq == 1 } + { + \seq_put_right:Nn \l_mjb_multicite_out_seq + { \citeauthor{#1},~\citeyear{#1} } + } + { + \int_compare:nTF { \seq_count:N \l_mjb_cite_seq == 2 } + { + \seq_put_right:Nx \l_mjb_multicite_out_seq + { + \exp_not:N \citeauthor{\seq_item:Nn \l_mjb_cite_seq { 1 }},~ + \exp_not:N \citeyear{\seq_item:Nn \l_mjb_cite_seq { 1 }}~ + \emoji{\seq_item:Nn \l_mjb_cite_seq { 2 }} + } + } + % we can handle up to 2 emojis + { + \int_compare:nTF { \seq_count:N \l_mjb_cite_seq == 3 } + { + \seq_put_right:Nx \l_mjb_multicite_out_seq + { + \exp_not:N \citeauthor{\seq_item:Nn \l_mjb_cite_seq { 1 }},~ + \exp_not:N \citeyear{\seq_item:Nn \l_mjb_cite_seq { 1 }}~ + \emoji{\seq_item:Nn \l_mjb_cite_seq { 2 }} + \emoji{\seq_item:Nn \l_mjb_cite_seq { 3 }} + } + } + { + \seq_put_right:Nx \l_mjb_multicite_out_seq + { + \exp_not:N \citeauthor{\seq_item:Nn \l_mjb_cite_seq { 1 }},~ + \exp_not:N \citeyear{\seq_item:Nn \l_mjb_cite_seq { 1 }}~ + \exp_not:N \textbf{emojicite~does~not~support~more~than~two~emojis}. + } + } + } + } + } +\ExplSyntaxOff + diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check index 3aa87198cc5..5adf3c4ad99 100755 --- a/Master/tlpkg/bin/tlpkg-ctan-check +++ b/Master/tlpkg/bin/tlpkg-ctan-check @@ -262,7 +262,8 @@ my @TLP_working = qw( ellipse ellipsis elmath elocalloc elpres els-cas-templates elsarticle elteikthesis eltex elvish elzcards - emarks embedall embedfile embrac emf emisa emoji emptypage emulateapj emp + emarks embedall embedfile embrac emf emisa + emoji emojicite emptypage emulateapj emp enctex encxvlna endfloat endheads endiagram endnotes endnotes-hy endnotesj endofproofwd engpron engrec engtlc enigma enotez diff --git a/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc b/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc index 61a6129976a..f34f140f167 100644 --- a/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc +++ b/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc @@ -15,6 +15,7 @@ depend combofont depend cstypo depend ctablestack depend emoji +depend emojicite depend enigma depend interpreter depend kanaparser diff --git a/Master/tlpkg/tlpsrc/emojicite.tlpsrc b/Master/tlpkg/tlpsrc/emojicite.tlpsrc new file mode 100644 index 00000000000..e69de29bb2d -- cgit v1.2.3