Skip to content

Conversation

@Tsaishashanth
Copy link

@Tsaishashanth Tsaishashanth commented Jan 5, 2026

User description

This PR updates the documentation for custom export formats in JabRef.

  • Added clear steps for beginners on how to modify existing exports.
  • Explained how to add new custom fields.
  • Kept the existing information about Citation Style Language and public layouts.

PR Type

Documentation


Description

  • Restructured custom export section with numbered beginner-friendly steps

  • Added detailed instructions for locating and copying layout files

  • Included step-by-step guide for adding new fields to exports

  • Provided complete workflow from file modification to library export


Diagram Walkthrough

flowchart LR
  A["Locate layout files"] --> B["Copy files locally"]
  B --> C["Add new fields"]
  C --> D["Modify export"]
  D --> E["Configure in JabRef"]
  E --> F["Export library"]
Loading

File Walkthrough

Relevant files
Documentation
customexports.md
Restructure custom export docs with numbered beginner steps

en/collaborative-work/export/customexports.md

  • Replaced single paragraph with 6 numbered sections providing
    step-by-step instructions
  • Added details on locating layout files in the repository structure
  • Included instructions for copying and modifying layout files locally
  • Provided guidance on adding new fields with matching syntax
    requirements
  • Added complete workflow from JabRef preferences configuration to final
    library export
  • Enhanced with code examples and file paths for clarity
+59/-2   

Expanded instructions for adding and modifying custom exports in JabRef, including detailed steps for locating layout files, making copies, adding new fields, modifying existing exports, and exporting libraries.
@qodo-free-for-open-source-projects
Copy link

qodo-free-for-open-source-projects bot commented Jan 5, 2026

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

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

qodo-free-for-open-source-projects bot commented Jan 5, 2026

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Provide an accessible link to layout files

Replace the internal repository path to layout files with a public GitHub link
and instructions, making the files accessible to all users, not just developers.

en/collaborative-work/export/customexports.md [15-16]

-- Layout files are in the repo at:
-  `jablib/src/main/resources/resource/openoffice/`
+- The standard layout files are part of the JabRef source code. You can browse and download them from the JabRef repository on GitHub. For instance, the OpenOffice/LibreOffice layouts are in:
+  [`src/main/resources/resource/layout/openoffice/`](https://github.com/JabRef/jabref/tree/main/src/main/resources/resource/layout/openoffice)
  • Apply / Chat
Suggestion importance[1-10]: 8

__

Why: This suggestion significantly improves the documentation's utility for non-developer users by providing a direct, accessible link to the layout files and correcting an inaccurate file path in the process.

Medium
Possible issue
Clarify field command and header roles

Clarify that the field command (e.g., \asset) and the column header (e.g.,
"Asset") do not need to match, explaining their different purposes to avoid user
confusion.

en/collaborative-work/export/customexports.md [39]

-> Make sure the **name in both files matches exactly** (`\asset` and `"Asset"`).
+> `\asset` fetches data from the `asset` field in your JabRef library. `"Asset"` is the column header in the CSV file. Ensure the field name used in the `\field` command (e.g., `\asset`) correctly matches the field in your library you wish to export.
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a misleading statement in the documentation that could confuse users, and the proposed change accurately clarifies the distinct roles of the field command and the header string.

Medium
  • Update

modified some part of code to pass common link issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant