summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/pgf-periodictable/pgf-PeriodicTableManual.tex
blob: 30abe7b8bb8bf745a9c4dfbd1c253ea44a007ab4 (plain)
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
\documentclass[a4paper,10pt,oneside,openany,fleqno]{article}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{pgf-PeriodicTable}
\usepgfPTlibrary{colorschemes}%
\input{manualfiles/pgfPTmanual.macros.tex}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\title{Manual for pgf-PeriodicTable \pgfPTversion}
\author{Hugo Gomes\\
  \texttt{hugo.parelho@gmail.com}}
\date{\today}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}%
\begin{titlepage}
\vspace{\stretch{1}}%
\maketitle\thispagestyle{empty}%
\vspace{-1cm}%
\makebox[\linewidth][c]{\scalebox{.6}{\pgfPT[show title=false,show legend=false]}}%
\\ [6pt]\makebox[\linewidth][c]{\bfseries\footnotesize\textsf{\pgfPTMmacro{pgfPT}[show title=false,show legend=false]}}%
\vspace{\stretch{6}}
\makebox[\linewidth][c]{\tikz{%
\node[text width=.9\linewidth+.5cm,text justified,draw=blue!10!black,rounded corners=10pt,fill=blue!5] at (0,0) {\color{blue!10!black}
\begin{abstract}
\noindent The purpose of this package is to provide the Periodic Table of Elements in a simple way. It relies on pgf/\txttikz{} to offer a full or partial periodic table with a variety of options and displaying the desired data. The data available, from all the actual 118 elements, is: atomic number, element name, chemical symbol, relative atomic mass, standard relative atomic mass, radioactivity, atomic radius (empirycal), covalente radius, ionic radius, first ionization energy, electronegati\-vity (Pauling), electroaffinity, oxidation states, melting point (in Kelvin and Celsius degrees), boiling point (in Kelvin and Celsius degrees), electron distribuition, electronic configuration (increasing $n$ and increasing $n+\ell$), density, specific heat capacity, thermal condutivity, lattice structure, lattice constants (a, b, c and c/a ratio), discovery year, discovery country and visible range spectral lines. It is possible to get the Periodic Table in six languages: English, French, German, Portuguese (from Portugal and from Brazil), Spanish and Italian.
\\ [6pt]
\end{abstract}
};}}
\vspace{\stretch{3}}
\end{titlepage}
\newpage%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagestyle{empty}%
\pdfbookmark[1]{Table of contents}{pdfContents}%
\tableofcontents%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newpage\setcounter{page}{1}%
\pagestyle{pgfPTManual}%
\ \vfill%
\section{Installation and usage}
\noindent
\pack{} is placed under the terms of the \textrm{\LaTeX} Project Public License, version 1.3 or later (http://www.latex-project.org/lppl.txt). \pack{} loads and only requires the \href{https://www.ctan.org/pkg/pgf}{\txttikz{}} package.
\\ [6pt]You need to put the package files (pgf-PeriodicTable.sty \&\ \textit{friends}) in a location where \textrm{PDF\LaTeX}, \textrm{Lua\LaTeX} or \textrm{Xe\LaTeX} can find them. According to the TDS conventions this may be a subdirectory named \textit{tex/latex/pgf-PeriodicTable/} or \textit{tex/latex/misc/} in your (site specific) installation tree (insert your appropriate directory delimiter instead of /, if needed).
\\ [6pt]If you are using \textrm{PDF\LaTeX}, \textrm{Lua\LaTeX} or \textrm{Xe\LaTeX} you can just simply include the style file without any option via the \texttt{\large\textcolor{green!40!black}{\textbackslash usepackage}} command, \texttt{\large\textcolor{green!40!black}{\textbackslash usepackage}\textcolor{purple!70!black}{\{}\textcolor{blue!70!black}{pgf-PeriodicTable}\textcolor{purple!40!black}{\}}}
\\ [6pt]It can also be loaded with \textit{one option} to select the desired language:\\ \texttt{\large\textcolor{green!40!black}{\textbackslash usepackage}\textcolor{blue!70!black}{[}\textcolor{brown!60!black}{language flag}\textcolor{blue!70!black}{]}\textcolor{purple!70!black}{\{}\textcolor{blue!70!black}{pgf-PeriodicTable}\textcolor{purple!40!black}{\}}}
\\ [6pt]\textit{The \textcolor{brown!60!black}{language flags} available are:}
\begin{itemize}
\item[$\checkmark$]\textbf{en} for English (default),
\item[$\checkmark$]\textbf{fr} for French,
\item[$\checkmark$]\textbf{de} for German,
\item[$\checkmark$]\textbf{pt} for Portuguese (Portugal),
\item[$\checkmark$]\textbf{br} for Portuguese (Brazil),
\item[$\checkmark$]\textbf{es} for Spanish and
\item[$\checkmark$]\textbf{it} for Italian.
\end{itemize}
\vfill\vfill\vfill\newpage\ \vfill%
\section{The data}
The data available in \pack{} was mainly compiled with selected and filtered data from Wikipedia, taken from November 2021 to July 2022.
\\ [12pt]\header
\\ [-1pt]\linhaimpar{Ar}{Relative Atomic Mass}{}{(Wikidata @09/jan/2022)}%
\\ [-1pt]\linhapar{Arstar}{Standard Relative\newline Atomic Mass}{}{ STANDARD ATOMIC WEIGHTS 2021, %
Commission on Isotopic Abundances and Atomic Weights,\newline\bfseries\textsf{\textcopyright} CIAAW, 2007--2022%
\newline(\href{https://ciaaw.org/impressum.htm}{https://ciaaw.org/impressum.htm})}%
\\ [-1pt]\linhaimpar{radio}{Radioactivity}{}{(gperiodic-3.0.3, Dec 26 2018)}%
\\ [-1pt]\linhapar{R}{Atomic Radius}{$\mathsf{pm}$}{Calculated (Wikidata @04/jul/2022)}%
\\ [-1pt]\linhaimpar{Rcov}{Covalente Radius}{$\mathsf{pm}$}{Single bond, Wikidata @04/jul/2022)}%
\\ [-1pt]\linhapar{Rion}{Ionic Radius}{$\mathsf{pm}$}{(Wikidata @04/jul/2022)}%
\\ [-1pt]\linhaimpar{Ei}{First Ionization Energy}{$\mathsf{kJ\cdot mol^{-1}}$}{(Wikidata @04/jul/2022)}%
\\ [-1pt]\linhapar{eneg}{Electronegativity\newline (Pauling)}{}{(Wikidata @04/jul/2022)}%
\\ [-1pt]\linhaimpar{eaff}{Electroaffinity}{$\mathsf{kJ\cdot mol^{-1}}$}{(Wikidata @04/jul/2022)}%
\\ [-1pt]\linhapar{O}{Oxidation States}{}{(Wikidata @09/jan/2022)}%
\\ [-1pt]\linhaimpar{Tmelt}{Melting Point}{$\mathsf{K}$}{at standard pressure (Wikidata @21/dez/2021)}%
\\ [-1pt]\linhapar{TmeltC}{Melting Point}{$\mathsf{^oC}$}{at standard pressure (Wikidata @21/dez/2021)}%
\\ [-1pt]\linhaimpar{Tboil}{Boiling Point}{$\mathsf{K}$}{at standard pressure (Wikidata @21/dez/2021)}%
\\ [-1pt]\linhapar{TboilC}{Boiling Point}{$\mathsf{^oC}$}{at standard pressure (Wikidata @21/dez/2021)}%
\\ [-1pt]\linhaimpar{eDist}{Electron Distribution}{}{(Wikidata @01/nov/2021)}%
\\ [-1pt]\linhapar{eConfign}{Electronic Configuration (increasing n)}{}{(Wikidata @01/nov/2021)}%
\\ [-1pt]\linhaimpar{eConfign}{Electronic Configuration (increasing $\mathsf{n+\ell}$)}{}{(Wikidata @01/nov/2021)}%
\\ [-1pt]\linhapar{d}{Density}{$\mathsf{g\cdot dm^{-3}}$ {\tiny for gases}\newline$\mathsf{g\cdot cm^{-3}}$ {\tiny all other physical states}}{physical state at $\mathsf{25^oC, 1\,atm}$ (Wikidata @01/nov/2021)}%
\\ [-1pt]\linhaimpar{Cp}{Specific heat capacity}{$\mathsf{J\cdot mol^{-1}\cdot K^{-1}}$}{at $\mathsf{25^oC}$ and $\mathsf{100\,kPa}$ (Wikidata @20/nov/2021)}%
\\ [-1pt]\linhapar{kT}{Thermal Conductivity}{$\mathsf{W\cdot m^{-1}\cdot K^{-1}}$}{at $\mathsf{25^oC}$ (Wikidata @21/nov/2021)}%
\\ [-1pt]\linhaimpar{ls}{Lattice Structure}{}{(Wikidata @20/dez/2021 and \href{http://wwwhomes.uni-bielefeld.de/achim/ele_structures.html}{University of Bielefeld})}%
\\ [-1pt]\linhapar{lsa}{Lattice constant: a}{$\mathsf{pm}$}{(University of Bielefeld @21/dez/2021)}%
\\ [-1pt]\linhaimpar{lsb}{Lattice constant: b}{$\mathsf{pm}$}{(University of Bielefeld @21/dez/2021)}%
\\ [-1pt]\linhapar{lsc}{Lattice constant: c}{$\mathsf{pm}$}{(University of Bielefeld @21/dez/2021)}%
\\ [-1pt]\linhaimpar{lsca}{Lattice c/a ratio}{}{Calculated from available data and rounded to two digits}%
\\ [-1pt]\linhapar{DiscY}{Discover Year}{}{(Wikidata @22/dez/2021)}%
\\ [-1pt]\linhaimpar{DiscC}{Discover Country}{}{(Wikidata @22/dez/2021)}%
\\ [-1pt]\linhapar{spectra}{Visible range spectral lines}{}{Elements spectrum made with \textcolor{blue!50!black}{\textbackslash pgfspectra}.\newline See the \footnotesize\href{https://ctan.org/pkg/pgf-spectra}{\textsf{pgf-spectra}}\scriptsize\ manual for more details}%
\\ [12pt]The utilization of the \textit{acronyms} will be explained in \hyperlink{secBuildCell}{Designing cells with \textbackslash pgfPTbuildcell}.
\vfill\vfill\vfill\newpage
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{file:commands}%
\input{manualfiles/pgf-PeriodicTableManual_commands.tex}%
\newpage%
\def\tmpSection{\bs{pgfPT}}%
\section{\texorpdfstring{Options for \tmpSection: creating a «Periodic Table»}{Options for \textbackslash pgfPT: creating a «Periodic Table»}}
\hypertarget{OPTIONS}{For the commands} \pgfPTMmacro{pgfPT}[] and \pgfPTMmacro{pgfPTstyle}[] there are a set of options available to draw the Periodic Table or any portion of the Periodic Table, as described below.
\\ [6pt]\tikz{\node[text width=\linewidth-6mm,draw=green!70,rounded corners=2pt,fill=black!10!green!10,inner sep=3mm] {%,text justified
\color{green!40!black}The list of options is a comma separated list of any of the following elements:
{\small\begin{itemize}
\item[$\rightsquigarrow$] a \sq{\red{key}} or a \sq{\red{key=value}} pair,
\item[\ding{252}] a \sq{\red{style}} or a \sq{\red{style=value}} pair,
\item[\ding{252}] a \textit{pseudo style} with a proper syntax: \sq{\red{style=\{key 1=value 1, key 2=value 2, \myldots\ , key n=value n\}}}, where none of the \textit{\sq{\red{keys}}} are mandatory.
\end{itemize}}
};}
\\ [3pt]The options \textit{can be divided} in two subsets, one that affects the \textit{appearance} of the \textit{entire} Periodic Table, the other that concerns the \textit{contents} of each cell of the Periodic Table.
\subsection{\texorpdfstring{$\maltese$ Periodic Table options: keys, styles and \itshape pseudo styles}{Periodic Table options}}
The following options and styles are used to \textit{control} the Periodic Table \textit{as a whole} in various aspects, such as the \red{cell width} or \red{cell height}, which elements are displayed (\red{Z list}), whether the title or legend are shown --  \red{show title} or \red{show legend} -- among others.
\label{file:generallayout}%
\input{manualfiles/pgf-PeriodicTableManual_generallayout.tex}%
\label{file:TitleLegend}%
\input{manualfiles/pgf-PeriodicTableManual_TitleLegend.tex}%
\label{file:periodgroup}%
\input{manualfiles/pgf-PeriodicTableManual_periodgroup.tex}%
\label{file:blocksfamilies}%
\input{manualfiles/pgf-PeriodicTableManual_blocksfamilies.tex}%
\newpage%
\label{file:variations}%
\input{manualfiles/pgf-PeriodicTableManual_variations.tex}%
\newpage%
\label{file:DarkMode}%
\input{manualfiles/pgf-PeriodicTableManual_DarkMode.tex}%
\label{file:exerciselayout}%
\input{manualfiles/pgf-PeriodicTableManual_exerciselayout.tex}%
\subsection{\texorpdfstring{$\maltese$ Cell contents options: keys, styles and \itshape pseudo styles}{Cell contents options}}
The following options and styles are used for customizing the contents available in each individual cell of the Periodic Table, like the \textit{fonts} or the \textit{colors} used in the shown contents.
\label{file:Z}%
\input{manualfiles/pgf-PeriodicTableManual_Z.tex}%
\label{file:CS}%
\input{manualfiles/pgf-PeriodicTableManual_CS.tex}%
\label{file:name}%
\input{manualfiles/pgf-PeriodicTableManual_name.tex}%
\label{file:Ar}%
\input{manualfiles/pgf-PeriodicTableManual_Ar.tex}%
\label{file:density}%
\input{manualfiles/pgf-PeriodicTableManual_density.tex}%
\label{file:ls}%
\input{manualfiles/pgf-PeriodicTableManual_ls.tex}%
\label{file:DiscY}%
\input{manualfiles/pgf-PeriodicTableManual_DiscY.tex}%
\label{file:eDist}%
\input{manualfiles/pgf-PeriodicTableManual_eDist.tex}%
\label{file:OtherCont}%
\input{manualfiles/pgf-PeriodicTableManual_OtherCont.tex}%
\newpage%
\label{sec:pgfPTbuildcell}
\def\tmpSection{\bs{pgfPTbuildcell}}%
\hypertarget{secBuildCell}{}%
\section{\texorpdfstring{Designing cells with \tmpSection}{Designing cells with \textbackslash pgfPTbuildcell}}
\input{manualfiles/pgf-PeriodicTableManual_buildCelll.tex}%
\newpage%
\section{\texorpdfstring{Designing color schemes}{Designing color schemes}}
\label{file:DesignCS}%
\input{manualfiles/pgf-PeriodicTableManual_DesignCS.tex}%
\newpage\ \vspace{1.5cm}%
\section{Libraries}
In this part the \hypertarget{sec:lib}{library} packages are documented. They provide additional commands to extend the capabilities provided by this package out of the box. The libraries are not loaded by default since many users will not need them.
\\ [1.5cm]%
\input{manualfiles/pgf-PeriodicTableManual_libCS.tex}%
\newpage%
\section{A few more examples}
\input{manualfiles/pgf-PeriodicTableManual_Examples.tex}%
\newpage\small%
\printindex%
\end{document}