Difference between revisions of "Zimwriterdb"

From openZIM
Jump to: navigation, search
(See also)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The zimwriter is a tool to create zim files. The articles for the files are read from a postgresql database. The schema for the database is documented in the zimwriter source as a sql script ''de/zim-postgresql.sql''.
+
The '''zimwriterdb''' is a tool coded in C++ to create zim files. The articles for the files are read from a postgresql database. The schema for the database is [https://gerrit.wikimedia.org/r/gitweb?p=openzim.git;a=blob;f=zimwriter/db/zim-postgresql.sql;h=02e7bfe4d30f4d8abefeb374d1ff4f18d07f6a5c;hb=HEAD documented in the zimwriter source]. The current implementation has a abstraction for the data source, so that it will be possible to implement other data sources (as a replacement to the database) e.g. the file system.
  
The current implementation has a abstraction for the data source, so that it will be possible to implement other data sources (as a replacement to the database) e.g. the file system.
+
== Fulltext search index ==
 +
The fulltext search, implemented in zimlib and used in zimreader, needs an index file. The index file is ZIM file with special articles in namespace "X". The indexer, which creates that index file is implemented as a data source in zimwriter. It reads the articles from a zim file to create the full text index. To use it, pass -Z ''zimfile'' to the writer e.g. ''zimwriter -Z wikipedia-de.zim wikipedia-de-x.zim''.
  
== zimindexer ==
+
== Requirements ==
The full text search implemented in zimlib and used in zimreader there is a index file needed. The index file is actually a zim file with special articles in namespace ''X''.
+
If you compile the software from source you need the following libraries installed:
 +
* cxxtools (version 2.0)
 +
* tntdb (for zimwriter) (release 1.1)
 +
* tntnet (for zimreader) (release 2.0)
 +
* libxz-dev
 +
* autoconf
 +
* automake
 +
* libtool
  
The indexer, which creates that index file is implemented as a data source in zimwriter. It reads the articles from a zim file to create the full text index. To use it, pass -Z ''zimfile'' to the writer e.g. ''zimwriter -Z wikipedia-de.zim wikipedia-de-x''.
+
== See also ==
 
+
* [[Git|Get the source code]]
== Binary ==
+
* [[Build_your_ZIM_file#buildZimFileFromDirectory.pl|buildZimFileFromDirectory.pl]], a tool able to fill the database
''coming soon...''
+
* [[zimlib]]
 +
* [[zimdump]]

Latest revision as of 20:51, 11 January 2013

The zimwriterdb is a tool coded in C++ to create zim files. The articles for the files are read from a postgresql database. The schema for the database is documented in the zimwriter source. The current implementation has a abstraction for the data source, so that it will be possible to implement other data sources (as a replacement to the database) e.g. the file system.

Fulltext search index

The fulltext search, implemented in zimlib and used in zimreader, needs an index file. The index file is ZIM file with special articles in namespace "X". The indexer, which creates that index file is implemented as a data source in zimwriter. It reads the articles from a zim file to create the full text index. To use it, pass -Z zimfile to the writer e.g. zimwriter -Z wikipedia-de.zim wikipedia-de-x.zim.

Requirements

If you compile the software from source you need the following libraries installed:

  • cxxtools (version 2.0)
  • tntdb (for zimwriter) (release 1.1)
  • tntnet (for zimreader) (release 2.0)
  • libxz-dev
  • autoconf
  • automake
  • libtool

See also