jabref2obsidian.export.export_note_pages#

jabref2obsidian.export.export_note_pages(entries: list, export_folder: str = 'output/Notes', asset_folder: str = '/Users/kirov/Library/Mobile Documents/iCloud~com~apple~iBooks/Documents/')[source]#

Export a list of notes for the literature entries in markdown format to a specified folder.

Parameters:#

entriesList[dict]

A list of dictionaries, where each dictionary represents a single literature entries. Each dictionary should contain the following keys:

  • 'title' : str : The title of the note.

  • 'groups' : str (optional) : A comma-separated list of groups to which the note belongs.

  • 'author' : str (optional) : The author of the note.

  • 'editor' : str (optional) : The editor of the note.

  • 'file' : str (optional) : The path to the file associated with the note.

  • 'ID' : str : A unique identifier for the note.

  • 'comment' : str (optional) : A comment or literature review associated with the note.

export_folderstr, optional

The path to the folder where the markdown files will be exported. Defaults to 'output/Notes'.

asset_folderstr, optional

The path to the folder where the associated files are located. Defaults to '/Users/kirov/Library/Mobile Documents/iCloud~com~apple~iBooks/Documents/'.

Note

This function creates a new folder at the specified export_folder path, if it does not already exist.

If the folder already exists, its contents will be deleted before creating new files. Each note is exported as a markdown file in the specified export_folder.

The markdown file includes various sections, such as title, asset, citation key, and literature review, depending on the keys present in the dictionary entry.

Any associated files are linked in the asset section, and citation information is also included. If any errors occur during the export process, the function prints an error message and continues with the next note.