fix(misc): fix some minor issues on import and update readme

makaanneo · Dec 3, 2022 · db0193e · db0193e
1 parent 6d7eae9
commit db0193e
Show file tree

Hide file tree

Showing 17 changed files with 476 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -11,19 +11,52 @@ Due to the fact that the PDF text and metadata are stored inside the note they a
 ## Usage
 
 Fill in the required values for the options.
-![Image](assets/JoplinOptions.png)
-
+### regular options
+![Image](assets/JoplinOptionsSimple.png)
+### advanced options
+![Image](assets/JoplinOptionsAdvanced.png)
 And copy PDF files inside the import path to start working.
 
 ## How it works
-These plugin imort files from certain folders, specified inside the settings. For pdf files it will extract some meta data if there as well as text stored inside the pdf (OCR must be done by the scanner application) and stores the text inside a comment block of the note itself.
+These plugin imort files from certain folders, specified inside the settings. For pdf files it will extract some meta data if there as well as text stored inside the pdf (OCR must be done by the scanner application) and stores the text inside a yaml code block of the note itself.
+![Image](assets/Athena_in_action.png)
 
 ## Format in Note
+The format of importat files is:
 
+``` markdown
+# 2022-12-03-simple-test-document.pdf
+[2022-12-03-simple-test-document.pdf](:/450edcc8f9894a3c888f729b0ad87f21)
 
+# metadata
+```
+````
+``` yaml document header
+Name: 2022-12-03-simple-test-document
+Author: ""
+Content: |
+  Part I
+  Lorem ipsum dolor sit amet
+  1  Lorem
+  ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor inci-
+  didunt ut labore et dolore magna aliqua. Nibh sed pulvinar proin gravida.
+  1
+Sender: ""
+Captured: 2022-12-03T13:10:12.124Z
+Created: 2022-12-03T13:09:12.000Z
+FileHash:
+  Algorithm: sha512
+  Hash: 16f6a18bc0797fb235e465bc6475516996911372c5bfe06b6af9180d29bcde95c611027614a4a1d4511a453fe918431016c113b9e42d594ec900138c51b3ad6a
+Metadata: null
+Modified: 2022-12-03T13:09:12.000Z
+Recipient: ""
+ResourceLink: "[2022-12-03-simple-test-document.pdf](:/450edcc8f9894a3c888f729b0ad87f21)"
 
-## Old style (Add function to auto migrate)
+```
+````
 
+## Old style (deprecated)
+The old style can be migrated by a command by selecting multiple notes.
 ```xml
 <!--
 PDFMETADATATEXTSTART
@@ -51,13 +84,9 @@ For the time being the meta data of files is stored inside the note as comment b
 
 ## Roadmap
 
-- [x] Research on better location for metadata and pdf text
 - [ ] Show import status in a status bar with progress
 - [ ] Improve tag handling on import (will be moved to other plugin)
 - [ ] Integrate OCR
-~~ - [ ] Integrate Import of already existing Resources (attached to notes)~~
-- [x] Build on export of files to a special folder for backups (archive directory)
-~~ - [ ] Handle email attachments (other plugin)~~
 - [ ] and a lot more
 
 ## Misc

diff --git a/assets/2022-12-03-complex-test-document.lyx b/assets/2022-12-03-complex-test-document.lyx
@@ -0,0 +1,313 @@
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 544
+\begin_document
+\begin_header
+\save_transient_properties true
+\origin unavailable
+\textclass article
+\use_default_options true
+\maintain_unincluded_children false
+\language english
+\language_package default
+\inputencoding auto
+\fontencoding global
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
+\font_default_family default
+\use_non_tex_fonts false
+\font_sc false
+\font_osf false
+\font_sf_scale 100 100
+\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures true
+\graphics default
+\default_output_format default
+\output_sync 0
+\bibtex_command default
+\index_command default
+\paperfontsize default
+\spacing single
+\use_hyperref true
+\pdf_title "Lorem ipsum dolor sit amet"
+\pdf_author "makaanneo"
+\pdf_subject "Lorem ipsum dolor sit amet"
+\pdf_keywords "Lorem ipsum dolor sit amet, test"
+\pdf_bookmarks true
+\pdf_bookmarksnumbered true
+\pdf_bookmarksopen true
+\pdf_bookmarksopenlevel 1
+\pdf_breaklinks true
+\pdf_pdfborder true
+\pdf_colorlinks true
+\pdf_backref false
+\pdf_pdfusetitle true
+\papersize default
+\use_geometry false
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 1
+\use_package esint 1
+\use_package mathdots 1
+\use_package mathtools 1
+\use_package mhchem 1
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
+\cite_engine basic
+\cite_engine_type default
+\biblio_style plain
+\use_bibtopic false
+\use_indices false
+\paperorientation portrait
+\suppress_date false
+\justification true
+\use_refstyle 1
+\use_minted 0
+\index Index
+\shortcut idx
+\color #008000
+\end_index
+\secnumdepth 3
+\tocdepth 3
+\paragraph_separation indent
+\paragraph_indentation default
+\is_math_indent 0
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0
+\papercolumns 1
+\papersides 1
+\paperpagestyle default
+\tracking_changes false
+\output_changes false
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict false
+\end_header
+
+\begin_body
+
+\begin_layout Part
+Lorem ipsum dolor sit amet
+\end_layout
+
+\begin_layout Section
+Lorem
+\end_layout
+
+\begin_layout Standard
+ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+ incididunt ut labore et dolore magna aliqua.
+ Nibh sed pulvinar proin gravida.
+ Mattis rhoncus urna neque viverra justo nec ultrices dui.
+ Purus ut faucibus pulvinar elementum integer enim.
+ Egestas egestas fringilla phasellus faucibus scelerisque.
+ Aliquam eleifend mi in nulla posuere sollicitudin aliquam ultrices.
+ Sodales neque sodales ut etiam sit amet.
+ Eu lobortis elementum nibh tellus.
+ Auctor urna nunc id cursus metus.
+ Vel turpis nunc eget lorem dolor sed.
+ Odio eu feugiat pretium nibh ipsum consequat.
+ Fames ac turpis egestas integer eget.
+ Nulla aliquet enim tortor at auctor urna nunc id cursus.
+ Ipsum nunc aliquet bibendum enim.
+ Ut faucibus pulvinar elementum integer.
+ Eleifend donec pretium vulputate sapien nec sagittis.
+ Orci a scelerisque purus semper eget duis at tellus.
+ Integer vitae justo eget magna.
+ Tincidunt ornare massa eget egestas purus viverra.
+\end_layout
+
+\begin_layout Subsection
+Varius
+\end_layout
+
+\begin_layout Standard
+sit amet mattis vulputate enim.
+ Feugiat sed lectus vestibulum mattis ullamcorper velit.
+ Id velit ut tortor pretium viverra suspendisse potenti.
+ Faucibus a pellentesque sit amet.
+ Laoreet sit amet cursus sit.
+ Neque volutpat ac tincidunt vitae semper.
+ Ultricies leo integer malesuada nunc vel risus commodo.
+ Ipsum a arcu cursus vitae congue mauris.
+ Posuere ac ut consequat semper viverra nam.
+ Ultrices neque ornare aenean euismod elementum.
+ Ullamcorper eget nulla facilisi etiam dignissim diam.
+ A erat nam at lectus urna duis convallis convallis tellus.
+ Adipiscing vitae proin sagittis nisl.
+ Nunc mattis enim ut tellus.
+ In fermentum posuere urna nec tincidunt praesent semper.
+ Aliquam ut porttitor leo a diam sollicitudin tempor id.
+ Enim nulla aliquet porttitor lacus.
+\end_layout
+
+\begin_layout Subsection
+Volutpat
+\end_layout
+
+\begin_layout Standard
+commodo sed egestas egestas fringilla phasellus.
+ Dolor sed viverra ipsum nunc aliquet bibendum enim.
+ Praesent tristique magna sit amet.
+ Egestas congue quisque egestas diam in arcu cursus euismod quis.
+ Tortor posuere ac ut consequat semper viverra nam libero justo.
+ Sagittis orci a scelerisque purus.
+ Eget dolor morbi non arcu risus quis varius.
+ Lectus vestibulum mattis ullamcorper velit sed ullamcorper morbi tincidunt
+ ornare.
+ Sit amet nisl purus in mollis nunc.
+ Proin sed libero enim sed.
+ Mi in nulla posuere sollicitudin aliquam ultrices sagittis orci.
+ Massa placerat duis ultricies lacus.
+ Consequat ac felis donec et odio pellentesque.
+\end_layout
+
+\begin_layout Section
+Consectetur
+\end_layout
+
+\begin_layout Standard
+a erat nam at lectus urna.
+ Tellus id interdum velit laoreet id donec ultrices tincidunt.
+ Magnis dis parturient montes nascetur ridiculus mus mauris.
+ Ipsum dolor sit amet consectetur.
+ Faucibus a pellentesque sit amet porttitor.
+ Leo duis ut diam quam nulla porttitor massa id neque.
+ Bibendum ut tristique et egestas quis ipsum suspendisse.
+ Sit amet purus gravida quis blandit turpis cursus.
+ Condimentum mattis pellentesque id nibh tortor id.
+ Amet massa vitae tortor condimentum lacinia quis vel eros donec.
+ Congue quisque egestas diam in arcu.
+ Ullamcorper dignissim cras tincidunt lobortis feugiat vivamus.
+ Tortor consequat id porta nibh venenatis cras.
+ Iaculis nunc sed augue lacus.
+ Praesent semper feugiat nibh sed pulvinar proin gravida.
+ Libero enim sed faucibus turpis in eu.
+ Et malesuada fames ac turpis egestas maecenas pharetra convallis posuere.
+ Id ornare arcu odio ut sem nulla pharetra.
+\end_layout
+
+\begin_layout Section
+Tortor
+\end_layout
+
+\begin_layout Standard
+consequat id porta nibh venenatis cras sed.
+ Libero volutpat sed cras ornare arcu dui.
+ Mauris cursus mattis molestie a iaculis at erat pellentesque.
+ Sed lectus vestibulum mattis ullamcorper velit sed.
+ Vitae sapien pellentesque habitant morbi tristique senectus et.
+ Sit amet aliquam id diam maecenas.
+ Mollis nunc sed id semper.
+ Cras sed felis eget velit.
+ Amet luctus venenatis lectus magna fringilla.
+ Nec feugiat nisl pretium fusce id velit ut.
+ Dictum sit amet justo donec enim diam vulputate.
+ Risus ultricies tristique nulla aliquet enim tortor.
+ Vel pharetra vel turpis nunc eget lorem dolor.
+ Sit amet commodo nulla facilisi nullam vehicula.
+ In pellentesque massa placerat duis ultricies.
+ Accumsan tortor posuere ac ut consequat semper viverra.
+ Magna etiam tempor orci eu lobortis elementum.
+ Amet aliquam id diam maecenas ultricies mi eget.
+ Laoreet sit amet cursus sit amet dictum sit amet justo.
+ Ornare arcu dui vivamus arcu felis bibendum ut.
+\end_layout
+
+\begin_layout Standard
+In eu mi bibendum neque egestas congue quisque egestas.
+ In tellus integer feugiat scelerisque varius.
+ Vel fringilla est ullamcorper eget nulla facilisi etiam dignissim.
+ Tristique risus nec feugiat in fermentum posuere urna nec tincidunt.
+ Sagittis purus sit amet volutpat consequat.
+ Quam viverra orci sagittis eu volutpat odio facilisis mauris.
+ Leo vel orci porta non pulvinar neque laoreet.
+ Eget felis eget nunc lobortis mattis aliquam faucibus.
+ Varius quam quisque id diam vel quam elementum pulvinar etiam.
+ Id donec ultrices tincidunt arcu non.
+ Sit amet luctus venenatis lectus.
+ Sit amet mauris commodo quis imperdiet massa tincidunt.
+\end_layout
+
+\begin_layout Subsection
+Amet
+\end_layout
+
+\begin_layout Standard
+nisl purus in mollis nunc sed id.
+ Ipsum dolor sit amet consectetur adipiscing elit ut aliquam.
+ Habitasse platea dictumst quisque sagittis purus sit amet volutpat consequat.
+ Justo eget magna fermentum iaculis eu non diam phasellus.
+ Massa tempor nec feugiat nisl pretium fusce id velit.
+ Arcu dui vivamus arcu felis bibendum ut.
+ Nunc sed velit dignissim sodales.
+ Turpis tincidunt id aliquet risus feugiat in.
+ Mollis nunc sed id semper risus in hendrerit gravida rutrum.
+ Enim tortor at auctor urna.
+\end_layout
+
+\begin_layout Standard
+Massa sed elementum tempus egestas sed sed.
+ Urna et pharetra pharetra massa massa ultricies mi.
+ Faucibus in ornare quam viverra.
+ Nibh sed pulvinar proin gravida hendrerit lectus.
+ Ante metus dictum at tempor commodo.
+ Id cursus metus aliquam eleifend mi in nulla.
+ Pulvinar mattis nunc sed blandit libero volutpat.
+ Ut eu sem integer vitae justo eget magna.
+ Sapien faucibus et molestie ac feugiat sed lectus.
+ Ornare aenean euismod elementum nisi quis eleifend quam adipiscing.
+ Semper eget duis at tellus at.
+ Risus ultricies tristique nulla aliquet.
+ Tincidunt dui ut ornare lectus sit amet.
+ Consectetur purus ut faucibus pulvinar elementum integer.
+ Et malesuada fames ac turpis egestas integer eget aliquet nibh.
+ Eget magna fermentum iaculis eu non diam phasellus vestibulum.
+ Odio euismod lacinia at quis risus sed vulputate.
+ Egestas purus viverra accumsan in nisl.
+ Nunc aliquet bibendum enim facilisis gravida neque convallis.
+ Eu tincidunt tortor aliquam nulla facilisi cras fermentum odio.
+\end_layout
+
+\begin_layout Subsubsection
+Purus
+\end_layout
+
+\begin_layout Standard
+in massa tempor nec feugiat.
+ Id aliquet risus feugiat in ante.
+ Morbi non arcu risus quis varius quam quisque.
+ Arcu dui vivamus arcu felis bibendum ut.
+ Amet mattis vulputate enim nulla.
+ Sollicitudin ac orci phasellus egestas tellus rutrum.
+ Semper feugiat nibh sed pulvinar proin gravida hendrerit lectus.
+ Tortor id aliquet lectus proin.
+ Commodo odio aenean sed adipiscing diam donec adipiscing tristique risus.
+ Quam adipiscing vitae proin sagittis nisl rhoncus mattis.
+ Facilisis leo vel fringilla est ullamcorper.
+ Massa enim nec dui nunc mattis enim ut.
+\end_layout
+
+\begin_layout Standard
+Vitae ultricies leo integer malesuada nunc vel risus commodo viverra.
+ Quam vulputate dignissim suspendisse in.
+ Aliquet nec ullamcorper sit amet risus nullam.
+ Dui nunc mattis enim ut tellus elementum.
+ Turpis egestas maecenas pharetra convallis.
+ Maecenas volutpat blandit aliquam etiam erat velit scelerisque in dictum.
+ Et pharetra pharetra massa massa ultricies mi quis.
+ Pharetra convallis posuere morbi leo urna molestie.
+ Duis ut diam quam nulla porttitor massa id.
+ Ut tristique et egestas quis.
+ Ultrices neque ornare aenean euismod elementum nisi.
+ Sagittis orci a scelerisque purus semper eget duis.
+ Massa tincidunt nunc pulvinar sapien et ligula ullamcorper.
+ Id donec ultrices tincidunt arcu non sodales neque sodales.
+\end_layout
+
+\end_body
+\end_document
diff --git a/assets/2022-12-03-complex-test-document.pdf b/assets/2022-12-03-complex-test-document.pdf