Skip to content

INPX format

Denis Shemanaev edited this page Aug 22, 2021 · 3 revisions

inpx

It's a zip file with file extension changed to .inpx that contains next files:

  • collection.info
  • version.info
  • structure.info optional
  • one or more .inp

collection.info

First line: collection name

Second line: collection filename (usually like .inpx but without extension)

Third line: type. 0 - fb2, 1 - non-fb2

Fourth line: description

Example:

My PDF collection
my_pdf_collection
1
My fancy PDF collection of useful stuff.

version.info

One line with collection version. Date is often used as version.

Example:

20170131

structure.info

Specifies the structure of .inp files in archive. Default structure (if this file isn't present):

AUTHOR;GENRE;TITLE;SERIES;SERNO;FILE;SIZE;LIBID;DEL;EXT;DATE;

file.inp

Contains books descriptions. One per line. Line delimiter - \r\n. Line fileds should be in the same order as in structure.info except delimited by 0x04 instead of ;. Field can be empty, i.e. have zero length.

Fields description:

Field Type Description
AUTHOR string One or more authors in format Last name,First name,Middle name: without spaces.
GENRE string One or more genres in format genre_id:. Can be found in Genres.cs.
TITLE string Book title.
SERIES string Book series.
SERNO integer Book number in series.
FILE string File name without extension.
SIZE integer File size in bytes.
LIBID integer Book id in library. Likely to be unique across one .inpx file.
DEL integer? Empty - book is present. 1 - book is deleted.
EXT string File extension without front dot.
DATE string Date of book publication or adding to the library. Must be in format YYYY-MM-DD.
LANG string Book's language. en, ru, etc...
KEYWORDS string Format keyword:.
FOLDER string Folder relative to library root. (this one isn't implemented yet in DotOPDS)

Example:

Shakespeare,William,:<0x04>tragedy:<0x04>Hamlet<0x04><0x04>0<0x04>shakespeare_hamlet<0x04>31878<0x04>1<0x04><0x04>fb2<0x04>1602-07-26<0x04><CR><LF>
Clone this wiki locally