How to edit Mobi file Leave feedback

Mobi format is an E-Book format, developed by the French company MobiPocket and is based on XML. E-Books in this format can contain text with rich formatting, images, and different annotations like bookmarks, notes, highlights, corrections and so on. Mobi books can have a DRM protection.

Starting from the version 23.9 the GroupDocs.Editor for Java is able to save (export) documents in the Mobi format, so from this version it can be said that Mobi is fully supported: on import, export and auto-detection.

Despite of a distinct format, which doesn’t belong to any of existing format families, Mobi has no dedicated loading options. So for loading it into the instance of the Editor class, users should simply specify a path to the Mobi file or a stream with its content in the constructor:

String inputMobiPath = "C://input/book.mobi";
Editor editorFromPath = new Editor(inputMobiPath);
  
FileInputStream  inputMobiStream = new FileInputStream("C://input/book.mobi");
Editor editorFromStream = new Editor(inputMobiStream);

There is no loading options, because Mobi has nothing to tune-up during loading, — it cannot have a password protection, and can be processed only in one way.

Because Mobi belongs to the e-Book format family, it utilize common edit options for all e-Book formats — an EbookEditOptions. This class may be described as a truncated version of a WordProcessingEditOptions class, because EbookEditOptions contains a subset of options from WordProcessingEditOptions — getEnablePagination() and getEnableLanguageInformation() and, as in the WordProcessingEditOptions, they are disabled (false) by default:

public boolean getEnablePagination();
public void setEnablePagination(boolean value);
  
public boolean getEnableLanguageInformation();
public void setEnableLanguageInformation(boolean value);

They have exactly the same meaning as their “siblings” from WordProcessingEditOptions. getEnablePagination() allows to switch between float and paginal mode in the resultant HTML document. getEnableLanguageInformation() allows to enable exporting language information in HTML. This is very useful for books, which have parts of text, written on different languages.

Example of usage is below (let’s assume that Editor instance with loaded Mobi document is already created):

EbookEditOptions editOptions = new EbookEditOptions();
editOptions.setEnablePagination(true);
editOptions.setEnableLanguageInformation(true);
EditableDocument opened = editor.edit(editOptions);
{
    //save it or pass to the WYSIWYG-editor
}

Before the version 23.4, the GroupDocs.Editor for Java was able only to load and edit the Mobi documents, but not to save (export) in the Mobi format. In other words, it was able to open and edit the Mobi document, and then save the edited document in some other format, but not in the Mobi. And in version 23.9 the export in the Mobi format was finally implemented.

For all the format families the saving procedure is the same — it is required to obtain a content of the edited document on the server-side, create an instance of the EditableDocument from it, and then pass it to the com.groupdocs.editor.save() instance method. And because the Mobi format belongs to the e-Book formats family, in order to save the document in the Mobi format a EbookSaveOptions class is required.

This class has a mandatory constructor with a single parameter — a desired e-Book format. For the Mobi it should be a EBookFormats.Mobi. All other parameters in the EbookSaveOptions class are in fact optional, but nevertheless described below:

• getSplitHeadingLevel() of the System.Int32 type controls an internal structure of the generated Mobi file: whether its internal content is divided onto packages and if yes, then how. This parameter exists because a content of the Mobi file is stored in the packages, usually, a package per chapter. And some users may want to control the policy of distribution of the content into the packages. By default its parameter is “2” — the most optimal.
• ExportDocumentProperties of the System.Boolean type also has a relation to the internal structure of the Mobi file — it decides whether to embed the built-in and custom document properties inside the resultant Mobi file (true) or not (false). By default is false — do not embed.

Concluding: in order to save the edited document in the Mobi format, the user should create an instance of the EbookSaveOptions class with EBookFormats.Mobi argument in the constructor parameter, and then pass this instance to the Editor.save() method along with other arguments.

The code example below demonstrates the full roundtrip: opening a Mobi document, editing it, and saving the edited version to the Mobi format.

//Create an Editor instance and load an input Mobi file
Editor editor = new Editor("Input.mobi");

//Create edit options
EbookEditOptions editOptions = new EbookEditOptions();

//Edit the Mobi document and obtain
EditableDocument doc = editor.edit(editOptions);

//Send EditableDocument to the client-side, edit it there, and obtain an edited version

//Create Mobi save options
EbookSaveOptions saveOptions = new EbookSaveOptions(EBookFormats.Mobi);
saveOptions.setExportDocumentProperties(true);//Tune save options

//Save the edited document in a Mobi format
editor.save(doc, "Output.mobi", saveOptions);

//Dispose document and Editor instances
doc.dispose();
editor.dispose();

As for documents of all supporting types, Mobi documents can be detected using a getDocumentInfo() method of the Editor class. In case when a valid Mobi document was loaded into the Editor instance, a getDocumentInfo() will return an instance of a EbookDocumentInfo class, which inherits from IDocumentInfo interface, which, in turn, defines 4 properties: getFormat(), getPageCount(), getSize(), and isEncrypted().

• getFormat() property returns a EBookFormats struct, which for the files with a *.mobi extension can have a Mobi or Azw3 value.
• getPageCount() property returns an approximate number of pages in case of MOBI or AZW3 or a number of chapters in case of ePub. For the Mobi, it is approximate, because Mobi format internally is a set of HTML documents (chapters), which are not separated on pages and even have no strict page dimensions, which allows to split content on page blocks and thus calculate the number of pages. This decision was made by Mobi format designers intentionally to allows variable page size (and count) on different devices — from FullHD displays to smartphones. So, for returning a page count for a Mobi document, GroupDocs.Editor assumes standard A4 page size in a portrait orientation, splits existing document content on such “papers”, and then calculates its count. So the returning number should be treated very carefully and approximately, users should not rely on it.
• getSize() property returns a number of bytes of a Mobi document.
• isEncrypted() property always returns a false value, because Mobi documents cannot be encrypted with password, like PDF or Office Open XML.