diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/awesomebox')
| -rw-r--r-- | Master/texmf-dist/doc/latex/awesomebox/README.md | 22 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf | bin | 50878 -> 52563 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex | 114 |
3 files changed, 100 insertions, 36 deletions
diff --git a/Master/texmf-dist/doc/latex/awesomebox/README.md b/Master/texmf-dist/doc/latex/awesomebox/README.md index 18adc1aac5d..97a862fa097 100644 --- a/Master/texmf-dist/doc/latex/awesomebox/README.md +++ b/Master/texmf-dist/doc/latex/awesomebox/README.md @@ -16,9 +16,10 @@ Requirements The following LaTeX packages are required (they should be already included in your LaTeX distribution): +- `array` - `fontawesome5` +- `ifthen` - `xcolor` -- `array` - `xparse` Installation @@ -30,6 +31,25 @@ document your are composing. For system wide installation, please refer to the documentation of your LaTeX distribution. +Compatibility +============= + +This repository also hosts the package `awesomebox-compat`, which +depends on the `fontawesome` package, instead of `fontawesome5`. Apart +from that, it has the exact same features set. + +This can be usefull for you if you want to use it with an old LaTeX +distribution, which does not embed `fontawesome5` yet (like Overleaf +system). To use it, download the file `awesomebox-compat.sty` in this +repository, put it near your tex files and just replace your +`\usepackage{awesomebox}` instruction by +`\usepackage{awesomebox-compat}`. + +Be aware that icon names changes between FontAwesome and FontAwesome5 +and thus using the compatibility package may break your current files. +FontAwesome also requires you to use XeLaTeX or LuaTeX: you cannot use +PDFLaTeX with the compatibility package. + License ======= diff --git a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf Binary files differindex c59857aae35..80d9c493664 100644 --- a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf +++ b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf diff --git a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex index 8403ed7dd75..7794b804592 100644 --- a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex +++ b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex @@ -19,7 +19,14 @@ %\usepackage[T1]{fontenc} %\usepackage[english,frenchb]{babel} -\usepackage[vmargin=2cm,hmargin=3cm,includeheadfoot=true]{geometry} +\usepackage{geometry} +\geometry{ + xetex, + vmargin=2cm, + hmargin=3cm, + includeheadfoot, + nomarginpar +} \linespread{1.2} \newcommand{\cf}[1]{(\emph{cf.} section \ref{#1}, % @@ -29,7 +36,7 @@ \newcommand{\colophon}{ ~\vfill \begin{center} - \scriptsize Prepared with \faHeart{} from Nantes, + \scriptsize Handcrafted with \faHeart{} from Nantes, France\\ Awesome Box is released under the \hrefcolor{http://www.wtfpl.net/txt/copying/}{WTFPL}. A copy of this @@ -38,6 +45,10 @@ \end{center} } +\title{Awesome Boxes} +\author{Étienne Deparis} +\date{2019-07-27 v0.6} + % configuration de la transformation en PDF \usepackage[pdfusetitle]{hyperref} \hypersetup{ @@ -50,10 +61,6 @@ \newcommand\hrefcolor[2]{\textcolor{magenta}{\href{#1}{#2}}} -\title{Awesome Boxes} -\author{Étienne Deparis} -\date{2019-04-04 v0.5} - \begin{document} \maketitle @@ -155,7 +162,6 @@ aliquet libero quis lectus elementum fermentum. \end{noteblock} \end{verbatim} - For the exactly same rendering: \begin{noteblock} @@ -188,7 +194,7 @@ and the bottom of your boxes, or a title, you can use our meta command: \begin{center} -\verb!\awesomebox[vrulecolor][hrule][title]{vrulewidth}{icon}{iconcolor}{your text content}! +\verb!\awesomebox[vrulecolor][hrule][title]{vrulewidth}{icon}{iconcolor}{content}! \end{center} Here are some examples of custom boxes: @@ -205,6 +211,8 @@ Here are some examples of custom boxes: dictum felis. Pellentesque tortor lacus, semper et neque vitae, egestas commodo nisl.} +\clearpage + \begin{center} \verb!\awesomebox{0pt}{\faCogs}{black}{Lorem ipsum…}! \end{center} @@ -229,8 +237,9 @@ Here are some examples of custom boxes: dictum felis. Pellentesque tortor lacus, semper et neque vitae, egestas commodo nisl.} +\vspace{2mm} \begin{center} -\verb!\awesomebox[white][\abShortLine]{0pt}{\faGrinBeam[regular]}{black}{Lorem ipsum…}! +\small\verb!\awesomebox[white][\abShortLine]{0pt}{\faGrinBeam[regular]}{black}{Lorem ipsum…}! \end{center} \awesomebox[white][\abShortLine]{0pt}{\faGrinBeam[regular]}{black}{% @@ -241,10 +250,9 @@ Here are some examples of custom boxes: dictum felis. Pellentesque tortor lacus, semper et neque vitae, egestas commodo nisl.} -\clearpage - +\vspace{2mm} \begin{center} -\verb!\awesomebox[white][\abLongLine][\textbf{Watch out}]{0pt}{\faBomb}{black}{Lorem ipsum…}! +\small\verb!\awesomebox[white][\abLongLine][\textbf{Watch out}]{0pt}{\faBomb}{black}{Lorem…}! \end{center} \awesomebox[white][\abLongLine][\textbf{Watch out}]{0pt}{\faBomb}{black}{% @@ -291,40 +299,57 @@ Which will render this way: \section{Other options} -Finally, you can also modify some internal options in order to modify -globally your awesome boxes (either the default ones or your new ones). +Some internal options can be customized, in order to globally modify +your awesome boxes (either the default ones or your new ones). \subsection{Left margin} -The left margin is the space left before the vertical rule to display -the icon. You can change it with the following command -(\verb!0.08\linewidth! is the default one):\\ -\verb!\setlength{\aweboxleftmargin}{0.08\linewidth}!. +The left margin is the space left to display the icon before the +vertical rule. You can change it with the following command +(\verb!0.12\linewidth! is the default one):\\ +\verb!\setlength{\aweboxleftmargin}{0.12\linewidth}!. + +You must declare you new length \emph{after} the \verb!\begin{document}! +instruction, or your custom length will be overriden by the default +one. \subsection{Content width} The content width is the space used to insert the body of your admonition block. You can change it with the following command -(\verb!0.92\linewidth! is the default one):\\ -\verb!\setlength{\aweboxcontentwidth}{0.92\linewidth}!. +(\verb!0.88\linewidth! is the default one):\\ +\verb!\setlength{\aweboxcontentwidth}{0.88\linewidth}!. + +You must declare you new length \emph{after} the \verb!\begin{document}! +instruction, or your custom length will be overriden by the default +one. \subsection{Vertical skip} This space is used before and after the awesome box. You can change it with (5mm is the default): \verb!\setlength{\aweboxvskip}{5mm}!. +You can put your new length either in the header or in the body of your +document. + \subsection{Sign raise} This length is used to raise (or lower) the left icon. Its default value is -5mm and you can change it with: \verb!\setlength{\aweboxsignraise}{-5mm}!. +You can put your new length either in the header or in the body of your +document. + \subsection{Vertical rule width} This width is used for the vertical rule of our four default boxes. Its default value is 2pt and you can change it with: \verb!\setlength{\aweboxrulewidth}{2pt}!. +You can put your new length either in the header or in the body of your +document. + \subsection{Vertical rule default color} The vertical rule color is an optional argument passed to the commands @@ -340,7 +365,7 @@ Awesome boxes may be used in any other environments, like in a list. \begin{verbatim} \begin{itemize} \item My first item -\item My second item with \notebox{A note box!} +\item Lorem ipsum… \notebox{Fusce aliquet…} \item Last and finally \end{itemize} \end{verbatim} @@ -349,7 +374,11 @@ will give: \begin{itemize} \item My first item -\item My second item with \notebox{A note box!} +\item Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam + aliquet libero quis lectus elementum fermentum. \notebox{Fusce aliquet + augue sapien, non efficitur mi ornare sed. Morbi at dictum + felis. Pellentesque tortor lacus, semper et neque vitae, egestas + commodo nisl.} \item Last and finally \end{itemize} @@ -370,16 +399,12 @@ will give: \begin{importantblock} \begin{itemize} - \vspace{-5mm} \item My first item \item My second item with \notebox{A note box!} \item Last and finally - \vspace{-5mm} \end{itemize} \end{importantblock} -\clearpage - Or with a more complex example with minted environment: \begin{verbatim} @@ -402,9 +427,28 @@ Or with a more complex example with minted environment: \section{Breaking changes} -Version 0.4 of this package introduced a way to customize the rule -color. Thus, the commands and environments arguments have been -reorganized to be in a more logical order. +\subsection{Version 0.6} + +This version improved a lot block components rendering. Historically, +awesome box used fixed length to display icon and content. This leads to +admonition block to overflow or to be thinner than paragraphs around. + +Please note that we change default block components width in purpose. It +used to be \verb!0.08\linewidth! for the margin and +\verb!0.92\linewidth! for the content. It is now \verb!0.12\linewidth! +for the margin and \verb!0.88\linewidth! for the content. + +We now compute the default \verb!\aweboxleftmargin! and +\verb!\aweboxcontentwidth! value in a \verb!\AtBeginDocument! +command. Thus, to avoid your custom lengths to be overriden by the +default ones, you must declare them \emph{after} the +\verb!\begin{document}! instruction. + +\subsection{Version 0.4} + +This version introduced a way to customize the rule color. Thus, the +commands and environments arguments have been reorganized to be in a +more logical order. Historically, the \verb!\awesomebox! command used the following syntax: @@ -413,7 +457,7 @@ Historically, the \verb!\awesomebox! command used the following syntax: \end{center} This syntax now leads to compiling errors, as you must now write it -as the following example shows you (and as explained in the Section +as the following example shows you (and as explained in the section \ref{sec:howtoown} "\nameref{sec:howtoown}"), to avoid an alternate declaration of rule and icon options: @@ -422,11 +466,11 @@ declaration of rule and icon options: \end{center} If you only use the provided boxes and environments (the -\verb!\notebox!, \verb!\tipbox!, \verb!\warningbox!, \verb!\cautionbox!, -and \verb!\importantbox! or the \texttt{noteblock}, \texttt{tipblock}, -\texttt{cautionblock}, \texttt{warningblock}, \texttt{importantblock} -environment) you are not affected by this change and your documents will -work without any change. +\verb!\notebox!, \verb!\tipbox!, \texttt{\textbackslash warn\-ing\-box}, +\verb!\cautionbox!, \verb!\importantbox! commands or the +\texttt{noteblock}, \texttt{tipblock}, \texttt{caution\-block}, +\texttt{warningblock}, \texttt{importantblock} environments) you are not +affected by this change and your documents will work without any change. \colophon |