Exporting

Export your rebuttal letters as Word documents, JSON data, or formatted reports.

Export Formats

Rebuttr supports multiple export formats to fit your workflow:

Word Document (.docx)

Professional, formatted documents ready for journal submission. Includes proper headings, formatting, and track changes support.

JSON (.json)

Structured data export for programmatic workflows, backups, or integration with other tools.

Markdown (.md)

Plain text with formatting. Ideal for version control, collaboration, or conversion to other formats.

PDF (.pdf)

Fixed-format document for final submissions or archiving. Generated from the Word template.

Exporting via Web Interface

Navigate to your paper
Click the "Export" button in the toolbar
Select your desired format
Configure export options (see below)
Click "Download"

Export Options

Content Options

Option	Description	Default
Include all reviewers	Export comments from all reviewers	Yes
Include editor comments	Include editor/AE comments in export	Yes
Include unanswered	Include comments without responses	No
Group by reviewer	Organize by reviewer vs. by category	Yes
Include line references	Show manuscript line references	Yes

Formatting Options

Option	Description	Default
Comment style	Italic, bold, or quoted	Italic
Response style	Normal, indented, or boxed	Normal
Numbering	Auto-number comments	Yes
Include header	Add paper title and metadata	Yes

Exporting via CLI

Export papers programmatically using the command line:

Terminal

# Export as Word document
$ rebuttr export --paper "My Paper" --format docx --output rebuttal.docx

# Export as JSON
$ rebuttr export --paper "My Paper" --format json --output data.json

# Export as Markdown
$ rebuttr export --paper "My Paper" --format md --output rebuttal.md

# Export specific reviewer only
$ rebuttr export --paper "My Paper" --reviewer 1 --output reviewer1.docx

# Export with custom options
$ rebuttr export --paper "My Paper" \
  --format docx \
  --group-by category \
  --include-unanswered \
  --output full-rebuttal.docx
                

Word Document Structure

Exported Word documents follow a professional structure:

                    Document Structure
                

RESPONSE TO REVIEWERS

Paper: [Your Paper Title]
Journal: [Target Journal]
Date: [Export Date]

────────────────────────────────

REVIEWER 1

Comment 1.1 (Major):
[Reviewer's comment in italics]

Response:
We thank the reviewer for... [Your response]

Comment 1.2 (Minor):
[Reviewer's comment in italics]

Response:
[Your response]

────────────────────────────────

REVIEWER 2
...
                

JSON Export Structure

JSON exports include complete data for backup or integration:

export.json

{
  "paper": {
    "id": "paper-123",
    "title": "My Research Paper",
    "journal": "Nature",
    "authors": ["Author One", "Author Two"],
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "reviews": [
    {
      "reviewer": "Reviewer 1",
      "comments": [
        {
          "id": "comment-1",
          "text": "The methodology...",
          "category": "major",
          "response": "We thank the reviewer...",
          "status": "completed",
          "lineReference": "Lines 45-67"
        }
      ]
    }
  ],
  "exportedAt": "2024-02-01T14:00:00Z"
}
                

See JSON Format Reference for complete schema documentation.

Batch Export

Export multiple papers at once:

Terminal

# Export all papers
$ rebuttr export --all --format json --output-dir ./exports/

# Export completed papers only
$ rebuttr export --all --completed --format docx --output-dir ./rebuttals/
                

Custom Templates

Create custom Word templates for journal-specific formatting:

Create a .docx template with your desired styles
Place it in ~/.config/rebuttr/templates/
Reference it during export:

Terminal

$ rebuttr export --paper "My Paper" --template nature.docx --output rebuttal.docx
                

Template Styles

Templates use named styles: "Comment" for reviewer text, "Response" for your replies, and standard heading styles for structure.

Best Practices

Export to JSON regularly as a backup
Use Word format for final submission to journals
Keep Markdown exports in version control
Test custom templates before important deadlines
Review the exported document for formatting issues

Pro Tip

Many journals accept Markdown or can convert from Word. Check your target journal's submission guidelines for preferred formats.

Warning

Always verify exported documents before submission. Review formatting, numbering, and ensure all responses are included.

Next Steps

JSON format - Complete schema reference
CLI reference - All command options
Multi-paper - Manage multiple submissions