Skip to content
Draft

V3 #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
5d9a098
sketch new documentclass
Nov 2, 2023
9552bda
also the ins
Nov 2, 2023
038af2a
Refactor dtx
paolobrasolin Nov 2, 2023
bf9b0b7
Implement basic metadata features
paolobrasolin Dec 28, 2023
14f2103
draft \maketitle
tetrapharmakon May 15, 2024
4b7d3ef
improve metadata rendering
tetrapharmakon May 15, 2024
84d70c2
add published toggle
tetrapharmakon May 15, 2024
9fcb081
stub backref support
tetrapharmakon May 15, 2024
5fd4678
implement backref
tetrapharmakon May 15, 2024
6f14968
testing
May 17, 2024
38b315b
better testing
tetrapharmakon May 17, 2024
13b1f09
Overcome hurdles
tetrapharmakon May 17, 2024
69c65ec
Refactor testing procedure
paolobrasolin May 17, 2024
13d123c
add compatibility flag
tetrapharmakon May 17, 2024
b256549
linting
tetrapharmakon May 17, 2024
60548d0
refactor pkg options
tetrapharmakon May 17, 2024
75013a7
delete cls
tetrapharmakon May 17, 2024
6ad42f0
gitignore cls
tetrapharmakon May 17, 2024
811d372
drop old doc files
tetrapharmakon May 17, 2024
ab76bff
stub documentation
tetrapharmakon May 17, 2024
1c4bc94
refactor
tetrapharmakon May 17, 2024
7d63123
move from makefile to l3build
tetrapharmakon May 17, 2024
4dfdb51
remove outdated ref to quantumarticle class
tetrapharmakon May 17, 2024
5223d05
add mwe and todo list for stuff found in the way
May 18, 2024
9b11a9e
stub documentation
May 18, 2024
2a1a9ff
spacing before \thanks content
May 18, 2024
5d1be82
draft documentation
May 20, 2024
69c111f
raise error if no \author given
tetrapharmakon May 20, 2024
cac01de
setup build environment
tetrapharmakon May 20, 2024
efd5e2d
hide superscript when affil is missing
tetrapharmakon May 20, 2024
9988230
affils numbered correctly when some are missing
tetrapharmakon May 20, 2024
ccb3cbd
Refactor internal data structure to improve metadata macro behaviour
tetrapharmakon May 20, 2024
cfafec7
Hide footnotes when lacking metadata
tetrapharmakon May 20, 2024
8cc2d65
(Almost) highlight code samples
tetrapharmakon May 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@
*.fmt
*.fot
*.cb
compositionalityarticle-ctan.zip
*.cb2
.*.lb

compositionalityarticle.cls
build/
*.hd
## Intermediate documents:
*.dvi
*.xdv
*-converted-to.*
all_test_papers/
# these rules might exclude image files for figures etc.
# *.ps
# *.eps
Expand Down
18 changes: 4 additions & 14 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
SHELL = /usr/bin/bash
PKG = compositionalityarticle
build/doc/compositionalityarticle.pdf build/unpacked/compositionalityarticle.cls: compositionalityarticle.dtx compositionalityarticle.ins build.lua
l3build doc

$(PKG).tar.gz: $(PKG).cls logo.eps ORCIDiD_iconvector.pdf $(PKG)-doc.tex $(PKG)-doc.pdf README.md
ctanify --pkgname $(PKG) --no-tds $^

$(PKG)-doc.pdf: $(PKG)-doc.tex
latexmk -pdf $<

clean:
latexmk -c $(PKG)-doc.tex

clobber:
latexmk -C $(PKG)-doc.tex
rm -f $(PKG).tar.gz
mwe.pdf: mwe.tex build/unpacked/compositionalityarticle.cls
latexmk -pdf mwe.tex
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,13 @@ The class may be distributed and/or modified under the conditions of the LaTeX P
If you find any bugs when using the article class or the template, please help us by opening a report in our bug-tracker under https://github.com/compositionality/latex-template/issues.
Please reproduce the problem by providing the full source of a minimal working LaTeX file, as well as the log file showing the error.

## Acknowledgements
This class is heavily based on the `quantumarticle' class for the journal https://quantum-journal.org. We thank the editors of Quantum for sharing their experiences and expertise.
### Build system

To build this package we use `l3build` from [CTAN](https://ctan.org/pkg/l3build).


```bash
l3build doc # builds documentation
l3build ctan # builds the package to upload on CTAN
l3build clean # removes build artifacts
```
1 change: 1 addition & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- if some metadata are empty, don't print them
9 changes: 9 additions & 0 deletions build.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module = "compositionalityarticle"

function update_tag(filename, content, tagname, tagdate)
content = string.gsub(content, "<VERSION>", tagname)
content = string.gsub(content, "<DATE>", tagdate)
return content
end

typesetopts = "-interaction=nonstopmode -shell-escape"
281 changes: 0 additions & 281 deletions compositionalityarticle-doc.tex

This file was deleted.

Loading