summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/defoldfonts/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/defoldfonts/README.md')
-rw-r--r--macros/latex/contrib/defoldfonts/README.md142
1 files changed, 142 insertions, 0 deletions
diff --git a/macros/latex/contrib/defoldfonts/README.md b/macros/latex/contrib/defoldfonts/README.md
new file mode 100644
index 0000000000..14ede15b32
--- /dev/null
+++ b/macros/latex/contrib/defoldfonts/README.md
@@ -0,0 +1,142 @@
+# Package `defoldfonts`
+
+Copyright © 2019–2023 Markus Kohm
+Release: 2023-07-28 v1.0
+License: LPPL 1.3c
+
+KOMA presents the `defoldfonts` package to define old font commands even if
+the class does not.
+
+----------------------------------------------------------------------------
+
+This work may be distributed and/or modified under the conditions of
+the LaTeX Project Public License, version 1.3c of the license.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3c or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
+
+This work has the LPPL maintenance status "maintained".
+
+The Current Maintainer and author of this work is Markus Kohm.
+
+----------------------------------------------------------------------------
+
+# Abstract
+
+In 1994 with LaTeX2ε the old font commands `\rm`, `\sf`, `\tt`, `\bf`, `\it`,
+`\sl`, and `\sc` became obsolete. They are not implemented in the LaTeX kernel
+anymore. Some classes, e.g., the standard classes still provide the deprecated
+font commands. Early versions of
+[KOMA-Script](https://www.ctan.org/pkg/koma-script) also did and additionally
+defined `\sfb`. Other classes do not provide these commands. For more than 15
+years [KOMA-Script](https://www.ctan.org/pkg/koma-script) officially also do
+not provide them. So depending on the class for several years using them
+resulted in an error message.
+
+However, some old BibTeX styles and even some packages still use these
+commands without testing, if they are defined. This also can result in
+errors. Package `defoldfonts` defines all eight old font commands, `\sfb`
+even, if not a [KOMA-Script](https://www.ctan.org/pkg/koma-script) class, but
+another class has is used.
+
+# Unpacking and Installation for Developers and Distributors
+
+A legal distribution of `defoldfonts` contain at least:
+
+* `defoldfonts.dtx`
+* `README.md`
+
+and optionally:
+
+* `LICENSE.md`
+* `defoldfonts.sty`
+* `defoldfonts.pdf`
+
+For generation of `defoldfonts.sty` you can use:
+
+ l3build unpack
+
+The unpacked files than can be found at `build/local/defoldfonts.sty`.
+
+For generation of the manual `defoldfonts.pdf` you can use:
+
+ l3build doc
+
+The manual `defoldfonts.pdf` than can be found in the main directory.
+
+Developers also can use `l3build` to unpack and install all files and even the
+documentation. Run
+
+ l3build install
+
+to locally install the package without manual, or run
+
+ l3build install --full
+
+to locally install the package with manual.
+
+# Unpacking and Installation for Users
+
+If you are a user, you should wait until all the packages has been added to
+your preferred TeX distribution. Then you can use the package manager of your
+TeX distribution to install all the packages.
+
+# How to get the Manuals
+
+After installation you should get the user manual using:
+
+ texdoc defoldfonts
+
+See the manual of your TeX distribution for more information.
+
+You can also build the manuals from the source. To do so, clone the source of
+the whole project, go to the directory `defoldfonts` and run:
+
+ l3build doc
+
+This will result in the file `defoldfonts.pdf`. This is the user
+manual and (optionally) the implemenation documentation of
+`defoldfonts`.
+
+# How to Contribute
+
+To become a contributor, clone the code and do heavy testing. If you find an
+issue, please report it using the [issue tracker](../../issues). You can
+also, e.g., make new test files to the packages. See the
+[`l3build`](https://ctan.prg/pkg/l3build) manual for more information about
+tests. If you've created a new test and think that it would be useful. Please
+either do a pull request or [add a new issue](../../issues/new/choose) and
+include your test file.
+
+Another kind of contribution would be to contact an author of one of the
+third-party packages and convince her or him to integrate the code of the
+corresponding enhancement package from this project into her or his package.
+
+# How to Report Issues
+
+If you think you have found a bug (or another kind of issue) using
+`defoldfonts` you should use the [issue tracker](../../issues). Please
+first search for similar issues already reported and maybe also already fixed
+and closed. Maybe the replies to such a similar report would help you too.
+
+If your issue is new, you should report it also using the [issue
+tracker](../../issues). Please be kind, not only when writing the report
+but also when reading replies and commenting or answering. And please always
+add a minimal working example and usually the relevant parts of the `log`-file
+to your report. Please use the [markdown for
+code](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)
+to add such files into the text of your report. The correct language
+identifier for LaTeX code would be `latex`. For `log`-files you won't need any
+language identifier. Usually you should not use attachments for code or
+`log`-files unless you've been asked to do so. And please note, reports should
+always be self-containing. External links often break and so the report become
+useles.
+
+# How to Say Thank You for my Work
+
+Hey, I'm doing this as a hobby. So no need to say thank you. But I'm a vain
+fop, so I'm certainly up for a quick thank you by email. On komascript.de you
+can find an [explanation of my wishes](https://komascript.de/wunschliste) if
+you want to give more. If you don't understand German, just click to links at
+that page.