Skip to content

Conversation

@Tsaishashanth
Copy link

@Tsaishashanth Tsaishashanth commented Jan 4, 2026

User description

Deleted the previous PR because it had incorrect information and Path.
This PR updates the custom export documentation in user-documentation.

Added a short beginner-friendly section at the top of customexports.md
to explain how to create and use custom export formats in JabRef.


PR Type

Documentation


Description

  • Added beginner-friendly overview section to custom exports documentation

  • Explains how to create and use custom export formats in JabRef

  • Provides guidance on copying existing layout files instead of creating from scratch

  • Documents the process of registering layout files via preferences menu


Diagram Walkthrough

flowchart LR
  A["Custom Exports Documentation"] --> B["New Beginner Overview Section"]
  B --> C["Explanation of Custom Export Formats"]
  B --> D["Step-by-step Registration Guide"]
  C --> E["Copy Existing Layout Files"]
  D --> F["File → Preferences → Custom export formats"]
Loading

File Walkthrough

Relevant files
Documentation
customimports.md
Add beginner overview section to custom exports                   

en/collect/import/customimports.md

  • Added new "Beginner overview" section at the top of the file
  • Explains what custom export formats do in JabRef
  • Provides beginner-friendly guidance on copying and modifying existing
    layout files
  • Documents the registration process via File → Preferences → Custom
    export formats menu
+14/-0   

Added beginner overview for custom export formats in JabRef.
@qodo-free-for-open-source-projects
Copy link

qodo-free-for-open-source-projects bot commented Jan 4, 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 4, 2026

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Correct content to match file's topic
Suggestion Impact:The commit removed the entire incorrect "Beginner overview" section that described custom exports instead of custom imports. This directly addresses the suggestion's concern about mismatched content, though it takes a different approach (deletion rather than correction).

code diff:

-## Beginner overview
-
-Custom export formats in JabRef let you control how bibliographic entries are written
-when exporting your library (for example to CSV, HTML, or plain text).
-
-If you are new to custom exports:
-- Start by **copying an existing layout file** and modifying it
-- You usually do **not** need to create a layout from scratch
-- Layout files are simple text files and can be edited with any text editor
-
-After creating or modifying a layout file, you register it in JabRef via  
-**File → Preferences → Custom export formats**, where you select the layout file
-and choose the file extension for the export.

Update the newly added content to describe custom imports instead of custom
exports to align with the file's topic, which is customimports.md.

en/collect/import/customimports.md [1-13]

 ## Beginner overview
 
-Custom export formats in JabRef let you control how bibliographic entries are written
-when exporting your library (for example to CSV, HTML, or plain text).
+Custom import formats in JabRef let you define how bibliographic entries are read
+from a file into your library (for example from a proprietary format).
 
-If you are new to custom exports:
-- Start by **copying an existing layout file** and modifying it
-- You usually do **not** need to create a layout from scratch
-- Layout files are simple text files and can be edited with any text editor
+If you are new to custom imports:
+- Start by **copying an existing import filter** and modifying it
+- You usually do **not** need to create a filter from scratch
+- Filter files are simple text files and can be edited with any text editor
 
-After creating or modifying a layout file, you register it in JabRef via  
-**File → Preferences → Custom export formats**, where you select the layout file
-and choose the file extension for the export.
+After creating or modifying a filter file, you register it in JabRef via
+**File → Preferences → Custom import formats**, where you select the filter file
+and provide a name for the import format.

[Suggestion processed]

Suggestion importance[1-10]: 9

__

Why: The suggestion correctly identifies a critical error where content about "exports" was added to a documentation file for "imports", which would be highly confusing for users.

High
  • Update

@koppor
Copy link
Member

koppor commented Jan 5, 2026

This is an attempt to get blocked, isn't it?

@Tsaishashanth
Copy link
Author

Hi @koppor sir,
Sorry for the mistakes. I’m new to open source and still learning.
I will check everything more carefully and fix issues.

Earlier, I mistakenly made changes to the wrong documentation file.  
This commit deletes those incorrect edits
@Tsaishashanth Tsaishashanth deleted the patch-1 branch January 5, 2026 13:38
@koppor
Copy link
Member

koppor commented Jan 5, 2026

I think, the difference between import and export has nothing todo with open source.

Not sure if there are languages where this is the same.

It felt so ridiculous to explain that there is a difference between it. Load import. Save Export.

With your other PR, that mistake is gone.

I don't have time now for review. Maybe someone of the community steps in. We don't have endless time. Just volunteers.

@Tsaishashanth
Copy link
Author

@koppor sorry sir

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.

2 participants