# HG changeset patch
# User Ben Schmidt
# Date 1475412974 -39600
# Node ID c3c848693108974e920d883fa8ef06a3c8820497
# Parent  bb4a7a82dbcc760ea54a7536025b794b1dc677db
Document list text search paths.

diff -r bb4a7a82dbcc -r c3c848693108 README.listtexts
--- a/README.listtexts	Wed May 25 16:03:09 2016 +1000
+++ b/README.listtexts	Sun Oct 02 23:56:14 2016 +1100
@@ -3,11 +3,11 @@
 List texts in Mlmmj
 ===================
 
-List texts are stored in listdir/text. They specify the content of various
-automatic emails that Mlmmj sends. They are provided in a number of different
-languages. The language to use for a list is chosen when you run the
-mlmmj-make-ml script and the appropriate files are copied into your
-listdir/text directory.
+List texts are stored in listdir/text and subdirectories of
+prefix/share/mlmmj/text.skel. They specify the content of various automatic
+emails that Mlmmj sends. They are provided in a number of different languages.
+The language to use for a list is chosen when you run the mlmmj-make-ml script
+and the appropriate files are copied into your listdir/text directory.
 
 This file documents the following aspects of list texts:
 
@@ -46,6 +46,22 @@
 conditionals can be used to customise the list text according to the values of
 the missing parts.
 
+Mlmmj checks these three paths for each candidate filename, and then moves on
+to the next candidate filename:
+
+- listdir/text
+- prefix/share/mlmmj/text.skel/default
+- prefix/share/mlmmj/text.skel/en
+
+The second path does not exist by default, but can be created by copying or
+symlinking the language of your choice to that path.
+
+Note that this search order means that if there is a more specific list text in
+a system directory, it will override a less-specific or compatibility list text
+in the listdir. This may be surprising, and may change in a future version, so
+should not be relied upon. Best practice is to ensure each list has its own
+copy of all textx present in system directories, or none of them.
+
 Supported list texts
 --------------------