deploy: 26317b2

apps/AppLocalisation.md

@@ -19,14 +19,16 @@ Localisation of each of them is described below.
 `data/languages.ts` contains a list of all languages covered by the site. It has four sections:
 
 <dl>
+  <dt>regions</dt>
+    <dd>Defines all BCP-47 compatible area codes used in the portal, with their localised names. Regions are used to cover linguistic or orthographic variation following the regions, or just to ensure a most useful fallback list depending on region: SME in Finland should fall back to Finnish, then English, while SME in Sweden should fall back to Swedish, then English.</dd>
   <dt>languages</dt>
-    <dd>The main language definition, contains language codes and the human readable names, possibly also regions covered by the language, in case there are linguistic or orthographic variation following the regions, or just to ensure a most useful fallback list depending on region.</dd>
+    <dd>The main language definition, contains language codes and the human readable names.</dd>
   <dt>fallbacks</dt>
-    <dd>This is a fallback definition for page content when the requested content is not available in the desired language. This makes pages "multilingual", but in a controlled manner.</dd>
+    <dd>This is a fallback definition for page content when the requested content is not available in the desired language. This makes pages "multilingual", but in a controlled manner, so that the most appropriate language available is used to build each element of the page.</dd>
   <dt>uiOnly</dt>
     <dd>Languages that are only used to select page language in the portal, not to select tools = we do not make or promote tools for these languages (at least not in this portal).</dd>
   <dt>excludeFromUi</dt>
-    <dd>Languages for which we do not have any translated content, but for which we still want them listed in the tools list. That is, skip these languages in the language selection drop down for the site.</dd>
+    <dd>Languages for which we do not have any translated content, but for which we still want them listed in the tools list. That is, skip these languages in the language selection drop down for the site, but list them in the overview of resources for languages.</dd>
 </dl>
 
 ## Categories
@@ -35,6 +37,23 @@ Localisation of each of them is described below.
 
 It is seen on top of each category page. One gets to these pages when clicking on a category label.
 
+## Resources
+
+`data/resources/` contains the definition of all resources described on the site. Except for the file `mod.ts`, all files contain strings that should be localised. The strings are the following:
+
+- `name` - the name of the resource
+- `description` - a short description of the resource
+- `moreInfo` - a longer description of the resource, if wanted
+- `links:text` - text to appear on the link button. Often this can just use the English text, but sometimes a translation will work better
+
+## Content files
+
+Most of the content for the portal lives in `src/`. All localisable text is placed in `.flt` files, including in subdirs. At present, the following dirs contain `.flt` files to be localised:
+
+```sh
+
+```
+
 # Divvun Manager
 
 (macOS & Windows)