docs/content/settings.md - Issue 29977630: Noissue - Add [paths] documentation and remove trailing spaces

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: Change [paths] description Created Jan. 10, 2019, 8:52 p.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

LEFT	RIGHT
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]': A root folder of another website may be specified here, which will	23 * `[paths]`: Configure where things are located on the filesystem:
Vasily Kuznetsov 2019/01/14 14:04:31 I think it would be easier to read if separate the I think it would be easier to read if separate the section description and key description, even though there's only one key. Also I think mentioning "remote resources" and "repositories" could be confusing so I tried to rewrite it only mentioning websites and directories (it seems that we use "directory" instead of "folder" in the rest of the docs, so I tried to be consistent): * `[paths]`: Configure where things are located on the filesystem: * `additional-paths`: One or more additional website root directories (paths should be relative to the root directory of this website). Pages, templates, translations, etc. from those websites will be added to this one. This is useful for sharing common resources between multiple websites. Feel free to correct further if something sounds odd or unclear. rhowell 2019/01/14 15:11:29 Yeah, this layout seems to be more clear. Thanks! Show quoted text On 2019/01/14 14:04:31, Vasily Kuznetsov wrote: > I think it would be easier to read if separate the section description and key > description, even though there's only one key. Also I think mentioning "remote > resources" and "repositories" could be confusing so I tried to rewrite it only > mentioning websites and directories (it seems that we use "directory" instead of > "folder" in the rest of the docs, so I tried to be consistent): > > * `[paths]`: Configure where things are located on the filesystem: > * `additional-paths`: One or more additional website root directories (paths > should be relative to the root directory of this website). Pages, templates, > translations, etc. from those websites will be added to this one. This is useful > for sharing common resources between multiple websites. > > Feel free to correct further if something sounds odd or unclear. Yeah, this layout seems to be more clear. Thanks!
23 allow this website to access the remote resources. This is useful for	24 * `additional-paths`: One or more additional website root directories (paths

24 websites that share common resources. If the shared resources are in a	25 should be relative to the root directory of this website). Pages, templates,

25 separate repository, they can be 'inherited' here by using the key:	26 translations, etc. from those websites will be added to this one. This is

26 `additional-paths = {}`	27 useful for sharing common resources between multiple websites.

27	28

28 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)

LEFT	RIGHT