Export for academicpages.github.io #12806

kaushikaW · 2025-03-23T18:17:15Z

draft for issue #12727

Implemented Steps So Far
File Format Selection:
When the user selects "MARKDOWN" as the export format, JabRef generates Markdown files based on the selected entries.
File Generation Process:
If the user exports the entire library (e.g., 6 entries) and specifies a filename (e.g., "publication"), JabRef creates six separate Markdown files, each corresponding to a different entry.
The files follow the naming convention "doc-fileNo.md" (e.g., doc-1.md, doc-2.md, etc.). (See Screenshot 2.)
Current Layout File Progress:
The markdown.layout file implementation is in progress.
Currently, it correctly saves the title of each entry.

acadeicspages github repo - https://github.com/kaushikaW/kaushikaW.github.io/tree/master

Does my current implementation align with the expected requirements? Are any feedback or adjustments needed?

screenshot 1

screenshot 2

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

koppor

Some initial comments.

This is far away from a complete solutioion.

You HAVE TO create a page using https://github.com/academicpages/academicpages.github.io AND INCLUDE A SCREENSHOT here - otherwise, it does not make sense to work on this task.

koppor · 2025-03-23T19:40:11Z

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

+        // handling Markdown file exporting logic
+        if (getFileType() == StandardFileType.MARKDOWN) {
+            String userProvidedName = file.getFileName().toString();


This is not good architecture. Check how the other exporters do it.

I implemented the exporting logic in separate class as AcademicPagesExporter . can you check whether my process is write . I'm still under development of creating the layout .

koppor · 2025-03-23T19:40:54Z

src/main/java/org/jabref/logic/exporter/ExporterFactory.java

@@ -62,6 +62,7 @@ public static ExporterFactory create(CliPreferences preferences) {
        exporters.add(new EmbeddedBibFilePdfExporter(bibDatabaseMode, preferences.getCustomEntryTypesRepository(), fieldPreferences));
        exporters.add(new CffExporter());
        exporters.add(new EndnoteXmlExporter(preferences.getBibEntryPreferences()));
+        exporters.add(new TemplateExporter("MARKDOWN", "md", "markdown", null, StandardFileType.MARKDOWN, layoutPreferences, saveOrder));


See line 46 - this one should be close to that.

Name is wrong - because Markdown can have different facets. Similar to text - can be structured in many formats (Cff, EndnoteXml, ...). Call it "academicpages.github.io" or similar.

koppor · 2025-03-23T19:44:35Z

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

+                            // The exception indicates that no type-specific layout
+                            // exists, so we
+                            // go with the default one.


Do not use exception for nomral control flow. There is also Files.exist etc.

koppor · 2025-03-23T19:44:48Z

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

+                    }
+
+                    // Write the entry
+                    if (layout != null) {


When can a layout be null?

koppor · 2025-03-23T19:45:44Z

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

+                    Map<EntryType, Layout> layouts = new HashMap<>();
+                    Layout layout;
+
+                    Number.serialExportNumber = 0;


What is this?

koppor · 2025-03-23T19:47:23Z

Related PR: #12220

jabref-machine · 2025-03-29T18:50:13Z

You have removed the "Mandatory Checks" section from your pull request description. Please adhere to our pull request template.

jabref-machine · 2025-03-29T18:50:14Z

Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of [x] (done), [ ] (not done yet) or [/] (not applicable).

trag-bot · 2025-03-29T18:51:01Z

@trag-bot didn't find any issues in the code! ✅✨

jabref-machine · 2025-03-29T18:55:37Z

JUnit tests are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

koppor · 2025-04-01T01:44:01Z

You have removed the "Mandatory Checks" section from your pull request description. Please adhere to our pull request template.

What our bot means: The heading is not existing. Please re-add the heading in your PR description.

koppor · 2025-04-01T01:44:37Z

JUnit tests are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

What our bot means: Reviews are eaiser if automated tests succeed.

koppor · 2025-05-12T21:12:16Z

Think, the AI used for crafting code in this PR changed too much.

Closing this issue due to inactivity 💤 Please ping us if you intend to resume work on this one.

kaushikaW added 2 commits March 23, 2025 23:23

partially implemented the requirement

081bc05

partially implemented the requirement

aa24970

kaushikaW changed the title ~~partially implemented the requirement~~ Export for academicpages.github.io #12727 Mar 23, 2025

kaushikaW changed the title ~~Export for academicpages.github.io #12727~~ Export for academicpages.github.io Mar 23, 2025

koppor requested changes Mar 23, 2025

View reviewed changes

kaushikaW added 2 commits March 29, 2025 20:48

refactor the code with academicExporter

3a84df8

draft PR

b24f101

JabRef deleted a comment from github-actions bot Mar 29, 2025

Merge branch 'main' into fix-for-issue-12727

a3043f8

kaushikaW requested a review from koppor March 29, 2025 18:51

koppor closed this May 12, 2025

Uh oh!

Export for academicpages.github.io #12806

Export for academicpages.github.io #12806

Uh oh!

Conversation

kaushikaW commented Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

koppor Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

kaushikaW Mar 29, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

koppor commented Mar 23, 2025

Uh oh!

jabref-machine commented Mar 29, 2025

Uh oh!

jabref-machine commented Mar 29, 2025

Uh oh!

trag-bot bot commented Mar 29, 2025

Uh oh!

jabref-machine commented Mar 29, 2025

Uh oh!

koppor commented Apr 1, 2025

Uh oh!

koppor commented Apr 1, 2025

Uh oh!

koppor commented May 12, 2025

Uh oh!

Uh oh!

kaushikaW commented Mar 23, 2025 •

edited

Loading