Configuration Variables

Complete List Of Configuration Variables

The following configuration variables from the file _config.yml are understood by Qgoda:

  • case-sensitive type: 0 or 1 default: 0

    Set to 0 if you want to ignore case of filenames, 1 otherwise. It is probably wise to keep the default value of 0 even on a case-sensitive file system. Otherwise, you may run into problems, when you copy the site on another machine or some storage medium such as a USB stick.
  • exclude type: Array default: empty

    A list of files and directories that should not be processed. Patterns are allowed. See Excluding Files!
  • exclude-watch type: Array default: same as "exclude" above

    A list of files and directories that should not trigger a rebuild, when they change. Patterns are allowed. See Excluding Files!
  • linguas type: Array default: undefined

    A list of language codes for your site like "en", "fr", and so on. It is recommended that you use HTTP language identifiers.
  • link-score type: Integer default: 5

    The relation score that two documents that have a link between each other get. Note that this is counted from each document's side. So, if document A links to B and B links to A, the overall relation score between A and B is 10.
  • no-scm type: List of patterns default: none

    A list of file name patterns that should be processed although not being under version control. This only makes sense in conjunction with scm.
  • title type: String default: "A New Qgoda Powered Site"

    The name of the site. Qgoda itself does not use this variable.
  • po type: Hash default: see below

    Container for various i18n settings, see below.
  • po.copyright_holder type: String default: none

    See po.copyright_holder in Multilanguage Configuration.
  • po.from_code type: String default: utf-8

    See po.from-code in Multilanguage Configuration.
  • po.msgfmt type: String default: msgfmt

    See po.msgfmt in Multilanguage Configuration.
  • po.msgid_bugs_address type: String default: none

    See po.msgid_bugs_address in Multilanguage Configuration.
  • po.qgoda type: String default: msgfmt

    See po.msgfmt in Multilanguage Configuration.
  • po.msgmerge type: String default: msgfmt

    See po.msgmerge in Multilanguage Configuration.
  • po.qgoda type: string or list default: 0

    See po.qgoda in Multilanguage Configuration.
  • po.refresh type: Boolean (0 or 1) default: 0

    See po.refresh in Multilanguage Configuration.
  • po.textdomain type: String default: none

    The textdomain of your site. The master translation catalog for your site will be TEXTDOMAIN.pot and the invocation of the template toolkit Gettext plug-in has to use the same value. The easiest way to achieve that is by invoking the Gettext plug-in with [% USE gtx = Gettext(config.po.textdomain, asset.lingua) %].
  • po.xgettext type: String default: xgettext

    Location of the xgettext program if not in $PATH.
  • po.xgettext-tt2 type: String default: xgettext-tt2

    Location of the xgettext-tt2 program if not in $PATH.
  • scm type: String default: none

    Source Code Management (SCM) system in use. The only supported variable at the moment is "git". That has the effect that only files under version control are processed. This check is done *after* filtering with the contents of the configuration variable exclude.
  • url type: String default: none

    The url (http://...) of the site, normally without a trailing slash (so that you can safely append asset.permalink to it). Qgoda itself does not use this variable.