Complete rebranding of bibtexkey as citationkey

CHANGELOG.md

@@ -23,6 +23,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We removed two useless preferences in the groups preferences dialog. [#6836](https://github.com/JabRef/jabref/pull/6836)
 - Synchronization of SpecialFields to keywords is now disabled by default. [#6621](https://github.com/JabRef/jabref/issues/6621)
 - JabRef no longer opens the entry editor with the first entry on startup [6855](https://github.com/JabRef/jabref/issues/6855)
+- We completed the rebranding of `bibtexkey` as `citationkey` which was started in JabRef 5.1.
 
 ### Fixed
 

docs/getting-into-the-code/high-level-documentation.md

@@ -35,5 +35,5 @@ All packages and classes which are currently not part of these packages \(we are
 
 ## Most Important Classes and their Relation
 
-Both GUI and CLI are started via the `JabRefMain` which will in turn call `JabRef` which then decides whether the GUI \(`JabRefFrame`\) or the CLI \(`JabRefCLI` and a lot of code in `JabRef`\) will be started. The `JabRefFrame` represents the Window which contains a `SidePane` on the left used for the fetchers/groups Each tab is a `BasePanel` which has a `SearchBar` at the top, a `MainTable` at the center and a `PreviewPanel` or an `EntryEditor` at the bottom. Any right click on the `MainTable` is handled by the `RightClickMenu`. Each `BasePanel` holds a `BibDatabaseContext` consisting of a `BibDatabase` and the `MetaData`, which are the only relevant data of the currently shown database. A `BibDatabase` has a list of `BibEntries`. Each `BibEntry` has a key, a bibtex key and a key/value store for the fields with their values. Interpreted data \(such as the type or the file field\) is stored in the `TypedBibentry` type. The user can change the `JabRefPreferences` through the `PreferencesDialog`.
+Both GUI and CLI are started via the `JabRefMain` which will in turn call `JabRef` which then decides whether the GUI \(`JabRefFrame`\) or the CLI \(`JabRefCLI` and a lot of code in `JabRef`\) will be started. The `JabRefFrame` represents the Window which contains a `SidePane` on the left used for the fetchers/groups Each tab is a `BasePanel` which has a `SearchBar` at the top, a `MainTable` at the center and a `PreviewPanel` or an `EntryEditor` at the bottom. Any right click on the `MainTable` is handled by the `RightClickMenu`. Each `BasePanel` holds a `BibDatabaseContext` consisting of a `BibDatabase` and the `MetaData`, which are the only relevant data of the currently shown database. A `BibDatabase` has a list of `BibEntries`. Each `BibEntry` has an ID, a citation key and a key/value store for the fields with their values. Interpreted data \(such as the type or the file field\) is stored in the `TypedBibentry` type. The user can change the `JabRefPreferences` through the `PreferencesDialog`.
 

src/jmh/java/org/jabref/benchmarks/Benchmarks.java

@@ -55,7 +55,7 @@ public void init() throws Exception {
         Random randomizer = new Random();
         for (int i = 0; i < 1000; i++) {
             BibEntry entry = new BibEntry();
-            entry.setCiteKey("id" + i);
+            entry.setCitationKey("id" + i);
             entry.setField(StandardField.TITLE, "This is my title " + i);
             entry.setField(StandardField.AUTHOR, "Firstname Lastname and FirstnameA LastnameA and FirstnameB LastnameB" + i);
             entry.setField(StandardField.JOURNAL, "Journal Title " + i);

src/main/java/org/jabref/gui/autocompleter/BibEntrySuggestionProvider.java

@@ -13,7 +13,7 @@
 import org.controlsfx.control.textfield.AutoCompletionBinding;
 
 /**
- * Delivers possible completions as a list of {@link BibEntry} based on their cite key.
+ * Delivers possible completions as a list of {@link BibEntry} based on their citation key.
  */
 public class BibEntrySuggestionProvider extends SuggestionProvider<BibEntry> {
 
@@ -25,7 +25,7 @@ public BibEntrySuggestionProvider(BibDatabase database) {
 
     @Override
     protected Equivalence<BibEntry> getEquivalence() {
-        return Equivalence.equals().onResultOf(BibEntry::getCiteKeyOptional);
+        return Equivalence.equals().onResultOf(BibEntry::getCitationKey);
     }
 
     @Override
@@ -36,7 +36,7 @@ protected Comparator<BibEntry> getComparator() {
     @Override
     protected boolean isMatch(BibEntry entry, AutoCompletionBinding.ISuggestionRequest request) {
         String userText = request.getUserText();
-        return entry.getCiteKeyOptional()
+        return entry.getCitationKey()
                     .map(key -> StringUtil.containsIgnoreCase(key, userText))
                     .orElse(false);
     }

src/main/java/org/jabref/gui/citationkeypattern/GenerateCitationKeyAction.java

@@ -68,15 +68,14 @@ public static boolean confirmOverwriteKeys(DialogService dialogService) {
     private void checkOverwriteKeysChosen() {
         // We don't want to generate keys for entries which already have one thus remove the entries
         if (Globals.prefs.getBoolean(JabRefPreferences.AVOID_OVERWRITING_KEY)) {
-            entries.removeIf(BibEntry::hasCiteKey);
-            // if we're going to override some cite keys warn the user about it
-        } else if (entries.parallelStream().anyMatch(BibEntry::hasCiteKey)) {
+            entries.removeIf(BibEntry::hasCitationKey);
+            // if we're going to override some citation keys warn the user about it
+        } else if (entries.parallelStream().anyMatch(BibEntry::hasCitationKey)) {
             boolean overwriteKeys = confirmOverwriteKeys(dialogService);
 
-            // The user doesn't want to override cite keys
+            // The user doesn't want to override citation keys
             if (!overwriteKeys) {
                 isCanceled = true;
-                return;
             }
         }
     }
@@ -87,7 +86,7 @@ private void generateKeys() {
         }
 
         stateManager.getActiveDatabase().ifPresent(databaseContext -> {
-            // generate the new cite keys for each entry
+            // generate the new citation keys for each entry
             final NamedCompound compound = new NamedCompound(Localization.lang("Autogenerate citation keys"));
             CitationKeyGenerator keyGenerator =
                     new CitationKeyGenerator(databaseContext, Globals.prefs.getCitationKeyPatternPreferences());
@@ -97,7 +96,7 @@ private void generateKeys() {
             }
             compound.end();
 
-            // register the undo event only if new cite keys were generated
+            // register the undo event only if new citation keys were generated
             if (compound.hasEdits()) {
                 frame.getUndoManager().addEdit(compound);
             }

src/main/java/org/jabref/gui/citationkeypattern/GenerateCitationKeySingleAction.java

@@ -32,7 +32,7 @@ public GenerateCitationKeySingleAction(BibEntry entry, BibDatabaseContext databa
 
     @Override
     public void execute() {
-        if (!entry.hasCiteKey() || GenerateCitationKeyAction.confirmOverwriteKeys(dialogService)) {
+        if (!entry.hasCitationKey() || GenerateCitationKeyAction.confirmOverwriteKeys(dialogService)) {
             new CitationKeyGenerator(databaseContext, preferencesService.getCitationKeyPatternPreferences())
                     .generateAndSetKey(entry)
                     .ifPresent(change -> undoManager.addEdit(new UndoableKeyChange(change)));

src/main/java/org/jabref/gui/collab/EntryAddChangeViewModel.java

@@ -17,7 +17,7 @@ class EntryAddChangeViewModel extends DatabaseChangeViewModel {
 
     public EntryAddChangeViewModel(BibEntry entry) {
         super();
-        this.name = entry.getCiteKeyOptional()
+        this.name = entry.getCitationKey()
                          .map(key -> Localization.lang("Added entry") + ": '" + key + '\'')
                          .orElse(Localization.lang("Added entry"));
         this.entry = entry;

src/main/java/org/jabref/gui/collab/EntryChangeViewModel.java

@@ -25,7 +25,7 @@ public EntryChangeViewModel(BibEntry entry, BibEntry newEntry) {
         this.oldEntry = entry;
         this.newEntry = newEntry;
 
-        name = entry.getCiteKeyOptional()
+        name = entry.getCitationKey()
                     .map(key -> Localization.lang("Modified entry") + ": '" + key + '\'')
                     .orElse(Localization.lang("Modified entry"));
     }

src/main/java/org/jabref/gui/collab/EntryDeleteChangeViewModel.java

@@ -22,7 +22,7 @@ class EntryDeleteChangeViewModel extends DatabaseChangeViewModel {
     public EntryDeleteChangeViewModel(BibEntry entry) {
         super(Localization.lang("Deleted entry"));
 
-        this.name = entry.getCiteKeyOptional()
+        this.name = entry.getCitationKey()
                          .map(key -> Localization.lang("Deleted entry") + ": '" + key + '\'')
                          .orElse(Localization.lang("Deleted entry"));
         this.entry = entry;

src/main/java/org/jabref/gui/customentrytypes/CustomEntryTypeDialogViewModel.java

@@ -50,7 +50,7 @@ public Field fromString(String string) {
         }
     };
 
-    private final ObservableList<Field> fieldsForAdding = FXCollections.observableArrayList(FieldFactory.getStandardFielsdsWithBibTexKey());
+    private final ObservableList<Field> fieldsForAdding = FXCollections.observableArrayList(FieldFactory.getStandardFieldsWithCitationKey());
     private final ObjectProperty<CustomEntryTypeViewModel> selectedEntryType = new SimpleObjectProperty<>();
     private final ObjectProperty<Field> selectedFieldToAdd = new SimpleObjectProperty<>();
     private final StringProperty entryTypeToAdd = new SimpleStringProperty("");

src/main/java/org/jabref/gui/edit/CopyMoreAction.java

@@ -104,8 +104,8 @@ private void copyKey() {
 
         // Collect all non-null keys.
         List<String> keys = entries.stream()
-                                   .filter(entry -> entry.getCiteKeyOptional().isPresent())
-                                   .map(entry -> entry.getCiteKeyOptional().get())
+                                   .filter(entry -> entry.getCitationKey().isPresent())
+                                   .map(entry -> entry.getCitationKey().get())
                                    .collect(Collectors.toList());
 
         if (keys.isEmpty()) {
@@ -131,8 +131,8 @@ private void copyCiteKey() {
 
         // Collect all non-null keys.
         List<String> keys = entries.stream()
-                                   .filter(entry -> entry.getCiteKeyOptional().isPresent())
-                                   .map(entry -> entry.getCiteKeyOptional().get())
+                                   .filter(entry -> entry.getCitationKey().isPresent())
+                                   .map(entry -> entry.getCitationKey().get())
                                    .collect(Collectors.toList());
 
         if (keys.isEmpty()) {
@@ -161,7 +161,7 @@ private void copyKeyAndTitle() {
         List<BibEntry> entries = stateManager.getSelectedEntries();
 
         // ToDo: this string should be configurable to allow arbitrary exports
-        StringReader layoutString = new StringReader("\\bibtexkey - \\begin{title}\\format[RemoveBrackets]{\\title}\\end{title}\n");
+        StringReader layoutString = new StringReader("\\citationkey - \\begin{title}\\format[RemoveBrackets]{\\title}\\end{title}\n");
         Layout layout;
         try {
             layout = new LayoutHelper(layoutString, preferencesService.getLayoutFormatterPreferences(Globals.journalAbbreviationRepository)).getLayoutFromText();
@@ -175,7 +175,7 @@ private void copyKeyAndTitle() {
         int entriesWithKeys = 0;
         // Collect all non-null keys.
         for (BibEntry entry : entries) {
-            if (entry.hasCiteKey()) {
+            if (entry.hasCitationKey()) {
                 entriesWithKeys++;
                 keyAndTitle.append(layout.doLayout(entry, stateManager.getActiveDatabase().get().getDatabase()));
             }
@@ -209,7 +209,7 @@ private void copyKeyAndLink() {
         StringBuilder keyAndLink = new StringBuilder();
 
         List<BibEntry> entriesWithKey = entries.stream()
-                                               .filter(BibEntry::hasCiteKey)
+                                               .filter(BibEntry::hasCitationKey)
                                                .collect(Collectors.toList());
 
         if (entriesWithKey.isEmpty()) {
@@ -218,7 +218,7 @@ private void copyKeyAndLink() {
         }
 
         for (BibEntry entry : entriesWithKey) {
-            String key = entry.getCiteKeyOptional().get();
+            String key = entry.getCitationKey().get();
             String url = entry.getField(StandardField.URL).orElse("");
             keyAndLink.append(url.isEmpty() ? key : String.format("<a href=\"%s\">%s</a>", url, key));
             keyAndLink.append(OS.NEWLINE);

src/main/java/org/jabref/gui/entryeditor/LatexCitationsTabViewModel.java

@@ -76,7 +76,7 @@ public void init(BibEntry entry) {
         cancelSearch();
 
         currentEntry = entry;
-        Optional<String> citeKey = entry.getCiteKeyOptional();
+        Optional<String> citeKey = entry.getCitationKey();
 
         if (citeKey.isPresent()) {
             startSearch(citeKey.get());

src/main/java/org/jabref/gui/entryeditor/SourceTab.java

@@ -278,10 +278,10 @@ private void storeSource(BibEntry outOfFocusEntry, String text) {
 
             NamedCompound compound = new NamedCompound(Localization.lang("source edit"));
             BibEntry newEntry = database.getEntries().get(0);
-            String newKey = newEntry.getCiteKeyOptional().orElse(null);
+            String newKey = newEntry.getCitationKey().orElse(null);
 
             if (newKey != null) {
-                outOfFocusEntry.setCiteKey(newKey);
+                outOfFocusEntry.setCitationKey(newKey);
             } else {
                 outOfFocusEntry.clearCiteKey();
             }

src/main/java/org/jabref/gui/exporter/WriteXMPAction.java

@@ -117,7 +117,7 @@ private void writeXMP() {
                                     .collect(Collectors.toList());
 
             Platform.runLater(() -> optionsDialog.getProgressArea()
-                                                 .appendText(entry.getCiteKeyOptional().orElse(Localization.lang("undefined")) + "\n"));
+                                                 .appendText(entry.getCitationKey().orElse(Localization.lang("undefined")) + "\n"));
 
             if (files.isEmpty()) {
                 skipped++;

src/main/java/org/jabref/gui/externalfiles/DownloadFullTextAction.java

@@ -126,7 +126,7 @@ private void downloadFullTexts(Map<BibEntry, Optional<URL>> downloads, BibDataba
                 addLinkedFileFromURL(databaseContext, result.get(), entry, dir.get());
             } else {
                 dialogService.notify(Localization.lang("No full text document found for entry %0.",
-                        entry.getCiteKeyOptional().orElse(Localization.lang("undefined"))));
+                        entry.getCitationKey().orElse(Localization.lang("undefined"))));
             }
         }
     }
@@ -164,19 +164,19 @@ private void addLinkedFileFromURL(BibDatabaseContext databaseContext, URL url, B
                             ExternalFileTypes.getInstance());
                     entry.addFile(downloadedFile);
                     dialogService.notify(Localization.lang("Finished downloading full text document for entry %0.",
-                            entry.getCiteKeyOptional().orElse(Localization.lang("undefined"))));
+                            entry.getCitationKey().orElse(Localization.lang("undefined"))));
                 });
                 downloadTask.titleProperty().set(Localization.lang("Downloading"));
                 downloadTask.messageProperty().set(
-                        Localization.lang("Fulltext for") + ": " + entry.getCiteKeyOptional().orElse(Localization.lang("New entry")));
+                        Localization.lang("Fulltext for") + ": " + entry.getCitationKey().orElse(Localization.lang("New entry")));
                 downloadTask.showToUser(true);
                 Globals.TASK_EXECUTOR.execute(downloadTask);
             } catch (MalformedURLException exception) {
                 dialogService.showErrorDialogAndWait(Localization.lang("Invalid URL"), exception);
             }
         } else {
             dialogService.notify(Localization.lang("Full text document for entry %0 already linked.",
-                    entry.getCiteKeyOptional().orElse(Localization.lang("undefined"))));
+                    entry.getCitationKey().orElse(Localization.lang("undefined"))));
         }
     }
 }

src/main/java/org/jabref/gui/externalfiles/ImportHandler.java

@@ -117,7 +117,7 @@ public void importEntries(List<BibEntry> entries) {
                 preferencesService.getOwnerPreferences(),
                 preferencesService.getTimestampPreferences());
 
-        // Generate bibtex keys
+        // Generate citation keys
         generateKeys(entries);
 
         // Add to group

src/main/java/org/jabref/gui/fieldeditors/CitationKeyEditor.fxml

@@ -6,5 +6,5 @@
 <fx:root xmlns:fx="http://javafx.com/fxml/1" type="HBox" xmlns="http://javafx.com/javafx/8.0.112"
          fx:controller="org.jabref.gui.fieldeditors.CitationKeyEditor">
     <EditorTextField fx:id="textField"/>
-    <Button fx:id="generateCiteKeyButton" text="%Generate" styleClass="icon-button"/>
+    <Button fx:id="generateCitationKeyButton" text="%Generate" styleClass="icon-button"/>
 </fx:root>

src/main/java/org/jabref/gui/fieldeditors/CitationKeyEditor.java

@@ -22,8 +22,8 @@
 public class CitationKeyEditor extends HBox implements FieldEditorFX {
 
     private final JabRefPreferences preferences;
-    @FXML private CitationKeyEditorViewModel viewModel;
-    @FXML private Button generateCiteKeyButton;
+    @FXML private final CitationKeyEditorViewModel viewModel;
+    @FXML private Button generateCitationKeyButton;
     @FXML private EditorTextField textField;
 
     public CitationKeyEditor(Field field,
@@ -61,12 +61,12 @@ public CitationKeyEditorViewModel getViewModel() {
     public void bindToEntry(BibEntry entry) {
         viewModel.bindToEntry(entry);
 
-        // Configure cite key button
+        // Configure button to generate citation key
         new ActionFactory(preferences.getKeyBindingRepository())
                 .configureIconButton(
                         StandardActions.GENERATE_CITE_KEY,
                         viewModel.getGenerateCiteKeyCommand(),
-                        generateCiteKeyButton);
+                        generateCitationKeyButton);
     }
 
     @Override

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

@@ -449,7 +449,7 @@ public void download() {
             downloadProgress.bind(downloadTask.workDonePercentageProperty());
             downloadTask.titleProperty().set(Localization.lang("Downloading"));
             downloadTask.messageProperty().set(
-                    Localization.lang("Fulltext for") + ": " + entry.getCiteKeyOptional().orElse(Localization.lang("New entry")));
+                    Localization.lang("Fulltext for") + ": " + entry.getCitationKey().orElse(Localization.lang("New entry")));
             downloadTask.showToUser(true);
             taskExecutor.execute(downloadTask);
         } catch (MalformedURLException exception) {

src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentConfirmationDialog.java

@@ -19,7 +19,7 @@ public MergeReviewIntoCommentConfirmationDialog(DialogService dialogService) {
     public boolean askUserForMerge(List<BibEntry> conflicts) {
         String bibKeys = conflicts
                 .stream()
-                .map(BibEntry::getCiteKeyOptional)
+                .map(BibEntry::getCitationKey)
                 .filter(Optional::isPresent)
                 .map(Optional::get)
                 .collect(Collectors.joining(",\n"));

src/main/java/org/jabref/gui/integrity/IntegrityCheckDialog.java

@@ -62,7 +62,7 @@ private void initialize() {
 
         messagesTable.getSelectionModel().getSelectedItems().addListener(this::onSelectionChanged);
         messagesTable.setItems(viewModel.getMessages());
-        keyColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().getEntry().getCiteKeyOptional().orElse("")));
+        keyColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().getEntry().getCitationKey().orElse("")));
         fieldColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().getField().getDisplayName()));
         messageColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().getMessage()));