Configuration

By default, lingdocs uses the config file shown below. The values in it can be overridden by creating a file lingdocs.cfg in the directory where you are executing lingdocs.

Output

General options relating to the produced output.

Formats

What formats should be built?

Default:

output:
  build:
    - latex
    - mkdocs
    - html
    - plain

Preview

What format should be used for previewing.

Default:

output:
  preview: 'mkdocs'

README

Should a README.md file be created?

Default:

output:
  readme: true

Layout

The layout of the produced document. Options: book, article, slides.

Default:

output:
  layout: 'book'

CLDF data appendix

Create index and detail pages for database entities?

data

This feature is disabled by default. You can point this to a different CLDF metadata.json file

Default:

data:
  data: false

Rich data

Insert links to this data into the document? (Slow and currently only supported for MkDocs).

Default:

data:
  rich: false

Light data

Only include entities referenced in document.

Default:

data:
  light: false

Interlinear examples

The default options can be overridden by specifying an argument, e.g. show_language=True.

Show language

Show the language label?

Default:

examples:
  show_language: true

Show first line

Show the Primary_Text line?

Default:

examples:
  show_primary: true

Source position

Where to place the source? after_translation / in_preamble

Default:

examples:
  source_position: 'after_translation'

LFTS

Different kinds of entities whose schematic inline representation is:

(language) form (‘translation’) ((source))

The default options can be overridden by specifying an argument, e.g. show_language=True.

Show language

Default:

lfts:
  show_language: true

Show free translation

Default:

lfts:
  show_translation: true

Show source

Default:

lfts:
  show_source: true

Locations

CLDF dataset location

The path to the CLDF metadata file.

Default:

paths:
  cldf: 'cldf/metadata.json'

Output folder

The folder to which output is written.

Default:

paths:
  output: 'output'

Additional references

Path to a bibfile with references not contained in the dataset.

Default:

paths:
  add_bib: 'extra/sources.bib'

Adding audio

this folder needs to contain .wav or .mp3 files.

Default:

paths:
  audio: 'extra/audio'

LaTeX

LaTeX-specific settings.

Article template

The default template for the article layout.

Default:

latex:
  article: 'article'

Book template

The default template for the book layout.

Default:

latex:
  book: 'book'

Interlinear package

The preferred setup for interlinear examples in LaTeX.

Default:

latex:
  interlinear: 'expex'

mkdocs

Adding audio

Add a path to your audio base URL.

Default:

mkdocs:
  audio: null

hypothes.is

Use hypothes.is for online annotation.

Default:

mkdocs:
  hypothes.is: false

CLLD

Database location

URI to the database of your CLLD app, i.e. something like sqlite:///path/to/your/db.sqlite.

Default:

clld:
  db_uri: null

html

hypothes.is

Use hypothes.is for online annotation.

Default:

html:
  hypothes.is: true

Input

Sublime text

Generate data (in the docs folder) for the Sublime text plugin.

Default:

input:
  sublime: false

File prefix

How your filenames should be prefixed, if at all.

Default:

input:
  content_file_prefix: null

plain

Empty settings for plaintext format.

github

Empty settings for github format.

External media hosting

if your audio is stored on a media server, the base URL here will be used for audio links.

Default:

media_url: null