diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/euflag/README.md')
| -rw-r--r-- | Master/texmf-dist/doc/latex/euflag/README.md | 218 |
1 files changed, 103 insertions, 115 deletions
diff --git a/Master/texmf-dist/doc/latex/euflag/README.md b/Master/texmf-dist/doc/latex/euflag/README.md index 09c6b0d927d..9551743a2c9 100644 --- a/Master/texmf-dist/doc/latex/euflag/README.md +++ b/Master/texmf-dist/doc/latex/euflag/README.md @@ -1,120 +1,98 @@ -# euflag - -This is the README.md file for the euflag LaTeX package v0.4 (2019-02-02) - -##Summary -%% This package implements a single command \euflag which reproduces the -official flag of the European Union using just the built-in picture -environment, with the _xcolor_ and _graphicx_ packages and the _amssymb_ -font. -%% The flag is reproduced at 1em high based on the current font size, so it -can be scaled arbitrarily by changing the font size (see examples in ). -%% \begingroup\centering\fontsize{230}{0}\selectfont\euflag\par\endgroup - - -##Normal installation - -If this package is distributed from CTAN, it should be in a zip file -which allows it to be installed automatically by the TeX Live update -manager _tlmgr_ and similar automated installers. If you are using -automated package installation, no further action is required. +[//]: # (euflag LaTeX package) -##TDS installation +# euflag -This package is also available as a `.tds.zip` file. TDS is the TeX -Directory Structure, the standard layout for a modern TeX installation. -This enables the package to be unzipped directly into your Personal TeX -Directory (see below for what this is and how to create one on your -system). +This is the README.md file for the euflag LaTeX package v0.7 (2020-05-16) +generated by ClassPack v.1.19 (2020-05-19) on 20 May 2020 at 19:09:55 - * Install it on any TDS-compliant personal system (laptop, desktop, -workstation, table, smartphone, PDA, etc) by unzipping it straight into -your Personal TeX Directory (folder). This will put all the files into -the right places, so you can start using them immediately. +## Summary +This package implements a single command `\euflag` which reproduces the +official flag of the European Union (EU) using just the built-in picture +environment, with the _xcolor_ and _graphicx_ packages and the _amssymb_ +font. - * If you haven't yet created a personal TeX directory, see below for -details of what one is, and how to create it. +The flag is reproduced at 1em high based on the current font size, so it +can be scaled arbitrarily by changing the font size locally (see +examples in the informal table labelled ‘examples’ in §2). An option +allows for the flag to be aligned on the bottom star. +[Raw LaTeX code omitted here: see PDF doc] - * On a shared (multiuser) system like a server, unzip it into the -$TEXMFLOCAL directory instead (see below), and run your TeX -directory-indexing program (eg _texhash__mktexlsr_, etc) so that -everyone can use it. +## Automated installation +If this package is distributed from CTAN, it should be in a zip file +which allows it to be installed automatically by the TeX Live Manager +(tlmgr) and similar automated installers. + +If you are using automated LaTeX package installation, no further action +is required: the package will be installed the first time you use it in +a LaTeX document. + +If you are using the TeX Live Manager (_tlmgr_) program manually, you +can install this package with the command: + + $ tlmgr install euflag + + +## TDS installation + +This package is also available as a TeX Directory System (TDS) zip file +(`.tds.zip`). This is the standard directory layout for a modern TeX +installation which enables the package to be unzipped directly into your +Personal TeX Directory without the need to use _tlmgr_. If you haven’t +yet created a Personal TeX Directory, see below for details of what one +is, and how to create it. + * You can install this package on any TDS-compliant personal system +(laptop, desktop, workstation, table, smartphone, PDA, etc) by unzipping +it straight into your Personal TeX Directory. This will put all the +files into the right places, so you can start using them immediately. + * On a shared (multiuser) system like a server, the administrator can +unzip it into the `$TEXMFLOCAL` directory instead (see below), and run +your TeX directory-indexing program (eg _texhash_, _mktexlsr_, etc) so +that everyone can use it. * If you are using an old non-TDS-compliant system, see below under Manual Installation. +### Your Personal TeX Directory -###Your Personal TeX Directory - -This is a directory (folder) on single-user systems where you should put -all your local manual modifications (updates, and additions such as new -or updated classes, packages, and fonts) that are _not_ handled -automatically by the TeX Live update manager (_tlmgr_). The name and -location are fixed: - - -<dl> - - <dt>Apple Mac OS X - -</dt> +This is a directory (folder) where you should put all local manual +modifications (updates, additions such as new or updated classes, +packages, and fonts) that are _not_ handled automatically by _tlmgr_. +The name and location are fixed (for all practical purposes): + * Apple Mac OS X - <dd>`~/Library/texmf` + ~/Library/texmf + * Unix and GNU/Linux -</dd> + ~/texmf + * MS-Windows 95/XP/NT - <dt>Unix and GNU/Linux + C:\texmf + * MS-Windows 2007 and above -</dt> - - <dd>`~/texmf` - -</dd> - - <dt>MS-Windows 95/XP - -</dt> - - <dd>`C:\texmf` - -</dd> - - <dt>MS-Windows 2007 and above - -</dt> - - <dd>`Computer\System\YOURNAME\texmf` - -</dd> - -</dl> + Computer\System\YOURNAME\texmf Create that folder now if it does not already exist. Put (or unzip) all -additions to your system that are not handled by _tlmgr_ into this +additions to your system that are _not_ handled by _tlmgr_ into this directory, following _exactly_ the subdirectory structure that is used in your main TeX distribution (unzipping a TDS file does this for you). This is what enables LaTeX to find stuff automatically. -> #### If you are a Windows user running _MiKTeX_ - - #### - -> When you create the folder, 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. -> -> Each time you add or remove software in your personal TeX folder, you _must_ also click on the `Update FNDB` button in the `General` tab. +> #### If you are a Windows user running _MiKTeX_ +> 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. +> > 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! > Unix (Mac and GNU/Linux) users do not need to (indeed, should not) run -their filename database indexer (_mktexlsr_ or _texhash_) for files put -in your personal TeX directory. +their filename database indexer program (_mktexlsr_ or _texhash_) for +files put into a personal TeX directory. -##Installation on shared systems +## Installation on shared systems On multi-user systems (Unix-based), identify the shared local directory tree with the command @@ -122,30 +100,36 @@ tree with the command kpsewhich -expand-var '$TEXMFLOCAL' This will give you the location of the shared `texmf` directory into -which you must install these files. +which you must unzip these files. -Do not forget to run the _texhash_ or _mktexlsr_ (filename indexer) -program after installation, otherwise the files will not be found by -LaTeX and nothing will work! +Do not forget to run your local TeX filename database indexer program +(_texhash_ or _mktexlsr_) after installation, otherwise the files will +not be found by LaTeX and nothing will work! -##Manual installation (non-TDS systems) +## Manual installation (non-TDS systems) -To install this software manually, unzip the zip file into a temporary -directory and move the class and/or package file[s] from the -`tex/latex/euflag` directory to a location (directory/folder) where -LaTeX will find it on your system. This is referred to in some -documentation as “the TEXINPUTS directory”, although it may be called -something else on your system. +To install this software manually, download and unzip the _non-_TDS zip +file into a temporary directory and move the class and/or package +file[s] and other files to the proper locations where LaTeX will find +them on your system. This is referred to in some documentation as “the +`TEXINPUTS` directory”, although it may be called something else on your +system. _It is your responsibility to know where this location is._ See the -question in the TeX FAQ at -http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf for more -information. If you do not know, or cannot find it, or do not have -access to it, your TeX system may be out of date and need replacing. +question in the TeX FAQ at https://texfaq.org/FAQ-inst-wlcf.html for +more information. If you do not know, or cannot find it, or do not have +access to it, your TeX system may be out of date and may need replacing. + -##Last resort +## Online systems and “last resort” systems + +Some online LaTeX systems use CTAN, so a package from there should be +available on demand. For other online LaTeX systems where you do not +have access to the file system, unzip the _non-_TDS zip file into a +temporary directory and upload the files to the online system. Follow +their instructions for where to put them. In an emergency, or as a last resort on unmanageable systems, it is possible simply to put the class and/or package file[s] into your @@ -155,32 +139,36 @@ While this may work, it is not supported, and may lead to other resources (packages, fonts, images etc) not being found. -##Usage +## Usage -Make this the first line of your LaTeX document: +Include the line shown below in the Preamble of your LaTeX document; a +`\documentclass` line should be at the top; a `\usepackage` command +normally goes anywhere in the Preamble: - \usepackage[options]{} + \usepackage[options]{euflag} -(or other class or package if more than one is supplied). Read the -documentation for the options available. The documentation is -distributed as a PDF document in the zip file. You can also regenerate -it by typesetting the `euflag.dtx` file with `xelatex` (and `biber` and -_makeindex_) in the normal way. +(similarly for other classes or packages if more than one is supplied +with this package). Read the documentation for the options available, if +any. The documentation is distributed as a PDF document in the zip file. +You can also regenerate it by typesetting the `euflag.dtx` file with +`xelatex` (and `biber` and _makeindex_) in the normal way. -##Bugs and TODO +## Bugs and TODO No outstanding reported bugs at the time of this version. +For TODO items, see the PDF documentation. + -##Copyright +## Copyright The following statement is included in the source code: Transformed from euflag.xml by ClassPack db2dtx.xsl - version 1.10 (2019-01-22) on Sunday 3 February 2019 at 21:19:20 + version 1.19 (2020-05-19) on Wednesday 20 May 2020 at 19:09:55 - euflag.sty is copyright © 2019 by Peter Flynn <peter@silmaril.ie> + euflag.sty is copyright © 2019-2020 by Peter Flynn <peter@silmaril.ie> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either |