Added a custom Export for academicpages.github.io #14463

GreLucie · 2025-11-29T10:50:03Z

This PR is to add a custom exporter for academicpages.github.io by adding the corresponding layouts.
It also implements a way to export multiple files to this format.

Steps to test

When jabref is running, go to file->Export->Export selected entries ( or all entries) and choose "Academic Pages Markdowns" for the export type.

You can then add the markdown file(s) to your academic page to see it on your own page.

More information about academic pages on the page : https://academicpages.github.io/

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
I added JUnit tests for changes (if applicable)
I added screenshots in the PR description (if change is visible to the user)
I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

github-actions · 2025-11-29T10:50:25Z

Hey @GreLucie!

Thank you for contributing to JabRef! Your help is truly appreciated ❤️

We have automated checks in place, based on which you will soon get feedback if any of them are failing. In a while, maintainers will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs.

Please re-check our contribution guide in case of any other doubts related to our contribution workflow.

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

Siedlerchr · 2025-11-29T14:22:58Z

jablib/src/test/java/org/jabref/logic/exporter/AcademicPagesExporterTest.java

+
+        String content = Files.readString(expectedFile);
+
+        // Verify YAML front matter fields


Please follow the pattern of other tests in that directory, do a full comparison. of the content

Siedlerchr · 2025-11-29T14:23:28Z

CHANGELOG.md

 ### Removed

-## [6.0-alpha.3] – 2025-10-30
+## [6.0-alpha.3] – 2025-11-29


Please revert this change

…uits avec le format exigé de academic pages

…r-issue-12727 # Conflicts: # jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

…Exporter.java

Siedlerchr · 2025-12-01T20:22:44Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.metadata.SelfContainedSaveOrder;

+import org.jetbrains.annotations.NotNull;


Use jspecify nonnull

Siedlerchr · 2025-12-01T20:23:07Z

CHANGELOG.md

 ### Removed

-## [6.0-alpha.3] – 2025-11-29
+## [6.0-alpha.3] – 2025-10-30


is this some automatic tool that always changes the date?

Hello, you told me to revert this change so I went back to the unmodified CHANGELOG for now. I know we have to change it eventually but while this PR is just a draft we decided to change it once all the issues have been fixed.

You can change it at any time - the earlier the better :) -- BUT - do NOT CHANGE RELEASE DATES

Add your change to the "Unreleased" section.

Note: Current diff shows CHANGELOG.md unmodified: https://github.com/JabRef/jabref/pull/14463/files (which is OK at this stage).

…r-issue-12727

koppor · 2025-12-05T23:00:20Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+    /**
+     * Initialize another export format based on templates stored in dir with layoutFile lfFilename.
+     *
+     */


Comment is strange. What is lfFilename? Where does it come from? I think, this is not something a user of the class should know. You can just delete whole JavaDoc comment.

koppor · 2025-12-05T23:00:49Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+
+    private static final Logger LOGGER = LoggerFactory.getLogger(AcademicPagesExporter.class);
+
+    private final String lfFileName;


Do not abbreviate. Use layoutFileFileName or short layoutFile (because you don't have layoutFileContent.

koppor · 2025-12-05T23:02:08Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+     */
+    @Override
+    public void export(@NonNull final BibDatabaseContext databaseContext,
+                       final Path file,


Are you sure that Path may be null?

Annoate all or nothing.

Proposal: Add @NullMarked to the class and mark only things which might be null - I think, there aren't any

koppor · 2025-12-05T23:02:33Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+            Files.createDirectories(exportDirectory);
+
+            for (BibEntry entry : entries) {
+                if (entry.getType() == null) {


Wait, what? When can this happen?

koppor · 2025-12-05T23:03:02Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+                List<BibEntry> individual_entry = new ArrayList<>();
+                individual_entry.add(entry);


Wait, what? Use List.of(entry) directly as parameter in the next line.

koppor · 2025-12-05T23:04:08Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+    }
+
+    private static @NonNull Path getPath(BibEntry entry, Path exportDirectory) {
+        Replace replace_formatter = new Replace();


Why underscores in varable names? In Java, it is camel case.

koppor · 2025-12-05T23:04:24Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+
+    private static @NonNull Path getPath(BibEntry entry, Path exportDirectory) {
+        Replace replace_formatter = new Replace();
+        replace_formatter.setArgument(" ,-");


Thsi is a magic constant - please add a comment why this strange argument.

koppor · 2025-12-05T23:04:37Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+        Replace replace_formatter = new Replace();
+        replace_formatter.setArgument(" ,-");
+        RemoveLatexCommandsFormatter commands_formatter = new RemoveLatexCommandsFormatter();
+        HTMLChars html_formatter = new HTMLChars();


Add all formatters as class variable

koppor · 2025-12-05T23:04:55Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+        HTMLChars html_formatter = new HTMLChars();
+        String title = entry.getTitle().get();
+        String formatted_title = commands_formatter.format(html_formatter.format(replace_formatter.format(title)));
+        SafeFileName safe_formatter = new SafeFileName(); // added custom formatter to remove all characters that are not allowed in filenames


Why? It is obvious - then remove the comment.

koppor · 2025-12-05T23:06:19Z

jablib/src/main/java/org/jabref/logic/layout/format/NumberMonthFormatter.java

+        Optional<Month> month = Month.parse(fieldText);
+        return month.map(Month::getTwoDigitNumber).orElse("01");


Merge this into one line plese.

I think we adressed all of the requested changes in our last commit. More tests were also added by one of our team members.

…porter.java Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

koppor

The exporter should be "intelligent"

Currently, if no PDF exists, it exports

paperurl: 'https://[insert username].github.io/files/[insert filename].pdf'

This is wrong - it has to omit paperurl if there is no PDF.

slidesurl has to be omitted in all cases, because there is "no standard" in JabRef for this.

bibtexurl can always be provided. -- Write the BibEntry to a file.

Use following method:

jabref/jablib/src/main/java/org/jabref/model/entry/BibEntry.java

Line 738 in 058767a

public @NonNull String getStringRepresentation(

For InProceedings, the venue has to be read from booktitle. That means: If journal (getFieldOrAlias) is empty, use Booktitleas venue. DO NOT use Unknownleave it empty.

category should also be mapped: InProceedings is conferences, Article is journals, all other can go into manuscripts.

citation needs to be generaed out of the entry preview

Right part at

paperurl is a file next to the markdown file - just copy the first attached file next to it and link it.

--

insert username is not acceptable. Two options:

Use user from org.jabref.logic.preferences.JabRefCliPreferences#getUserHostInfo - make this method public
Make it configurable in the preferences (for the export for acamdemic pages)
Ask at each export using a dialog

I think, the first option is best.

you can try out the export for yourself using https://github.com/JabRef/jabref-demonstration-libraries/blob/main/chocolate/Chocolate.bib - it has even attached files.

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

koppor · 2025-12-07T20:21:51Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+     * @param databaseContext the database to export from
+     * @param file            the directory to write to
+     * @param entries         a list containing all entries that should be exported
+     * @param abbreviationRepository the built-in repository


Not sure why not all comments start at the same column

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

koppor · 2025-12-07T20:24:39Z

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

+        }
+    }
+
+    private @NonNull Path getPath(BibEntry entry, Path exportDirectory) throws SaveException {


Can the other parameters be null? I don't think so.

Just remove @NonNull and annotate the whole class as @NullMarked. - I assume, no parameter maybe null or is there one?

koppor · 2025-12-07T20:26:51Z

jablib/src/main/java/org/jabref/logic/layout/format/NumberMonthFormatter.java

+/**
+ * Convert the month name into the corresponding number and return 01 by default
+ */
+public class NumberMonthFormatter implements LayoutFormatter {


I think, it should be called MonthNumberFormatter

koppor · 2025-12-07T20:31:42Z

jablib/src/main/java/org/jabref/logic/layout/format/SafeFileName.java

+
+    @Override
+    public String format(String fieldText) {
+        return fieldText.replaceAll("[\\\\/:*?\"<>|]", "");


Please use org.jabref.logic.util.io.FileUtil#getValidFileName

…porter.java Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

jabref-machine · 2025-12-07T22:13:34Z

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. 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 "Source Code Tests / Checkstyle (pull_request)" and click on it.

In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues, commit, and push.

sadok-lajmi and others added 11 commits November 5, 2025 15:51

modification des fichiers qui font la configuration des exporters

48450d4

Adding the empty layouts in resources/resource/layout/academicpages

65bbc44

création du fichier academicpages.article.layout

a4e2fea

utilisation du fichier article.layout pour le new TemplateExporter

3e34b92

generalisation du layout en utilisant academicpages.layout

8e76f57

améliorations au academicpages layout

2799f1d

ajout d'un custom formatter to help with academic layout

be96c94

AcademicPagesExporter

1421e98

test: add AcademicPagesExporter tests

e4a987c

Delete unecessary imports

df7aa05

Changelog

9b12666

github-actions bot added the first contrib label Nov 29, 2025

GreLucie changed the title ~~Fix for issue 12727~~ Added a custom Export for academicpages.github.io Nov 29, 2025

GreLucie added 3 commits November 29, 2025 12:00

Changed CHANGELOG.md

f588da4

trying to fix the CHANGELOG.md

de65527

Adding blankspace in CHANGELOG.md

2d8afcf

Siedlerchr reviewed Nov 29, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java Show resolved Hide resolved

Siedlerchr reviewed Nov 29, 2025

View reviewed changes

CHANGELOG.md Outdated

### Removed

## [6.0-alpha.3] – 2025-10-30

## [6.0-alpha.3] – 2025-11-29

Copy link

Member

Siedlerchr Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this change

sadok-lajmi added 2 commits November 30, 2025 00:05

Correction du nouveau exporter + Cohérence des noms des fichiers prod…

4ea372d

…uits avec le format exigé de academic pages

Merge remote-tracking branch 'origin/fix-for-issue-12727' into fix-fo…

3972b34

…r-issue-12727 # Conflicts: # jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesExporter.java

github-actions bot added the status: changes-required Pull requests that are not yet complete label Nov 30, 2025

GreLucie added 2 commits December 1, 2025 20:34

Reverted the date on the CHANGELOG.md and one change on AcademicPages…

9b8a86d

…Exporter.java

revert all changes to Changelog.md

9087390

Siedlerchr reviewed Dec 1, 2025

View reviewed changes

sadok-lajmi and others added 3 commits December 2, 2025 08:39

format correction for the file : LayoutEntry

655afe3

Merge remote-tracking branch 'origin/fix-for-issue-12727' into fix-fo…

4d7dac1

…r-issue-12727

trying to fix Open Rewrite problem

30e7626

GreLucie added 2 commits December 5, 2025 09:06

Updated CHANGELOG.md

7ccbc6f

added the link to issue 12727

6f25e5c

GreLucie marked this pull request as ready for review December 5, 2025 08:44

koppor requested changes Dec 5, 2025

View reviewed changes

github-actions bot added the status: changes-required Pull requests that are not yet complete label Dec 5, 2025

Update jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesEx…

3c24b32

…porter.java Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 6, 2025

GreLucie and others added 4 commits December 6, 2025 14:00

Adressing some of the comments regarding the PR

b38bed2

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

fe03fc4

Comment added for replaceFormatter.setArgument(' ,-')

c2a06e0

tests: added 4 test cases and specified the SaveException

280a1fb

github-actions bot added the status: changes-required Pull requests that are not yet complete label Dec 6, 2025

AloisHasNeurons and others added 8 commits December 6, 2025 16:36

Fixed submodules?

6a4c5b0

add all formatters as class variable

100fe95

changed a comment

07088a8

Trying to fix indentation in AcademicPagesExporterTest

fcd3db4

Revert change on AcademicPagesExporter

1efe4a2

Fixed some indentation in AcademicPagesExporterTest

488620d

add all formatters as class variable

5d6e3a2

Fixed tests not passing.

91a6a05

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 7, 2025

GreLucie requested a review from koppor December 7, 2025 14:39

koppor mentioned this pull request Dec 7, 2025

Export markdown file containing all papers + links #12729

Open

koppor requested changes Dec 7, 2025

View reviewed changes

github-actions bot added the status: changes-required Pull requests that are not yet complete label Dec 7, 2025

GreLucie and others added 4 commits December 7, 2025 22:57

Update jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesEx…

6ad9b7a

…porter.java Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Update jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesEx…

d9ab1a6

…porter.java Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Update jablib/src/main/java/org/jabref/logic/exporter/AcademicPagesEx…

a587653

…porter.java Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

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

43576c3


		String content = Files.readString(expectedFile);

		// Verify YAML front matter fields


		private static final Logger LOGGER = LoggerFactory.getLogger(AcademicPagesExporter.class);

		private final String lfFileName;

		List<BibEntry> individual_entry = new ArrayList<>();
		individual_entry.add(entry);

		Optional<Month> month = Month.parse(fieldText);
		return month.map(Month::getTwoDigitNumber).orElse("01");

Uh oh!

Added a custom Export for academicpages.github.io #14463

Are you sure you want to change the base?

Added a custom Export for academicpages.github.io #14463

Conversation

GreLucie commented Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

github-actions bot commented Nov 29, 2025

Hey @GreLucie!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jabref-machine commented Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

GreLucie commented Nov 29, 2025 •

edited

Loading