Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Delta Between Two Patch Sets: docs/content/settings.md

Issue 29977630: Noissue - Add [paths] documentation and remove trailing spaces (Closed) Base URL: https://hg.adblockplus.org/cms/
Left Patch Set: Created Jan. 10, 2019, 1:26 a.m.
Right Patch Set: Fix indentation Created Jan. 17, 2019, 2:51 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « docs/content/pages.md ('k') | docs/content/static.md » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
1 # Configuration (settings.ini) # 1 # Configuration (settings.ini) #
2 2
3 The following sections can be defined in `settings.ini`: 3 The following sections can be defined in `settings.ini`:
4 4
5 * `[general]`: The following settings should be listed here: 5 * `[general]`: The following settings should be listed here:
6 * `defaultlocale`: The fallback locale, to be used whenever no localized 6 * `defaultlocale`: The fallback locale, to be used whenever no localized
7 page/strings can be found for a locale. 7 page/strings can be found for a locale.
8 * `defaultpage`: The default page which is displayed by the server if the URL 8 * `defaultpage`: The default page which is displayed by the server if the URL
9 doesn't contain a page name. Note that while the test server will consider 9 doesn't contain a page name. Note that while the test server will consider
10 that setting automatically, the real server might need to be configured 10 that setting automatically, the real server might need to be configured
11 accordingly. 11 accordingly.
12 * `crowdin-project-name`: The Crowdin project name, this must be set if 12 * `crowdin-project-name`: The Crowdin project name, this must be set if
13 you intend to use the cms.bin.translate script to update the Crowdin 13 you intend to use the cms.bin.translate script to update the Crowdin
14 translations. 14 translations.
15 * `siteurl`: The base URL where pages will be served from.
15 * `[langnames]`: Defines the language names correspoding to particular language 16 * `[langnames]`: Defines the language names correspoding to particular language
16 codes. 17 codes.
17 * `[rtl]`: Any language codes listed here are treated as right-to-left languages . 18 * `[rtl]`: Any language codes listed here are treated as right-to-left languages .
18 The values of the settings are ignored. 19 The values of the settings are ignored.
19 * `[locale_overrides]`: Every entry defines that a page should use a different 20 * `[locale_overrides]`: Every entry defines that a page should use a different
20 locale file, not the one matching its name (to be used when multiple pages 21 locale file, not the one matching its name (to be used when multiple pages
21 share localization data). 22 share localization data).
22 * '[paths]': Optionally, this can be used to add additional root folders. E.g. 23 * `[paths]`: Configure where things are located on the filesystem:
Vasily Kuznetsov 2019/01/10 16:39:46 I think it would be useful to explain the main use
rhowell 2019/01/10 20:52:59 I gave it a shot, but feel free to add or change a
23 `additional-paths = {}` 24 * `additional-paths`: One or more additional website root directories (paths
25 should be relative to the root directory of this website). Pages, templates,
26 translations, etc. from those websites will be added to this one. This is
27 useful for sharing common resources between multiple websites.
24 28
25 Prev: [XTM Integration](../usage/xml-sync.md) | Up: [Home](../../README.md) | Ne xt: [Custom Jinja2 global functions and variables (`globals`)](globals.md) 29 Prev: [XTM Integration](../usage/xml-sync.md) | Up: [Home](../../README.md) | Ne xt: [Custom Jinja2 global functions and variables (`globals`)](globals.md)
LEFTRIGHT

Powered by Google App Engine
This is Rietveld