Module koplugin.exporter

Export highlights to different targets.

Some conventions:

  • Target: each local format or remote service this plugin can translate to.

Each new target should inherit from "formats/base" and implement at least an export function.

  • Highlight: Text or image in document. Stored in "highlights" table of documents sidecar file.

Parser uses this table. If highlight...text field is empty the parser uses highlight...pboxes field to get an image instead.

  • Bookmarks: Data in bookmark explorer. Stored in "bookmarks" table of documents sidecar file.

Every field in bookmarks._ has "text" and "notes" fields. When user edits a highlight or "renames" bookmark the text field is created or updated. The parser looks to bookmarks..text field for edited notes. bookmarks..notes isn't used for exporting operations.

  • Clippings: Parsed form of highlights. Single table for all documents.

  • Booknotes: Every table in clippings table. clippings = {"title" = booknotes}

Functions

Exporter:exportCurrentNotes () Parse and export highlights from the currently opened document.
Exporter:exportAllNotes () Parse and export highlights from all the documents in History and from the Kindle "My Clippings.txt".
Exporter:exportFilesNotes (files) Parse and export highlights from selected documents.


Functions

Exporter:exportCurrentNotes ()
Parse and export highlights from the currently opened document.
Exporter:exportAllNotes ()
Parse and export highlights from all the documents in History and from the Kindle "My Clippings.txt".
Exporter:exportFilesNotes (files)
Parse and export highlights from selected documents.

Parameters:

  • files table list of files as a table of {[file_path] = true}
generated by LDoc 1.5.0 Last updated 2024-02-29 17:23:34