comments

src/sampleconf/fields

@@ -37,6 +37,24 @@
 # The following ones are probably hard-coded in the c code, can't change at
 # all.
 # Also reserved: F(parentid), Q(uniqueid)
+#   XE (file ext), XP (for path elements), XSFN, XSFS, XXST, XXND, XXPG
+# Using XX was not a good idea. 
+#
+# There was initially some effort made to have some compatibility with
+# Xapian Omega, but it probably is now irrelevant, given how differently
+# the indexes are now structured. In any case see
+# xapian/applications/omega/docs/termprefixes.rst in the Xapian source for
+# Xapian/Omega  prefix usage. In a nutshell Omega reserves all single
+# letters except X which is the start for user-defined prefixes.
+#
+# Recoll uses a lot of X-starting prefixes, and also some XX ones so that
+# locally defined prefixes should start with XY to avoid any possible
+# collision with the predefined ones.
+#
+# I hereby commit to not using XY for Recoll.
+# *** USE XY for beginning your local prefixes *** e.g.:
+# myfield = XYMYFIELD
+
 author = A
 xapdate = D
 keywords= K
@@ -52,18 +70,8 @@ containerfilename = XCFN ; pfxonly = 1 ; noterms = 1
 rclUnsplitFN = XSFS
 xapyear = Y
 recipient = XTO
-
-# Extension examples. These are actually used by default by Recoll, you can
-# add your own to search for fields produced by the filters and not handled
-# by default. 
-# Some values are internally reserved by recoll: 
-#   XE (file ext), XP (for path elements), XSFN, XSFS, XXST, XXND, XXPG
 rclbes = XB ; noterms = 1
-# Using XX was not a good idea. 
-#
-# I hereby commit to not using XY for Recoll:
-# *** USE XY for beginning your local prefixes *** ie:
-# myfield = XYMYPREF
+
 
 [values]
 ###########