Skip to content

Document the jabkit shorten command #643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
koppor wants to merge 1 commit into from
Closed

Document the jabkit shorten command #643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions en/jabkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,19 @@
pdf Manage PDF metadata.
get-cited-works Get the cited works (bibliography).
get-citing-works Get the works citing the work at hand.
shorten Shorten a paper's references until it fits a page count.
```

Hint: Using `jabkit <COMMAND> --help` will show the supported options for each command.

The `shorten` command compiles a LaTeX paper with `latexmk` and shortens its
cited references — abbreviating author lists to the first author, abbreviating
journal names, and cleaning up DOIs — until the compiled document fits a target
page count (`--pages`, defaulting to one page fewer than the current length).
The referenced `.bib` file is rewritten in place; use `--output` to write the
shortened `.bib` elsewhere. A local TeX installation (`latexmk`) is used when

Check warning on line 69 in en/jabkit.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.", "location": {"path": "en/jabkit.md", "range": {"start": {"line": 69, "column": 66}}}, "severity": "WARNING"}
available, otherwise the `texlive/texlive` Docker image.

## Updating JabKit

Make use of `--fresh` to update JabKit
Expand Down
Loading