|
|
|
If you want to create your document by using the JAMK LaTeX template, you can fork this repository to effortlessly copy all the files into your own workspace in GitLab. After you have forked the repository, it is advised to work on the template using a LaTeX editor. There are numerous different editors available for most operating systems and distributions, so take some time to get familiar with the different editors and choose what is right for you.
|
|
|
|
|
|
|
|
You can also clone your repository into the machine using Git, which allows you to work on the template with version control. The repository also has a CI/CD Pipeline which automates the process of converting the LaTeX files into a PDF.
|
|
|
|
|
|
|
|
Steps on forking the project:
|
|
|
|
|
|
|
|
```
|
|
|
|
1) On the front page of the project, in the top right hand corner you can find a button says "fork" - press it
|
|
|
|
2) Select the namespace to fork the project into (most likely your student number
|
|
|
|
3) Profit
|
|
|
|
```
|
|
|
|
|
|
|
|
Congratulations, you can now start working on your document using LaTex!
|
|
|
|
|
|
|
|
## Pipeline
|
|
|
|
|
|
|
|
As aforementioned, the project contains a CI/CD Pipeline which automatically compiles a PDF from the LaTeX files. The configuration for this is located in the ``` .gitlab-ci.yml ``` file. You shouldn't have to edit this file unless you want to do something special with it.
|
|
|
|
|
|
|
|
To run the pipeline:
|
|
|
|
|
|
|
|
```
|
|
|
|
1) Using the left navigation bar, navigate to CI/CD -> Pipelines
|
|
|
|
2) On the top right corner, press the green button that says "Run Pipeline"
|
|
|
|
3) The pipeline will take some time to run, after which it should return a nice green check mark to indicate that the pipeline worked
|
|
|
|
```
|
|
|
|
|
|
|
|
If for some reason the pipeline fails, it is most likely due to an error in your LaTeX code. Debugging the code can be an excruciating task, and I would not recommend doing it via the Pipeline. Most LaTeX editors will allow you to compile the code (I presume...), and will give you the same errors as the Pipeline, and is a lot faster. When the editor gives you no errors, try the Pipeline again.
|
|
|
|
|
|
|
|
LaTeX errors are a bit cryptic, so my personal advice is to refer to the documentation of the command that is causing the trouble if the error gives you no clue of whats wrong. If you are unable to fix the problem on your own, contact the author of this document for help. **NOTE:** I will probably regret writing this line of text.
|
|
|
|
|
|
|
|
## The PDF
|
|
|
|
|
|
|
|
You can find the PDF under the artifacts of successful Pipeline jobs. However, if you want to view the latest PDF a lot easier, you can edit the link at the bottom of the README.md file. What you need to do is to change the project creator in the URL. Below is an example:
|
|
|
|
|
|
|
|
```
|
|
|
|
Edit the link in README.md file
|
|
|
|
|
|
|
|
[Click me!](https://gitlab.labranet.jamk.fi/sahka/jamk-report-latex/-/jobs/artifacts/master/browse?job=compile_pdf)
|
|
|
|
|
|
|
|
Change "sahka" to your username / student number:
|
|
|
|
|
|
|
|
[Click me!](https://gitlab.labranet.jamk.fi/<your student number>/jamk-report-latex/-/jobs/artifacts/master/browse?job=compile_pdf)
|
|
|
|
``` |
|
|
\ No newline at end of file |