Skip to content

Commit

Permalink
update templates
Browse files Browse the repository at this point in the history
  • Loading branch information
@zaikunzhang
zaikunzhang committed Sep 26, 2024
1 parent 5d5ea55 commit 980fe36
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
10 changes: 7 additions & 3 deletions templates/README.txt
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
This directory contains LaTeX templates for the team of Dr. Zaikun Zhang.

Before starting, under the directory containing the main TeX file, create a symbolic named "ref.bib"
to the universal BibTeX file, which should be a local copy of
https://github.com/equipez/bibliographie/blob/main/ref.bib

Usage:

- `make` or `make all` to compile everything and get the BibTeX file.
- `make pdf` to get the pdf file.
- `make bib` to get the bib file.
- `make` or `make pdf` to get the pdf file.
- `make bib` to get the BibTeX file.
- `make all` to compile everything and get the BibTeX file.
4 changes: 2 additions & 2 deletions templates/article/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
LC := latexmk
LCFLAGS := -file-line-error -halt-on-error -interaction=nonstopmode

all: pdf bib

pdf: *.tex
$(LC) $(LCFLAGS) $^

bib: pdf *.bib
getbib

all: pdf bib

.PHONY: clean
clean:
$(LC) -c
Expand Down
5 changes: 3 additions & 2 deletions templates/article/template.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@
\newcommand{\TT}{\mathcal{T}}
\newcommand{\ZZ}{\mathbb{Z}}
\newcommand{\NN}{\mathbb{N}}
\newcommand{\FF}{\mathbb{F}}
\newcommand{\FF}{\mathcal{F}}
\newcommand{\CC}{\mathbb{C}}
\newcommand{\XX}{\mathcal{X}}
\newcommand{\sset}{\mathcal{S}}
Expand Down Expand Up @@ -293,6 +293,7 @@
\renewcommand{\pp}{\mathbf{p}}
\renewcommand{\ggg}{\mathbf{g}}
\newcommand{\GG}{\mathbf{G}}
\DeclareMathOperator{\expc}{\mathbb{E}}
\renewcommand{\Pr}{\mathbb{P}}
\newcommand{\lb}{\underline}
\newcommand{\ub}{\overline}
Expand Down Expand Up @@ -372,7 +373,7 @@

This is an article template for the team of Zaikun Zhang.

\cite{Zhang_2014}
I am citing~\cite{Zhang_2014} as an example.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% References
Expand Down
5 changes: 3 additions & 2 deletions vim/templates/article.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
% https://github.com/equipez/bibliographie/blob/main/ref.bib
% When the paper is finished, run `getbib` in the current directory to get the BibTeX file
% containing only the cited references. The name will be xyz.bib if this TeX file is xyz.tex.
\newcommand{\universalbib}{/home/zaikunzhang/Bureau/bibliographie/ref.bib}
\newcommand{\universalbib}{ref.bib}
\ifdraft{\IfFileExists{\universalbib}{\renewcommand{\bibfile}{\universalbib}}{}}{}
% 20221018: \iscite does not work as intended.
% The counter `cite' is used to count the number of citations.
Expand Down Expand Up @@ -223,7 +223,7 @@
\newcommand{\TT}{\mathcal{T}}
\newcommand{\ZZ}{\mathbb{Z}}
\newcommand{\NN}{\mathbb{N}}
\newcommand{\FF}{\mathbb{F}}
\newcommand{\FF}{\mathcal{F}}
\newcommand{\CC}{\mathbb{C}}
\newcommand{\XX}{\mathcal{X}}
\newcommand{\sset}{\mathcal{S}}
Expand Down Expand Up @@ -294,6 +294,7 @@
\renewcommand{\pp}{\mathbf{p}}
\renewcommand{\ggg}{\mathbf{g}}
\newcommand{\GG}{\mathbf{G}}
\DeclareMathOperator{\expc}{\mathbb{E}}
\renewcommand{\Pr}{\mathbb{P}}
\newcommand{\lb}{\underline}
\newcommand{\ub}{\overline}
Expand Down

1 comment on commit 980fe36

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (22) 
expc
nbiber
newcommand
newcounter
newtheorem
normalfont
normalsize
numberwithin
rceil
Reddi
relpenalty
renewcommand
rfloor
rmod
rsg
textbf
textcolor
textsc
texttt
thepage
todo
ttt
Some files were automatically ignored 🙈

These sample patterns would exclude them:

^\Qbiber/example_biber-tool.conf\E$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the [email protected]:equipez/textools.git repository
on the main branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/equipez/textools/actions/runs/11045433996/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:latex/dict/latex.txt 434 11 9
cspell:html-symbol-entities/entities.txt 1409 2
cspell:html/dict/html.txt 2060 2
cspell:python/src/python/python.txt 392 1 1
cspell:swift/src/swift.txt 53 1

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:latex/dict/latex.txt
          cspell:html-symbol-entities/entities.txt
          cspell:html/dict/html.txt
          cspell:python/src/python/python.txt
          cspell:swift/src/swift.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Pattern suggestions ✂️ (1)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 413 file-count: 3
# latex
\\(?:n(?:ew|ormal|osub)|r(?:enew)|t(?:able(?:of|)|he|itle))(?=[a-z]+)
Warnings (2)

See the 📜action log or 📝 job summary for details.

ℹ️ Warnings Count
ℹ️ candidate-pattern 3
ℹ️ noisy-file 1

See ℹ️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.