rdd-technical-reference.md

title: 'SUB RDD Technical Reference'

author:
- Software Quality Working Group

Purpose

This guideline should help you getting started a new software development project (or improving an existing one!) in the Research and Development Department of the Göttingen State and University Library.

Our goal is to establish better software quality by following standards the developer team has mutually agreed upon. Roughly basing on the DARIAH Technical Reference, these standards are discussed, worked out, and decided in the Software Quality Working Group, which meets biweekly on Tuesdays at 12:30-13:30. However, they aren't cast in stone, so in case you have a good idea for a better standard, feel free to contribute!

Status

This document is a living document and will be extended as soon as the Software Quality Working Group has agreed upon a new standard for software projects in RDD.

Guidelines

Do you stick to our code style guides?

General

The basic definitions are given by our EditorConfig, i.e. unix line breaks and 2 space indentation.

Unfortunately, not all editors support EditorConfig. In case you use eXide, the IDE that comes with exist-db, you can set 2 space indentation as default by editing /db/apps/eXide/src/preferences.js.

Specific for programming languagues

For the more prominent programming languages we have formatting and general style guides we ask you to follow:

• Java: The Java style guide can be found here. It's based on the Google style guide for Java with some minor RDD specific setting. You can configure Eclipse to use it automatically at Eclipse > Preferences > Java > Code Style > Formatter. Just load the RDD Eclipse Java Google Style in the formatter preferences and use it in your RDD projects.

• JavaScript: For JS we use the Airbnb JavaScript Style Guide. @TODO: How to use in editor?

• HTML/CSS: For HTML/CSS we agreed upon the Google HTML/CSS Style Guide. @TODO: How to use in editor?

• XQuery: We use the xqdoc style guide with the following addenda:

  • use double quotes instead of single quotes

• XSLT: @TODO

• SPARQL: For SPARQL there is not really any official style guide and there is no possibility to simply include any code style automatically using a code style file. We just collect some advices how to format and use SPARQL code.

  • Declaration of variables should start with a ? (and not with a $).
  • { paranthesis should be at the end of the line. @TODO: examples
  • Group concatenations in SELECT command should be in seperate lines.
  • @TODO: more