texlive[67946] Master: floatrowbytocbasic, for real (16aug23)
commits+karl at tug.org
commits+karl at tug.org
Wed Aug 16 21:44:23 CEST 2023
Revision: 67946
http://tug.org/svn/texlive?view=revision&revision=67946
Author: karl
Date: 2023-08-16 21:44:23 +0200 (Wed, 16 Aug 2023)
Log Message:
-----------
floatrowbytocbasic, for real (16aug23)
Added Paths:
-----------
trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/
trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/LICENSE.md
trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/README.md
trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/floatrowbytocbasic.pdf
trunk/Master/texmf-dist/source/latex/floatrowbytocbasic/
trunk/Master/texmf-dist/source/latex/floatrowbytocbasic/floatrowbytocbasic.dtx
trunk/Master/texmf-dist/tex/latex/floatrowbytocbasic/
trunk/Master/texmf-dist/tex/latex/floatrowbytocbasic/floatrowbytocbasic.sty
trunk/Master/tlpkg/tlpsrc/floatrowbytocbasic.tlpsrc
Added: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/LICENSE.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/LICENSE.md (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/LICENSE.md 2023-08-16 19:44:23 UTC (rev 67946)
@@ -0,0 +1,19 @@
+----------------------------------------------------------------------------
+
+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 2005/12/01
+or later. This work has the LPPL maintenance status “maintained”.
+The current maintainer and author of this work is Markus Kohm.
+
+----------------------------------------------------------------------------
+
+Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz
+in der Version 1.3c, verteilt und/oder verändert werden. Die aktuelle
+Version dieser Lizenz ist http://www.latex-project.org/lppl.txt und
+Version 1.3c oder später ist Teil aller Verteilungen von LaTeX 2005/12/01
+oder später. Dieses Werk hat den LPPL-Verwaltungs-Status „maintained”
+Der aktuelle Verwalter und Autor dieses Werks ist Markus Kohm.
+
+----------------------------------------------------------------------------
Property changes on: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/LICENSE.md
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/README.md (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/README.md 2023-08-16 19:44:23 UTC (rev 67946)
@@ -0,0 +1,153 @@
+# Package `floatrowbytocbasic`
+
+Copyright © 2008–2023 Markus Kohm
+
+Release: 2023-08-16 v1.0
+
+License: LPPL 1.3c
+
+KOMA presents the `floatrowbytocbasic` package to extend the functionality
+of package [`floatrow`](https://ctan.org/pkg/floatrow). The
+`floatrowbytocbasic` package is part of the *third-party enhancements*
+project.
+
+----------------------------------------------------------------------------
+
+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.
+
+The Current Maintainer and author of this work is Markus Kohm.
+
+----------------------------------------------------------------------------
+
+# Abstract
+
+For several years
+[KOMA-Script](https://www.sourceforge.net/project/koma-script) provided a
+package `scrhack`, that has been made not only to improve the compatibility of
+third-party packages with KOMA-Script classes, but also to generally improve
+third-party packages. The package consisted not only in the package file
+`scrhack.sty` but also in several so called hacks as separate files with
+extension `.hak`. In the course of splitting off former KOMA-Script packages
+from the KOMA-Script collection, it was decided to create independent packages
+from the individual hacks. These new independent packages then serve as
+replacements for the original packages they were intended to improve. Package
+`floatrowbytocbasic` is such an enhancement package. It provides additional
+features of using package [`tocbasic`](https://ctan.org/pkg/tocbasic) by
+patching package [`floatrow`](https://ctan.org/pkg/floatrow).
+
+# Installation for Users
+
+If you are a user, you should wait until the package has been added to your
+preferred TeX distribution. Then you can use the package manager of your TeX
+distribution to install the package.
+
+# Unpacking for Distributors
+
+Distributors should download [the distribution from
+CTAN](https://www.ctan.org/pkg/floatrowbytocbasic). This consists in:
+
+* `floatrowbytocbasic.dtx`
+* `README.md`
+* `LICENSE.md`
+* `floatrowbytocbasic.pdf`
+
+If distributors also want to distribute `floatrowbytocbasic.sty`, they can
+unpack it using
+
+ tex floatrowbytocbasic.dtx
+
+Note, that you have to use `tex` not `latex`, `pdflatex`, `xelatex` or
+`lualatex`!
+
+Note also, that a legal distribution consists at least in:
+
+* `floatrowbytocbasic.dtx`
+* `README.md`
+
+The following files are optionally, but must not be distributed without the
+previous ones:
+
+* `LICENSE.md`
+* `floatrowbytocbasic.sty`
+* `floatrowbytocbasic.pdf`
+
+# Unpacking and Installation for Developers
+
+Developers who want the current developer version of the code to be installed
+for testing, should clone [the `third-party-enhancements`
+repository](https://github.com/komascript/third-party-enhancements), 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 of
+`floatrowbytocbasic` only run the same command from within the
+`floatrowbytocbasic` subdirectory. For installation without the manual omit
+option `--full`, but this is not recommended for developers.
+
+# How to get the Manual
+
+After installation you should get the user manual using:
+
+ texdoc floatrowbytocbasic
+
+See the manual of your TeX distribution for more information.
+
+Developers or distributors can also build the manual from the source using:
+
+ l3build doc
+
+# How to Contribute
+
+To become a contributor, e.g., do heavy testing. If you find an issue, please
+report it using [the issue
+tracker](https://github.com/komascript/third-party-enhancements/issues). You
+can also become a developer and, e.g., make new test files to the
+packages. See the [`l3build`](https://ctan.org/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](https://github.com/komascript/third-party-enhancements/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
+`floatrowbytocbasic` you should use [the issue
+tracker](https://github.com/komascript/third-party-enhancements/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](https://github.com/komascript/third-party-enhancements/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.
Property changes on: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/README.md
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/floatrowbytocbasic.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/floatrowbytocbasic.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/floatrowbytocbasic.pdf 2023-08-16 19:43:47 UTC (rev 67945)
+++ trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/floatrowbytocbasic.pdf 2023-08-16 19:44:23 UTC (rev 67946)
Property changes on: trunk/Master/texmf-dist/doc/latex/floatrowbytocbasic/floatrowbytocbasic.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/source/latex/floatrowbytocbasic/floatrowbytocbasic.dtx
===================================================================
--- trunk/Master/texmf-dist/source/latex/floatrowbytocbasic/floatrowbytocbasic.dtx (rev 0)
+++ trunk/Master/texmf-dist/source/latex/floatrowbytocbasic/floatrowbytocbasic.dtx 2023-08-16 19:44:23 UTC (rev 67946)
@@ -0,0 +1,650 @@
+% \iffalse meta-comment
+% ======================================================================
+% floatrowbytocbasic.dtx
+% Copyright © 2008–2023 Markus Kohm
+%
+% This work is a KOMA-Script spin-off. For the original sources of
+% KOMA-Script's `floatrow.hak' see file `scrhack.dtx' in the KOMA-Script
+% sources at <https://sourceforge.net/p/koma-script/code/>.
+%
+% Development is taking place as part of `third-party-hacks' at
+% <https://github.com/komascript/third-party-hacks>. New issues should
+% be reported there as well as known issues can be found.
+%
+% 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 and of this work.
+%
+% The Current Maintainer and author of this work is Markus Kohm.
+%
+% This work consists of the file `floatrowbytocbasic.dtx' and
+% `README.md'.
+%
+% The recommended way to install `floatrowbytocbasic' is to use
+% the package manager of your TeX distribution.
+% ======================================================================
+%
+%<*dtx>
+\ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
+\ProvidesFile{floatrowbytocbasic.dtx}
+%</dtx>
+%<*dtx|package>
+%<package>\ProvidesPackage{floatrowbytocbasic}
+ [2023-08-16 v1.0
+%<dtx> sources and unpack driver of
+ improved floatrow package using tocbasic]
+%</dtx|package>
+%<*dtx>
+\ifx\documentclass\undefined
+ \input docstrip.tex
+ \generate{%
+ \file{floatrowbytocbasic.sty}{%
+ \from{floatrowbytocbasic.dtx}{package}%
+ }%
+ }%
+\else
+ \let\endbatchfile\relax
+\fi
+\endbatchfile
+\documentclass[ngerman,USenglish]{koma-script-source-doc}
+\usepackage{babel}
+\usepackage{csquotes}
+\usepackage[style=alphabetic]{biblatex}
+\begin{filecontents}[force]{\jobname.bib}
+ at online{pkg:floatrow,
+ author={Olga Lapko},
+ title={\pkg*{floatrow} --- Modifying the layout of floats},
+ version={0.3b},
+ date={2008-08-02},
+ url={https://ctan.org/pkg/floatrow},
+ urldate={2023-07-18},
+ note={The \pkg*{floatrow} package provides many ways to customize layouts of
+ floating environments and has code to cooperate with the \pkg{caption}
+ 3.x package. The package offers mechanisms to put floats side by side,
+ and to put the caption beside its float. The \pkg*{floatrow} settings
+ could be expanded to the floats created by packages \pkg{rotating},
+ \pkg{wrapfig}, \pkg{subfig} (in the case of rows of subfloats), and
+ \pkg{longtable}.},
+}
+ at manual{pkg:floatrow:manual,
+ author={Olga Lapko},
+ date={2009-08-02},
+ title={The \pkg*{floatrow} package},
+ url={http://mirrors.ctan.org/macros/latex/contrib/floatrow/floatrow.pdf},
+ urldate={2023-07-18},
+ abstract={This package was created as extension of the \pkg{float} package.
+ The \pkg*{floatrow} package borrows core code from the \pkg{float}
+ and \pkg{rotfloat} packages, so you must not load these packages.},
+}
+ at online{pkg:xpatch,
+ author = {Enrico Gregorio},
+ version = {0.3},
+ date = {2020-03-25},
+ title = {\pkg*{xpatch} – Extending \pkg{etoolbox} patching commands},
+ url = {https://ctan.org/pkg/xpatch},
+ urldate = {2023-07-19},
+ note = {The package generalises the macro patching commands provided
+ by Philipp Lehmann's \pkg{etoolbox}.},
+}
+ at manual{pkg:xpatch:manual,
+ author = {Enrico Gregorio},
+ version = {0.3},
+ date = {2020-03-25},
+ title = {The \pkg*{xpatch} package
+ extending \pkg{etoolbox} patching commands},
+ url = {http://mirrors.ctan.org/macros/latex/contrib/xpatch/xpatch.pdf},
+ urldate = {2023-07-19},
+ abstract = {},
+}
+ at online{pkg:scrlfile,
+ author = {Markus Kohm},
+ version = {3.41},
+ date = {2023-07-07},
+ title = {\pkg*{scrlfile} – Installation control (not only) for
+ \KOMAScript{} packages},
+ url = {https://ctan.org/pkg/scrlfile},
+ urldate = {2023-07-19},
+ note = {The package provides hooks for the execution of commands before
+ or after loading files, classes or packages independent from the
+ \LaTeX{} kernel version.},
+}
+ at online{pkg:koma-script,
+ author={Markus Kohm},
+ version={3.41},
+ date={2023-07-07},
+ title={{\KOMAScript} --- A bundle of versatile classes and packages},
+ url={https://ctan.org/pkg/koma-script},
+ urldate={2023-07-14},
+ note={The \KOMAScript{} bundle provides replacements for the \pkg*{article},
+ \pkg*{report}, and \pkg*{book} classes with emphasis on typography and
+ versatility. There is also a letter class.},
+}
+ at online{pkg:tocbasic,
+ author={Markus Kohm},
+ version={3.41},
+ date={2023-07-07},
+ title={\pkg*{tocbasic} --- Management of tables/lists of contents (and the
+ like)},
+ url={https://ctan.org/pkg/tocbasic},
+ urldate={2023-07-14},
+ note={The package provides means to create specialised ``table of
+ contents''-like lists of features of a document.},
+}
+ at manual{pkg:koma-script:manual:de,
+ author={Markus Kohm},
+ date={2023-06-16},
+ title={{\KOMAScript}},
+ subtitle={Die Anleitung},
+ url={http://mirrors.ctan.org/macros/latex/contrib/koma-script/scrguide-de.pdf},
+ urldate={2023-07-04},
+}
+ at manual{pkg:koma-script:manual:en,
+ author={Markus Kohm},
+ date={2023-06-16},
+ title={{\KOMAScript}},
+ subtitle={The Guide},
+ url={http://mirrors.ctan.org/macros/latex/contrib/koma-script/scrguide-en.pdf},
+ urldate={2023-07-14},
+}
+\end{filecontents}
+\addbibresource{\jobname.bib}
+\setcounter{StandardModuleDepth}{2}
+\begin{document}
+ \nocite{pkg:floatrow,pkg:koma-script,pkg:tocbasic}
+ \DocInput{floatrowbytocbasic.dtx}
+\end{document}
+%</dtx>
+%\fi
+%
+% \changes{v0.1}{2023/06/01}{start of \KOMAScript{} spin-off}
+% \changes{v1.0}{2023/08/19}{first package release}
+%
+% \GetFileInfo{floatrowbytocbasic.dtx}
+% \title{Improving Package \pkg{floatrow} Using
+% \href{https://komascript.de/}{\KOMAScript} Package \pkg{tocbasic}}
+% \author{\href{mailto:komascript at gmx.info}{Markus Kohm}}
+% \date{Version \filedate{} \fileversion}
+% \maketitle
+% \begin{abstract}
+% Package \pkg*{floatrowbytocbasic} has started as hack module of the
+% \KOMAScript{} package \pkg*{scrhack} years ago to fix an issue when using
+% package \pkg{floatrow} with \KOMAScript~3. This became necessary because
+% package \pkg{floatrow} still depends on an interface once proposed by the
+% \KOMAScript{} author, but which has long since failed to meet
+% requirements. Unfortunately, this problem could not be solved in dialog
+% with the author of \pkg{floatrow}. Although \pkg*{floatrowbytocbasic} still
+% loads the \pkg{floatrow} package, it then changes some internal commands to
+% use and optimally support the \KOMAScript{} package \pkg{tocbasic}. On the
+% one hand, the user interface of \pkg{floatrow} remains usable unchanged,
+% but at the same time the package benefits from many possibilities of
+% \pkg{tocbasic}.
+% \end{abstract}
+%
+% \tableofcontents
+%
+%\iffalse
+%<*doc>
+%\fi
+\section{Why should I use this package instead of
+ \texorpdfstring{\pkg{floatrow}}{floatrow} only if I use a \KOMAScript{}
+ class or \KOMAScript{} package \texorpdfstring{\pkg{tocbasic}}{tocbasic}?}
+\label{sec:whywithkomascript}
+
+The main symptom of using a deprecated interface to \KOMAScript{} by package
+\pkg{floatrow}, namely the use of \cs{float at listhead} and
+\cs{float at addtolists}, are corresponding warnings when using one of the
+\KOMAScript{} classes at the same time, for example:
+\begin{verbatim}
+ Class scrbook Warning: \float at addtolists detected!
+ (scrbook) Implementation of \float at addtolist became
+ (scrbook) deprecated in KOMA-Script v3.01 2008/11/14 and
+ (scrbook) has been replaced by several more flexible
+ (scrbook) features of package `tocbasic`.
+ (scrbook) Since Version 3.12 support for deprecated
+ (scrbook) \float at addtolist interface has been
+ (scrbook) restricted to only some of the KOMA-Script
+ (scrbook) features and been removed from others.
+ (scrbook) Loading of package `scrhack' may help to
+ (scrbook) avoid this warning, if you are using a
+ (scrbook) a package that still implements the
+ (scrbook) deprecated \float at addtolist interface.
+\end{verbatim}
+or
+\begin{verbatim}
+ Class scrbook Warning: \float at listhead detected!
+ (scrbook) Implementation of \float at listhead became
+ (scrbook) deprecated in KOMA-Script v3.01 2008/11/14 and
+ (scrbook) has been replaced by several more flexible
+ (scrbook) features of package `tocbasic`.
+ (scrbook) Maybe implementation of \float at listhead will
+ (scrbook) removed from KOMA-Script soon.
+ (scrbook) Loading of package `scrhack' may help to
+ (scrbook) avoid this warning, if you are using a
+ (scrbook) a package that still implements the
+ (scrbook) deprecated \float at listhead interface.
+\end{verbatim}
+
+If you know, that the issue is because of loading package \pkg{floatrow} you
+can avoid it using \pkg{floatrowbytocbasic} as explained in
+\autoref{sec:howtouse}.
+
+\section{Why should I use this package instead of
+ \texorpdfstring{\pkg{floatrow}}{floatrow} only if I don't use a
+ \KOMAScript{} class or package?}
+\label{sec:whywithoutkomascript}
+
+Package \pkg{floatrow} does not check if a file extension or environment
+already has been defined when using \cs{DeclareNewFloatType}. So several
+definitions of float environments either with the same name or the same file
+extension could happen by accident. Package \pkg*{floatrowbytocbasic} adds
+test to avoid such issues. But it also allows to redefine an environment or
+reuse a file extension, if you want. Alternatively you can force the
+definition or do the definition only if needed. See description of
+\cs{DeclareFloatType}, \cs{RedeclareFloatType} and \cs{ProvideFloatType} in
+\autoref{sec:howtouse} for more information.
+
+Package \pkg{tocbasic} provides several additional features, e.g.:
+\begin{itemize}
+\item automatic handling of language switching using \pkg{babel},
+\item optional numbered heading for a list/table of contents,
+\item optional adding an entry to the table of contents for a list/table of
+ contents even if the heading is not numbered,
+\item easy configuration of entries to a list/table of contents.
+\end{itemize}
+Several more features can be added by the class or other packages. See section
+about \pkg*{tocbasic} in the \KOMAScript{} manual, either
+\autocite{pkg:koma-script:manual:en} or \autocite{pkg:koma-script:manual:de}.
+
+\section{How to use
+ \texorpdfstring{\pkg*{floatrowbytocbasic}}{floatrowbytocbasic}}
+\label{sec:howtouse}
+
+In the document preamble of your document you just can replace
+\begin{verbatim}
+ \usepackage{floatrow}
+\end{verbatim}
+by
+\begin{verbatim}
+ \usepackage{floatrowbytocbasic}
+\end{verbatim}
+to load package \pkg*{floatrowbytocbasic}. This does still also load package
+\pkg{floatrow} but additionally patches several commands of \pkg{floatrow} to
+avoid the issues shown in \autoref{sec:whywithkomascript}.
+
+If you want you can alternatively also load both packages explicitly, either
+\pkg{floatrow} before \pkg{floatrowbytocbasic} or---if you
+want---\pkg{floatrowbytocbasic} before \pkg{floatrow}. This is also useful, if
+you use a package, that uses \pkg{floatrow} itself. In this case, you always
+should load \pkg{floatrowbytocbasic} \emph{before} the package, that uses
+\pkg{floatrow}. Otherwise it is very likely that for some new float
+environments the enhancements of \pkg*{floatrowbytocbasic} will not be
+used. Only if \pkg*{floatrowbytocbasic} is loaded before the first use of
+\cs{DeclareNewFloatType} can it be ensured that the definition of the new
+sliding environments is really done with the help of \pkg{tocbasic} and thus
+its extended user interface is used.
+
+When using a class that uses \pkg{floatrow}, the correct operation can be
+ensured with
+\begin{verbatim}
+ \AddToHook{package/floatrow/after}{\RequirePackage{floatrowbytocbasic}}
+\end{verbatim}
+even before \cs{documentclass}. This requires at least \LaTeX{}
+2020/10/01. For older versions of \LaTeX{} you can use
+\begin{verbatim}
+ \RequirePackage{scrlfile}
+ \AfterPackage{floatrow}{\RequirePackage{floatrowbytocbasic}}
+\end{verbatim}
+also before \cs{documentclass}. This would require the \KOMAScript{} package
+\pkg{scrlfile}\nocite{pkg:scrlfile}.
+
+The user interface of \pkg*{floatrowbytocbasic} is the same as of
+\pkg{floatrow}, see \autocite{pkg:floatrow:manual}. Following we document only
+the differences.
+
+\DescribeCommand{\DeclareNewFloatType}
+\DescribeCommand{\ProvideFloatType}
+\DescribeCommand{\RedeclareFloatType}
+\DescribeCommand{\DeclareFloatType}
+See \autocite[section~2]{pkg:floatrow:manual} for the basic usage of
+\cs{DeclareNewFloatType}. The command takes two mandatory arguments. It is of
+the form:
+\begin{quote}
+ \cs{DeclareNewFloatType}\marg{type}\marg{options}
+\end{quote}
+\pkg{floatrowbytocbasic} adds the registration of the file extension of the
+new \meta{type} given either by option \opt{fileext} in the \meta{options} or
+implicitly (see \autocite[section~4]{pkg:floatrow:manual}). The main problem
+here is to decide what to do, if \meta{ext} already has been
+registered. Package \pkg{floatrow} simply does not care for this case. It does
+neither report an error nor a warning, but just redefine the float \meta{type}
+and reuses the auxiliary file extension. Because of the ``\texttt{New}'' in
+the name of the command, we have decided to report an error instead, but only
+of the owner/category differs and therefore is not \texttt{float}. But we
+also decided to define three new commands:
+\begin{quote}\raggedright
+ \cs{DeclareFloatType}\marg{type}\marg{options}\\
+ \cs{ProvideFloatType}\marg{type}\marg{options}\\
+ \cs{RedeclareFloatType}\marg{type}\marg{options}
+\end{quote}
+\cs{DeclareFloatTpye} also does not care for already existing \meta{type}
+environment or already registered file extension. \cs{DeclareNewFloatType}
+reports and error for an already existing \meta{type}
+environment. \cs{ProvideFloatType} does not overwrite existing \meta{type}
+environment or already registered file extensions for other
+owners. \cs{RedeclareFloatType} does overwrite only already existing
+\meta{type} environment with registered file extension. There are also cases
+like defined \cs{\meta{type}} but not \cs{end\meta{type}} or not defined
+environment \meta{type} but registered file extension. But there are no
+special commands to handle these. If users need to take care for these cases,
+they can test for definition using the \LaTeX{} kernel macro \cs{@ifundefined}
+and the \pkg{tocbasic} command \cs{Ifattoclist}, described in the
+\KOMAScript{} user manuals \autocite{pkg:koma-script:manual:en}
+resp. \autocite{pkg:koma-script:manual:de}.
+%
+% \iffalse
+%</doc>
+% \fi
+%
+% \MaybeStop{\printbibliography[heading=bibintoc]\PrintIndex}
+%
+% \iffalse
+%<*package>
+%<@@=floatrowbytocbasic>
+% \fi
+% \section{Implementation}
+%
+% \pkg{floatrowbytocbasic} depend on \KOMAScript{} package \pkg{tocbasic}. So
+% we load it already before everything else. We use this package also to
+% require at least \KOMAScript{} 3.41, which is one version before the
+% intended spin-off.
+% \begin{macrocode}
+\RequirePackage{tocbasic}[2023/07/07]
+% \end{macrocode}
+%
+% We also load package \pkg{floatrow}, because we reuse most of the code:
+% \begin{macrocode}
+\RequirePackage{floatrow}
+% \end{macrocode}
+%
+% As often as possible, we do not redefine macors of \pkg{floatrow}, but patch
+% them using \pkg{xpatch}\nocite{pkg:xpatch}:
+% \begin{macrocode}
+\RequirePackage{xpatch}
+% \end{macrocode}
+%
+% We also use some \LaTeX3 functions. So if the \LaTeX{} kernel is
+% too old, we require \pkg{expl3}:
+% \begin{macrocode}
+\@ifundefined{ExplSyntaxOn}{%
+ \RequirePackage{expl3}%
+}{}
+% \end{macrocode}
+%
+% \begin{command}{\DeclareFloatType}
+% Basicly \cs{DeclareFloatType} is \cs{DeclareNewFloatType} of
+% \pkg{floatrow}:
+% \begin{macrocode}
+\@ifundefined{NewCommandCopy}{\let\DeclareFloatType\DeclareNewFloatType}{%
+ \NewCommandCopy\DeclareFloatType\DeclareNewFloatType
+}
+% \end{macrocode}
+% But we also have to take care, that a not yet registered file extension has
+% to be registered.
+% \begin{description}
+% \item[Note:] We do not need to setup feature \texttt{chapteratlist}, because
+% classes like the \KOMAScript{} classes should use
+%\begin{verbatim}
+% \AtAddToTocList[float]{\setuptoc{\@currext}{chapteratlist}}
+%\end{verbatim}
+% to implement such features.
+% \end{description}
+% \begin{macrocode}
+\newcommand*{\floatrowbytocbasic at incompatibility@error}[1]{%
+ \PackageError{floatrowbytocbasic}{incompatible definition of
+ \expandafter\string\csname #1\endcsname}{%
+ Package `floatrowbytocbasic' depends on the original definition of
+ package\MessageBreal
+ `floatrow'.\MessageBreak
+ Some changes to that definition are tolerated.\MessageBreak
+ \@ifundefined{#1}%
+ {But it seems the definition is completely missing!}%
+ {But the current definition is incompatible!}%
+ \MessageBreak
+ Make sure, you have installed the original package `floatrow' as
+ referred\MessageBreak
+ by section ``References'' of the manual.%
+ }%
+}
+\xpatchcmd{\DeclareFloatType}{%
+ \xdef\@tempa{\noexpand\flrow at types{\the\flrow at types \FR at tmp{#1}}}%
+ \@tempa
+}{%
+ \Ifattoclist{\@nameuse{ext@\FB at captype}}{%
+ \let\reserved at a\relax
+ \owneroftoc[\def\reserved at a]{\@nameuse{ext@\FB at captype}}\relax
+ \@ifundefined{reserved at a}{}{%
+ \Ifstr{\reserved at a}{float}{%
+ \PackageInfo{floarowtbytocbasic}{%
+ reusing file extension `\@nameuse{ext@\FB at captype}' for\MessageBreak
+ float type `#1'%
+ }%
+ }{%
+ \PackageWarning{floatrowbytocbasic}{%
+ reusing file extension `\@nameuse{ext@\FB at captype}' of owner\MessageBreak
+ `\reserved at a' for float `#1'\MessageBreak
+ not recommended%
+ }%
+ }%
+ }%
+ }{%
+ \addtotoclist[float]{\@nameuse{ext@\FB at captype}}%
+ }%
+ \xdef\@tempa{\noexpand\flrow at types{\the\flrow at types \FR at tmp{#1}}}%
+ \@tempa
+}{}{%
+ \floatrowbytocbasic at incompatibility@error{DeclareNewFloatType}%
+}
+% \end{macrocode}
+% \begin{description}
+% \item[Note:] In difference to \pkg{floatrow} we think, reusing a counter is
+% not a big problem, so we don't report an error.
+% \end{description}
+% \begin{macrocode}
+\xpatchcmd{\DeclareFloatType}{%
+ \newcounter{#1}%
+}{%
+ \@ifundefined{c@#1}{\newcounter{#1}}{%
+ \PackageInfo{floatrowbytocbasic}{%
+ reusing existing counter for float type `#1'%
+ }%
+ }%
+}{}{%
+ \floatrowbytocbasic at incompatibility@error{DeclareNewFloatType}%
+}
+\xpatchcmd{\DeclareFloatType}{%
+ \@namedef{l@#1}{\@dottedtocline{1}{1.5em}{2.3em}}%
+}{%
+ \@ifundefined{l@#1}{\expandafter\let\csname l@#1\endcsname\l at figure
+ \@ifundefined{l@#1}{%
+ \DeclareTOCStyleEntry[level=1,numwith=2.3em,indent=1.5em]{default}{#1}%
+ }{}%
+ }{}%
+}{}{%
+ \floatrowbytocbasic at incompatibility@error{DeclareNewFloatType}%
+}
+% \end{macrocode}
+% \end{command}
+%
+% \begin{command}{\DeclareNewFloatType,\ProvideFloatType,\RedeclareFloatType}
+% \cs{DeclareNewFloatType} and \cs{RedeclareFloatType} similar to
+% \cs{newcommand} and \cs{renewcommand} do some tests and maybe report an
+% error, before (nevertheless) defining the float.
+% \begin{description}
+% \item[Note:] The test for already defined floats is somehow complicated,
+% because \pkg{floatrow} delays the definition until
+% |\begin{document}|. Before, there is only a list of \cs{FR at tmp} commands
+% stored in toks register \cs{flrow at types}. But we also have to test for
+% reusing another environment instead of a float.
+% \end{description}
+% \begin{macrocode}
+\renewcommand{\DeclareNewFloatType}[2]{%
+ \floatrowbytocbasic at get@currext{#1}{#2}%
+ \@tempswatrue
+ \begingroup
+ \def\FR at tmp##1{%
+ \Ifstr{#1}{##1}{\aftergroup\@tempswafalse}{}%
+ }%
+ \the\flrow at types
+ \endgroup
+ \if at tempswa
+ \expandafter\@ifdefinable\csname #1\endcsname {%
+ \Ifattoclist{\floatrowbytocbasic at currext}{%
+ \let\reserved at a\relax
+ \owneroftoc[\def\reserved at a]{\floatrowbytocbasic at currext}\relax
+ \@ifundefined{reserved at a}{%
+ \DeclareFloatType{#1}{#2}%
+ }{%
+ \Ifstr{\reserved at a}{float}{%
+ \PackageInfo{floatrowbytocbasic}{%
+ reusing `\floatrowbytocbasic at currext' of owner `float'%
+ }%
+ \DeclareFloatType{#1}{#2}%
+ }{%
+ \PackageError{floatrowbytocbasic}{%
+ reusing `\floatrowbytocbasic at currext' of owner `\reserved at a' not
+ allowed%
+ }{%
+ Each file extension should be used only once.\MessageBreak
+ Reusing is only allowed with the same owner/category.\MessageBreak
+ You, the class, or another package already uses
+ `\floatrowbytocbasic at currext'.\MessageBreak
+ \@eha
+ }%
+ }%
+ }%
+ }{%
+ \DeclareFloatType{#1}{#2}%
+ }%
+ }%
+ \else
+ \PackageError{floatrowbytocbasic}{Float `#1' already defined}{%
+ Each float can be defined only once using
+ \string\DeclareNewFloatType.\MessageBreak
+ If you want to redefine an already existing float, please
+ use\MessageBreak
+ \string\RedeclareFloatType.\MessageBreak
+ \@eha
+ }%
+ \fi
+}
+\newcommand{\ProvideFloatType}[2]{%
+ \@ifundefined{#1}{%
+ \@tempswatrue
+ \begingroup
+ \def\FR at tmp##1{%
+ \Ifstr{#1}{##1}{\aftergroup\@tempswafalse}{}%
+ }%
+ \the\flrow at types
+ \endgroup
+ \if at tempswa
+ \DeclareNewFloatType{#1}{#2}%
+ \fi
+ }{}%
+}
+\newcommand{\RedeclareFloatType}[2]{%
+ \@tempswafalse
+ \@ifundefined{#1}{%
+ \begingroup
+ \def\FR at tmp##1{%
+ \Ifstr{#1}{##1}{\aftergroup\@tempswatrue}{}%
+ }%
+ \the\flrow at types
+ \endgroup
+ }{\@tempswatrue}%
+ \floatrowbytocbasic at get@currext{#1}{#2}%
+ \if at tempswa
+ \Ifattoclist{\floatrowbytocbasic at currext}{%
+ \removefromtoclist{\floatrowbytocbasic at currext}%
+ }{%
+ \PackageError{floatrowbytocbasic}{%
+ extension `\floatrowbytocbasic at currext' not yet registered%
+ }{%
+ I can only renew floats with already registered
+ extensions.\MessageBreak
+ \@ehc
+ }%
+ }%
+ \else
+ \@latex at error{Environment #1 undefined}\@ehc
+ \removefromtoclist{\floatrowbytocbasic at currext}%
+ \fi
+ \DeclareFloatType{#1}{#2}%
+}
+% \end{macrocode}
+% \end{command}
+%
+% \ExplSyntaxOn
+% \begin{macro}{\__floatrowbytocbasic_get_ext_from_prop:nn,
+% \floatrowbytocbasic at get@currext}
+% \ExplSyntaxOff
+% Helper macros to set \cs{floatrowbytocbasic at currext} to the extension set by
+% the options (=\#2). \#1 is the name of the new float type. We are not really
+% interested in handling of all the options. So we just use the options to
+% setup a property list and then get the one interesting property.
+% \begin{macrocode}
+\ExplSyntaxOn
+\prop_new:N \@@_DeclareNewFloatType_prop
+\tl_new:N \@@_ext_tl
+\cs_new:Nn \@@_get_ext_from_prop:nn
+ {
+ \prop_set_from_keyval:Nn \@@_DeclareNewFloatType_prop { #2 }
+ \prop_get:NnN \@@_DeclareNewFloatType_prop { fileext } \@@_ext_tl
+ \quark_if_no_value:NT \@@_ext_tl
+ {
+ \tl_set:Nn \@@_ext_tl { lo#1 }
+ }
+ }
+\newcommand*{\floatrowbytocbasic at get@currext}[2]{%
+ \@@_get_ext_from_prop:nn { #1 } { #2 }
+ \let\floatrowbytocbasic at currext\@@_ext_tl
+}
+\ExplSyntaxOff
+% \end{macrocode}
+% \end{macro}
+% \ExplSyntaxOff
+%
+% \begin{command}{\listof}
+% This command is redefined using a complete new definition using
+% \pkg{tocbasic}'s \cs{listoftoc}.
+% \begin{macrocode}
+\renewcommand*{\listof}[2]{%
+ \@ifundefined{ext@#1}{\flrow at error{Unknown float style `#1'}}{%
+ \@ifundefined{l@#1}{\expandafter\let\csname l@#1\endcsname\l at figure
+ \@ifundefined{l@#1}{%
+ \DeclareTOCStyleEntry[level=1,numwidth=2.3em,indent=1.5em]
+ {default}{#1}%
+ }{}%
+ }{}%
+ \listoftoc[{#2}]{\csname ext@#1\endcsname}%
+ }%
+}%
+% \end{macrocode}
+% \end{command}
+%
+% \iffalse
+%</package>
+% \fi
+%
+% \Finale
+% \PrintChanges
+%
+% \endinput
+% Local Variables:
+% mode: doctex
+% ispell-local-dictionary: "en_US"
+% eval: (flyspell-mode 1)
+% TeX-master: t
+% End:
Property changes on: trunk/Master/texmf-dist/source/latex/floatrowbytocbasic/floatrowbytocbasic.dtx
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/floatrowbytocbasic/floatrowbytocbasic.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/floatrowbytocbasic/floatrowbytocbasic.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/floatrowbytocbasic/floatrowbytocbasic.sty 2023-08-16 19:44:23 UTC (rev 67946)
@@ -0,0 +1,225 @@
+%%
+%% This is file `floatrowbytocbasic.sty',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% floatrowbytocbasic.dtx (with options: `package')
+%%
+%% IMPORTANT NOTICE:
+%%
+%% For the copyright see the source file.
+%%
+%% Any modified versions of this file must be renamed
+%% with new filenames distinct from floatrowbytocbasic.sty.
+%%
+%% For distribution of the original source see the terms
+%% for copying and modification in the file floatrowbytocbasic.dtx.
+%%
+%% This generated file may be distributed as long as the
+%% original source files, as listed above, are part of the
+%% same distribution. (The sources need not necessarily be
+%% in the same archive or directory.)
+\ProvidesPackage{floatrowbytocbasic}
+ [2023-08-16 v1.0
+ improved floatrow package using tocbasic]
+\RequirePackage{tocbasic}[2023/07/07]
+\RequirePackage{floatrow}
+\RequirePackage{xpatch}
+\@ifundefined{ExplSyntaxOn}{%
+ \RequirePackage{expl3}%
+}{}
+\@ifundefined{NewCommandCopy}{\let\DeclareFloatType\DeclareNewFloatType}{%
+ \NewCommandCopy\DeclareFloatType\DeclareNewFloatType
+}
+\newcommand*{\floatrowbytocbasic at incompatibility@error}[1]{%
+ \PackageError{floatrowbytocbasic}{incompatible definition of
+ \expandafter\string\csname #1\endcsname}{%
+ Package `floatrowbytocbasic' depends on the original definition of
+ package\MessageBreal
+ `floatrow'.\MessageBreak
+ Some changes to that definition are tolerated.\MessageBreak
+ \@ifundefined{#1}%
+ {But it seems the definition is completely missing!}%
+ {But the current definition is incompatible!}%
+ \MessageBreak
+ Make sure, you have installed the original package `floatrow' as
+ referred\MessageBreak
+ by section ``References'' of the manual.%
+ }%
+}
+\xpatchcmd{\DeclareFloatType}{%
+ \xdef\@tempa{\noexpand\flrow at types{\the\flrow at types \FR at tmp{#1}}}%
+ \@tempa
+}{%
+ \Ifattoclist{\@nameuse{ext@\FB at captype}}{%
+ \let\reserved at a\relax
+ \owneroftoc[\def\reserved at a]{\@nameuse{ext@\FB at captype}}\relax
+ \@ifundefined{reserved at a}{}{%
+ \Ifstr{\reserved at a}{float}{%
+ \PackageInfo{floarowtbytocbasic}{%
+ reusing file extension `\@nameuse{ext@\FB at captype}' for\MessageBreak
+ float type `#1'%
+ }%
+ }{%
+ \PackageWarning{floatrowbytocbasic}{%
+ reusing file extension `\@nameuse{ext@\FB at captype}' of owner\MessageBreak
+ `\reserved at a' for float `#1'\MessageBreak
+ not recommended%
+ }%
+ }%
+ }%
+ }{%
+ \addtotoclist[float]{\@nameuse{ext@\FB at captype}}%
+ }%
+ \xdef\@tempa{\noexpand\flrow at types{\the\flrow at types \FR at tmp{#1}}}%
+ \@tempa
+}{}{%
+ \floatrowbytocbasic at incompatibility@error{DeclareNewFloatType}%
+}
+\xpatchcmd{\DeclareFloatType}{%
+ \newcounter{#1}%
+}{%
+ \@ifundefined{c@#1}{\newcounter{#1}}{%
+ \PackageInfo{floatrowbytocbasic}{%
+ reusing existing counter for float type `#1'%
+ }%
+ }%
+}{}{%
+ \floatrowbytocbasic at incompatibility@error{DeclareNewFloatType}%
+}
+\xpatchcmd{\DeclareFloatType}{%
+ \@namedef{l@#1}{\@dottedtocline{1}{1.5em}{2.3em}}%
+}{%
+ \@ifundefined{l@#1}{\expandafter\let\csname l@#1\endcsname\l at figure
+ \@ifundefined{l@#1}{%
+ \DeclareTOCStyleEntry[level=1,numwith=2.3em,indent=1.5em]{default}{#1}%
+ }{}%
+ }{}%
+}{}{%
+ \floatrowbytocbasic at incompatibility@error{DeclareNewFloatType}%
+}
+\renewcommand{\DeclareNewFloatType}[2]{%
+ \floatrowbytocbasic at get@currext{#1}{#2}%
+ \@tempswatrue
+ \begingroup
+ \def\FR at tmp##1{%
+ \Ifstr{#1}{##1}{\aftergroup\@tempswafalse}{}%
+ }%
+ \the\flrow at types
+ \endgroup
+ \if at tempswa
+ \expandafter\@ifdefinable\csname #1\endcsname {%
+ \Ifattoclist{\floatrowbytocbasic at currext}{%
+ \let\reserved at a\relax
+ \owneroftoc[\def\reserved at a]{\floatrowbytocbasic at currext}\relax
+ \@ifundefined{reserved at a}{%
+ \DeclareFloatType{#1}{#2}%
+ }{%
+ \Ifstr{\reserved at a}{float}{%
+ \PackageInfo{floatrowbytocbasic}{%
+ reusing `\floatrowbytocbasic at currext' of owner `float'%
+ }%
+ \DeclareFloatType{#1}{#2}%
+ }{%
+ \PackageError{floatrowbytocbasic}{%
+ reusing `\floatrowbytocbasic at currext' of owner `\reserved at a' not
+ allowed%
+ }{%
+ Each file extension should be used only once.\MessageBreak
+ Reusing is only allowed with the same owner/category.\MessageBreak
+ You, the class, or another package already uses
+ `\floatrowbytocbasic at currext'.\MessageBreak
+ \@eha
+ }%
+ }%
+ }%
+ }{%
+ \DeclareFloatType{#1}{#2}%
+ }%
+ }%
+ \else
+ \PackageError{floatrowbytocbasic}{Float `#1' already defined}{%
+ Each float can be defined only once using
+ \string\DeclareNewFloatType.\MessageBreak
+ If you want to redefine an already existing float, please
+ use\MessageBreak
+ \string\RedeclareFloatType.\MessageBreak
+ \@eha
+ }%
+ \fi
+}
+\newcommand{\ProvideFloatType}[2]{%
+ \@ifundefined{#1}{%
+ \@tempswatrue
+ \begingroup
+ \def\FR at tmp##1{%
+ \Ifstr{#1}{##1}{\aftergroup\@tempswafalse}{}%
+ }%
+ \the\flrow at types
+ \endgroup
+ \if at tempswa
+ \DeclareNewFloatType{#1}{#2}%
+ \fi
+ }{}%
+}
+\newcommand{\RedeclareFloatType}[2]{%
+ \@tempswafalse
+ \@ifundefined{#1}{%
+ \begingroup
+ \def\FR at tmp##1{%
+ \Ifstr{#1}{##1}{\aftergroup\@tempswatrue}{}%
+ }%
+ \the\flrow at types
+ \endgroup
+ }{\@tempswatrue}%
+ \floatrowbytocbasic at get@currext{#1}{#2}%
+ \if at tempswa
+ \Ifattoclist{\floatrowbytocbasic at currext}{%
+ \removefromtoclist{\floatrowbytocbasic at currext}%
+ }{%
+ \PackageError{floatrowbytocbasic}{%
+ extension `\floatrowbytocbasic at currext' not yet registered%
+ }{%
+ I can only renew floats with already registered
+ extensions.\MessageBreak
+ \@ehc
+ }%
+ }%
+ \else
+ \@latex at error{Environment #1 undefined}\@ehc
+ \removefromtoclist{\floatrowbytocbasic at currext}%
+ \fi
+ \DeclareFloatType{#1}{#2}%
+}
+\ExplSyntaxOn
+\prop_new:N \__floatrowbytocbasic_DeclareNewFloatType_prop
+\tl_new:N \__floatrowbytocbasic_ext_tl
+\cs_new:Nn \__floatrowbytocbasic_get_ext_from_prop:nn
+ {
+ \prop_set_from_keyval:Nn \__floatrowbytocbasic_DeclareNewFloatType_prop { #2 }
+ \prop_get:NnN \__floatrowbytocbasic_DeclareNewFloatType_prop { fileext } \__floatrowbytocbasic_ext_tl
+ \quark_if_no_value:NT \__floatrowbytocbasic_ext_tl
+ {
+ \tl_set:Nn \__floatrowbytocbasic_ext_tl { lo#1 }
+ }
+ }
+\newcommand*{\floatrowbytocbasic at get@currext}[2]{%
+ \__floatrowbytocbasic_get_ext_from_prop:nn { #1 } { #2 }
+ \let\floatrowbytocbasic at currext\__floatrowbytocbasic_ext_tl
+}
+\ExplSyntaxOff
+\renewcommand*{\listof}[2]{%
+ \@ifundefined{ext@#1}{\flrow at error{Unknown float style `#1'}}{%
+ \@ifundefined{l@#1}{\expandafter\let\csname l@#1\endcsname\l at figure
+ \@ifundefined{l@#1}{%
+ \DeclareTOCStyleEntry[level=1,numwidth=2.3em,indent=1.5em]
+ {default}{#1}%
+ }{}%
+ }{}%
+ \listoftoc[{#2}]{\csname ext@#1\endcsname}%
+ }%
+}%
+\endinput
+%%
+%% End of file `floatrowbytocbasic.sty'.
Property changes on: trunk/Master/texmf-dist/tex/latex/floatrowbytocbasic/floatrowbytocbasic.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/tlpkg/tlpsrc/floatrowbytocbasic.tlpsrc
===================================================================
More information about the tex-live-commits
mailing list.