Skip to content

GitLab

Last edited by Fabian Nuraddin Alexander Gabel
Page history

Repository Structure

The basic repository folders, when cloned, look like this

├── bin
├── docker
├── review
├── static
├── testing
└── topics

/bin

Contains all scripts that are executed while building the project.

/docker

Contains the Dockerfiles for the docker images related to this project.

/review

Contains auxiliary scripts that may be used on review servers that have PHP available.

/static

For files that are not changed and included as they are on the production site.

/static/home and /static/forschung/{aa,cm,dm,nm,st}

UTF-8 copies of the staff and chair .html pages from the production site. The folder naming and structure has been preserved. The contained files are used for title (name) extraction by the routines preproc_staff and preproc_wg.

Staff files are named key.html, where key is and unique identifier (e.g. fgabel). These keys are also replaced by the preprocessors preproc_staff and preproc_wg.

For the routine build_standalone, these files contain a MARKER that is replaced with the respective research topic links through the routing integrate_pandoc.sh (deprecated) and replace_marker

Basically a minimal HTML file will suffice, e.g. ahaupt.html with content

<h1>Alexander Haupt, M.Sc.</h1>

/static/include/

/static/include{css,images,javascript}

Contains the files for css, javascript, images contain copies from the production site and are used only for review purposes and therefore also copied for the review apps. These files are not needed for the production site, as they are already available and not to be changed by the delivery.

/static/include/html

Contains .html files with SSI-directives that need to be included for use at the production site. If theses files are also included in versions for review, the review server needs to have an Apache HTTP Server with loaded mod_include. For local testing, use the provided alpine-www3-dev.Dockerfile which resembles the virtualisation used for the review app hosted at www3-dev.tuhh.de.

/static/ssi

/static/ssi/htaccess

Use this as .htaccess file in order to activate SSI on the Apache server

topic_template.shtml

Basic file template for the research topic pages on the prodcution site. SSI directives dynamically include the .html files from [/static/include/html] and also set the pages title.

EXPLAIN THE DIRECTIVES IN MORE DETAIL

This file also contains the following markers which is replaced by the routine replace_marker

  • TOPIC-FILE-MARKER: Name of the respective file
  • TOPIC-FILE-MARKER: Title of the topic file
  • {project_root} absolute path on the production system. This is necessary as the review apps use a different folder structure (/ref_name/ref_shortsha/ instead of just /)

/static/misc

Miscellaneous files.

  • TUHH_BUILD_README.md Markdown file with markers to be replaced during deployment:

image

/testing

Contains all reference files needed for the test suite.

/topics

This folder contains the .md-files of the research areas and topics. Assets are contained in subfolders.

/topics/{csl,bibtex,img}

These folders contain assets corresponding to the .md-files in /topics.