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

Unified Diff: docs/content/settings.md

Issue 29977630: Noissue - Add [paths] documentation and remove trailing spaces (Closed) Base URL: https://hg.adblockplus.org/cms/
Patch Set: Reword [paths] documentation Created Jan. 14, 2019, 3:10 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/content/pages.md ('k') | docs/content/static.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/content/settings.md
===================================================================
--- a/docs/content/settings.md
+++ b/docs/content/settings.md
@@ -2,22 +2,28 @@
The following sections can be defined in `settings.ini`:
-* `[general]`: following settings should be listed here:
+* `[general]`: The following settings should be listed here:
* `defaultlocale`: The fallback locale, to be used whenever no localized
page/strings can be found for a locale.
- * `defaultpage`: the default page which is displayed by the server if the URL
+ * `defaultpage`: The default page which is displayed by the server if the URL
doesn't contain a page name. Note that while the test server will consider
that setting automatically, the real server might need to be configured
accordingly.
- * `crowdin-project-name`: The Crowdin project name, this must be set for if
+ * `crowdin-project-name`: The Crowdin project name, this must be set if
you intend to use the cms.bin.translate script to update the Crowdin
translations.
-* `[langnames]`: defines the language names correspoding to particular language
+ * `siteurl`: The base URL where pages will be served from.
+* `[langnames]`: Defines the language names correspoding to particular language
codes.
-* `[rtl]`: any language codes listed here are treated as right-to-left languages.
+* `[rtl]`: Any language codes listed here are treated as right-to-left languages.
The values of the settings are ignored.
-* `[locale_overrides]`: every entry defines that a page should use a different
+* `[locale_overrides]`: Every entry defines that a page should use a different
locale file, not the one matching its name (to be used when multiple pages
share localization data).
+* `[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,
Vasily Kuznetsov 2019/01/14 16:33:15 Nit: The following lines of the bullet item should
rhowell 2019/01/14 17:21:08 Oops! Thanks for catching that.
Vasily Kuznetsov 2019/01/16 10:24:05 Sorry to be annoying, but the following lines are
rhowell 2019/01/17 02:52:40 Sheesh, that's what I get for rushing! Sorry bout
+translations, etc. from those websites will be added to this one. This is useful
+for sharing common resources between multiple websites.
Prev: [XTM Integration](../usage/xml-sync.md) | Up: [Home](../../README.md) | Next: [Custom Jinja2 global functions and variables (`globals`)](globals.md)
« no previous file with comments | « docs/content/pages.md ('k') | docs/content/static.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld