summaryrefslogtreecommitdiff
path: root/graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex')
-rw-r--r--graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex31
1 files changed, 21 insertions, 10 deletions
diff --git a/graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex b/graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex
index e3ef5b24ae..00b3b0ddbf 100644
--- a/graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex
+++ b/graphics/metapost/contrib/macros/wordcloud/doc/wordcloud-doc-en.tex
@@ -6,9 +6,6 @@
% Originally written by Maxime Chupin <notezik@gmail.com>,
% 2023.
%
-% Distributed under the terms of the GNU free documentation licence:
-% http://www.gnu.org/licenses/fdl.html
-% without any invariant section or cover text.
\documentclass[english]{ltxdoc}
@@ -42,7 +39,7 @@
\noindent
{\Large drawing wordclouds \\[0.2cm]with \hologo{METAPOST} and Lua}\\[3cm]
\parbox{0.6\textwidth}{
- \wordcloud[scale=2,rotate=0,margin=0.5pt,usecolor]{(Wordcloud,10);(\\hologo{METAPOST},6);(\\LaTeX,7);(Lua,4);(algorithm,3);(code,2);(mathematics,2);(CTAN,2);(mplib,4);(\\hologo{LuaTeX},4);(latexmp,3);(graphism,2)}
+ \wordcloud[scale=2,rotate=0,margin=0.5pt,usecolor]{(Wordcloud,10);(\hologo{METAPOST},6);(\LaTeX,7);(Lua,4);(algorithm,3);(code,2);(mathematics,2);(CTAN,2);(mplib,4);(\hologo{LuaTeX},4);(latexmp,3);(graphism,2)}
}\hfill
\parbox{0.5\textwidth}{\Large\raggedleft
\textbf{Contributor}\\
@@ -51,8 +48,8 @@
}
\vfill
\begin{center}
- Version 0.1, 2023, August, 9th \\
- \url{https://plmlab.math.cnrs.fr/mchupin/wordcloud}
+ Version 0.2, 2023, September, 7th \\
+ \url{https://plmlab.math.cnrs.fr/mchupin/mchupin/wordcloud}
\end{center}
%% == Page de garde ====================================================
\newpage
@@ -348,7 +345,7 @@ have the same options:
\hologo{METAPOST}.} ;
\item[\texttt{margin=}\meta{value with units}:] to adjust the margins
(default \lstinline+0.3pt+) ;
- \item[\texttt{rotation=}\meta{angle}:] to rotate (degrees) the words with
+ \item[\texttt{rotate=}\meta{angle}:] to rotate (degrees) the words with
$\pm$\meta{angle} alternatively (default 0) ;
\item[\texttt{usecolor}:] to use color for word drawing (boolean, default
\lstinline+false+) as described in section~\ref{sec:colors} ;
@@ -361,12 +358,19 @@ have the same options:
Here an example:
\begin{ExempleLaTeX}
-\wordcloud[scale=1,rotate=45,margin=0.5pt,usecolor,colors={red!40,blue!40,green!20!black}]{(Wordcloud,10);(\\hologo{METAPOST},6);(\\LaTeX,7);(Lua,4);(algorithm,3);(code,2);(mathematics,2);(CTAN,2);(mplib,4);(\\hologo{LuaTeX},4);(latexmp,3);(graphism,2)}
+\wordcloud[scale=1,rotate=45,margin=0.5pt,usecolor,colors={red!40,blue!40,green!20!black}]{(Wordcloud,10);(\hologo{METAPOST},6);(\LaTeX,7);(Lua,4);(algorithm,3);(code,2);(mathematics,2);(CTAN,2);(mplib,4);(\hologo{LuaTeX},4);(\texttt{latexmp},3);(graphism,2)}
\end{ExempleLaTeX}
+Since version 0.2, you could use any \LaTeX{} code to define words for the
+wordcloud. In the definition of the \LaTeX{} command, \wordcloudpkg{} uses
+\lstinline+\luaescapestring+ to deals with commands. For example, as far as we
+know, this \wordcloudpkg package is the only wordcloud tool that could build a
+wordcloud of mathematical formulas.
+
\begin{remark}
-Because the list of words and weights is given to Lua, we have to escape the
-\lstinline+\+ to use \LaTeX{} commands.
+ Because the \hologo{METAPOST} side uses \lstinline+textext+ command to build
+ words, \lstinline+\mplibtextextlabel{enable}+ is used to enable string labels
+ typeset via \lstinline+textext()+ instead of \emph{infont} operator.
\end{remark}
\subsection{Add ignored words}
@@ -420,6 +424,13 @@ Some things to do:
\item Add options for rotation of words.
\end{itemize}
+\section{History}
+
+\begin{description}
+ \item[v0.2 (09/2023):] Deal with \lstinline+\luaescapestring+ for list with
+ \lstinline+\wordcloud+. Typos in doc.
+ \item[v0.1 (08/2023):] First publication.
+\end{description}
\printbibliography
\printindex
\newpage