Skip to content
Website of the research project "Opening Reproducible Research"
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_posts
public
.gitignore
.travis.yml
404.html
CNAME
Gemfile
Makefile
README.md
_config.yml
about.md
agile-2017.md
all.md
all_content.md
almost.md
android-chrome-144x144.png
android-chrome-192x192.png
android-chrome-36x36.png
android-chrome-48x48.png
android-chrome-72x72.png
android-chrome-96x96.png
apple-touch-icon-114x114.png
apple-touch-icon-120x120.png
apple-touch-icon-144-precomposed.png
apple-touch-icon-144x144.png
apple-touch-icon-152x152.png
apple-touch-icon-180x180.png
apple-touch-icon-57x57.png
apple-touch-icon-60x60.png
apple-touch-icon-72x72.png
apple-touch-icon-76x76.png
apple-touch-icon-precomposed.png
apple-touch-icon.png
atom.xml
badges.md
blogroll.md
browserconfig.xml
egu2017sc81.md
favicon-16x16.png
favicon-194x194.png
favicon-32x32.png
favicon-96x96.png
favicon.ico
googlee80d040598e4ac1c.html
hilfskraft-geolok.md
hilfskraft.md
imprint.md
index.html
manifest.json
mstile-144x144.png
mstile-150x150.png
mstile-310x150.png
mstile-310x310.png
mstile-70x70.png
o2r-web-api.md
publications.md
results.md
rss_r.xml
safari-pinned-tab.svg
search.html
survey.md
zenodo_release.py

README.md

o2r

DOI

This is the project website of the DFG-funded research project "Opening Reproducible Research" by Institute for Geoinformatics (ifgi) and University and Regional Library (ULB), University of Münster, Germany

The design is based on Hyde by Mark Otto.

Building the site

Follow the instructions for Poole to install the required software. Then run the site locally with

bundle exec jekyll serve

Use the --draft switch to preview the draft posts.

Publishing site repository and PDF on Zenodo

After each new blog post is published, a Zenodo deposit with a PDF of all blog posts and relevant pages is updated automatically manually, see Makefile for details.

The PDF file o2r_project_website_and_blog.pdf is generated from a special page at http://127.0.0.1:4000/all_content/ (file all_content.md) using wkhtmltopdf. A zip archive of this project is created with zip, file o2r_project_website_and_blog_git-repository.zip.

Both these files are then published to Zenodo with the Zenodo API by the file zenodo_release.py. The environment variable ZENODO_TOKEN must have a valid API key for Zenodo (or for Zenodo Sandbox for testing).

The process is controlled with the make target update_zenodo_deposit or directly with

ZENODO_TOKEN=... python3 zenodo_release.py
# increase logging output for testing with LOGLEVEL=DEBUG

Site testing

Build Status

The page is tested in the context of a Travis CI build: https://travis-ci.org/o2r-project/o2r-project.github.io

This is based on the files .travis.yml and Gemfile.

Useful stuff

Authoring posts & publishing drafts

You can use jekyll-compose to streamline some tasks, e.g.

bundle exec jekyll draft "My new draft"
bundle exec jekyll publish _drafts/my-new-draft.md

Images

We use the kramdown parser engine and subsequently can use some advanced syntax (e.g. for named lists, image resizing, quotes, and more).

To float images, use the CSS classes .img.leftfloat or .img.rightfloat, for example ![geocontainers logo](http://geocontainers.org/img/geocontainers-logo.png "geocontainers logo"){:width="100" .img.rightfloat}

Note: When the rendering engine is changed, these changes are prone to break.

Excerpts

The file index.html contains some logic trying to do a clever handling of the post excerpts, i.e. the texts that are shown in the listing of posts. The procedure is as follows:

  • If the disable_excerpt attribute is set to true, show the full content and do not show the "Read more" link. This is useful for short posts.
  • If the number of paragraphs in the post's excerpt is the same as the number of paragraphs of the post content, then see above. This is so that no "Read more" link is put on pages with no further text.
  • In any other case, show the excerpt and add a "Read more" link. You can set the length of the excerpt manually by using Jekyll's default tag <!--more-->.

Comments

We use DISQUS for comments, based on their Jekyll Installation Instructions, though not quite: Instead of enabling comments for each post, you must add disable_comments: true to the frontmatter to disable them explicitly. Data privacy issues are mentioned on the imprint page.

Ribbon

A generic "Fork me" ribbon has been added and can be configured (text, link) in the file _config.yml. The color is configured in public/css/o2r.css. The ribbon appears on all pages via _layouts/default.html, and stylesheets are included in _includes/head_default.html if enabled.

Exclude pages from menu

If you do not want a page to appear in the left hand side menu, include the parameter exclude_from_nav: true in the page's frontmatter.

Footnotes

Testing footnotes[^2] for *Opening Reproducible Research*[^1].

[^1]: would be useful!
[^2]: yes, no promises on results...
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.