|
|
In the following, we list all different types of file templates and their usage.
|
|
|
In the following, we list all the different types of file templates and their usage.
|
|
|
|
|
|
# Naming of the Files
|
|
|
|
|
|
If creating a new file/research-topic, make sure to use a filename that is
|
|
|
* matching the title of your topic (see below)
|
|
|
* using only lowercase letters
|
|
|
* now containing spaces (replace spaces with the underscore `_`)
|
|
|
|
|
|
Example: If your topic is called: "Discrete Schrödinger Operators", you should call the file `discrete_schroedinger_operators.md`.
|
|
|
|
|
|
# Basic Directives
|
|
|
|
... | ... | @@ -9,7 +18,7 @@ Each file makes use of the following directives |
|
|
* `### Collaborators (MAT): setting the keys for the collaborators of the institute of mathematics. Keys like `ataraz`, `cseifert`, etc. are taken from the URL of our institute web pages:
|
|
|
|
|
|
![image](uploads/ed1c5e8b1a0a007273d632f03b9afc3f/image.png)
|
|
|
* `### Colaborators (External)`: for specifying further collaborators that are not institute members
|
|
|
* `### Collaborators (External)`: for specifying further collaborators that are not institute members
|
|
|
|
|
|
The directives for including BibTeX references are explained [at the end of this page](https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/wikis/Styleguide#bibtex).
|
|
|
|
... | ... | @@ -135,7 +144,7 @@ bibliography: bib/my-bibtex-file.bib |
|
|
|
|
|
By default, this uses the sytling ...
|
|
|
|
|
|
If you want to provide another styling, you can provide a csl file in [`/topics/csl`](https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/wikis/Repository-Structure#topicscslbibteximg). It may be included already. If not, just add it to the corresponding folder and use the following directives in the header of the Markdown file corresponding where you want the references to be rendered according to the csl file:
|
|
|
If you want to provide another styling, you can provide a csl file in [`/topics/csl`](https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/wikis/Repository-Structure#topicscslbibteximg). It may be included already. If not, just add it to the corresponding folder and use the following directives in the header of the Markdown file corresponding to where you want the references to be rendered according to the csl file:
|
|
|
|
|
|
```
|
|
|
---
|
... | ... | @@ -156,7 +165,7 @@ For example, if your BibTeX file contains the reference |
|
|
}
|
|
|
```
|
|
|
|
|
|
tne, in order to cite this reference, use the syntax
|
|
|
then, in order to cite this reference, use the syntax
|
|
|
|
|
|
```
|
|
|
[@gggu2021]
|
... | ... | @@ -170,10 +179,9 @@ and the corresponding entry in the "References" section |
|
|
|
|
|
![image](uploads/b66a1edc61eecd29502cfb9a8033190f/image.png)
|
|
|
|
|
|
Note that using a BibTeX file your `.md`-file will no longer contain the references explicitly. Instead, they will be added to the end of the file automatically at build-time. Therefore, it suffices to add a level-2 heading for structure
|
|
|
Note that using a BibTeX file your `.md`-file will no longer contain the references explicitly. Instead, they will be added to the end of the file automatically at build time. Therefore, it suffices to add a level-2 heading for structure
|
|
|
```
|
|
|
## References
|
|
|
|
|
|
```
|
|
|
at the end of the `.md`-file. |
|
|
\ No newline at end of file |
|
|
|