Switch to unified view

a/src/sampleconf/fields b/src/sampleconf/fields
...
...
6
#
6
#
7
# Important: 
7
# Important: 
8
#   - the field names MUST be all lowercase alphabetic ascii here. They can
8
#   - the field names MUST be all lowercase alphabetic ascii here. They can
9
#     be anycased in the documents.
9
#     be anycased in the documents.
10
10
11
[prefixes]
12
11
#####################################################
13
#####################################################
12
# This section defines what prefix the terms inside named fields will be
14
# This section defines what prefix the terms inside named fields will be
13
# indexed with (in addition to prefix-less indexing for general search)
15
# indexed with (in addition to prefix-less indexing for general search)
14
# ALL prefixes MUST be all UPPERCASE. Extension prefixes begin with X 
16
# ALL prefixes MUST be all UPPERCASE. 
15
# 
17
# 
16
# The choice of field names is rather arbitrary. Use of any of the aliases
18
# The field names should be the canonic ones, not the aliases defined in
17
# defined in the following section will yield exactly the same results,
19
# the following section. Don't change those which are predefined here, 
18
# (both for indexing and search).
20
# quite a few are hard-coded in the c++. But you can add more (for new
21
# fields emitted by filters).
19
#
22
#
20
# Fields can have two relevance boost factors defined, such as in:
23
# Fields can have two relevance boost factors defined, such as in:
21
# caption = S ; wdfinc=10
24
# caption = S ; wdfinc=10
22
#  and/or
25
#  and/or
23
# caption = S ; boost = 10
26
# caption = S ; boost = 10
...
...
25
# caption terms by a factor of 10 at indexing time. The second one 
28
# caption terms by a factor of 10 at indexing time. The second one 
26
# (NOT CURRENTLY IMPLEMENTED) would automatically boost the weight of a
29
# (NOT CURRENTLY IMPLEMENTED) would automatically boost the weight of a
27
# caption-based field query (ie: caption:mytitle or title:mytitle) at query
30
# caption-based field query (ie: caption:mytitle or title:mytitle) at query
28
# time.
31
# time.
29
32
30
[prefixes]
33
# The following ones are probably hard-coded in the c code, can't change at
31
34
# all.
32
# Native fields matching omega uses, which we index without an X first
35
# Also reserved: F(parentid), Q(uniqueid)
33
# letter. Don't change these. Caption is used for 'title' to keep a last
34
# remnant of omega compatibility inside the data record. 
35
# Also reserved/hardcoded: D(ate), M(onth), Y(ear), 
36
#           F(parentid), Q(uniqueid), T(mime type)
37
caption = S ; wdfinc = 10
36
title = S ; wdfinc = 10
38
author = A
37
author = A
38
abstract =
39
caption = S
40
title = S
41
subject = S
42
author = A
39
keywords = K
43
keywords= K
44
xapyear = Y
45
xapyearmon = M
46
xapdate = D
47
mtype = T
48
rclUnsplitFN = XSFS
49
filename = XSFN
50
ext = XE
40
51
41
# Extension examples. These are actually used by default by Recoll, you can
52
# Extension examples. These are actually used by default by Recoll, you can
42
# add your own to search for fields produced by the filters and not handled
53
# add your own to search for fields produced by the filters and not handled
43
# by default. 
54
# by default. 
44
# Some values are internally reserved by recoll: 
55
# Some values are internally reserved by recoll: 
45
#   XE (file ext), XP (for path elements), XSFN, XSFS, XXST, XXND, 
56
#   XE (file ext), XP (for path elements), XSFN, XSFS, XXST, XXND, XXPG
46
# Using XX was not a good idea. 
57
# Using XX was not a good idea. 
47
#
58
#
48
# I hereby commit to not using XY for Recoll:
59
# I hereby commit to not using XY for Recoll:
49
# *** USE XY for beginning your local prefixes *** ie:
60
# *** USE XY for beginning your local prefixes *** ie:
50
# myfield = XYMYPREF
61
# myfield = XYMYPREF
51
recipient = XTO
62
recipient = XTO
52
63
64
[stored]
53
############################
65
############################
54
# Some fields are stored in the document data record inside the index and
66
# Some fields are stored in the document data record inside the index and
55
# can be returned in result lists. There is no necessity that stored fields
67
# can be returned in result lists. There is no necessity that stored fields
56
# should be indexed (have a prefix in the preceding section) (example:
68
# should be indexed (have a prefix in the preceding section) (example:
57
# "url", but this one doesn't need to be listed here, it's stored by hard
69
# "url", but this one doesn't need to be listed here, it's stored by hard
...
...
62
# Only canonical names should be used here, not aliases.
74
# Only canonical names should be used here, not aliases.
63
# "author" used to be stored by default, now set here as optional
75
# "author" used to be stored by default, now set here as optional
64
# "rclaptg" is used for viewer specialization (depending on local config)
76
# "rclaptg" is used for viewer specialization (depending on local config)
65
# "rclbes" defines the backend type (ie normal fs, firefox cache). Should
77
# "rclbes" defines the backend type (ie normal fs, firefox cache). Should
66
#   probably be hardcoded, don't remove it
78
#   probably be hardcoded, don't remove it
67
[stored]
68
author=
79
author=
69
rclaptg=
80
rclaptg=
70
rclbes=
81
rclbes=
71
filename=
82
filename=
72
83
84
[aliases]
73
##########################
85
##########################
74
# This section defines field names aliases or synonyms. Any right hand side
86
# This section defines field names aliases or synonyms. Any right hand side
75
# value will be turned into the lhs canonic name before further treatment
87
# value will be turned into the lhs canonic name before further treatment
76
#
88
#
77
# The left-hand values in the recoll distribution file are well known and
89
# The left-hand values in the recoll distribution file are well known and
78
# must match names used in the c++ code, or even the index data
90
# must match names used in the c++ code, or even the index data
79
# record. They can't change! But you can add others.
91
# record. They can't change! But you can add others.
80
#
92
#
81
# Filters should only add canonic names to the meta array when indexing,
93
# Filters should only add canonic names to the meta array when indexing,
82
# not aliases.
94
# not aliases.
83
84
[aliases]
85
abstract = summary dc:summary description xesam:description
95
abstract = summary dc:summary description xesam:description
86
author = creator dc:creator xesam:author xesam:creator from
96
author = creator dc:creator xesam:author xesam:creator from
87
title = caption title dc:title subject
97
title = caption title dc:title subject
88
# catg = dc:type contentCategory
98
# catg = dc:type contentCategory
89
dbytes = size xesam:size
99
dbytes = size xesam:size
...
...
95
     dc:description
105
     dc:description
96
mtype = mime mimetype xesam:mimetype contenttype xesam:contenttype dc:format
106
mtype = mime mimetype xesam:mimetype contenttype xesam:contenttype dc:format
97
recipient = to xesam:recipient
107
recipient = to xesam:recipient
98
url = dc:identifier xesam:url
108
url = dc:identifier xesam:url
99
109
100
#########################
110
[xattrtofields]
101
# This section defines a hierarchy for field names. Searching for a lhs
102
# ancestor will be expanded to a search for itself and all rhs descendants
103
# This is not used for now
104
[specialisations]
105
author = from
106
107
######################
111
######################
108
# Section to define translations from extended file attribute names to
112
# Section to define translations from extended file attribute names to
109
# field names. xattr use must be enabled at compile time for this to be
113
# field names. xattr use must be enabled at compile time for this to be
110
# used. Enter translations as "xattrname = fieldname". Case matters.
114
# used. Enter translations as "xattrname = fieldname". Case matters.
111
[xattrtofields]
112
115
113
116
114
########################
117
########################
115
# Sections reserved for specific filters follow
118
# Sections reserved for specific filters follow
116
#
119
#