Giter Site home page Giter Site logo

argenos / zotero-mdnotes Goto Github PK

View Code? Open in Web Editor NEW
1.3K 19.0 84.0 2.79 MB

A Zotero plugin to export item metadata and notes as markdown files

Home Page: https://argenos.github.io/zotero-mdnotes/

License: GNU General Public License v3.0

JavaScript 97.79% Makefile 2.21%
zotero obsidian markdown zotero-plugin zotfile-extracted-annotations zotero-notes obsidian-md

zotero-mdnotes's Introduction

Mdnotes

A Zotero plugin to export item metadata and notes as markdown files.

Features

Right now the menu is not context-aware, so read below to see what has to be selected for the menu to correctly create the files. Note that the output of the following options depends on your configuration, the options below apply for the default settings:

What you want to do What to select Menu
Export Zotero item metadata file Zotero Item Export to markdown
Export Zotero notes to markdown Zotero Note Export to markdown
Create a file for your own notes Zotero Item Create mdnotes file
Batch export all of the above Zotero Item Batch export to markdown

With the exception of Create mdnotes file (for your own notes), you will be asked to choose a path. The file name(s) are automatically chosen based on the naming convention described in the section for each menu.

To access the menu right-click on an item or note:

mdnotes-batch

Requirements

Tested with Zotero v5.0.89 in Ubuntu 18.04.

It is highly recommended that you have the following plugins installed:

I have not tested without them, so I can't guarantee nothing will break.

Installation

You can install the plugin in Zotero as described here:

To install a plugin in Zotero, download its .xpi file to your computer. Then, in Zotero, click “Tools → Add-Ons”, then drag the .xpi for the plugin onto the Add-Ons window that opens

You can grab the latest version of zotero-mdnotes here.

Acknowledgements

This plugin is based and was inspired by zotero-roam-export.

zotero-mdnotes's People

Contributors

argenos avatar einalex avatar glunk avatar huangyxi avatar jmuccigr avatar knavynde avatar nathanlesage avatar nicolindemann avatar philipmottershead avatar rlam3 avatar rxy0424 avatar xfap avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

zotero-mdnotes's Issues

Export to markdown creating links even though 'no links' option is selected

Describe the bug
I have the 'No links' options selected in mdnotes preferences. Still, when I export to markdown, the authors' names have wiki-style links

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'Mdnotes preferences'
  2. Click on 'Internal Links > No links'
  3. Click Ok
  4. Select a Zotero item > export to markdown
  5. Look at note, author will have links

Expected behavior
I expected 'export to markdown' to generate a note with metadata in plain text (with no links)

Screenshots
If applicable, add screenshots to help explain your problem.
image
image

Desktop (please complete the following information):

  • OS: Windows 8
  • Zotero version: v5.0.93
  • Mdnotes version: v0.1.2
  • Zotfile version: v5.0.16
  • BetterBibtex version: v5.2.89

Additional context
Thanks for all your work argenos, you and your software are really awesome! It would be great if this issue could be resolved, but even if not, your add-on is still amazing as is 👍

List format choices

Would it be possible to choose the format for markdown lists? Currently, we have "*". It would be great to choose "-" for unordered lists as well. Also, some might find numbered lists and task/to-do lists helpful.

Include parent collections in topics

It seems that parent collection(s) is not included unless one item is manually added to the parent collection(s). Would it be possible to include the parent collection(s) as an option? Thank you!

Change the batch exportation md file name

Thanks for the template version, it is amazing!!

Is there a way to have more control on the batch exportation md file name?
I unchecked "Use the item's citekey as title?" but the title is with hyphens: "This-is-the-title.md". I know that we can edit the prefix and suffix, but I need to store the batch exportation file with something like ".md", and without changing the bibtext citation key

Multi Word Keywords in Zotero get split as TAG's (#)

I have a lot of Multi Word Keywords in Zotero (Names, Occupations and so on).

But when exporting to MD and open in i.e. Obsidian, only the first Word or Character are converted to a TAG when there are spaces in the Zotero Keyword.

Would it be possible to automatically eiter replace all spaces in a Keyword with i.e. a "_" underscore, or to get Multi Word TAG in the MD files?

This happens when I try to use hashtag.

A good additional alternative formulti word keywords there all words are multi character (i.e. more than 3 char) would be to automatically create sub-tags (i.e. CamelBack or Hyphen based)...

As it is now, I got a lot of single Character TAG's in i.e. Obsidian or Zettlr.

I use multi word keyword to tag both Workflow based notations and Content in Zotero, and it would be great if it was possible to get this reflected in the MD files...

collapse the entries in context menu

It's merely my personal opinion but, the four entries added by mdnotes are overwhelming and make my context menu messy. Please consider collapsing them into a second-level menu.

Batch export naming behaviour

Hi,

I'm having an odd issue, there is a high chance it is a bug :
With

  • Use the item's citekey as title? unchecked and
  • Single file organization

In Internal Links, switching from [[Wiki style]] to any of the two other styles weirdly affects the naming of the file : caps are off and there are hyphens between words.

Example :

Wiki : An Automatic Monitoring System for High-Frequency Measuring and Real-Time Management of Cyanobacterial Blooms in Urban Water Bodies.md
No link or markdown : an-automatic-monitoring-system-for-high-frequency-measuring-and-real-time-management-of-cyanobacterial-blooms-in-urban-water-bodies.md

Thanks for your work, by the way!

Export md to clipboard

Is your feature request related to a problem? Please describe.
I am using Zotero in combination with Obsidian. I used mdnotes to quickly copy over metadata from my Zotero database into my Vault. For this, I am exporting an item of my library to a temporary md file. Afterward, I copy the content of this md file into my vault.

Describe the solution you'd like
For me, it would be much faster, if I could not create a md file but copy the md content directly to the clipboard.

Blockquotes in notes not consistently formatted

In zotero, I mark citations within extracted (via zotfile) highlights as blockquotes. This leads to source code like this:

<p>"Arthur De Vany and W. David Walls, have constructed a very convincing model for the film industry [...]</p>
<blockquote>
<p>Film audiences make hits or flops ... not by revealing preferences they already have, but by discovering what they like. when they see a movie they like, they make a discovery and they tell their friends about it; reviewers do this too. This information is transmitted to other consumers and demand develops dynamically over time as the audience sequentially discovers and reveals its demand ... A hit is generated by an information cascade ... A flop is an information bandwagon too; in this case the cascade kills the film."</p>
</blockquote>

In the generated markdown file it is marked just the other way around and thus wrongly:

> "Arthur De Vany and W. David Walls, have constructed a very convincing model for the film industry [...] 

Film audiences make hits or flops ... not by revealing preferences they already have, but by discovering what they like. when they see a movie they like, they make a discovery and they tell their friends about it; reviewers do this too. This information is transmitted to other consumers and demand develops dynamically over time as the audience sequentially discovers and reveals its demand ... A hit is generated by an information cascade ... A flop is an information bandwagon too; in this case the cascade kills the film."

Color Dictionary

Is your feature request related to a problem? Please describe.

Referencing to the request for color dictionary at #8

Describe the solution you'd like

To assign "names" to annotation colors and types (much like in Highlights App for Mac). It seems that the customization might be possible by manually changing the settings for Zotfile annotation extraction.

20200910152747@2x

Additional context

Only "Batch export to markdown" gives me expected behaviour of copying the content of highlights and notes into markdown file

Describe the bug
A clear and concise description of what the bug is.

I don't know if it is a bug or a feature - but if it is a feature it isn't intuitive to me.
I have used zotflie to "Export Annotations"
Only "Batch export to markdown" gives me expected behaviour of copying the content of highlights and notes into markdown file.

  • The "export to markdown" option result, which link to nonexisting note in Obsidian
## Highlights and Annotations

- [[cohen2017 - Extracted Annotations (05122020, 145108)]]
  • Create Mdnotes file
## Notes
- 
  • Batch export
## Highlights and Annotations

- [[cohen2017 - Extracted Annotations (05122020, 145108)]]

* Mdnotes File Name: [[cohen2017]]

# Extracted Annotations (2020-05-12)

> "**(Yellow)** - The concept of "Truth" needs a different definition in biology compared to physics. The mathematical laws of the universe do not vary according to the seasons or the number of hours since a good meal. Maxwell's equations for electromagnetic wave propagation are not influenced by cultural background or by genetic disorders" ([Cohen 2017:80](zotero://open-pdf/library/items/FLQZ3X3K?page=1))

aaaaa ([note on p.80](zotero://open-pdf/library/items/FLQZ3X3K?page=1))

> "**(Red)** - The purpose of this paper is to discuss some issues related to replications in thefield of cognitive electrophysiology, which generally refers to using the brain's electromagneticfields in order to understand aspects of cognition and how cognitive processes are implemented by neural circuits in the brain. " ([Cohen 2017:80](zotero://open-pdf/library/items/FLQZ3X3K?page=1))

Expected behavior
"Export to markdown" will copy content of the highlights and annotation to markdown note.

The effect should be something like that

## Highlights and Annotations

> "**(Yellow)** - The concept of "Truth" needs a different definition in biology compared to physics. The mathematical laws of the universe do not vary according to the seasons or the number of hours since a good meal. Maxwell's equations for electromagnetic wave propagation are not influenced by cultural background or by genetic disorders" ([Cohen 2017:80](zotero://open-pdf/library/items/FLQZ3X3K?page=1))

aaaaa ([note on p.80](zotero://open-pdf/library/items/FLQZ3X3K?page=1))

> "**(Red)** - The purpose of this paper is to discuss some issues related to replications in thefield of cognitive electrophysiology, which generally refers to using the brain's electromagneticfields in order to understand aspects of cognition and how cognitive processes are implemented by neural circuits in the brain. " ([Cohen 2017:80](zotero://open-pdf/library/items/FLQZ3X3K?page=1))

Should I use templates to use this result?

Desktop (please complete the following information):

OS: [MacOS Big Sur]
Zotero version: [v5.0.93]
Mdnotes version: [ v0.1.2]
Zotfile version: [v5.0.16]
BetterBibtex version: [v5.2.89]

Export item metadata in YAML frontmatter

Thanks for the very useful tool. These may be good ideas for enhancements. Since they're related, I'm putting them in one issue.

  1. Instead of exporting each field in brackets, e.g. [[Title]], give the option of using YAML format, e.g., title: and enclosing the fields in a YAML header (---/...).

  2. Export the fields as it's done now, but also enter information in corresponding YAML fields defined by Zettlr or pandoc. E.g., still export [[Title]], but also initialize a YAML header with title:

  3. Modify the exported MD file so it starts with a generic YAML header (with or without appropriate fields initialized, as in 2); this would eliminate one step in initializing a literature zettel.

"Titles" for different item types

Is your feature request related to a problem? Please describe.

Currently, only ProceedingsTitle is available.

Describe the solution you'd like

Allow other types of titles to be used (e.g., publication, website, blog)
I have added other types of "titles" in the preference file here

Additional context

To add these "title" types manually, here are the settings & values copied out of Zotero:

  • publicationTitle
    • extensions.mdnotes.placeholder.publicationTitle;{"content":"{{bullet}} Publication: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • programTitle
    • extensions.mdnotes.placeholder.programTitle;{"content":"{{bullet}} Program: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • websiteTitle
    • extensions.mdnotes.placeholder.websiteTitle;{"content":"{{bullet}} Website: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • blogTitle
    • extensions.mdnotes.placeholder.blogTitle;{"content":"{{bullet}} Blog: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • bookTitle
    • extensions.mdnotes.placeholder.bookTitle;{"content":"{{bullet}} Book: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • encyclopediaTitle
    • extensions.mdnotes.placeholder.encyclopediaTitle;{"content":"{{bullet}} Encyclopedia: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • forumTitle
    • extensions.mdnotes.placeholder.forumTitle;{"content":"{{bullet}} Forum: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}
  • shortTitle
    • extensions.mdnotes.placeholder.shortTitle;{"content":"{{bullet}} Short Title: {{field_contents}}", "field_contents": "{{content}}", "link_style": "wiki"}

Format Date

Is your feature request related to a problem? Please describe.

Thank you so much for the recent update!

Currently, the date formats for the "Date" field are not consistent. This seems to be a known issue for Zotero. In contrast, "Date Added" is consistently formatted in "YYYY-MM-DD"
20201116175737@2x
20201116175724@2x
20201116175712@2x

Describe the solution you'd like

Would it be possible to format "Date" in the same format as "Date Added"?

Additional context

Is there a way to set the prefix?

Is there a way to set the prefix of the note being exported?

In addition to the -zotero I'd like to use a prefix before the citation key. Thank you!

Export markdown notes not working on windows

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

  1. Right click on pdf and choose extract annotations
  2. Right click on extracted annotations and click on Export to markdown
  3. Choose the folder
  4. Nothing appears in the folder

However, if you right click on the reference item (the top level item), and choose export, there will be a .md file for the reference, but not the notes.

Expected behavior
extracted markdown notes.

Screenshots
Zotero 2020-11-16 13-02-44.zip
image
image

Desktop (please complete the following information):

  • OS: Windows 10
  • Zotero version: 5.0.93
  • Mdnotes version: 0.0.7
  • Zotfile version: 5.0.16
  • BetterBibtex version: 5.2.86

Seperated notes and integration notes

Would it be possible to export 2 types of file:

  1. Notes and highlights are export separately (each note and highlights will have their own unique ID)
  2. The integration file. This file will have the article metadata and it also embed all the notes and highlights (![[highlight unique ID]])
    So the integration file would look like this:
    https://ibb.co/hmMT14t

Incorrect output of "Date Added"

With the latest update, the outputs of "Date Added" are incorrect that:

  1. "2020-01-23" becomes "2020-00-23"
  2. "2020-02-01" becomes "2020-01-01"

Keep notes updated after changes in Zotero

Originally posted as a question in #5 and in Obsidian's forum, the main idea would be

a similar workflow as Better-BibTeX to keep exported notes updated when things change in the Zotero side, so there would be no need to re-export to update highlights and annotations.

Export note with its "related" links and tags

There is valuable information collected in the "tags" and "related" fields that it is lost when converted to md. It would be amazing to be able to keep it.

A decision has to be made on how to keep it: my understanding is that different md editors manage internal links differently. I guess the more standard the better.

Custom internal link style

Is your feature request related to a problem? Please describe.
Currently, for internal link style, we can choose between no link, [[wikilink]], and [markdown](link). However, I find a different link format to work better with my setup.

Describe the solution you'd like
Ability to customize the link format. The user would have a %c where the link's content would go.

Additional context
I already added this functionality on my local version of zotero-mdnotes. However, I haven't added a preference that enables/disables lowerCaseDashTitle, so this isn't perfect, since it's not ideal for wikilinks. Nor have I added a way to escape the %c with a backslash, in case anyone wants to. Still, it works!

Example
If someone wanted to add some emoji to their exported notes:

image

Collections and sub Collections as folder-structure

Is it somehow possible to export the Collection structure as a folder structure?
Or can you add this function?

I have seen someone asking for all Parent Collections (i.e. the complete structure) as "Topics"
If you are to implement this, would it be possible for you to add a feature to choose either "Topic" or "Folder Structure" or both?

Great tool... I have looked for something like this for a long time, so thanks...

doesn't work

I have created the extracted annatations from PDF file which was mark lots of notes. However, when I selected the note file created by zotfile, then select batch export to markdown, and I choose the folder. It doesn't creat any file in this folder. Why would this thing happen?
Thank you in advance.

image
image

Can't get linked pdfs (dropbox) from zotero to show up in exported md file

Hi there,
Thanks so much for making this xpi. I have been able to get this working, but cannot figure out why the links to my pdfs are not showing up in the md note that gets created after batch export. I have all my pdfs stored in dropbox and linked to the references inside zotero. I have no trouble accessing the pdfs from inside zotero (I can easily open them in my default app). Whenever I do an export, the items (notes) under the reference get exported, as does the metadata. A local link to the citation also gets exported (so if I click on the link in my exported md note in Obsidian, it will open the citation in Zotero). However no cloud link (e.g. to the pdf of the articles themselves) is never created). I'm not sure how to get a link to the actual pdf to show up inside my exported notes. I Have zotfile and Betterbibtex installed and have checked for issues with naming conventions possibly causing issues, but haven't found any. I'm on the latest version of Zotero and zotero-mdnotes (on Mac).
Side Question: Is there a way for annotations on pdfs to be auto-extracted and auto-exported into the md note?
Thanks!

Update stuck in v0.0.6

Even when i installed the 0.0.7 from this website, Zotero will auto "update" it to 0.0.6.
And it will keep updating 0.0.6 everytime i click update addon. (0.0.6 -> 0.0.6)

PDF Table of Contents - Missing Links

Hello,

Thank you for this add-on, it has become an important part of my reading workflow and habit.

I like to extract Table of Contents from long PDFs into my zotero notes using zotfile, to help structure my notes.
As you know, "Batch export to markdown" doesn't export the ToC extracted by zotfile. As a workaround, I create a new note item, and copy-paste the ToC into it.

The resulting "Batch export to markdown" only converts one link out of two, in alternation.

Example output:

[Chapter 1](zotero://open-pdf/0_XXXXXXXX/68)
Chapter 2
[Chapter 3](zotero://open-pdf/0_XXXXXXXX/106)
Chapter 4
[Chapter 5](zotero://open-pdf/0_XXXXXXXX/147)

The links are definitely there in the note created by zotfile, and are retained after I paste them in the new note item. From the zotero notes, I can click and open all of the PDF chapters.

Is there a possible fix for the output to consistently generate links or, alternatively, would it be possible to have the option to extract the PDF ToC when available?

Thank you!

Links in capital letters

Hey,
I'm still enjoying using MdNotes so far, thank you!

I might be wrong, but it seems that link names from tags and collections (so I assume all of them) that are natively in full capital letters are transformed into a lower case word, with the exception of the first letter. Is there something I missed? It's quite annoying for acronyms.

Example :

  • Zotero tag : GITHUB
  • MD link : [[Github]]

Oh by the way, I think it is expected to be implemented in the next version, but could there be a possibility to choose, among the metadata to export, the format for each item (ex : collections as links, publication type as tags, author names as plain text, etc).

Thanks!

How to create .md note from Zotfile extracted annotations?

Hi, this seems very useful to me but I can't figure out how to get Zotfile extracted annotations exported to a .md note as illustrated in the readme.md file. I selected the note and tried 'export' but no file was created. I also don't understand the difference between 'create notes file' and 'export Zotero note to markdown'. Is the item supposed to be highlighted or is a specific note supposed to be highlighted? Thanks for the help.

Standard template little concern

Hi,

Very nice to see the update, great work! The template and placeholders customisation features are amazing, an excellent idea.
I also greatly appreciate to see our concerns be addressed. Thank you.
The default update stuck to 0.1.0 so I had the ghost link issue until updating to 0.1.2 but that's a small concern.

A very little issue : the standard template is written is such a fashion that if the zotero file is not tagged (uncommon, I know) the resulting "Tag" line on the MD will be , #zotero, #literature-notes, #reference instead of - Tags: #zotero, #literature-notes, #reference for example.

By the way, I think that {{abstractNote}} is missing from the placeholders dictionary of the wiki.

Edit : Removed my previous comments on {{noteContent}} to make a proper ticket.

Underlined texts are as the heading

The underlined texts in PDF which are annotated by PDF Expert are always extracted as Heading 4.

I'd like to make the underlined texts normal body like the highlighted texts. Please fix it. Thank you!

Screenshot are as follows.

截屏2020-10-21 16 01 12

截屏2020-10-21 16 01 32

Including authors name in the title

I am using the export to a single file (metadata and annotations).
Is it possible to include the authors name or Author et al. in the notes title?

URL field not included in markdown file

Describe the bug
The URL field is not included in the generated markdown file(s), despite being marked as "to export" in the settings page.

To Reproduce
Make sure "URLS" is selected in "to export".
Right click on zotero entry and select "batch export to markdown"

Expected behavior
Markdown file containing the URL field.

Screenshots
image

Desktop (please complete the following information):

  • OS: Ubuntu 20.10 (Pop Os)
  • Zotero version: 5.0.93
  • Mdnotes version:v0.0.7
  • Zotfile version: v5.0.16
  • BetterBibtex version: v5.2.84

Additional context
N/A

Small extra question: Is there any way to remove the "Zotero Links" field from the generated markdown file?

Thank you for your great work!

http to doi

Would it be possible to (have an option to) add the http in the doi links?

Current : *DOI: [10.0000/pr6000001](10.00000/pr6000001)
Suggestion : *DOI: [10.0000/pr6000001](https://doi.org/10.00000/pr6000001)

Export markdown notes doesn't work with zotero-shortdoi plugin active

Describe the bug
A clear and concise description of what the bug is.

To Reproduce

Right click on pdf and choose extract annotations
Right click on extracted annotations and click on Export to markdown
Choose the folder
Nothing appears in the folder

A clear and concise description of what you expected to happen.

  • A extracted md file will appear.

Screenshots
If applicable, add screenshots to help explain your problem.

My settings
image
image

Desktop (please complete the following information):

  • OS: [MacOS Big Sur]
  • Zotero version: [v5.0.93]
  • Mdnotes version: [ v0.1.2]
  • Zotfile version: [v5.0.16]
  • BetterBibtex version: [v5.2.89]

Additional context
Add any other context about the problem here.
The md file is saved as
undefinedthe-involvement-of-endogenous-neural-oscillations-in-the-processing-of-rhythmic-input-more-than-a-regular-repetition-of-evoked-neural-responsesundefined.md
the name of the pdf is Zoefel et al. - 2018 - The Involvement of Endogenous Neural Oscillations in the Processing of Rhythmic Input More Than a R.pdf
The author and citation of the item are defined in the Zotero.

The link to the physical pdf has the "wrong" path

When I create a metadata note using the "Create Zotero item metadata file" or "Create Notes file" buttons it does create the expected .md files at the folder location that I have specified. As you describe in the readme the link to the physical pdf attachment looks something like

  • PDF Attachments: [Chen et al. - 2020 - Quantum Extremal Islands Made Easy, Part I Entang.pdf](zotero://open-pdf/library/items/V94J57B5)

However, for me (Ubuntu 20.04) Zotero stores that pdf in the location /home/vasko/ownCloud/Zotero/storage/V94J57B5.

How can I change the path to the pdf file that gets populated in the markdown style link?

Template for own Notes file

I would like another feature if possible:

an option that allow customed content of Notes file.

Example:

preferences -> note file setting:
Custom Format:

### Research Question

### Hypotheses

### Methods/Measures

### Key Findings

Result:

image

Switch to joplin-turndown for a better HTML-to-Markdown conversion

Hello there! I've already created a Pull Request because I read the contributing guidelines only after I already implemented the changes, so first of all: sorry for that! 😕 But I want to accomodate how you want things handled here with this issue.

Is your feature request related to a problem? Please describe.

The problem I faced while first using this plugin was that I have amended my Zotfile settings to spit out actual well-formed HTML (instead of simple paragraphs with quotes, my Zotfile produces blockquotes, as it should be). With the current implementation of the HTML-to-Markdown-conversion, this produces ugly results.

Describe the solution you'd like

As you may see reviewing the PR, the solution is to switch to Joplin Turndown for making the HTML->MD-conversion. This allows for any amount of notes and any possible input to be well-formed into correct Markdown.

Additional context

Here it gets complicated: I already have done quite some work which does not interfere with the rest of the plugin at all. It simply exchanges the current HTML-MD-conversion to a more complete one. However, the way I have set up the PR, it both doesn't interfere with the rest of the plugin, but also enables to make the plugin itself more maintainable. I would volunteer to refactor, if, but only if, you are fine with this.


The PR can be found here.

Bibliography export

Now that the cite key is exported, it would be great that the bibliography can be exported in the default format at the same time, please consider adding it, thanks a lot!

{{noteContent}} not working in every file format

(I posted this in #43 as comments, but I am rewriting it properly here for the sake of clarity.)

I can't figure out how to configure a template to include my highlights and annotations. I use the single file approach, with some metadata, links and annotations and I didn't manage to include the later in my MD files.

It seems that {{noteContent}} only works in the files that use the Zotero Note Template.md format. And as far as I know, there is no command to export that single file in the right-click menu, with the single file organisation.
It is included in the batch export, but I don't think we have its template available to document what it does.

Format template fields

Currently fields are like this:

{{title}}
{{citekey}}
{{related}
{{collections}}
{{tags}}, #zotero-notes

Describe the solution you'd like
It would be nice to preformat the template, so it could be like this

{{title}}
*{{citekey}}*
*{{related}}*
**{{collections}}**
**{{tags}}**, #zotero-notes

Currently this comes out as:

image

Ideally it could be:

  • Cite key: campbellDickensCholeraBig2019
  • Related: [[aidenUnchartedBigData2013]]
  • Topics: [[DigitalHumanities]], [[Big Data]]
  • Tags: #Data, #DigitalHumanities, #zotero-notes

Make Item Notes Title and Item Title different

Currently Item Notes Title and Item Title are the same thing, so if I have

{{title}}
{{citekey}}
{{related}}
{{collections}}
{{tags}}, #zotero-notes

It shows up as
image

Later on in my "batch export" it gets to the Zotero Note Template, which is

{{title}}
{{tags}}
{{related}}


{{noteContent}}

Rendered as:

image

It would be nice if I could make it H2, so:

Extracted Annotations

Tags: #testtag

However in the advanced config because title and title is the same I cannot specify that I want a H2 header. It looks like you tried to allow this, but it doesn't quite work

image

Headings in notes not formatted

Thank you for this fantastic tool, I just started using it and think its going to be fantastic!

I notice that the export notes to markdown readme shows manually created notes and zotfile annotations carrying formatting over from zotero. When I export my own notes, which often have chapter of section headings those headings aren't reflected in the output markdown note. Perhaps I've failed to properly adjust a setting, but if not I wanted to bring this to your attention. Thank you again for your efforts on this very awesome tool.

Win 10
Zotero 5.0.92
Zotero-mdnotes 0.0.7

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.