Difference between revisions of "Zimwriterdb"

From openZIM
Jump to: navigation, search
m (moved ZIMwriter to Zzimwriter)
(See also)
 
(13 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''.
+
''This tool (and page) is not maintained anymore.''
  
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 '''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://github.com/openzim/zimwriterdb/blob/master/db/zim-postgresql.sql in the zimwriterdb source]. The current implementation has an 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.
  
== Create a fulltext serach index ==
+
== 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|namespace ''X'']].
+
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''.
  
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
  
== Binary ==
+
== See also ==
''coming soon...''
+
* [https://github.com/openzim/zimwriterdb Code repository]
 +
* [[Build_your_ZIM_file#buildZimFileFromDirectory.pl|buildZimFileFromDirectory.pl]], a tool able to fill the database
 +
* [[zimlib]]
 +
* [[zimdump]]

Latest revision as of 10:00, 14 December 2020

This tool (and page) is not maintained anymore.

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 in the zimwriterdb source. The current implementation has an 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