summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/easyformat/easyformat.pdfbin168134 -> 47204 bytes
-rw-r--r--Master/texmf-dist/doc/latex/easyformat/easyformat.tex42
2 files changed, 25 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf b/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf
index 472dac41f4e..94ebdff9d10 100644
--- a/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf
+++ b/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/easyformat/easyformat.tex b/Master/texmf-dist/doc/latex/easyformat/easyformat.tex
index 904680da685..78c8a0aa999 100644
--- a/Master/texmf-dist/doc/latex/easyformat/easyformat.tex
+++ b/Master/texmf-dist/doc/latex/easyformat/easyformat.tex
@@ -11,7 +11,7 @@
\def\easyformat{\texttt{easyformat}}
\title{\easyformat\\[.5em]
- \large _the_ manual for the 2017/04/17 version (v1.2.0)}
+ \large _the_ manual for the 2017/05/28 version (v1.3.0)}
\author{Evert Provoost}
@@ -22,7 +22,7 @@
\maketitle
\begin{abstract}
- \easyformat\ is a package that allows the use of~\_ to begin/end _italic_ or __bold__ and \cir\ to begin/end ^smallcaps^. As an alternative to the standard \LaTeXe\ \verb|\textit{italic}|, \verb|\textbf{bold}| and \verb|\textsc{smallcaps}|.
+ \easyformat\ is a package that allows the use of~\verb|_| to begin/end _italic_ or __bold__ and \verb|^| to begin/end ^smallcaps^. As an alternative to the standard \LaTeX\ \verb|\textit{italic}|, \verb|\textbf{bold}| and \verb|\textsc{smallcaps}|.
\end{abstract}
\tableofcontents
@@ -80,9 +80,9 @@
\section{Usage, syntax and examples}
Like usual you import the package with: \verb|\usepackage{easyformat}|
- \easyformat\ makes \_ an active character, however it was already 'special' before so you still have to type~\verb|\_| if you want to insert an underscore.
+ \easyformat\ makes \verb|_| an active character, however it was already `special' before so you still have to type~\verb|\_| if you want to insert an underscore.
- The same can be said of \cir, however since this one is difficult to add in ordinary \LaTeX, the \easyformat\ package gives you \verb|\cir| to get \cir.
+ The same can be said of \verb|^|, however since this one is difficult to add in ordinary \LaTeX, the \easyformat\ package gives you \verb|\cir| to get \cir.
\newpage
@@ -110,13 +110,15 @@
Those with a good eye might have noticed that \easyformat\ adds italics correction when needed. Just like \verb|\textit{zet}tim| would have.
\section{Troubleshooting}
+ \easyformat\ tends to conflict with the loading of other packages, therefore you should probably load \easyformat\ last.
+
\begin{quotation}
``For some or other reason I get some weird formatting\dots''
\end{quotation}
It could be a bug---in which case I'd love to hear from you (see \ref{contact})---however, you probably forgot to close your formatting somewhere and because of how \easyformat\ works you can get weird results.
- %__Explanation:__ when you start eg. _italics_ with \_, \easyformat\ %remembers the shape (the same is true for ^smallcaps^, when you %start __boldface__ it remembers the series) of the font. When you %get out of _italics_, it resets the shape (respectively the series) %to what it was before the starting the formatting.
+ %__Explanation:__ when you start eg. _italics_ with \verb|_|, \easyformat\ %remembers the shape (the same is true for ^smallcaps^, when you %start __boldface__ it remembers the series) of the font. When you %get out of _italics_, it resets the shape (respectively the series) %to what it was before the starting the formatting.
%% This is solved in version 2017/04/09 v1.1.0
@@ -131,12 +133,12 @@
% \hspace*{0pt}\verb|\setundact|
%\end{quote}
- %This first resets the \_ character so it can only be used as the start of %subscripts; then adds the subtitle and afterwards re-initiates \_ for %__bold__ and _italic_. (Obviously the \easyformat\ syntax does not work %_in_ the subtitle, so you'll have to use the \LaTeX-commands.)
+ %This first resets the \verb|_| character so it can only be used as the start of %subscripts; then adds the subtitle and afterwards re-initiates \verb|_| for %__bold__ and _italic_. (Obviously the \easyformat\ syntax does not work %_in_ the subtitle, so you'll have to use the \LaTeX-commands.)
\section{Macros}
\subsection{Special characters}
\noindent\fbox{\texttt{\textbackslash cir}}
- Add the circumflex (\cir) character.
+ Insert a circumflex (\cir) character.
\subsection{Fonts}
\noindent\fbox{\texttt{\textbackslash nrfamily}}
@@ -164,21 +166,21 @@
\noindent\fbox{\texttt{\textbackslash disableeasyformat}}
Disables the \easyformat\ syntax.\\
- \noindent\fbox{\texttt{\textbackslash setcaract}}
- Sets the catcode of \cir\ to 13 (active).\\
+ \noindent\fbox{\texttt{\textbackslash setciract}}
+ Sets the catcode of \verb|^| to 13 (active).\\
- \noindent\fbox{\texttt{\textbackslash setcarsup}}
- Sets the catcode of \cir\ to 7 (superscript).\\
+ \noindent\fbox{\texttt{\textbackslash setcirsup}}
+ Sets the catcode of \verb|^| to 7 (superscript).\\
\noindent\fbox{\texttt{\textbackslash setundact}}
- Sets the catcode of \_ to 13 (active).\\
+ Sets the catcode of \verb|_| to 13 (active).\\
\noindent\fbox{\texttt{\textbackslash setundsub}}
- Sets the catcode of \_ to 8 (subscript).
+ Sets the catcode of \verb|_| to 8 (subscript).
\section{Technical details}
- \subsection{Why \_ and not *?\label{Why?!}}
- To make * work we would have to make it an active character, however this would break things like \verb|\section*{Art}|. The~\_ is already protected by \TeX\ because of it's meaning in mathmode. However, it has little to no use in textmode. This is why we can use~\_ for this purpose and not~*.
+ \subsection{Why \texttt{\_} and not *?\label{Why?!}}
+ To make * work we would have to make it an active character, however this would break things like \verb|\section*{Art}|. The~\verb|_| is already protected by \TeX\ because of it's meaning in mathmode. However, it has little to no use in textmode. This is why we can use~\verb|_| for this purpose and not~*.
\subsection{Does this break mathmode?}
No it doesn't. It keeps behaving like before in mathmode, it's meaning only changes in textmode. (We first check whether we are in mathmode or not and behave accordingly.)
@@ -190,8 +192,15 @@
\section{Changelog}
We only include important changes from v1.0.0 onwards, since earlier versions barely worked.
+ \subsection*{2017/05/28 v1.3.0}
+ Removed forced re-enabling of the \easyformat-syntax at the start of the document.
+ Rewritten to use \texttt{expl3}, this makes the code shorter and a future move to \LaTeX3 easier.
+ Fixed an error that could occur with \verb|\cir|.
+ \easyformat\ now also behaves correctly when a fontpackage is loaded.
+
\subsection*{2017/04/17 v1.2.0}
- Improved handling of mixed styles. Added \verb|^smallcaps^| for ^smallcaps^.
+ Improved handling of mixed styles.
+ Added \verb|^smallcaps^| for ^smallcaps^.
\subsection*{2017/04/09 v1.1.0}
Made usage of syntax in \verb|\section{}|, and similar macros, possible. Changed the behaviour so it works more like \verb|\emph{}| (this also simplifies the code).
@@ -199,7 +208,6 @@
\subsection*{2017/04/07 v1.0.0}
First stable version.
-
% Insert a friendly message :)
\vspace*{\fill}\noindent
Made with $\heartsuit$ in Berlaar, Belgium.