== Programming ==
=== Introduction ===zimlib is written in C++. To use the library, you need the include files of zimlib have to link against
libzim. Both are installed when zimlib is built with the normal "./configure; make; make install ".
Errors are handled with exceptions. When something goes wrong, zimlib throws an error, which is always derived from std::exception.
int main(int argc, char* argv)
You may save that file under the name "zimlist.cpp" and compile using the command:
'''g++ -o zimlist -lzim zimlist.cpp'''. You get a program, which lists the urls and titles of the file named ''wikipedia.zim''. Of course it is better to pass that name as a parameter in argc/argv. But this should be an easy task for you, so I do not show that.
In subsequent examples I show only the code needed to use the library. The main-function with the error catcher should always be in place.
Articles are addressed either by index or by namespace and url or title. The index is normally not that useful. So let us look how to find a specific article.
''zim::File'' has methods ''find'' and ''findByTitle''. Both take 2 parameters. A char for the namespace (which is normally 'A' for articles) and a string, which specifies the url (in find) or the title (in findByTitle). It returns a const_iterator pointing to the lexicographically next article. Be aware, that the returned iterator may point to end(), so you should check that, before dereferencing the iterator.
;Sample: find a article by title and print the content:
The simpler searches articles by title either by a praefix or by a range of titles. You pass a namespace and either a single ''std::string'' and you get all articles, whose title starts with that string or you pass two strings and you get all articles whose title is between these strings (including the passed strings).