Repository files navigation

Copyright © 2023–2024 Markus Kohm

Release: See theREADME.md of the individual packages.

License: LPPL 1.3c

KOMA presents thethird-party enhancements project.

This work may be distributed and/or modified under the conditions ofthe LaTeX Project Public License, version 1.3c of the license.The latest version of this license is inhttp://www.latex-project.org/lppl.txtand version 1.3c or later is part of all distributions of LaTeXversion 2005/12/01 or later.

This work has the LPPL maintenance status "maintained".

The Current Maintainer and author of this work is Markus Kohm.

For several yearsKOMA-Script provided apackagescrhack, that has been made not only to improve the compatibility ofthird-party packages with KOMA-Script classes, but also to generally improvethird-party packages. The package consisted not only in the package filescrhack.sty but also in several so called hacks as separate files withextension.hak. In the course of splitting off former KOMA-Script packagesfrom the KOMA-Script collection, it was decided to create independent packagesfrom the individual hacks. These new independent packages then serve asreplacements for the original packages they were intended to improve. Inaddition, to preserve the functionality of loading the enhancements only whenthe corresponding original package is loaded, a newscrhack was created todo just that.

Thethird-party enhancements project combines both the newscrhack and thenew standalone packages.

The project consists of several sub-folders. Each of these hosts one of thestandalone packages. These are:

• scrhack — compatibility package to emulate the former KOMA-Script packagescrhack.
• floatbytocbasic — an enhancement to packagefloat using packagetocbasic.
• floatrowbytocbasic — an enhancement to packagefloatrow using packagetocbasic.
• listingsbytocbasic — an enhancement to packagelistings using packagetocbasic (withdrawn without beeingreleased).
• lscapeenhanced — an enhancement to packagelscape resp. packagepdflscape.
• setspaceenhanced — an enhancement to packagesetspace.
• standardsectioning — defining the sectioning commands of the standardclasses.

There is also abuild.lua forl3build in the main folder. However, thisshould be used only to do all the checks using:

l3build check

or do a local installation of all the packages.

You should not use it for distribution, uploading etc. See thefollowing section for more information.

If you are a user, you should wait until all the packages have been added toyour preferred TeX distribution. Then you can use the package manager of yourTeX distribution to install all the packages at once.

Since no distribution of the entire project is planned, distributors areexplicitly referred to the individual README.md files in the subdirectoriesof the single packages.

Developers who want the current developer version of the code to be installedfor testing, should clonethethird-party-enhancementsrepository, e.g.,using

git clone https://github.com/komascript/third-party-enhancements.git

You can than either unpack and install all the third-party enhancements using:

l3build install --full

from within the main directory of the cloned respository. For installation oneof the new standalone package, run the same command from within thecorresponding subdirectory or the standalone package. For installationwithout the manuals omit option--full, but this is not recommended fordevelopers.

After installation you should get the user manuals using:

texdoc NAMEOFTHEPACKAGE

Note: You have to replaceNAMEOFTHEPACKAGE with the name of the singlepackage whose manual you want to read. There isn't a manual of the wholethird-party enhancement project.

Developers or distributors can also build the manuals from the source using:

l3build doc

To become a contributor, e.g., do heavy testing. If you find an issue, pleasereport it usingthe issuetracker. Youcan also become a developer and, e.g., make new test files to thepackages. See thel3build manual for moreinformation about tests. If you've created a new test and think that it wouldbe useful. Please either do a pull request oradd a newissueand include your test file.

Another kind of contribution would be to contact an author of one of thethird-party packages and convince her or him to integrate the code of thecorresponding enhancement package from this project into her or his package.

If you think you have found a bug (or another kind of issue) usingany of the packages you should usethe issuetracker. Pleasefirst search for similar issues already reported and maybe also already fixedand closed. Maybe the replies to such a similar report would help you too.

If your issue is new, you should report it also usingthe issuetracker. Pleasebe kind, not only when writing the report but also when reading replies andcommenting or answering. And please always add a minimal working example andusually the relevant parts of thelog-file to your report. Please use themarkdown forcodeto add such files into the text of your report. The correct languageidentifier for LaTeX code would belatex. Forlog-files you won't need anylanguage identifier. Usually you should not use attachments for code orlog-files unless you've been asked to do so. And please note, reports shouldalways be self-containing. External links often break and so the report becomeuseles.

Hey, I'm doing this as a hobby. So no need to say thank you. But I'm a vainfop, so I'm certainly up for a quick thank you by email. On komascript.de youcan find anexplanation of my wishes ifyou want to give more. If you don't understand German, just click to links atthat page.