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

Unified Diff: docs/content/locales.md

Issue 29628724: Issue 5521 - Restructure CMS documentation to make it easier to use and extend (Closed) Base URL: https://hg.adblockplus.org/cms
Patch Set: Add initial API docs Created Dec. 13, 2017, 11:08 a.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
Index: docs/content/locales.md
===================================================================
new file mode 100644
--- /dev/null
+++ b/docs/content/locales.md
@@ -0,0 +1,19 @@
+# Localization files #
+
+The language-specific data is stored in the `locales` directory. Each language
+(identified by its locale code) is given a subdirectory here. The `.json` files
+contain localizable strings using the following format:
+
+ {
+ "stringid": {
+ "message": "Translated string",
+ "description": "Optional string description"
+ },
+ ...
+ }
+
+Any other files are considered localizable files and will be available on the
+server unchanged. This is useful for images for example: a language-dependent
+image can be placed into the `locales/en` directory and a German version
+of the same image into the `locales/de` directory. E.g. the file
+`locales/en/foo.png` will be available on the server under the URL `/en/foo.png`.
« docs/content/includes.md ('K') | « docs/content/includes.md ('k') | docs/content/pages.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld