Skip to content

Add steps for modifying an existing export filter - #726

Open
linamedani wants to merge 1 commit into
JabRef:mainfrom
linamedani:custom-export-docs
Open

linamedani wants to merge 1 commit into
JabRef:mainfrom
linamedani:custom-export-docs

Conversation

@linamedani

Copy link
Copy Markdown

Pull Request Description

Summary

The custom exports page explains how to add a new export filter, but not how to adapt one of the existing ones. I added a short section in en/collaborative-work/export/customexports.md based on the steps Siedlerchr described on the forum (https://discourse.jabref.org/t/export-custom-field/4501), using the CSV export as an example. I also mentioned two points that caused problems in that thread (selecting the exporter as file type and writing field names in lowercase), and replaced the outdated reference to the download page with a link to the layout files on GitHub.

Steps to test

Open JabRef and follow the steps of the new section "Modifying an existing export filter" on the custom exports page. After exporting, the CSV file should contain the new column with the field value.

Custom export format in the preferences:
im

Exported CSV with the new column:

Capture

Related issues and pull requests

Closes #518

Checklist

  • I reviewed and take ownership of all content in this PR, including any AI-assisted text
  • I opened JabRef and followed these instructions myself to confirm they still work (tested on version: development build from main (100.0.0))
  • Any links I added or changed work (no 404s)
  • Any images or tables I added display correctly
  • I checked spelling/grammar

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can start a comment with 'qodo' or '@qodo' to chat about any finding

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document how to modify an existing export filter

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Add a CSV example showing how to adapt a standard export filter with a new column.
• Clarify exporter selection, lowercase field commands, and how companion layout files are found.
• Link directly to standard layout files instead of the outdated download-page reference.
Diagram

graph TD
  Repo["Standard CSV layouts"] --> Local["Modified CSV layouts"] --> Prefs["Custom export formats"] --> Dialog["Export dialog"] --> Output[("CSV file")]
Loading
High-Level Assessment

Extending the existing custom-exports page is appropriate: the CSV walkthrough builds on its layout-file guidance without duplicating a separate guide.

Files changed (1) +16 / -1

Documentation (1) +16 / -1
customexports.mdAdd a walkthrough for adapting the standard CSV exporter +16/-1

Add a walkthrough for adapting the standard CSV exporter

• Adds steps to copy and edit the CSV header and entry layouts, register the result as a custom export format, and select it when exporting. Clarifies companion layout discovery and lowercase field commands, and replaces the download-page reference with a direct link to standard layouts.

en/collaborative-work/export/customexports.md

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation for custom exports (how to modify existing ones and add new ones)

1 participant