summaryrefslogtreecommitdiff
path: root/macros/jptex/latex/plautopatch/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/jptex/latex/plautopatch/README.md')
-rw-r--r--macros/jptex/latex/plautopatch/README.md99
1 files changed, 99 insertions, 0 deletions
diff --git a/macros/jptex/latex/plautopatch/README.md b/macros/jptex/latex/plautopatch/README.md
new file mode 100644
index 0000000000..2f399b8c9a
--- /dev/null
+++ b/macros/jptex/latex/plautopatch/README.md
@@ -0,0 +1,99 @@
+# plautopatch
+
+Japanese pLaTeX/upLaTeX formats and packages often conflict
+with other LaTeX packages which are unaware of pLaTeX/upLaTeX.
+In the worst case, such packages throw a fatal error or
+end up with a wrong output.
+
+The goal of this package "plautopatch" is that
+there should be no need to worry about such incompatibilities,
+because specific patches are loaded automatically
+whenever necessary.
+This helps not only to simplify source files, but also
+to make the appearance of working pLaTeX/upLaTeX sources
+similar to those of ordinary LaTeX ones.
+
+The following patches are currently registered:
+
+- doc (latex) -> pldocverb (platex-tools)
+- tracefnt (latex) -> ptrace/uptrace (platex/uplatex)
+- fltrace (latex) -> pfltrace (platex)
+- array (latex-tools) -> plarray (platex-tools)
+- array (latex-tools) + plext (platex) -> plextarray (platex-tools)
+- delarray (latex-tools) + plext (platex) -> plextdelarray (platex-tools)
+- colortbl + plext (platex) -> plextcolortbl (platex-tools)
+- arydshln -> plarydshln (maintained here!)
+- arydshln + plext (platex) -> plextarydshln (maintained here!)
+- siunitx -> plsiunitx (maintained here!)
+- collcell -> plcollcell (maintained here!)
+- everysel (ms) -> pxeverysel (platex-tools)
+- everyshi (ms) -> pxeveryshi (platex-tools)
+- atbegshi (oberdiek) -> pxatbegshi (platex-tools)
+- ftnright (latex-tools) -> pxftnright (platex-tools)
+- multicol (latex-tools) -> pxmulticol (platex-tools)
+- xspace (latex-tools) -> pxxspace (platex-tools)
+- textpos -> pxtextpos (gentombow)
+- eso-pic -> pxesopic (gentombow)
+- pdfpages -> pxpdfpages (gentombow)
+- stfloats (sttools) -> pxstfloats (pxsttools)
+- hyperref -> pxjahyper (by Takayuki YATO)
+- pgfrcs (pgf) -> pxpgfrcs (maintained here!)
+- pgfcore (pgf) -> pxpgfmark (by Takayuki YATO)
+
+## Requirements
+
+If LaTeX2e 2020-10-01 or newer is running,
+this package uses the new hook system such as
+`\AddToHook{package/before/...}` and
+`\AddToHook{package/after/...}`.
+If LaTeX2e is older than that, this package depends on
+`filehook` package (written by Martin Scharrer).
+
+## Miscellaneous
+
+This bundle may distribute some tiny patches
+together with the main package.
+All packages are meant for use with pLaTeX/upLaTeX.
+Short information:
+
+- plarydshln.sty:
+ Patch for arydshln.sty (by Hiroshi Nakashima) to improve
+ compatibility with pLaTeX kernel.
+- plextarydshln.sty:
+ Patch for arydshln.sty (by Hiroshi Nakashima) to improve
+ compatibility with plext.sty in pLaTeX.
+- plsiunitx.sty:
+ Patch for siunitx.sty (by Joseph Wright) to fix
+ conflict with plarray.sty (platex-tools).
+- plcollcell.sty:
+ Patch for collcell.sty (by Martin Scharrer) to fix
+ conflict with plarray.sty (platex-tools).
+- pxpgfrcs.sty:
+ Patch for pgfrcs.sty (part of PGF) to support
+ Japanese classes for vertical writing.
+- pxstfloats.sty:
+ Patch for stfloats.sty (sttools) to improve
+ compatibility with pLaTeX kernel.
+ Actually part of pxsttols (https://github.com/aminophen/pxsttools)
+ but included here for convenience.
+
+## Installation
+
+- *.sty -> $TEXMF/tex/platex/plautopatch
+- *.tex, *.pdf -> $TEXMF/doc/platex/plautopatch
+
+## Repository
+
+The bundle is maintained on GitHub:
+ https://github.com/aminophen/plautopatch
+
+## License
+
+The bundle may be distributed and/or modified under the terms of
+the 3-clause BSD license (see [LICENSE](./LICENSE)).
+
+## Release Date
+
+2021-12-07
+
+Hironobu Yamashita