diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/easyformat/README | 8 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/easyformat/easyformat.pdf | bin | 146508 -> 168134 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/easyformat/easyformat.tex | 99 |
3 files changed, 84 insertions, 23 deletions
diff --git a/Master/texmf-dist/doc/latex/easyformat/README b/Master/texmf-dist/doc/latex/easyformat/README index a5e1a68d638..bc6d0d39211 100644 --- a/Master/texmf-dist/doc/latex/easyformat/README +++ b/Master/texmf-dist/doc/latex/easyformat/README @@ -1,12 +1,14 @@ -easyformat is a package that allows the use of _ (the underscore) to add italics and bold text. +easyformat is a package that allows the use of _ (the underscore) +to add italics and bold text and ^ (the circumflex) to add smallcaps. Usage: Import the package with: \usepackage{easyformat} Now you can do the following in textmode: -_italics_, __bold__, ___bolditalic___. +_italics_, __bold__, ___bolditalic___ and ^smallcaps^. -The underscore's (_) meaning in mathmode stays the same. +The underscore's (_) and circumflex's (^) meaning in +mathmode stay the same. (See easyformat.pdf for more info.) diff --git a/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf b/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf Binary files differindex 48ecdb6b477..472dac41f4e 100644 --- a/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf +++ b/Master/texmf-dist/doc/latex/easyformat/easyformat.pdf diff --git a/Master/texmf-dist/doc/latex/easyformat/easyformat.tex b/Master/texmf-dist/doc/latex/easyformat/easyformat.tex index a0f544a76ff..904680da685 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/09 version (v1.1.0)} + \large _the_ manual for the 2017/04/17 version (v1.2.0)} \author{Evert Provoost} @@ -22,10 +22,10 @@ \maketitle \begin{abstract} - \easyformat\ is a package that allows the use of~\_ to begin/end _italic_ or __bold__ formatting as an alternative to the standard \LaTeXe\ \verb|\textit{italic}| and/or \verb|\textbf{bold}|. + \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}|. \end{abstract} - %\tableofcontents % NOT NEEDED + \tableofcontents \newpage %% NOT NEEDED. @@ -63,38 +63,63 @@ \verb|__Stop!__, you _have_ to wait!| \end{quote} - (Why underscores? See: \ref{Why?!}) + (Why underscores? See: \ref{Why?!})\\ + + And since it is good practice to add abbreviations using ^smallcaps^, \easyformat\ gives you \verb|^smallcaps^|. + + So: + \begin{quote} + \verb|^nasa^ and ^esa^ are probably the best known space agencies.| + \end{quote} + + Results in: + \begin{quote} + ^nasa^ and ^esa^ are probably the best known space agencies. + \end{quote} \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. + + 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. + + \newpage As already said, \easyformat\ uses a Markdown-like syntax, so: \begin{quote} - \verb|_italic,_ __bold,__ and ___bolditalic!___| + \verb|_italic,_ __bold,__, ___bolditalic___ and ^smallcaps!^| \end{quote} Gives: \begin{quote} - _italic,_ __bold,__ and ___bolditalic!___ + _italic,_ __bold,__, ___bolditalic___ and ^smallcaps!^ \end{quote} However we can also do more complex stuff, eg.: \begin{quote} - \verb|_Lorem __ipsum_ totalem__ da __givea _zin_ doram__ _zet_tim, liefkan.| + \verb|_Lorem __ipsum_ totalem__ ^da^ __givea _zin_ doram__ _zet_tim, liefkan.| \end{quote} Becomes: \begin{quote} - _Lorem __ipsum_ totalem__ da __givea _zin_ doram__ _zet_tim, liefkan. + _Lorem __ipsum_ totalem__ ^da^ __givea _zin_ doram__ _zet_tim, liefkan. \end{quote} - Those with a good eye might have noticed that \easyformat\ adds italicscorrection when needed. Just like \verb|\textit{zet}tim| would have. + Those with a good eye might have noticed that \easyformat\ adds italics correction when needed. Just like \verb|\textit{zet}tim| would have. - \section{Utilities} - %% This is solved in version 2017/04/09 + \section{Troubleshooting} + \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. + + + %% This is solved in version 2017/04/09 v1.1.0 %\subsection{Underscore in subtitles\label{undtitles}} %If you ever try something similar to \verb|\section{__Vectors:__ %$\vec{F}_g$}|: \TeX\ will shout at you. Why? I don't really know. However I %do know how to fix this. If we want to get the previous example we would use: @@ -108,17 +133,48 @@ %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.) - \subsection{\texttt{\textbackslash nrshape}} - Reverts the fontshape to the default. + \section{Macros} + \subsection{Special characters} + \noindent\fbox{\texttt{\textbackslash cir}} + Add the circumflex (\cir) character. + + \subsection{Fonts} + \noindent\fbox{\texttt{\textbackslash nrfamily}} + Reverts the fontfamily to the default.\\ + + \noindent\fbox{\texttt{\textbackslash nrshape}} + Reverts the fontshape to the default.\\ + + \noindent\fbox{\texttt{\textbackslash nrseries}} + Reverts the fontseries to the default.\\ + + \noindent\fbox{\texttt{\textbackslash setffamily\{_fontfamily_\}}} + Quickly change the fontfamily.\\ + + \noindent\fbox{\texttt{\textbackslash setfshape\{_fontshape_\}}} + Quickly change the fontshape.\\ + + \noindent\fbox{\texttt{\textbackslash setfseries\{_fontseries_\}}} + Quickly change the fontseries. + + \subsection{\easyformat\ syntax} + \noindent\fbox{\texttt{\textbackslash enableeasyformat}} + Enables the \easyformat\ syntax.\\ - \subsection{\texttt{\textbackslash nrseries}} - Reverts the fontseries to the default. + \noindent\fbox{\texttt{\textbackslash disableeasyformat}} + Disables the \easyformat\ syntax.\\ - \subsection{\texttt{\textbackslash setundact}} - Sets the catcode of \_ to 13 (active), effectively _(re-)enabling_ the \easyformat\ syntax. + \noindent\fbox{\texttt{\textbackslash setcaract}} + Sets the catcode of \cir\ to 13 (active).\\ - \subsection{\texttt{\textbackslash setundsub}} - Sets the catcode of \_ to 8 (subscript), effectively _disabling_ the \easyformat\ syntax. + \noindent\fbox{\texttt{\textbackslash setcarsup}} + Sets the catcode of \cir\ to 7 (superscript).\\ + + \noindent\fbox{\texttt{\textbackslash setundact}} + Sets the catcode of \_ to 13 (active).\\ + + \noindent\fbox{\texttt{\textbackslash setundsub}} + Sets the catcode of \_ to 8 (subscript). \section{Technical details} \subsection{Why \_ and not *?\label{Why?!}} @@ -127,13 +183,16 @@ \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.) - \section{Contact} + \section{Contact\label{contact}} If you want to make suggestions or have any questions whose answer could be included in a future version of this document, you can email to this address: \url{mailto:evert.provoost@gmail.com} \newpage \section{Changelog} We only include important changes from v1.0.0 onwards, since earlier versions barely worked. + \subsection*{2017/04/17 v1.2.0} + 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). |