https://github.com/dpmj/alcazar
A free and Open-Source LaTeX template for academic works: theses, reports, etc.
https://github.com/dpmj/alcazar
latex latex-book latex-report latex-template latex-theme latex-thesis pdflatex report thesis thesis-latex-template thesis-template thesis-template-latex
Last synced: 5 months ago
JSON representation
A free and Open-Source LaTeX template for academic works: theses, reports, etc.
- Host: GitHub
- URL: https://github.com/dpmj/alcazar
- Owner: dpmj
- License: cc-by-sa-4.0
- Created: 2023-05-14T17:45:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-14T18:19:59.000Z (about 1 year ago)
- Last Synced: 2024-09-08T17:22:26.032Z (8 months ago)
- Topics: latex, latex-book, latex-report, latex-template, latex-theme, latex-thesis, pdflatex, report, thesis, thesis-latex-template, thesis-template, thesis-template-latex
- Language: TeX
- Homepage:
- Size: 14.5 MB
- Stars: 19
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Philosophy
- KISS.
- Easy to use.
- Organized, elegant, coherent and consistent.
- Compact, but not crowded.
- Compatible with `pdflatex`.
- No strange packages.
## Features
## Requirements
- `biber` for `biblatex`.
- `python 3` and `pygments` for the `minted` package.
## Build
### CLI, makefiles, etc.
This project can be easily built using the following commands with these recommended parameters. The `-shell-escape' flag is required for the `minted' package.
```bash
$ pdflatex -shell-escape -synctex=1 -interaction=nonstopmode -file-line-error main
$ biber main
$ makeglossaries main
$ pdflatex -shell-escape -synctex=1 -interaction=nonstopmode -file-line-error main
$ pdflatex -shell-escape -synctex=1 -interaction=nonstopmode -file-line-error main
```
### Overleaf
Works out of the box, no configuration required. Simply download this repo as a `.zip` and then upload the archive to Overleaf as a new project.
### LaTeX Workshop extension for VS Code / Codium
If you are using the LaTeX Workshop extension by James Yu, you need to add the following tools to your configuration file, under `latex-workshop.latex.tools` (In the UI, navigate to *Latex-workshop > Latex: Recipes > Edit in settings.json*):
```json
{
"name": "biber",
"command": "biber",
"args": [
"%DOC%"
],
},
{
"name": "makeglossaries",
"command": "makeglossaries",
"args": [
"%DOCFILE%"
],
}
```
Edit the `pdflatex` entry as follows to include the `-shell-escape` argument, necessary for the `minted` package.
```json
{
"name": "pdflatex",
"command": "pdflatex",
"args": [
"-shell-escape",
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"%DOC%"
],
"env": {}
}
```
Now add a new recipe, under `latex-workshop.latex.recipes` (In the UI: *Latex-workshop > Latex: Tools > Edit in settings.json*):
```json
{
"name": "alcazar",
"tools": [
"pdflatex",
"makeglossaries",
"biber",
"pdflatex",
"pdflatex"
]
}
```
And run the `alcazar' recipe on a `.tex' file from the project.
**Note:** If you keep getting a `makeglossaries` error saying that `main.aux` could not be found, set the `latex-workshop.latex.autoBuild.cleanAndRetry.enabled` setting to `false` (in the UI, uncheck *"Latex-workshop > Latex > AutoBuild > Clean and retry: Enabled"*)
## File structure
The file structure of Alcázar is simple and self-explanatory:
```
./
├── bibliography/ # BIBLIOGRAPHY
| ├── bibliography.tex # Bibliography generation
| └── references.bib # BibTeX references
|
├── figures/ # Put your figures here
|
├── glossary/ # GLOSSARY
| ├── glossary.sty # Glossary definitions
| └── glossary.tex # Glossary generation
|
├── opening/ # OPENING
| ├── resources/ # Graphics used in the opening (logos, etc)
| |
| ├── about.tex # Details about the authors
| ├── abstract.tex # Abstract, in various languages
| ├── acknowledgements.tex # Acknowledgements
| ├── dedication.tex # Dedication
| ├── opening.tex # Structures the opening part of the document
| └── publications.tex # Your publications. Optional, comment line in opening.tex
| └── titlepage.tex # Title page
|
├── style/ # STYLE
| ├── alcazar.sty # Style definition and configuration
| ├── colors.sty # Colors definition
| └── pkgs.sty # Only used to import packages
|
├── text/ # TEXT
| ├── appendix/ # Put your addendum here
| | ├── appendix.tex # Appendix generation
| | └── thanks.tex # Say thanks. Optional, comment line in main.tex
| |
| └── chapters/ # Put your chapters here
|
└── main.tex # The main document.
```
- In `main.tex` you will find some variable definitions, fill them in according to your thesis and the document will update all occurrences automatically.
- Fill in your author information in the `opening/about.tex` file.
## License
This work is licensed under a
[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).
## Disclaimer
This work is not affiliated with any institution, and the references, logos, and the like are merely examples of usage. Any third-party resources included in this repository are the property of their respective owners, and are provided for convenience only.