Update Styleguide authored by Fabian Nuraddin Alexander Gabel's avatar Fabian Nuraddin Alexander Gabel
In the following, we list all different types of file templates and their usage.
# Directives
Each file makes use of the following directives
* `# Title`: for setting the title of the area/topic
* `### Working Groups`: setting the keys of the involved chairs
* `### 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 webpages:
![image](uploads/ed1c5e8b1a0a007273d632f03b9afc3f/image.png)
* `### Colaborators (External)`: for specifying further collaborators that are not institute members
# Template (full) Topic # Template (full) Topic
This is a full standalone file that uses all possible directives.
``` ```
# The Title of our Impressive Research Project # The Title of our Impressive Research Project
...@@ -15,15 +31,43 @@ ...@@ -15,15 +31,43 @@
``` ```
The keys like `ataraz`, `cseifert`, etc. are taken from the URL of our institute webpages: # Template Research Area
![image](uploads/ed1c5e8b1a0a007273d632f03b9afc3f/image.png) ## Usage
For general areas of research. Delete the collaborator lines. Will only appear on chair research pages.
## Template
```
# The Title of our Impressive Research Area
# Template Research Area ### Working Groups: aa, cm, dm, nm, st
## Description
# Template Research Topic ...
```
# Template Research Topic within Research Area
## Usage
Delete the Working Groups directive.
## Template
```
# The Title of our Impressive Research Topic
### Collaborators (MAT): ataraz, cseifert
### Collaborators (External): [Vaughan Jones](https://as.vanderbilt.edu/math/bio/?who=vaughan-jones), [Terry Tao](https://terrytao.wordpress.com/about/)
## Description
...
```
\ No newline at end of file