# element

**Repository Path**: stonego/element

## Basic Information

- **Project Name**: element
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-13
- **Last Updated**: 2025-09-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# A Latex Template for Scientific Style Book (Notes)

## Preview

![](./Screenshots/Table-of-Content.png)
<!-- ![](./List-of.png)
![](./List-of-Symbols.png) -->
![](./Screenshots/Preface.png)
<!-- ![](./Bib.png) -->

[YouTube Preview](https://youtu.be/eR4vrsafcxk)

<!-- <iframe width="560" height="315" src="https://www.youtube.com/embed/eR4vrsafcxk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> -->

[Minimal working example](https://github.com/Jue-Xu/Latex-Template-for-Scientific-Style-Book/blob/main/notes_template.pdf)

[Overleaf template](https://www.overleaf.com/learn/latex/Glossaries)

my study notes [to do]

## Features
- Cross-refs: link of definitions and theorems
- ToC: list of theorems, definitions, minitoc
- header and footer: hyperlink
- bib: hyperlink, backref, custom entry
- support index, glossary, symbol
- clean layout
- More glossary support [at branch](https://github.com/Jue-Xu/Latex-Template-for-Scientific-Style-Book/tree/glossary).
Not work on Overleaf (see the discussion of the [issue](https://github.com/Jue-Xu/Latex-Template-for-Scientific-Style-Book/issues/2).

## Compile
This template (this branch) works fine with the [Overleaf online compiler](https://www.overleaf.com/latex/templates/latex-template-for-scientific-style-book/ntprxjksmqxx) except the Glossary part (see below for more details)

### Compile with your local machine: lualatex and latexmk
`.latexmkrc` configuration file
```
$pdflatex = 'lualatex -synctex=1 -interaction=nonstopmode --shell-escape %O %S';
@generated_exts = (@generated_exts, 'synctex.gz');
$pdf_mode = 1;

add_cus_dep('glo', 'gls', 0, 'makeglo2gls');
sub makeglo2gls {
    system("makeindex -s '$_[0]'.ist -t '$_[0]'.glg -o '$_[0]'.gls '$_[0]'.glo");
}
```

<!-- ### Glossary related
```
# Also delete the *.glstex files from package glossaries-extra. Problem is,
# that that package generates files of the form "basename-digit.glstex" if
# multiple glossaries are present. Latexmk looks for "basename.glstex" and so
# does not find those. For that purpose, use wildcard.
$clean_ext = "%R-*.glstex";

push @generated_exts, 'glstex', 'glg';

add_cus_dep('aux', 'glstex', 0, 'run_bib2gls');

# PERL subroutine. $_[0] is the argument (filename in this case).
# File from author from here: https://tex.stackexchange.com/a/401979/120853
sub run_bib2gls {
    if ( $silent ) {
    #    my $ret = system "bib2gls --silent --group '$_[0]'"; # Original version
        my $ret = system "bib2gls --silent --group $_[0]"; # Runs in PowerShell
    } else {
    #    my $ret = system "bib2gls --group '$_[0]'"; # Original version
        my $ret = system "bib2gls --group $_[0]"; # Runs in PowerShell
    };

    my ($base, $path) = fileparse( $_[0] );
    if ($path && -e "$base.glstex") {
        rename "$base.glstex", "$path$base.glstex";
    }

    # Analyze log file.
    local *LOG;
    $LOG = "$_[0].glg";
    if (!$ret && -e $LOG) {
        open LOG, "<$LOG";
    while (<LOG>) {
            if (/^Reading (.*\.bib)\s$/) {
        rdb_ensure_file( $rule, $1 );
        }
    }
    close LOG;
    }
    return $ret;
}
```

command line in terminal
```
pdflatex notes.tex
makeglossaries notes
pdflatex notes.tex
```

### bib2gls
need [Java](https://java.com/en/download/)
```
pdflatex notes.tex
bib2gls notes
pdflatex notes.tex
``` -->

## Related Tools

### VSCode
Extension: [Latex Workshop by James Yu](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)

Extension Setting:
```
   "latex-workshop.latex.recipe.default":"latexmk",
    "latex-workshop.latex.recipes":[
        {
            "name": "latexmk",
            "tools": [
                "latexmk"
            ]
        }
    ],
    "latex-workshop.latex.tools":[
    {
        "name": "latexmk",
        "command": "latexmk",
        "args": [
            // "-pdflatex=lualatex",
            "-f",
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "-pdf",
            "-outdir=%OUTDIR%",
            "%DOC%"
        ],
        "env": {}
    }
    }
```

### Zotero
https://www.zotero.org/

#### Better BibTeX
https://retorque.re/zotero-better-bibtex/

## License 
Creative Commons CC BY 4.0


Feel free to fork or modify this Repo.
Give me a star if this template is helpful to you.

If you have any question or suggestion, you could open an issue on GitHub.