summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tcolorbox/README
blob: 9df1250c23932639b8952b00a92a0e8ae02cc58e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
%% The LaTeX package tcolorbox - version 4.31 (2020/07/31)
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2006-2020 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
%% -------------------------------------------------------------------------------------------
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%   http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This work has the LPPL maintenance status `author-maintained'.
%%
%% This work consists of all files listed in README
%%

tcolorbox provides an environment for colored and framed text boxes with a
heading line. Optionally, such a box can be split in an upper and a lower
part. The package tcolorbox can be used for the setting of LaTeX examples where
one part of the box displays the source code and the other part shows the
output. Another common use case is the setting of theorems. The package supports
saving and reuse of source code and text parts.

Contents of the package
=======================
  'README'                        this file
  'CHANGES'                       log of changes (history)
  'tcolorbox.sty'                 LaTeX package file (style file)
  'tcbbreakable.code.tex'         LaTeX package file (library of tcolorbox)
  'tcbdocumenation.code.tex'      LaTeX package file (library of tcolorbox)
  'tcbexternal.code.tex'          LaTeX package file (library of tcolorbox)
  'tcbfitting.code.tex'           LaTeX package file (library of tcolorbox)
  'tcbhooks.code.tex'             LaTeX package file (library of tcolorbox)
  'tcblistings.code.tex'          LaTeX package file (library of tcolorbox)
  'tcblistingscore.code.tex'      LaTeX package file (library of tcolorbox)
  'tcblistingsutf8.code.tex'      LaTeX package file (library of tcolorbox)
  'tcbmagazine.code.tex'          LaTeX package file (library of tcolorbox)
  'tcbminted.code.tex'            LaTeX package file (library of tcolorbox)
  'tcbposter.code.tex'            LaTeX package file (library of tcolorbox)
  'tcbprocessing.code.tex'        LaTeX package file (library of tcolorbox)
  'tcbraster.code.tex'            LaTeX package file (library of tcolorbox)
  'tcbskins.code.tex'             LaTeX package file (library of tcolorbox)
  'tcbskinsjigsaw.code.tex'       LaTeX package file (library of tcolorbox)
  'tcbtheorems.code.tex'          LaTeX package file (library of tcolorbox)
  'tcbvignette.code.tex'          LaTeX package file (library of tcolorbox)
  'tcbxparse.code.tex'            LaTeX package file (library of tcolorbox)
  'blueshade.png'                 Picture (package)
  'crinklepaper.png'              Picture (package)
  'goldshade.png'                 Picture (package)
  'pink_marble.png'               Picture (package)
  'tcolorbox.pdf'                 Documentation for tcolorbox
  'tcolorbox.tex'                 Source code of the documentation (main file)
  '*.doc.*'                       Source code of the documentation (include files)
  'tcolorbox-tutorial-poster.pdf' Tutorial for poster creation
  'tcolorbox-tutorial-poster.tex' Source code of the tutorial
  'tcolorbox-example.tex'         Example file for package usage
  'tcolorbox-example.pdf'         Compiled example
  'tcolorbox-example-poster.tex'  Example file for package usage
  'tcolorbox-example-poster.pdf'  Compiled example
  'Basilica_5.png'                Example picture
  'lichtspiel.jpg'                Example picture

Installation
============
Copy the contents of the 'tcolorbox.tds.zip' from CTAN to your local TeX file tree.

Alternatively, put the files to their respective locations within the TeX installation:
  'tcolorbox.sty'             ->  /tex/latex/tcolorbox
  'tcbbreakable.code.tex'     ->  /tex/latex/tcolorbox
  'tcbdocumenation.code.tex'  ->  /tex/latex/tcolorbox
  'tcbexternal.code.tex'      ->  /tex/latex/tcolorbox
  'tcbfitting.code.tex'       ->  /tex/latex/tcolorbox
  'tcbhooks.code.tex'         ->  /tex/latex/tcolorbox
  'tcblistings.code.tex'      ->  /tex/latex/tcolorbox
  'tcblistingscore.code.tex'  ->  /tex/latex/tcolorbox
  'tcblistingsutf8.code.tex'  ->  /tex/latex/tcolorbox
  'tcbmagazine.code.tex'      ->  /tex/latex/tcolorbox
  'tcbminted.code.tex'        ->  /tex/latex/tcolorbox
  'tcbposter.code.tex'        ->  /tex/latex/tcolorbox
  'tcbprocessing.code.tex'    ->  /tex/latex/tcolorbox
  'tcbraster.code.tex'        ->  /tex/latex/tcolorbox
  'tcbskins.code.tex'         ->  /tex/latex/tcolorbox
  'tcbskinsjigsaw.code.tex'   ->  /tex/latex/tcolorbox
  'tcbtheorems.code.tex'      ->  /tex/latex/tcolorbox
  'tcbvignette.code.tex'      ->  /tex/latex/tcolorbox
  'tcbxparse.code.tex'        ->  /tex/latex/tcolorbox
  'blueshade.png'             ->  /tex/latex/tcolorbox
  'crinklepaper.png'          ->  /tex/latex/tcolorbox
  'goldshade.png'             ->  /tex/latex/tcolorbox
  'pink_marble.png'           ->  /tex/latex/tcolorbox

  all other files             ->  /doc/latex/tcolorbox