Skip to content

Commit

Permalink
Merge branch 'main' into issue179
Browse files Browse the repository at this point in the history
  • Loading branch information
lvjr committed Nov 30, 2024
2 parents a593bcd + d7a818c commit 486cccd
Show file tree
Hide file tree
Showing 82 changed files with 1,251 additions and 1,295 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.tlg text !eol
42 changes: 42 additions & 0 deletions .github/workflows/latex-package.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# these packages are collected from tabularray.sty and its test files
# to update all needed texlive packages from this file
# run `texfindpkg -i latex-package.txt -o texlive-package.txt`

-f # the following are latex packages
amsfonts
amsmath
array
blindtext
booktabs
diagbox
enumitem
environ
epstopdf-base
etoolbox
functional
geometry
hyperref
l3kernel
lmodern
mathtools
multirow
nameref
ninecolors
pict2e
shortvrb
siunitx
tabularx
varwidth
xcolor
xparse
zref

-p # the following are texlive packages
cm-super # for ppmcheckpdf on table-011 which contains itemize env hence \textbullet
ec
l3build
latex-bin # depends on latex
luatex
pdftex
ppmcheckpdf
xetex
52 changes: 52 additions & 0 deletions .github/workflows/texlive-package.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
amsfonts
amsmath
atveryend
auxhook
bigintcalc
blindtext
booktabs
cm-super
colortbl
diagbox
ec
enumitem
environ
epstopdf-pkg
etoolbox
fp
functional
geometry
graphics
hyperref
iftex
infwarerr
kvoptions
kvsetkeys
l3build
l3packages
latex
latex-bin
lm
ltxcmds
luatex
mathtools
multirow
ninecolors
pdfescape
pdftex
pdftexcmds
pict2e
ppmcheckpdf
refcount
rerunfilecheck
siunitx
stringenc
tools
translations
trimspaces
uniquecounter
url
varwidth
xcolor
xetex
zref
133 changes: 0 additions & 133 deletions .github/workflows/texlive.package

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/texlive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Install TeX Live
uses: teatimeguest/setup-texlive-action@v3
with:
package-file: .github/workflows/texlive.package
package-file: .github/workflows/texlive-package.txt
update-all-packages: true
- name: Test tabularray with l3build
run: |
Expand All @@ -34,7 +34,7 @@ jobs:
- name: Install TeX Live
uses: teatimeguest/setup-texlive-action@v3
with:
package-file: .github/workflows/texlive.package
package-file: .github/workflows/texlive-package.txt
update-all-packages: true
- name: Test tabularray with l3build
run: |
Expand Down
File renamed without changes.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# The LaTeX3 package `tabularray`

```
Package: Typeset tabulars and arrays with LaTeX3
Copyright: 2021-2024 (c) Jianrui Lyu <[email protected]>
Copyright: 2023-2024 (c) Yukai Chou <[email protected]>
CTAN: https://ctan.org/pkg/tabularray
Repository: https://github.com/lvjr/tabularray
Repository: https://bitbucket.org/lvjr/tabularray
License: The LaTeX Project Public License 1.3c
```

## 1\. Introduction

LaTeX tables are implemented using TeX commands such as `\halign`, `\noalign`, `\span`, and `\omit`.
In order to implement new features, many macro packages have modified the inner table commands inside LaTeX.
This makes package code complicated, difficult to maintain, and often conflicts with each other.

At present, the LaTeX3 programming layer is basically mature.
This `tabularray` package will discard the old `\halign` commands and directly use LaTeX3 functions to parse the table,
and then typeset the entire table.
Under the premise of being compatible with the basic syntax of LaTeX2 tables,
this macro package will completely separate the contents and styles of the table,
and the styles of the table can be completely set in key-value way.

## 2\. Contributing

To make the upcoming releases more stable, you are very welcome to test the latest package file in the repository.
To test it, you only need to download [`tabularray.sty`](https://github.com/lvjr/tabularray/raw/main/tabularray.sty)
and put it into the folder of your TeX documents.

If you want to make a contribution to `tabularray` package, you can get necessary informations from [CONTRIBUTING.md](https://github.com/lvjr/tabularray/blob/main/CONTRIBUTING.md) file.
The following are all contributors to the package:

- [dbitouze](https://github.com/lvjr/tabularray/commits?author=dbitouze) (Denis Bitouzé)
- [IsaacOscar](https://github.com/lvjr/tabularray/commits?author=IsaacOscar) (Isaac Oscar Gariano)
- [krlmlr](https://github.com/lvjr/tabularray/commits?author=krlmlr) (Kirill Müller)
- [mbertucci47](https://github.com/lvjr/tabularray/commits?author=mbertucci47) (Matthew Bertucci)
- [pkl97](https://github.com/lvjr/tabularray/commits?author=pkl97)
- [qinglee](https://github.com/lvjr/tabularray/commits?author=qinglee) (Qing Lee)
- [SainoNamkho](https://github.com/lvjr/tabularray/commits?author=SainoNamkho)
- [Yodude2002](https://github.com/lvjr/tabularray/commits?author=Yodude2002)
6 changes: 0 additions & 6 deletions README.txt

This file was deleted.

14 changes: 0 additions & 14 deletions manual/manual-3.tex
Original file line number Diff line number Diff line change
Expand Up @@ -166,20 +166,6 @@ \subsection{Hspan and Vspan Algorithms}
\end{tblr}
\end{demohigh}

\subsection{Use Verbatim Commands}

%With \verb!verb! key, you can write \verb!\verb! commands in the cell text:
%
%\begin{demohigh}
%\begin{tblr}{hlines,verb}
% 20 & 30 & \verb!\hello{world}!40 \\
% 50 & \verb!\hello!60 & 70 \\
%\end{tblr}
%\end{demohigh}

The inner key \verb!verb! is obsolete from version 2023A, and will be removed in the future.
Instead you can use more reliable \verb!\fakeverb! command (see Section \ref{sec:fakeverb}).

\subsection{Set Baseline for the Table}

With \verb!baseline! key, you can set baseline for the table.
Expand Down
6 changes: 3 additions & 3 deletions manual/manual-6.tex
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ \section{Control Horizontal Alignment}
\section{Use Safe Verbatim Commands}%
\label{sec:fakeverb}

Due to the limitation of TeX, even if you have passed \texttt{verb} option to a
\texttt{tabularray} table, you still could not use some special characters in a
\verb!\verb! command. As an replacement, you may use \verb|\fakeverb| command from \href{https://www.ctan.org/pkg/codehigh}{\texttt{codehigh}} package.
Due to the limitations of TeX,
we are not able to make \fakeverb{\verb} command behave well inside \texttt{tabularray} tables.
As a replacement, you may use \fakeverb{\fakeverb} command from \href{https://www.ctan.org/pkg/codehigh}{\texttt{codehigh}} package.

The \verb|\fakeverb| command will remove the backslashes in the following control symbols before
typesetting its content: \fakeverb{\\\\}, \fakeverb{\\\{}, \fakeverb{\\\}}, \fakeverb{\\\#}, \fakeverb{\\\^} and \texttt{\textbackslash\textvisiblespace}, \fakeverb{\\\%}.
Expand Down
Loading

0 comments on commit 486cccd

Please sign in to comment.