/
oc11-0-definition-list_00015.xml
42 lines (41 loc) · 3.77 KB
/
oc11-0-definition-list_00015.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0" encoding="UTF-8"?>
<DocumentationDefinitionLists xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="opencms://system/modules/com.alkacon.opencms.documentation/schemas/documentation-definition-list.xsd">
<DocumentationDefinitionList language="en">
<Heading><![CDATA[List of specific fields for sorting]]></Heading>
<PropertyDef>false</PropertyDef>
<Entry>
<Term><![CDATA[disptitle_{locale}_sort]]></Term>
<Description name="Description0">
<links/>
<content><![CDATA[<p>Default field for alphabetical sorting by type. It is treated special on indexing. If the field is not filled via a search setting in the schema of a content type, it's value falls back to the (localized) title property.</p>
<div class="alert alert-info">The field is defined as dynamic field <code>*_sort</code> in the schema and it is indexed in a suitable way for alpha-numerical sorting. If you want to improve sorting by locale specific sort fields, you could add dynamic fields <code>*_{locale}_sort</code>.</div>
<div class="alert alert-info">The field is indexed the way, that even for PDFs etc. the fields <code>disptitle_sort</code> and <code>disptitle_{locale}_sort</code> will be indexed for all locales the indexed file is available.</div>]]></content>
</Description>
</Entry>
<Entry>
<Term><![CDATA[disporder_{locale}_i]]></Term>
<Description name="Description0">
<links/>
<content><![CDATA[<p>Default field for individual sorting of contents (by a manually assigned integer). You can fill it via a search setting in the schema of a content type, or set it via the (inherited) property <code>display-order</code>.</p>
<div class="alert alert-info">The field is always indexed as <code>disporder_i</code> and <code>disporder_{locale}_i</code> for all locales the indexed resource is available.</div>]]></content>
</Description>
</Entry>
<Entry>
<Term><![CDATA[instancedate_{locale}_dt]]></Term>
<Description name="Description0">
<links/>
<content><![CDATA[<p>Default field for sorting by date. You can fill it via a search setting in the schema of a content type. If not, it is set to index field with the name of the value of the (inherited) property <code>instancedate.copyfield</code>. If this is not set, the release date of the file would be used, and if set neither, the date last-modified.</p>
<div class="alert alert-info">The field is always indexed as <code>instancedate_i</code> and <code>instancedate_{locale}_i</code> for all locales the indexed resource is available.</div>]]></content>
</Description>
</Entry>
<Entry>
<Term><![CDATA[instancedatecurrenttill_{locale}_dt]]></Term>
<Description name="Description0">
<links/>
<content><![CDATA[<p>Default field used for time ranges. You can fill it via a search setting in the schema of a content type. If not, it is set to index field with the name of the value of the (inherited) property <code>instancedate.copyfield</code>. If this is not set, the release date of the file would be used, and if set neither, the date last-modified.</p>
<div class="alert alert-info">The field is always indexed as <code>instancedatecurrenttill_i</code> and <code>instancedatecurrenttill_{locale}_i</code> for all locales the indexed resource is available.</div>
<div class="alert alert-info">Usually, instancedate and instancedatecurrenttill may be the same, but you may have events where instancedate holds the start time and instancedatecurrenttill the end time of the event. The reason: You may have a list, showing the next 10 events and you want to show "running" events in it as well.</div>]]></content>
</Description>
</Entry>
</DocumentationDefinitionList>
</DocumentationDefinitionLists>