summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/awesomebox
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-02-01 23:02:41 +0000
committerKarl Berry <karl@freefriends.org>2018-02-01 23:02:41 +0000
commit2386e67a40f8dbbe9d00e1619d33e7a6d5a7ab49 (patch)
treec93229807d295021f88471b5bad2aac9e11ec76d /Master/texmf-dist/doc/latex/awesomebox
parent4ee655e7ae033901bf8b6c959fd72bdaf444aff7 (diff)
awesomebox (1feb18)
git-svn-id: svn://tug.org/texlive/trunk@46513 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/awesomebox')
-rw-r--r--Master/texmf-dist/doc/latex/awesomebox/README47
-rw-r--r--Master/texmf-dist/doc/latex/awesomebox/README.md50
-rw-r--r--Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdfbin51046 -> 52064 bytes
-rw-r--r--Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex19
4 files changed, 68 insertions, 48 deletions
diff --git a/Master/texmf-dist/doc/latex/awesomebox/README b/Master/texmf-dist/doc/latex/awesomebox/README
deleted file mode 100644
index a27913d846d..00000000000
--- a/Master/texmf-dist/doc/latex/awesomebox/README
+++ /dev/null
@@ -1,47 +0,0 @@
-Awesome Boxes is all about drawing admonition blocks around text to
-inform or alert your readers about something particular. The specific
-aim of this package is to use FontAwesome¹ icons to ease the
-illustration of these blocks.
-
-This means all the magic of this package only exists if you previously
-installed FontAwesome on your system and made it available for use with
-XeTeX. Yes, this package requires you to use XeLaTeX too.
-
-The idea of admonition blocks comes from the ones you can easily do with
-AsciiDoc².
-
-We use the previous work of Honza Ustohal on fontawesome.sty³ to build
-this package. However, we made two important modifications:
-
- 1. we rename the internal commands of fontawesome.sty from \fa to
- \abIcon and the \FA font switch to \ABFamily to avoid collision if
- you want to use both of them;
- 2. we remove most of the provided icons to only kept the one we really
- use in this package.
-
-For more details, please refer to the awesomebox.pdf document.
-
-¹ http://fontawesome.io/icons/
-² http://asciidoctor.org/docs/user-manual/#admonition
-³ https://gist.github.com/sway/3101743
-⁴ https://github.com/milouse/latex-awesomebox/blob/master/awesomebox.pdf
-
-* Requirements
-
- - a working XeLaTeX environment
- - the ifxetex, ifluatex, xltxtra, xcolor and tabularx LaTeX packages
- - FontAwesome (http://fontawesome.io/icons/)
-
-* Installation
-
-Download the awesomebox.sty file and put it in the same folder of the
-document your are composing.
-
-For system wide installation, please refer to the documentation of your
-XeLaTeX distribution.
-
-* License
-
-Awesome Box is released under the WTFPL
-(http://www.wtfpl.net/txt/copying/). A copy of this license is
-distributed in this package.
diff --git a/Master/texmf-dist/doc/latex/awesomebox/README.md b/Master/texmf-dist/doc/latex/awesomebox/README.md
new file mode 100644
index 00000000000..c66ed3c1e28
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/awesomebox/README.md
@@ -0,0 +1,50 @@
+Awesome Boxes is all about drawing admonition blocks around text to
+inform or alert your readers about something particular. The specific
+aim of this package is to use
+[FontAwesome](http://fontawesome.io/icons/) icons to ease the
+illustration of these blocks.
+
+This means all the magic of this package only exists if you previously
+installed FontAwesome on your system and made it available for use with
+XeTeX. Yes, this package requires you to use XeLaTeX too.
+
+The idea of admonition blocks comes from the ones you can easily do with
+[AsciiDoc](http://asciidoctor.org/docs/user-manual/#admonition).
+
+We use the previous work of Honza Ustohal on
+[fontawesome.sty](https://gist.github.com/sway/3101743) to build this
+package. However, we made two important modifications:
+
+1. we rename the internal commands of `fontawesome.sty` from `\fa` to
+ `\abIcon` and the `\FA` font switch to `\ABFamily` to avoid
+ collision if you want to use both of them;
+2. we remove most of the provided icons to only kept the one we really
+ use in this package.
+
+For more details, please refer to the
+[awesomebox.pdf](https://github.com/milouse/latex-awesomebox/blob/master/awesomebox.pdf)
+document.
+
+Requirements
+============
+
+- a working XeLaTeX environment
+- the `ifxetex`, `ifluatex`, `xltxtra`, `xcolor` and `tabularx` LaTeX
+ packages
+- [FontAwesome](http://fontawesome.io/icons/)
+
+Installation
+============
+
+Download the `awesomebox.sty` file and put it in the same folder of the
+document your are composing.
+
+For system wide installation, please refer to the documentation of your
+XeLaTeX distribution.
+
+License
+=======
+
+Awesome Box is released under the
+[WTFPL](http://www.wtfpl.net/txt/copying/). A copy of this license is
+distributed in this package.
diff --git a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf
index 8cce7b01432..aa26ad521a8 100644
--- a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf
+++ b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex
index 9c99aed0ad8..6410cb2ace0 100644
--- a/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex
+++ b/Master/texmf-dist/doc/latex/awesomebox/awesomebox.tex
@@ -47,7 +47,7 @@
\title{Awesome Boxes}
\author{Étienne Deparis}
-\date{\today}
+\date{2018-01-31 v0.2}
\begin{document}
@@ -268,6 +268,23 @@ 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}!.
+\section{In other environments}
+
+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 Last and finally
+\end{itemize}
+\end{verbatim}
+
+\begin{itemize}
+\item My first item
+\item My second item with \notebox{A note box!}
+\item Last and finally
+\end{itemize}
\colophon