Home - MusicalForm/guidelines GitHub Wiki

This Wiki is a straightforward way to modify most contents of our guidelines homepage. However, the preferred way to edit the guidelines is to clone the guidelines repository with --recursive option and edit, preview, render and upload the website using Quarto (see below).

[!WARNING] Please be careful editing syntactic elements which may be important for rendering the website. In particular, do not modify labels such as {#sec-tilia_layout}. The way how the pages are rendered in this wiki is completely irrelevant, as long as everything is showing correctly on the website.

Pages that can be edited here in the wiki are:

  • Intro: What is form? A working definition
  • Workflow: Learn about the annotation tool
  • Principles: Basic rules that should always hold
  • Syntax: Syntactic rules of how labels can be combined, enhanced, and specified
  • Examples: Example analysis and discussions thereof

Pages that cannot be edited here (only in the guidelines repo) are:

  • index.qmd: Start page called "Home" on the website.
  • Vocabulary.ipynb: Collection and explanation of possible form annotation labels (the notebook renders a CSV export of this spreadsheet)
  • about.qmd: About the form project

Markdown syntax

The website is rendered using Quarto. Please refer to its Markdown documentation to learn about its extended Markdown syntax. Github uses its own Markdown flavour and will not correctly render some of the Quarto syntax. This does not matter: What matters is that things are correctly rendered on the website.