ELAN site

A static site featuring information for ELAN researchers and stakeholders. It is made and build using the static site generator Hugo.

Click here to visit the site.

Installation

If you just want to add or edit a post or publication, you only need to clone this repo to your device and push your changes. As long as your post/publication is in accordance with the template, there's no need for you to install anything.

For more rigorous changes that require being previewed locally, you do need to install the following:

Follow Hugo's quick start to install the required software for static site generation.

Above will allow you to preview most functionality, but the search feature. To preview that, you can either install Scoop, and run the commands that installs nodejs and nvm, which will allow us to install everything required to build the search feature:

scoop install nodejs nvm

or you can install the prebuilt Nodejs installer.

Running everything locally

To get everything up and going locally, run:

hugo && npx -y pagefind --site public --serve

and visit http://localhost:1414 (or whatever preview server is used.)

Adding content (posts, publications and project)

As mentioned before, you do not need to have Hugo installed to add and edit posts, publications and projects. As long as the new md-files adhere to the right archetype, everything should run smoothly. However, Hugo does allow you to automagically spawn a file that already includes the respective archetype.

hugo new content (nl/en)news/NAME.md

To add a publication and retrieve relevant information from pubmed, open the terminal and type:

python pubmedget.py -pmid PMID

Next, go to the file shown in the window to add the datasources, categories and Dutch summary accordingly, and to set draft to false. You may have to make some adjustments to the authors as well (such as changing "Mozart JC" to "Mozart JCWT"). Make sure NOT to use spaces in categories and datasources.

To add a publication without retrieving data from pubmed, type the following:

hugo new content en/publications/NAME.md

To add a project, open the terminal and type

hugo new content en/projects/NAME.md

The front matters and contents of all generated md-files can be edited in the respective folders.

Existing content in the content folders can be edited.

Content summary

There are two ways to create a summary for a post (news). One is by adding <!--more--> to mark the preceding content as the abstraction.

+++
title = "title"
date = {{ .Date }}
draft = false
type = "News"
+++
Some text
<!--more -->
More text

The second is to create a summary, which will not appear in the post

+++
title = "title"
date = {{ .Date }}
draft = false
type = "News"
summary = "Summary
+++

How to link

There are two types of links: those that link to pages on this website and those that link to pages on other websites.

Below is an example for the former type of link

[here]({{< relref "sciencecommittee" >}} "PHEG Science Committee")

Below is an example for an external link

[LUMC](https://lumc.nl)

Updating the map of ELAN and the statistics

The theme elancholia includes a folder "visual_generator". You can update the data used by the notebook (and potentially the notebook), and run it. The SVGs will be updated automatically. The hugo command needs to be ran to update the

Updating the flowchart

The map charts contains all the mmd files that are used to generate charts. For the "flowcharts" subdirectory, the "main.mmd" is considered to be the main body of the flowcharts shown in here. All other charts are just expansions of this chart.