kiwix/kiwix-tools
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-tools.git synced 2025-09-22 11:22:38 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixed the "book name"-vs-"ZIM name" bug in docs

Browse Source
This commit is contained in:
Veloman Yunkan 2024-03-06 19:25:25 +04:00
parent 67c0ebd6ad
commit 8ea12b2ce5
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/kiwix-serve.rst
View File

@ -339,8 +339,8 @@ filtering criteria must be specified via the following URL parameters:
* ``q`` - include in the results only entries that contain the specified text * ``q`` - include in the results only entries that contain the specified text
in the title or description. in the title or description.
* ``name`` - include in the results only the entry with the specified * ``name`` - include in the results only entries with a matching
:term:`name <ZIM name>`. :term:`book name <Book name>`.
Examples: Examples:
@ -617,9 +617,11 @@ A multi-ZIM search request must comply with the following constraints:
a multi-ZIM search, however must respect the :ref:`multi-ZIM search a multi-ZIM search, however must respect the :ref:`multi-ZIM search
constraints <multi-zim-search-constraints>`. constraints <multi-zim-search-constraints>`.
``books.name``: :term:`name <ZIM name>` of the ZIM file. Can be repeated ``books.name``: :term:`name of the ZIM file <ZIM name>` (not to be confused
for a multi-ZIM search, however must respect the :ref:`multi-ZIM search with ``books.filter.name`` which selects/filters based on the :term:`book
constraints <multi-zim-search-constraints>`. name <Book name>`). Can be repeated for a multi-ZIM search, however must
respect the :ref:`multi-ZIM search constraints
<multi-zim-search-constraints>`.
``books.filter.{criteria}``: allows to take full advantage of :ref:`library ``books.filter.{criteria}``: allows to take full advantage of :ref:`library
filtering <library-filtering>` functionality of the `/catalog/v2/entries`_ filtering <library-filtering>` functionality of the `/catalog/v2/entries`_
@ -799,6 +801,13 @@ Glossary
.. glossary:: .. glossary::
Book name
Name of the book as specified in the ZIM file metadata (for a
``kiwix-serve`` started *WITHOUT* the :option:`--library` option) or the
library XML file (for a ``kiwix-serve`` started with the
:option:`--library` option).
ZIM filename ZIM filename
Name of a ZIM file on the server filesystem. Name of a ZIM file on the server filesystem.
@ -808,15 +817,16 @@ Glossary
Identifier of a ZIM file in the server's library (used for referring to a Identifier of a ZIM file in the server's library (used for referring to a
particular ZIM file in requests). particular ZIM file in requests).
For a ``kiwix-serve`` started with a list of ZIM files, ZIM names are ZIM names are derived from the filenames as follows:
derived from the filename by dropping the extension and replacing certain
characters (spaces are replaced with underscores, and ``+`` symbols are
replaced with the text ``plus``). Presence of the
:option:`-z`/:option:`--nodatealiases` option will create additional names
(aliases) for filenames with dates.
For a ``kiwix-serve`` started with the :option:`--library` option, ZIM - file extension is removed,
names come from the library XML file. - all characters are converted to lowercase,
- diacritics are removed,
- spaces are replaced with underscores,
- ``+`` symbols are replaced with the text ``plus``.
Presence of the :option:`-z`/:option:`--nodatealiases` option will create
additional names (aliases) for filenames with dates.
ZIM names are expected to be unique across the library. Any name conflicts ZIM names are expected to be unique across the library. Any name conflicts
(including those caused by the usage of the (including those caused by the usage of the