summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/csquotes/README.md
blob: 5534ce2eb198778b77aa04da034a2c1c78b84e47 (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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# `csquotes`: Context sensitive quotation facilities

## About

This package provides advanced facilities for inline and display
quotations. It is designed for a wide range of tasks ranging from
the most simple applications to the more complex demands of formal
quotations. The facilities include commands, environments, and
user-definable 'smart quotes' which dynamically adjust to their
context. Quotation marks are switched automatically if quotations
are nested and they can be adjusted to the current language. There
are additional facilities designed to cope with the more specific
demands of academic writing, especially in the humanities and the
social sciences. All quote styles as well as the optional active
quotes are freely configurable.

## License

Copyright (c) 2003-2011 Philipp Lehman, 2015-2019,2021 Joseph Wright.
Permission is granted to copy, distribute and/or modify this
software under the terms of the LaTeX Project Public License (LPPL),
version 1.3c or any later version.

This software is provided 'as is', without warranty of any kind,
either expressed or implied, including, but not limited to, the
implied warranties of merchantability and fitness for a particular
purpose.

## Requirements

- e-TeX
- `etoolbox` 1.7 or later
- `keyval`

AUTOMATIC INSTALLATION

TeX Live: The `csquotes` package is included in TeX Live.
          Use the TeX Live package manager to install it.

MiKTeX:   The `csquotes` package is included in MiKTeX.
          Use the MiKTeX package manager to install it.

## Semi-automatic installation

1. Download the file

   http://mirror.ctan.org/install/macros/latex/contrib/csquotes.tds.zip

2. Unpack the archive in the root directory of the local TeX
   installation tree, for example

        /usr/local/share/texmf/
    
   or

        /usr/share/texmf-local/

   or

        C:\Local TeX Files\

3. Update the file hash tables (also known as the file name
   database).
   
   On teTeX and TeX Live systems, run `texhash` as root (`sudo
   texhash`). On MiKTeX, run `initexmf --update-fndb` in a command
   window or use the 'Refresh FNDB' button of the MiKTeX Options
   window.

## Manual installation

1. Copy the files `csquotes.sty`,  `csquotes.def`, `csq-compat.def`,
   and `csquotes.cfg` to

        <TEXMFLOCAL>/tex/latex/csquotes/

   where `<TEXMFLOCAL>` denotes the root of the local TeX installation
   tree, for example

        /usr/local/share/texmf/

   or

        /usr/share/texmf-local/

   or

        C:\Local TeX Files\

2. The file `csquotes.pdf` goes to

        <TEXMFLOCAL>/doc/latex/csquotes/

3. Update the file hash tables (also known as the file name
   database).

   On teTeX and TeX Live systems, run `texhash` as root (`sudo
   texhash`). On MiKTeX, run `initexmf --update-fndb` in a command
   window or use the 'Refresh FNDB' button of the MiKTeX Options
   window.

Note that you may have to create some or all of the above
directories if this is the first package you're installing locally
(as opposed to via a package manager).

## Usage

Refer to `csquotes.pdf` for a systematic reference manual.

## Changes

A list of changes relevant to users of this package is included at
the end of `csquotes.pdf`. Skimming the respective section of the
manual is highly recommended.