summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/boites/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/boites/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/boites/README')
-rw-r--r--macros/latex/contrib/boites/README77
1 files changed, 77 insertions, 0 deletions
diff --git a/macros/latex/contrib/boites/README b/macros/latex/contrib/boites/README
new file mode 100644
index 0000000000..fb555baf29
--- /dev/null
+++ b/macros/latex/contrib/boites/README
@@ -0,0 +1,77 @@
+boites
+======
+
+`boites` is a LaTeX package to typeset boxes that may break across pages.
+
+License
+-------
+
+(c) 1998-1999 Vincent Zoonekynd <zoonek@math.jussieu.fr>
+
+Distributed under the GNU Public Licence
+
+Description
+-----------
+
+These environments allow page breaks inside framed boxes. They include
+a few examples (shaded box, box with a wavy line on its side, etc.)
+
+See also the
+[`framed`](http://github.github.com/github-flavored-markdown/sample_content.html)
+package.
+
+Usage
+-----
+
+In the preamble:
+
+ \usepackage{boites,boites_examples,graphicx}
+
+Before using the various environments:
+
+ `\bkcounttrue`: the lines will be numbered
+
+ `\bkcountfalse`: the lines will not be numbered
+
+Boxed text with a title:
+
+ \begin{boiteepaisseavecuntitre}
+ ...
+ \end{boiteepaisseavecuntitre}
+
+Text with a double vertical line on the left and a number (17, in this
+example):
+
+ \begin{boitenumeroteeavecunedoublebarre}{17}
+ ...
+ \end{boitenumeroteeavecunedoublebarre}
+
+Text with a wavy line on the left:
+
+ \begin{boiteavecunelignequiondulesurlecote}
+ ...
+ \end{boiteavecunelignequiondulesurlecote}
+
+Shaded box:
+
+ \begin{boitecoloriee}
+ ...
+ \end{boitecoloriee}
+
+If you wish other kinds of boxes, have a look at `boites_examples.sty`
+and feel free to adapt the macros.
+
+Features
+--------
+
+ * These environments may be nested.
+ * They may appear in a multicols environment.
+ * Floating material, footnotes, marginpars appearing inside
+ them will be lost.
+
+History
+-------
+
+ * 1992: original macros (eclbkbox.sty) by Hideki Isozaki
+ * 1998: a few modifications to make the macros more configurable,
+ more comments and inclusion of some examples (Vincent Zoonekynd)