Legend and explanations
Explanations and legends relating to the index documentation.
Index terminology
The terms used in the index documentation are borrowed from Apache Lucene.
| Term | Abbr. | Meaning |
|---|---|---|
| Stored | S | The content of the field is stored in the index and available in search results. |
| Compressed | Z | The content of the field is stored in the index using compressed format and might be available in search results. |
| Analyzed | A |
The content has been tokenized so that individual terms and phrases can be searched. When a field is analyzed; facets for this field are made of individual terms. |
| Indexed | I |
The content has been indexed as it is; searches can only match the full content (prefix and fuzzy searches are possible also). When a field is simply indexed (as opposed to analyzed), facets values use the entire field value. |
| Int | N | The field is interpreted as a numeric field so that it can be stored and sorted efficiently. |
| Long | L | The field is interpreted as a numeric field so that it can be stored and sorted efficiently. |
Cardinality
The cardinality denotes the number instances if the field is supported by the kind of indexable item.
| Term | Abbr. | Meaning |
|---|---|---|
| 1 | If the field is supported, it is always available | |
| 0..1 | ? | If the field is supported, it might be available |
| 0..N | * | If the field is supported, there might be multiple instances |
| 1..N | + | If the field is supported, there is at least one instance |
Legend
For brevity, the documents use icons to denote the different kinds of indexable items.
| Icon | Description |
|---|---|
 | Folders |
 | Microsoft Word document |
 | PDF document |
 | HTML document |
 | XML document |
 | PageSeeder document (PSML) |
 | Any other type of document |
 | Image (gif, bmp, png or jpeg) |
 | Task |
 | Comment |