Skip to content
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.

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

Add special fields ADR #7300

Merged
merged 2 commits into from
Jan 7, 2021
Merged

Conversation

koppor
Copy link
Member

@koppor koppor commented Jan 5, 2021

As input for #6840

This writes down the ADR for special fields discussed at #JabCon.

Result: We have special fields as "normal" BibTeX key/value fields. We do not have synchronization of keywords any more.

Documentation: This will obsolete the last paragraph at https://docs.jabref.org/finding-sorting-and-cleaning-entries/specialfields#configuration-of-the-storage-mode-in-the-library.

For the brave: The ADR can be edited using the UI available at https://github.com/koppor/adr-manager/.

  • Change in CHANGELOG.md described (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

Co-authored-by: Oliver Kopp <[email protected]>
Copy link
Member

@tobiasdiez tobiasdiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM!

What was our timeline for the migration? Do we have an open issue for this?

* Good, because can be easily removed (e.g., by a formatter)
* Good, because prepares future power of JabRef to make field properties configurable
* Bad, because bloats BibTeX file (see below)
* Bad, because requires more timing (see below)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by timing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo --> fixed to "Bad, because requires more writing when editing BibTeX manually by hand"

### Special fields as sub-feature of groups

* Good, because one concept rulez them all
* Good, because groups already have special handling for author names
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the connection to author names?

@koppor
Copy link
Member Author

koppor commented Jan 6, 2021

Thanks, LGTM!

Finally, after months after JabCon 😅

What was our timeline for the migration? Do we have an open issue for this?

The migration itself is (IMHO) the linked issue #6840 with Milestone v5.3

We already have the default to not do any synchronization (released with v5.2). --> #6846

At #JabCon we also noted down following next steps:

  • Introduce a pre-set for filtering for special fields as groups
  • “Next” step: Configurable fields (to be discussed)

We don't have issues for that - should I add some?

Copy link
Member

@tobiasdiez tobiasdiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation!

@Siedlerchr Siedlerchr merged commit 0aec483 into JabRef:master Jan 7, 2021
@Siedlerchr Siedlerchr deleted the add-special-field-adr branch January 7, 2021 11:20
Siedlerchr added a commit that referenced this pull request Jan 7, 2021
…dtask

* upstream/master:
  Adjust zbmath fetcher (#7298)
  Add "acm-siggraph.csl" required by CitationStyle.java
  Added Keyboard shortcuts (clear/set read status) (#7302)
  Add special fields ADR (#7300)
  Overwrite local copies
  Squashed 'buildres/csl/csl-locales/' content from commit ecb8e70233
  Squashed 'buildres/csl/csl-styles/' content from commit 737ffa1
  Adapt workflow and build.gradle
  Move CSL to buildres/csl to speedup "processResources" during development
Siedlerchr added a commit that referenced this pull request Jan 10, 2021
* upstream/master: (34 commits)
  Fixed exception about missing custom css file (#7292)
  Update the templates for opening a new issue (#7321)
  Entitlements file Mac (#7317)
  Make CONTRIBUTING.md much shorter. Move long text to docs/contributing.md (#7293)
  Include Github-optimized screenshot into repository (#7318)
  Remove obsolete registry patch file (#7316)
  Fix AUTHORS
  GitBook: [master] one page modified
  Remove broken Sonarqube integration (#7315)
  GitBook: [master] 5 pages and 32 assets modified
  docs: update license year (#7314)
  Add javafx version number + update javafx (#7312)
  Add missing authors
  Adjust zbmath fetcher (#7298)
  Add "acm-siggraph.csl" required by CitationStyle.java
  Added Keyboard shortcuts (clear/set read status) (#7302)
  Add special fields ADR (#7300)
  Overwrite local copies
  Squashed 'buildres/csl/csl-locales/' content from commit ecb8e70233
  Squashed 'buildres/csl/csl-styles/' content from commit 737ffa1
  ...
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.

4 participants