Add Copy markdown to copy citation (#13387)

* fix:Added copy Markdown to copy citation #12552.

* fix:Added copy Markdown to copy citation #12552.

* fix:Added copy Markdown to copy citation #12552.

* fix:Added @VisibleForTesting in method processMarkdown  #12552.

* fix:submodule removal

* fix:Added @VisibleForTesting in method processMarkdown  #12552.

* Revert submodule changes to match main

* Reset submodule pointers to match main branch

* refactor:removed unecessary debugging statements and whitespace stripping.

* refactor:used List.of instead of Array.asList

* Add CHANGELOG.md entry

---------

Co-authored-by: Tushar <[email protected]>
Co-authored-by: Oliver Kopp <[email protected]>
Co-authored-by: Carl Christian Snethlage <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -21,6 +21,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added the field `monthfiled` to the default list of fields to resolve BibTeX-Strings for [#13375](https://github.com/JabRef/jabref/issues/13375)
 - We added a new ID based fetcher for [EuropePMC](https://europepmc.org/). [#13389](https://github.com/JabRef/jabref/pull/13389)
 - We added an initial [cite as you write](https://retorque.re/zotero-better-bibtex/citing/cayw/) endpoint. [#13187](https://github.com/JabRef/jabref/issues/13187)
+- We added "copy preview as markdown" feature. [#12552](https://github.com/JabRef/jabref/issues/12552)
 - In case no citation relation information can be fetched, we show the data providers reason. [#13549](https://github.com/JabRef/jabref/pull/13549)
 
 ### Changed

jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java

@@ -19,6 +19,7 @@ public enum StandardActions implements Action {
     COPY_KEY_AND_LINK(Localization.lang("Copy citation key and link"), KeyBinding.COPY_CITATION_KEY_AND_LINK),
     COPY_CITATION_HTML(Localization.lang("Copy citation (html)"), KeyBinding.COPY_PREVIEW),
     COPY_CITATION_TEXT(Localization.lang("Copy citation (text)")),
+    COPY_CITATION_MARKDOWN(Localization.lang("Copy citation (markdown)")),
     COPY_CITATION_PREVIEW(Localization.lang("Copy preview"), KeyBinding.COPY_PREVIEW),
     EXPORT_TO_CLIPBOARD(Localization.lang("Export to clipboard"), IconTheme.JabRefIcons.EXPORT_TO_CLIPBOARD),
     EXPORT_SELECTED_TO_CLIPBOARD(Localization.lang("Export selected entries to clipboard"), IconTheme.JabRefIcons.EXPORT_TO_CLIPBOARD),

jabgui/src/main/java/org/jabref/gui/maintable/RightClickMenu.java

@@ -192,7 +192,8 @@ private static Menu createCopySubMenu(ActionFactory factory,
         if (previewPreferences.getSelectedPreviewLayout() instanceof CitationStylePreviewLayout) {
             copySpecialMenu.getItems().addAll(
                     factory.createMenuItem(StandardActions.COPY_CITATION_HTML, new CopyCitationAction(CitationStyleOutputFormat.HTML, dialogService, stateManager, clipBoardManager, taskExecutor, preferences, abbreviationRepository)),
-                    factory.createMenuItem(StandardActions.COPY_CITATION_TEXT, new CopyCitationAction(CitationStyleOutputFormat.TEXT, dialogService, stateManager, clipBoardManager, taskExecutor, preferences, abbreviationRepository)));
+                    factory.createMenuItem(StandardActions.COPY_CITATION_TEXT, new CopyCitationAction(CitationStyleOutputFormat.TEXT, dialogService, stateManager, clipBoardManager, taskExecutor, preferences, abbreviationRepository)),
+                    factory.createMenuItem(StandardActions.COPY_CITATION_MARKDOWN, new CopyCitationAction(CitationStyleOutputFormat.MARKDOWN, dialogService, stateManager, clipBoardManager, taskExecutor, preferences, abbreviationRepository)));
         } else {
             copySpecialMenu.getItems().add(factory.createMenuItem(StandardActions.COPY_CITATION_PREVIEW, new CopyCitationAction(CitationStyleOutputFormat.HTML, dialogService, stateManager, clipBoardManager, taskExecutor, preferences, abbreviationRepository)));
         }

jabgui/src/main/java/org/jabref/gui/preview/ClipboardContentGenerator.java

@@ -23,6 +23,7 @@
 
 import com.airhacks.afterburner.injection.Injector;
 import com.google.common.annotations.VisibleForTesting;
+import com.vladsch.flexmark.html2md.converter.FlexmarkHtmlConverter;
 
 public class ClipboardContentGenerator {
 
@@ -45,6 +46,7 @@ public ClipboardContent generate(List<BibEntry> selectedEntries, CitationStyleOu
             return switch (outputFormat) {
                 case HTML -> processHtml(citations);
                 case TEXT -> processText(citations);
+                case MARKDOWN -> processMarkdown(citations);
             };
         } else {
             // if it is not a citation style take care of the preview
@@ -120,6 +122,32 @@ static ClipboardContent processHtml(List<String> citations) {
         return content;
     }
 
+    /**
+     * Insert each citation into HTML.
+     * convert HTML to markdown using flexmark.
+    */
+    @VisibleForTesting
+    static ClipboardContent processMarkdown(List<String> citations) {
+        String result = "<!DOCTYPE html>" + OS.NEWLINE +
+                "<html>" + OS.NEWLINE +
+                "   <head>" + OS.NEWLINE +
+                "      <meta charset=\"utf-8\">" + OS.NEWLINE +
+                "   </head>" + OS.NEWLINE +
+                "   <body>" + OS.NEWLINE + OS.NEWLINE;
+
+        result += String.join(CitationStyleOutputFormat.HTML.getLineSeparator(), citations);
+        result += OS.NEWLINE +
+                "   </body>" + OS.NEWLINE +
+                "</html>" + OS.NEWLINE;
+
+        FlexmarkHtmlConverter converter = FlexmarkHtmlConverter.builder().build();
+        String markdown = converter.convert(result);
+
+        ClipboardContent content = new ClipboardContent();
+        content.putString(markdown);
+        return content;
+    }
+
     private List<String> generateTextBasedPreviewLayoutCitations(List<BibEntry> selectedEntries, BibDatabaseContext bibDatabaseContext) throws IOException {
         TextBasedPreviewLayout customPreviewLayout = previewPreferences.getCustomPreviewLayout();
         Reader customLayoutReader = Reader.of(customPreviewLayout.getText().replace("__NEWLINE__", "\n"));

jabgui/src/test/java/org/jabref/gui/preview/ClipboardContentGeneratorTest.java

@@ -138,4 +138,22 @@ void processHtmlAsHtml() {
         Object actual = htmlTransferable.getHtml();
         assertEquals(expected, actual);
     }
+
+    @Test
+    void processMarkdownAsMarkdown() {
+        String expected = "\\[1\\]  \n" +
+                "B. Smith, B. Jones, and J. Williams, \"Title of the test entry,\" *BibTeX Journal*, vol. 34, no. 3, pp. 45--67, Jul. 2016.\n" +
+                "\n" +
+                "\\[1\\]  \n" +
+                "B. Smith, B. Jones, and J. Williams, \"Title of the test entry,\" *BibTeX Journal*, vol. 34, no. 3, pp. 45--67, Jul. 2016.\n";
+
+        String citation = "  <div class=\"csl-entry\">" + OS.NEWLINE +
+                "    <div class=\"csl-left-margin\">[1]</div><div class=\"csl-right-inline\">B. Smith, B. Jones, and J. Williams, “Title of the test entry,” <i>BibTeX Journal</i>, vol. 34, no. 3, pp. 45–67, Jul. 2016.</div>" + OS.NEWLINE +
+                "  </div>" + OS.NEWLINE;
+
+        ClipboardContent markdown = ClipboardContentGenerator.processMarkdown(List.of(citation, citation));
+        String actual = markdown.getString();
+        assertEquals(expected, actual);
+    }
 }
+

jablib/src/main/java/org/jabref/logic/citationstyle/CitationStyleOutputFormat.java

@@ -5,7 +5,8 @@
 public enum CitationStyleOutputFormat {
 
     HTML("html", OS.NEWLINE + "<br>" + OS.NEWLINE),
-    TEXT("text", "");
+    TEXT("text", ""),
+    MARKDOWN("markdown", "");
 
     private final String format;
     private final String lineSeparator;

jablib/src/main/resources/l10n/JabRef_en.properties

@@ -171,6 +171,8 @@ Copy=Copy
 Copy\ title=Copy title
 Copy\ citation\ (html)=Copy citation (html)
 Copy\ citation\ (text)=Copy citation (text)
+Copy\ citation\ (markdown)=Copy citation (markdown)
+
 Copy\ citation\ key=Copy citation key
 Copy\ citation\ key\ and\ link=Copy citation key and link
 Copy\ citation\ key\ and\ title=Copy citation key and title