package oepub

  1. Overview
  2. Docs

Module Oepub.NavSource

Module representing the Navmap with its Navpoint contained in toc.ncx

Sourcetype point = {
  1. id : string;
  2. play_order : int;
  3. title : string;
  4. src : string;
  5. htmlref : string option;
}

the type of navpoint

Sourcetype map = point list

the type of navmap

Sourceval compare_play_order : point -> point -> int

compare_play_order lhs rhs compares lhs and rhs only by their point.play_order field. This functions is useful if you want to sort a collection by the point.play_order