Thesis Project Pages

This directory contains the thesis project pages.

Directory structure

📂 theses
┣ 📂 completed
┃ ┣ 📂 2022                    # year when thesis project was completed (not the year when it was started!)
┃ ┃ ┣ 📁 2022-001_a-thesis     # thesis project directory 
┃ ┃ ┃ ...
┃ ┃ ┣ 📁 2022-n_another-thesis # thesis project directory 
┃ ┃ ┗ 🗋 _index.md              # section file (do not change)
┃ ┃ ...
┃ ┣ 📁 2000
┃ ┗ 🗋 _index.md               # section file (do not change)
┣ 📂 current
┃ ┣ 📁 thesis-the-movie       # thesis project directory 
┃ ┃ ...
┃ ┣ 📁 thesis-reloaded
┃ ┗ 🗋 _index.md              # section file (do not change)
┗ 📂 open
┃ ┣ 📁 thesis-revolution     # thesis project directory 
┃ ┃ ...
┃ ┣ 📁 return-of-the-thesis  # thesis project directory 
┃ ┗ 🗋 _index.md              # section file (do not change)
┗ 🗋 _index.md                # section file (do not change)
                             #   note: in hugo's terms, a file named "_index.md" (not to be confused with "index.md") is called a "branch bundle" (2)

(1) hugo page resources documentation
    https://gohugo.io/content-management/page-resources/
(2) hugo bundle documentation
    https://gohugo.io/content-management/page-bundles/

Thesis project directory

Each thesis project directory must be structured as follows:

📂 2022-001_a-thesis     # thesis project directory 
┃                        #   naming convention: <internal_id: "yyyy-n"> 
┃                        #   the naming convention is only used to keep order, but is not used for the page generation)
┣ 🗋 abstract.md          # (optional) abstract (must contain only abstract and nothing else)  
┣ 🗋 index.md             # thesis project page (meta data in front matter + main content) 
┃                        #   note: in hugo terms, a file named "index.md" is called a "leaf bundle" (1)
┣ 🗋 image1.png           # ┓
┣ 🗋 ...                  # ┣ (optional) images / resources (1)
┗ 🗋 someOtherImageN.png  # ┛

(1) hugo bundle documentation
    https://gohugo.io/content-management/page-bundles/

Front matter custom variables

The custom variables for thesis project are as follows:

key	data type	allowed values / format	description	example
`swc_custom_data.thesis.``student`	string		name of student working on the thesis project (for current and completed thesis projects only)	`student: "Erika Mustermann"`
`swc_custom_data.thesis.``degrees`	array	array subset of `bachelor`, `master`, `diplom`	for open thesis project: all suitable degree(s); for current and completed projects: array containing only the degree that applies to this thesis project	`degrees: ["bachelor", "master"]` `degrees: ["master"]`
`swc_custom_data.thesis.``supervisors`	array	array with id(s) of supervisors (for ids see team member pages)	supervisor(s) for this thesis project	`supervisors: ["id:person/alex-mattukat", "id:person/christian-plewnia"]`
`swc_custom_data.thesis.``internal_id`	string	format: `"YYYY-NNN"`	SWC’s internal id for this thesis project	`internal_id: "2022-003"`
`swc_custom_data.thesis.``research_projects`	array	array with id(s) of research projects (for ids see research project pages)	research project(s) this thesis project is related to	`research_projects: ["id:research_project/cloud-service-selection-and-cost-optimization"]`
`swc_custom_data.thesis.``submission_date`	date	format: `YYYY-MM-DD`	date when the thesis report was submitted (completed)	`submission_date: 2022-06-01`
`swc_custom_data.thesis.``resources`	array	array of resource items	Resources for this thesis project (see section below)	see section below

Abstract

If a thesis project directory contains a file named abstract.md and this file is not empty, an abstract section is added at the beginning of the thesis project page with the contents from the abstract.md file.

Resources (PDFs, artifacts, or other materials)

For a thesis project, any number of resources (PDFs, artifacts, or other materials) can be defined. If at least on resource is defined, a special resource section is shown on the thesis project page.

Defining resources

Add entries below the resources key, for example:

swc_custom_data:
  thesis:
    # ...
    resources:
      - content_type: "pdf"
        description: "Thesis report"
        url: ""
        language: "de"
      - content_type: "pdf"
        description: "Slides of final presentation"
        url: ""
        language: "en"
      - content_type: "mp4"
        description: "Demo video"
        url: ""
        language: "en"

Uploading resources

Do not put larger resources in this repository (reasons: significantly increases repository size, increases time to clone this git repository). Instead put resource files into our docs directory in the owncloud.