libkiwix/include
Matthieu Gautier 135028c16a Introduce better API to manipulate entries in a zim file.
The previous API suffer different problems:
- It was difficult to handle articles redirecting to other article.
- It was not possible to get few information (title) without getting
  the whole content.

The new API introduce the new class `Entry` that act as a proxy to an
article in the zim file.

Methods of `Reader` now return an `Entry` and the user has to call
`Entry`'s methods to get useful information.
No redirection is made explicitly.
If an entry is not found, an exception is raised instead of returning
an invalid `Entry`.

The common pattern to get the content of an entry become :

```
std::string content;
try {
  auto entry = reader.getEntryFromPath(path);
  entry = entry.getFinalEntry();
  content = entry.getContent();
} catch (NoEntry& e) {
  ...
}
```

Older methods are keep (with the same behavior) but are marked as
deprecated.
2018-04-19 18:04:07 +02:00
..
common Add a function to create a temporary directory. 2018-04-19 17:53:05 +02:00
ctpp2 Add a new script to compile resources. 2016-12-23 13:06:12 +01:00
common.h Allow us to declare method to be deprecated. 2018-04-19 18:04:07 +02:00
downloader.h Add a downloader tools to download files. 2018-04-19 17:53:08 +02:00
entry.h Introduce better API to manipulate entries in a zim file. 2018-04-19 18:04:07 +02:00
kiwix.h Format all the code using clang-format. 2017-07-05 15:22:34 +02:00
library.h Add some documentation to kiwix-lib API 2018-03-12 17:34:45 +01:00
manager.h Add method to `Manager` to populate the library from a opds stream. 2018-04-19 17:53:08 +02:00
meson.build Introduce better API to manipulate entries in a zim file. 2018-04-19 18:04:07 +02:00
opds_dumper.h Add a potential search description link in the opds stream. 2018-04-19 17:08:01 +02:00
reader.h Introduce better API to manipulate entries in a zim file. 2018-04-19 18:04:07 +02:00
searcher.h Only add a reader to the searcher if the reader as fulltext index. 2018-03-12 17:34:45 +01:00
xapianSearcher.h Be able to get the reader index from a search result. 2017-07-17 18:16:11 +02:00