geolexica / geolexica-server

Generalized backend for Geolexica sites
2 stars 1 forks source link

Duplicated output formats configuration #69

Closed skalee closed 4 years ago

skalee commented 4 years ago

In _config.yml, both:

collections:
  concepts:
    output: true
  concepts_json:
    output: true
    output_ext: .json
  concepts_jsonld:
    output: true
    output_ext: .jsonld
  concepts_ttl:
    output: true
    output_ext: .ttl
  concepts_tbx:
    output: true
    output_ext: .tbx.xml
  concepts_yaml:
    output: true
    output_ext: .yaml

and:

geolexica:
  formats:
    - html
    - json
    - json-ld
    - turtle
    - yaml

probably serve the same purpose, that is defining which concept formats should be rendered and which should not. This should be cleaned-up. Personally, I prefer the latter for conciseness, but on the other hand the former may be easier in Jekyll and perhaps it can be used to configure more things.

Something to think about.

ronaldtse commented 4 years ago

Let's only use the latter, not sure if we need the former (it was only used so that we can generate those formats when we didn't have the latter).

skalee commented 4 years ago

The former is how you normally define document collections in Jekyll. May be potentially useful to define other settings in future (e.g. permalinks). And finally, these collections must be defined somewhere (here or maybe in hooks), otherwise site won't generate. This is why I haven't made my mind yet. Also, it's probably quite unimportant for now, but it's good to keep an open issue for that.

ronaldtse commented 4 years ago

@skalee at this point it would be easiest for the user to use the geolexica YAML format; the less configuration needed by the user to start, the better.

skalee commented 4 years ago

The more I think about this, the more apparent is that separate collections for various output formats are more a maintenance issue than a feature. There should be one collection geolexica_concepts, if any, which should not require any configuration.

Therefore yes, geolexica -> formats is probably a better idea.

ronaldtse commented 4 years ago

Excellent :-)