summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/boites/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-11-23 23:59:23 +0000
committerKarl Berry <karl@freefriends.org>2013-11-23 23:59:23 +0000
commitb83e40cafc2d8b440489311729d1e34d4aba372f (patch)
tree9cf18fa9338ac76409ed8ab82bf15e4861675468 /Master/texmf-dist/doc/latex/boites/README
parent416fb244aa3fb5b9bbf58e6a4c20ad3b0fe32cb7 (diff)
boites (23nov13)
git-svn-id: svn://tug.org/texlive/trunk@32221 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/boites/README')
-rw-r--r--Master/texmf-dist/doc/latex/boites/README82
1 files changed, 48 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/boites/README b/Master/texmf-dist/doc/latex/boites/README
index edff10820c6..fb555baf29c 100644
--- a/Master/texmf-dist/doc/latex/boites/README
+++ b/Master/texmf-dist/doc/latex/boites/README
@@ -1,63 +1,77 @@
-boites.sty (boxes that may break across pages)
+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
+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.)
+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 macros/latex/contrib/other/misc/framed.sty.
+See also the
+[`framed`](http://github.github.com/github-flavored-markdown/sample_content.html)
+package.
-* USAGE
+Usage
+-----
In the preamble:
- \usepackage{boites,boites_examples,graphicx}
+ \usepackage{boites,boites_examples,graphicx}
Before using the various environments:
- \bkcounttrue: the lines will be numbered
- \bkcountfalse: the lines will not be numbered
+ `\bkcounttrue`: the lines will be numbered
+
+ `\bkcountfalse`: the lines will not be numbered
Boxed text with a title:
- \begin{boiteepaisseavecuntitre}
- ...
- \end{boiteepaisseavecuntitre}
+ \begin{boiteepaisseavecuntitre}
+ ...
+ \end{boiteepaisseavecuntitre}
-Text with a double vertical line on the left and a number
-(17, in this example):
+Text with a double vertical line on the left and a number (17, in this
+example):
- \begin{boitenumeroteeavecunedoublebarre}{17}
- ...
- \end{boitenumeroteeavecunedoublebarre}
+ \begin{boitenumeroteeavecunedoublebarre}{17}
+ ...
+ \end{boitenumeroteeavecunedoublebarre}
Text with a wavy line on the left:
- \begin{boiteavecunelignequiondulesurlecote}
- ...
- \end{boiteavecunelignequiondulesurlecote}
+ \begin{boiteavecunelignequiondulesurlecote}
+ ...
+ \end{boiteavecunelignequiondulesurlecote}
Shaded box:
- \begin{boitecoloriee}
- ...
- \end{boitecoloriee}
+ \begin{boitecoloriee}
+ ...
+ \end{boitecoloriee}
-If you wish other kinds of boxes, have a look at boites_examples.sty
+If you wish other kinds of boxes, have a look at `boites_examples.sty`
and feel free to adapt the macros.
-* FEATURES:
+Features
+--------
-- These environments may be nested.
-- They may appear in a multicols environment.
-- Floating material, footnotes, marginpars appearing inside
- them will be lost.
+ * These environments may be nested.
+ * They may appear in a multicols environment.
+ * Floating material, footnotes, marginpars appearing inside
+ them will be lost.
-* HISTORY:
+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)
+ * 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)