Debian Codegraph @

texmf-dist/doc/latex/euflag/README.md

raw
1
2 [//]: # (euflag LaTeX package)
3
4 # euflag
5
6 This is the README.md file for the euflag LaTeX package v0.8 (2020-05-22)
7 generated by ClassPack v.1.19 (2020-05-19) on 22 May 2020 at 23:43:47
8
9 ## Summary
10
11 This package implements a single command `\euflag` which reproduces the
12 official flag of the European Union (EU) using just the built-in picture
13 environment, with the _xcolor_ and _graphicx_ packages and the _amssymb_
14 font.
15
16 The flag is reproduced at 1em high based on the current font size, so it
17 can be scaled arbitrarily by changing the font size locally (see
18 examples in the informal table labelled ‘examples’ in §2). An option
19 allows for the flag to be aligned on the bottom star.
20
21 [Raw LaTeX code omitted here: see PDF doc]
22
23
24 ## Automated installation
25
26 If this package is distributed from CTAN, it should be in a zip file
27 which allows it to be installed automatically by the TeX Live Manager
28 (tlmgr) and similar automated installers.
29
30 If you are using automated LaTeX package installation, no further action
31 is required: the package will be installed the first time you use it in
32 a LaTeX document.
33
34 If you are using the TeX Live Manager (_tlmgr_) program manually, you
35 can install this package with the command:
36
37 $ tlmgr install euflag
38
39
40 ## TDS installation
41
42 This package is also available as a TeX Directory System (TDS) zip file
43 (`.tds.zip`). This is the standard directory layout for a modern TeX
44 installation which enables the package to be unzipped directly into your
45 Personal TeX Directory without the need to use _tlmgr_. If you haven’t
46 yet created a Personal TeX Directory, see below for details of what one
47 is, and how to create it.
48 * You can install this package on any TDS-compliant personal system
49 (laptop, desktop, workstation, table, smartphone, PDA, etc) by unzipping
50 it straight into your Personal TeX Directory. This will put all the
51 files into the right places, so you can start using them immediately.
52 * On a shared (multiuser) system like a server, the administrator can
53 unzip it into the `$TEXMFLOCAL` directory instead (see below), and run
54 your TeX directory-indexing program (eg _texhash_, _mktexlsr_, etc) so
55 that everyone can use it.
56 * If you are using an old non-TDS-compliant system, see below under Manual
57 Installation.
58
59 ### Your Personal TeX Directory
60
61 This is a directory (folder) where you should put all local manual
62 modifications (updates, additions such as new or updated classes,
63 packages, and fonts) that are _not_ handled automatically by _tlmgr_.
64 The name and location are fixed (for all practical purposes):
65 * Apple Mac OS X
66
67 ~/Library/texmf
68 * Unix and GNU/Linux
69
70 ~/texmf
71 * MS-Windows 95/XP/NT
72
73 C:\texmf
74 * MS-Windows 2007 and above
75
76 Computer\System\YOURNAME\texmf
77
78 Create that folder now if it does not already exist. Put (or unzip) all
79 additions to your system that are _not_ handled by _tlmgr_ into this
80 directory, following _exactly_ the subdirectory structure that is used
81 in your main TeX distribution (unzipping a TDS file does this for you).
82 This is what enables LaTeX to find stuff automatically.
83
84
85 > #### If you are a Windows user running _MiKTeX_
86 > When you create the folder for your Personal TeX Directory, you MUST add it to _MiKTeX_ ’s list of supported folders. Run the _MiKTeX Maintenance/Settings_ program, select the `Roots` tab, and add the folder. You only have to do this once.
87 > > Each time you add or remove software in your Personal TeX Directory, you MUST then click on the `Update FNDB` button in the `General` tab of the _MiKTeX Maintenance/Settings_ program, otherwise _MiKTeX_ will not find them and nothing will work!
88 >
89
90 Unix (Mac and GNU/Linux) users do not need to (indeed, should not) run
91 their filename database indexer program (_mktexlsr_ or _texhash_) for
92 files put into a personal TeX directory.
93
94
95 ## Installation on shared systems
96
97 On multi-user systems (Unix-based), identify the shared local directory
98 tree with the command
99
100 kpsewhich -expand-var '$TEXMFLOCAL'
101
102 This will give you the location of the shared `texmf` directory into
103 which you must unzip these files.
104
105 Do not forget to run your local TeX filename database indexer program
106 (_texhash_ or _mktexlsr_) after installation, otherwise the files will
107 not be found by LaTeX and nothing will work!
108
109
110 ## Manual installation (non-TDS systems)
111
112 To install this software manually, download and unzip the _non-_TDS zip
113 file into a temporary directory and move the class and/or package
114 file[s] and other files to the proper locations where LaTeX will find
115 them on your system. This is referred to in some documentation as “the
116 `TEXINPUTS` directory”, although it may be called something else on your
117 system.
118
119 _It is your responsibility to know where this location is._ See the
120 question in the TeX FAQ at https://texfaq.org/FAQ-inst-wlcf.html for
121 more information. If you do not know, or cannot find it, or do not have
122 access to it, your TeX system may be out of date and may need replacing.
123
124
125
126 ## Online systems and “last resort” systems
127
128 Some online LaTeX systems use CTAN, so a package from there should be
129 available on demand. For other online LaTeX systems where you do not
130 have access to the file system, unzip the _non-_TDS zip file into a
131 temporary directory and upload the files to the online system. Follow
132 their instructions for where to put them.
133
134 In an emergency, or as a last resort on unmanageable systems, it is
135 possible simply to put the class and/or package file[s] into your
136 current working directory (the same folder as your `.tex` file[s]).
137
138 While this may work, it is not supported, and may lead to other
139 resources (packages, fonts, images etc) not being found.
140
141
142 ## Usage
143
144 Include the line shown below in the Preamble of your LaTeX document; a
145 `\documentclass` line should be at the top; a `\usepackage` command
146 normally goes anywhere in the Preamble:
147
148 \usepackage[options]{euflag}
149
150 (similarly for other classes or packages if more than one is supplied
151 with this package). Read the documentation for the options available, if
152 any. The documentation is distributed as a PDF document in the zip file.
153 You can also regenerate it by typesetting the `euflag.dtx` file with
154 `xelatex` (and `biber` and _makeindex_) in the normal way.
155
156
157 ## Bugs and TODO
158
159 No outstanding reported bugs at the time of this version.
160
161 For TODO items, see the PDF documentation.
162
163
164 ## Copyright
165
166 The following statement is included in the source code:
167
168 Transformed from euflag.xml by ClassPack db2dtx.xsl
169 version 1.19 (2020-05-19) on Friday 22 May 2020 at 23:43:47
170
171 euflag.sty is copyright © 2019-2020 by Peter Flynn <[email protected]>
172
173 This work may be distributed and/or modified under the
174 conditions of the LaTeX Project Public License, either
175 version 1.3 of this license or (at your option) any later
176 version. The latest version of this license is in:
177
178 http://www.latex-project.org/lppl.txt
179
180 and version 1.3 or later is part of all distributions of
181 LaTeX version 2005/12/01 or later.
182
183 This work has the LPPL maintenance status ‘maintained’.
184
185 The current maintainer of this work is Peter Flynn <[email protected]>
186
187 This work consists of the files euflag.dtx and euflag.ins,
188 the derived file ,
189 and any other ancillary files listed in the MANIFEST.
190
191