first steps to reusable bibliography and merged acronyms with glossary

Author: thomasWeise

bookbase

@@ -10,7 +10,7 @@
 You need a nice editor in which you can write the programs.
 Actually, you want an editor where you can not just write programs.
 You want an editor where you can also directly execute and test your programs.
-In software development, you often work with a \pgls{VCS} like \git.
+In software development, you often work with a \pgls{vcs} like \git.
 You want to do that convenient from your editor.
 Such an editor, which integrates many of the common tasks that occur during programming, is called an \pgls{IDE}.
 In this book, we will use the \pycharm\ \pgls{IDE}~\cite{VHN2023HOADWP,Y2022PPADT}.

text/main/basics/gettingStarted/gettingStarted.tex

@@ -1261,7 +1261,7 @@
 These methods are \pythonilIdx{\_\_enter\_\_} and \pythonilIdx{\_\_exit\_\_}.
 Since \pythonilIdx{with}~blocks are nice syntactical sugar of the \python\ language, we will here play around with them a little bit.
 
-As example, let us create a simple API that allows us to write output in a subset of the \acrfull{XML} format~\cite{BPSMM2008EMLX1FE,K2019ITXJY,CH2013XFCAMLTMC}.
+As example, let us create a simple API that allows us to write output in a subset of the \glsreset{xml}\pgls{xml} format~\cite{BPSMM2008EMLX1FE,K2019ITXJY,CH2013XFCAMLTMC}.
 \pgls{xml} is a format for data interchange which was predominant in distributed systems the~2000s.
 After that, it began to fade out in favor~\cite{A2020XLATDOEOL} of \pgls{json}~\cite{E2017SE4TJDIS,RFC8259} and \pgls{yaml}~\cite{DNMAASBE2021YAMLYV1,K2019ITXJY,CGTYB2022YFFDCAIE}.
 It is still very relevant today, for example, as foundation of several document formats such as those used in LibreOffice~\cite{DF2024LTDF,GL2012LTSOOSSCBAFACSOL} and Microsoft~Word~\cite{MS2024MW,DR2019STFAWAUMW}, or as the basis for the SVG graphics format~\cite{DDGLMSWFJJ2011SVGSSE}.
@@ -1302,10 +1302,10 @@
 Therefore, they are escaped as entities~\xmlil{&} and~\xmlil{>}.
 
 \gitPython{\programmingWithPythonCodeRepo}{dunder/xml_context.py}{--args format --labels part_1}{dunder:xml_context:part_1}{%
-Part~1 of our very simply context manager-based \pgls{XML} output API.}%
+Part~1 of our very simply context manager-based \pgls{xml} output API.}%
 %
 \gitPython{\programmingWithPythonCodeRepo}{dunder/xml_context.py}{--args format --labels part_2}{dunder:xml_context:part_2}{%
-Part~2 of our very simply context manager-based \pgls{XML} output API.}%
+Part~2 of our very simply context manager-based \pgls{xml} output API.}%
 
 Would it not be nice to have a simple \pgls{API} that allows us to produce valid~\pgls{xml} and that takes care of the escaping of special characters?
 While countless such tools already exist {\dots} let us make our own.
@@ -1415,11 +1415,11 @@
 %
 \gitPythonAndOutputFormat{xml_style}%
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{dunder}{xml_user_print.py}{--args format}{dunder:xml_user_print}{%
-An example of using our simple context manager-based \pgls{XML} output API from \cref{lst:dunder:xml_context:part_1,lst:dunder:xml_context:part_2}, where the output is printed to the \pgls{stdout}.}%
+An example of using our simple context manager-based \pgls{xml} output API from \cref{lst:dunder:xml_context:part_1,lst:dunder:xml_context:part_2}, where the output is printed to the \pgls{stdout}.}%
 %
 \gitPythonAndOutputFormat{xml_style}%
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{dunder}{xml_user_file.py}{--args format}{dunder:xml_user_file}{%
-An example of using our simple context manager-based \pgls{XML} output API from \cref{lst:dunder:xml_context:part_1,lst:dunder:xml_context:part_2}, where the output is written to a text file\pythonIdx{write}\pythonIdx{IO!write}\pythonIdx{open}\pythonIdx{remove}\pythonIdx{os!remove}.}%
+An example of using our simple context manager-based \pgls{xml} output API from \cref{lst:dunder:xml_context:part_1,lst:dunder:xml_context:part_2}, where the output is written to a text file\pythonIdx{write}\pythonIdx{IO!write}\pythonIdx{open}\pythonIdx{remove}\pythonIdx{os!remove}.}%
 
 We now use this \pgls{API} in \cref{lst:dunder:xml_user_print,lst:dunder:xml_user_file} to basically reproduce the small \pgls{xml}~snippet that I showed you before.
 In the former example, we use \pythonil{print} as destination function.
@@ -1671,7 +1671,7 @@
 The \emph{dunder} stands for \emph{double underscore}, because the names of such methods begins and ends with~\pythonilIdx{\_\_}.
 
 Knowing about dunder methods allows us to create classes which can seamlessly be used in arithmetic expressions, in \pythonilIdx{with}~statements, as sequences to iterate over with \pythonilIdx{for}~loops, that support indexing with~\pythonil{[...]}\pythonIdx{[\idxdots]}.
-By implementing dunder methods, we can use the \python\ syntax to construct new collections, support more complex mathematical structures, ensure that resources are properly managed (and eventually disposed), or create elegant and concise APIs.%
+By implementing dunder methods, we can use the \python\ syntax to construct new collections, support more complex mathematical structures, ensure that resources are properly managed (and eventually disposed), or create elegant and concise \pglspl{API}.%
 \endhsection%
 %
 \FloatBarrier%

text/main/classes/dunder/dunder.tex

@@ -609,7 +609,7 @@
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{exceptions}{file_with.py}{--args format}{exceptions:file_with}{%
 Using a \pythonilIdx{with}~block for closing files after writing to and reading from them\pythonIdx{os!remove}\pythonIdx{remove}\pythonIdx{IO!write}\pythonIdx{write}\pythonIdx{readline}\pythonIdx{IO!readline}.}%
 
-Many of \python's resource-related APIs are realized as context managers.
+Many of \python's resource-related \pglspl{API} are realized as context managers.
 This also holds for the file input/output API.
 We now rewrite \cref{lst:exceptions:file_try_finally} using a \pythonilIdx{with} block as \cref{lst:exceptions:file_with}.
 The first thing you will notice is that the file is much shorter.

text/main/controlFlow/exceptions/exceptions.tex

@@ -601,7 +601,7 @@
 %
 \begin{sloppypar}%
 Finally, generator expressions can also be passed to the constructors of collection datastructures or other functions that create such datastructures.
-Assume that we are processing numbers stored in a \pgls{CSV} format.
+Assume that we are processing numbers stored in a \pgls{csv} format.
 Often, the rows of text files with tabular or matrix data are in this format.
 In \cref{lst:iteration:generator_expressions_to_collection}, we first define a string \pythonil{csv_text} with the value~\pythonil{"22,56,33,67,43,33,12"}.
 Invoking \pythonil{csv_text.split(",")}\pythonIdx{split}\pythonIdx{str!split} will split the string into a list of single strings based on the delimiter~\pythonil{","}.
@@ -751,14 +751,14 @@
 %
 Another important utility function when dealing with sequences is the function~\pythonilIdx{map}.
 We explore its use in \cref{lst:iteration:map}.
-Back in \cref{lst:iteration:generator_expressions_to_collection}, we used a generator expression to process data that we exracted from a \pgls{CSV}-formatted string.
+Back in \cref{lst:iteration:generator_expressions_to_collection}, we used a generator expression to process data that we exracted from a \pgls{csv}-formatted string.
 Instead of doing \pythonil{int(s) for s in csv_text.split(",")} we can simply write \pythonil{map(int, csv_text.split(",")}.
 The first argument to \pythonilIdx{map} is a function that should be applied all of the elements in the sequence passed in as its second argument.
 The result of \pythonilIdx{map} is a new sequence with the return values of this function.
 In \cref{lst:iteration:map}, we map the string \pythonil{csv_text} split at all~\pythonil{","} to \pythonilsIdx{int} and then \pythonilIdx{filter} the sequence to retain only values greater than~20.
 We can conveniently iterate over the resulting filtered and mapped sequence using a~\pythonilIdx{for}~loop.
 
-How about we now obtain all the unique squares of the values in the CSV data, i.e., we discard all duplicate squares.
+How about we now obtain all the unique squares of the values in the \pgls{csv} data, i.e., we discard all duplicate squares.
 First, we again use \pythonilIdx{split}\pythonIdx{str!split} to divide the text into chunks based on the separator~\pythonil{","}.
 Then we map these chunks to integers and return their squares using the \pythonilIdx{map}~function, but this provide a~\pythonilIdx{lambda} that does the transformation.
 Now we want to retain only the unique values.

text/main/controlFlow/iteration/iteration.tex

@@ -3,8 +3,8 @@
 A software developer rarely works on a stand-alone project all by themself.
 Instead, they develop projects that are part of an ecosystem of applications.
 Their programs will usually depend on libraries, i.e., \python\ packages that offer functionality.
-Often, their projects are stored in \pglspl{VCS} like \git\ repositories.
-In this part of the book, we will take a small glimpse on how to work within a system of existing projects and \pglspl{VCS}.%
+Often, their projects are stored in \pglspl{vcs} like \git\ repositories.
+In this part of the book, we will take a small glimpse on how to work within a system of existing projects and \pglspl{vcs}.%
 %
 \hinput{packages}{packages.tex}%
 \hinput{git}{git.tex}%

text/main/ecosystem/ecosystem.tex

@@ -1,11 +1,11 @@
 \hsection{The Distributed Version Control System git}%
 %
-Today, \git~\cite{S2023LG,T2024BGAGVCPMATFTND} is maybe the \pgls{VCS} with the most wide-spread use.
-It is the \pgls{VCS} on which \github~\cite{PRGWSUdVLFTEKPKFBV2016TSRFTAOGAG,GH2025RD,S2021GAGCC} is based, which, in turn, is maybe the most important hub for open source software projects in the world.
+Today, \git~\cite{S2023LG,T2024BGAGVCPMATFTND} is maybe the \pgls{vcs} with the most wide-spread use.
+It is the \pgls{vcs} on which \github~\cite{PRGWSUdVLFTEKPKFBV2016TSRFTAOGAG,GH2025RD,S2021GAGCC} is based, which, in turn, is maybe the most important hub for open source software projects in the world.
 \git\ is based on a \pgls{clientServerArchitecture}, where the \pgls{server} hosts and manages repositories of source code and other resources.
 The \git\ \pgls{client} is a command line application that is run in the \pgls{terminal} and which allows you to clone (i.e., download) source code repositories and upload (i.e., commit) changes to them.
 A repository is something like a directory with files and their editing history, i.e., you can work and improve source code, commit changes, and see the history of all past commits.
-This is what \pglspl{VCS} are for:
+This is what \pglspl{vcs} are for:
 They do not just provide the current state of a project and allow teams to cooperative and continuous develop software, they also store the history of the project so as to enable us to see which code was used in which version of our software and to track changes.
 How to correctly use \git\ thus is a very complex and involved topic beyond the scope of this book.
 However, we will here take at least a look into a very small subset of functions that provide you a starting point for working with \git\ repositories.%

text/main/ecosystem/git/git.tex

@@ -238,7 +238,7 @@
 %
 \subfloat[][%
 Well, there may be other issues unrelated to packages{\dots} %
-{\dots}the program I chose here is from our book on \citetitle{databases}~\cite{databases}, and it needs the \postgresql\ \pgls{DBMS} running with a specific \pgls{db} ready. %
+{\dots}the program I chose here is from our book on \citetitle{databases}~\cite{databases}, and it needs the \postgresql\ \pgls{dbms} running with a specific \pgls{db} ready. %
 So likely, you cannot just run it {\dots} it was just an example.%
 \label{fig:gitClonePycharm26ranError}%
 ]{\tightbox{\includegraphics[width=0.48\linewidth]{\currentDir/gitClonePycharm26ranError}}}%