Compare commits

...

2 Commits

Author SHA1 Message Date
Florian
8586397afc Add basic CoCalc instructions 2025-11-16 19:52:24 +01:00
Florian
68e5f9d4f0 Add FAQ 2025-11-16 19:15:56 +01:00
3 changed files with 77 additions and 3 deletions

View File

@ -68,14 +68,14 @@ publication-pdf-with-solutions: clean publication-dir main-solutions.tex
# Build a ZIP file without tasks
publication-zip-without-exercises: clean publication-dir
rm -rf temp/*
cp --parents main-script.tex praeamble.tex commands.tex setup.tex content/* graphics/* listings/**/*.{tex,pdf,bib,java,txt} titlepage.tex imprint.tex temp/
cp --parents main-script.tex praeamble.tex commands.tex setup.tex content/* docs/* graphics/* install-verification/* listings/**/*.{tex,pdf,bib,java,txt} titlepage.tex imprint.tex temp/
cd temp && zip ../public/project-without-exercises * **/* **/**/*
# Build a ZIP file with tasks and without solutions
publication-zip-with-exercises: clean publication-dir
rm -rf temp/* exercises/**/_*
cp --parents main-exercises.tex praeamble.tex commands.tex setup.tex graphics/* listings/**/*.{tex,pdf,bib,java,txt} titlepage-exercises.tex imprint.tex first-steps-with-latex.tex temp/
cp --parents main-exercises.tex praeamble.tex commands.tex setup.tex docs/* graphics/* install-verification/* listings/**/*.{tex,pdf,bib,java,txt} titlepage-exercises.tex imprint.tex first-steps-with-latex.tex temp/
cp --parents exercises/**/* temp/
rm -f temp/exercises/**/*.done.{tex,bib,synctex.gz}
rm -f temp/exercises/**/*.rend.tex
@ -88,7 +88,7 @@ publication-zip-with-exercises: clean publication-dir
# Build a ZIP file with tasks and solutions
publication-zip-with-solutions: clean publication-dir
rm -rf temp/* exercises/**/_*
cp --parents main-solutions.tex praeamble.tex commands.tex setup.tex graphics/* listings/**/*.{tex,pdf,bib,java,txt} titlepage-exercises.tex imprint.tex first-steps-with-latex.tex temp/
cp --parents main-solutions.tex praeamble.tex commands.tex setup.tex docs/* graphics/* install-verification/* listings/**/*.{tex,pdf,bib,java,txt} titlepage-exercises.tex imprint.tex first-steps-with-latex.tex temp/
cp --parents exercises/**/* temp/
rm -f temp/exercises/**/*.raw.{tex,bib,synctex.gz}
rm -f temp/exercises/**/*.aux

View File

@ -0,0 +1,18 @@
# Instructions for compiling this project in CoCalc
> [CoCalc](https://academiccloud.de/services/cocalc/) is a web service for data scientists. As part of the [AcademicCloud](https://academiccloud.de/), it is available to students at University of Bamberg. CoCalc is useful for collaboration on $\LaTeX$ documents, Jupyter Notebooks, and much more. CoCalc provides an [extensive documentation](https://doc.cocalc.com/latex.html).
>
> **Please note**: The Academic Cloud version is currently in preview, causing limited resources, no backups, and changes without prior notice. Use at your own risk.
This tutorial demonstrates how to set up CoCalc to compile the LaTeX script.
## Project setup
1. Open CoCalc. Students at University of Bamberg may use [this instance](https://academiccloud.de/services/cocalc/).
2. Click the blue button to go to your projects.
3. Click on “Create Project …”.
+ Add a title (e.g., “latex-workshop”).
+ Click on “Customize software environment” and choose “TeXLive” from the dropdown.
+ Create the project and wait for the initialization to finish. It is done when you see a blue button allowing you to “Create or Upload Files …”
4. Choose “Explorer” on the left side and click on “Upload.” Select your compressed project archive. Once uploaded, click on the name and proceed to “Extract Files …”
5. Back in the Explorer, you can now navigate through our project directory. Go to the file `main-exercises.tex`. It should load a familiar $\LaTeX$ work environment and automatically build the document for you. Compilation will be triggered whenever you hit `Ctrl + S`.

56
docs/faq.md Normal file
View File

@ -0,0 +1,56 @@
# Frequently asked questions
- [Frequently asked questions](#frequently-asked-questions)
- [Error: “File 'setup.tex' not found. \\input{setup.tex}”](#error-file-setuptex-not-found-inputsetuptex)
- [Error: “Unable to find xyz.sty”](#error-unable-to-find-xyzsty)
- [I accidentally dismissed the prompt asking me to install a missing package.](#i-accidentally-dismissed-the-prompt-asking-me-to-install-a-missing-package)
- [I want to use my own tools.](#i-want-to-use-my-own-tools)
- [I need more help.](#i-need-more-help)
## Error: “File 'setup.tex' not found. \input{setup.tex}”
**Windows-specific diagnosis**:
If this error shows up when you compile the script for the first time, you may have opened the $\LaTeX$ file without unzipping the project archive first. To resolve the error, go back to the folder where you store your downloads. Locate the project archive (something like `latex-project-….zip`). Do not double-click it. Instead, right-click and select “Unzip”, “Extract”, or similar. This will extract the ZIP archive to a new folder. Open this folder and proceed with opening the file you were looking for.
**Generic hints**:
The compiler complains that a file called `setup.tex` cannot be found in the same folder as the file you are compiling. Make sure the file exists and there are no typos in your file name.
## Error: “Unable to find xyz.sty”
**Windows-specific diagnosis**:
This error typically relates to packages missing from your $\LaTeX$ installation. On Windows, it can typically be solved like this:
1. Open the Mik$\TeX$ Console, a program that comes with your $\LaTeX$ installation.
2. In there, you will find the “Packages” tab.
3. Click the button to search for package updates. This should resolve the error.
**Generic hints**:
The compiler complains that a package, particularly the corresponding .sty document, is missing. Typically, there is a `\usepackage{xyz}` command that loads the package xyz. Make sure there are no typos in the package name. If you do not use $\TeX$live-full (Linux), try to install the package via the Mik$\TeX$ Console (Windows) or your $\LaTeX$ distribution's helper tools.
## I accidentally dismissed the prompt asking me to install a missing package.
Try re-opening $\TeX$studio. If this does not help, there is still the option to manually install the required packages from the Mik$\TeX$ Console or similar distribution-specific management software.
## I want to use my own tools.
Sure, feel free. We provide instructions for [CoCalc](./cocalc-instructions.md) and [VS Code/Codium](./vs-code-instructions.md). Any other editor will do if you know your ways around the terminal. In essence, all we do here is this:
```bash
pdflatex main.tex
biber main
pdflatex main.tex
pdflatex main.tex
```
Just run `pdflatex main.tex` twice if you do not have any citations. Or have a look at XeTeX, LuaTeX, … ([numerous other tools available](https://www.tug.org/interest.html#free)).
## I need more help.
Please refer to our various resources:
- the workshop's [presentation](https://wiai.de/latex-weekend)
- the [Moodle course](https://wiai.de/latex)
- the Git project containing the [script](https://git.stuve-bamberg.de/latex/latex-skript)
- the WIAI Student Council's [website](https://www.uni-bamberg.de/wiai/fs)