Difference between revisions of "Search indexes"

Jump to navigation Jump to search
67 bytes removed ,  16:37, 25 November 2023
(Add specification for the listing entries)
 
 
(3 intermediate revisions by one other user not shown)
Line 4: Line 4:


All indexes are optional.
All indexes are optional.
All indexes and listing items MUST be stored in uncompressed cluster.


== Xapian Indexes ==
== Xapian Indexes ==
Line 15: Line 17:
'''Mimetype''' : <code>application/octet-stream+xapian</code>
'''Mimetype''' : <code>application/octet-stream+xapian</code>


=== Tittle index ===
=== Title index ===
'''Namespace''': <code>X</code>
'''Namespace''': <code>X</code>


Line 54: Line 56:
'''Mimetype''' : <code>application/octet-stream+zimlisting</code>
'''Mimetype''' : <code>application/octet-stream+zimlisting</code>


The content of the listing is the list of all article entries in the zim archive.
The content of the listing is the list of all "article entries" in the zim archive.
 
Those "article entries" may be redirect (what is a article entry is not really defined in the spec, it is up to the creator to define in which category a entry is).


Entries are sorted using the key <code><title></code> (All article entries are in <code>C</code> namespace by definition)
Entries are sorted using the key <code><title></code> (All article entries are in <code>C</code> namespace by definition)


Content size is <code>4 * <nbArticle></code>
Content size is <code>4 * <nbArticle></code>
Entry numbers are relatives to the beginning of the <code>C</code> namespace. For now, as <code>C</code> namespace is the first namespace, there is no article before the <code>C</code> namespace the article number are also absolute. It may be not always the case if we add other namespace in the future.


<code>listing/titleOrdered/v1</code> may be used to pick random articles or to search article by title and be sure that no resource entries are included.
<code>listing/titleOrdered/v1</code> may be used to pick random articles or to search article by title and be sure that no resource entries are included.

Navigation menu