GITBOOK-263: Add user comments section

JabRef · Mar 24, 2024 · aad58ee · aad58ee
1 parent aedb7b3
commit aad58ee
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 0 deletions.
diff --git a/en/.gitbook/assets/empty-comments.png b/en/.gitbook/assets/empty-comments.png
diff --git a/en/.gitbook/assets/image (5).png b/en/.gitbook/assets/image (5).png
diff --git a/en/.gitbook/assets/image (6).png b/en/.gitbook/assets/image (6).png
diff --git a/en/.gitbook/assets/image (7).png b/en/.gitbook/assets/image (7).png
diff --git a/en/.gitbook/assets/image (8).png b/en/.gitbook/assets/image (8).png
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -85,3 +85,4 @@
 * [Contribute to JabRef](contributing/README.md)
   * [How to Improve the Help Page](contributing/how-to-improve-the-help-page.md)
   * [How to translate the JabRef User Interface](contributing/how-to-translate-the-ui.md)
+* [Comment on an entry](comment-on-an-entry.md)
diff --git a/en/comment-on-an-entry.md b/en/comment-on-an-entry.md
@@ -0,0 +1,30 @@
+---
+description: Add comments on an entry
+---
+
+# Comment on an entry
+
+One can add free text to an entry. This is possible in the "Comments" tab of JabRef.&#x20;
+
+There is the general "comments" field.
+
+JabRef offers to separate comments from  as well as user-specific comments field.&#x20;
+
+The following screenshots show the comments for the user `koppor`. As default, general comments are managed through the field `comment`. In addition, the field `comment-koppor` stores the comments of the user koppor.
+
+<figure><img src=".gitbook/assets/image (5).png" alt=""><figcaption><p>JabRef's entry editor showing two comment fields</p></figcaption></figure>
+
+Now, lets assume, the library (.bib File) is shared among different users. `koppor` closed the library and opened it later again. He sees that a user `otheruser` has written a comment:
+
+<figure><img src=".gitbook/assets/image (6).png" alt=""><figcaption><p>JabRef showing the comment of the user "otheruser".</p></figcaption></figure>
+
+Now, koppor desides, that he does not want to add any comments in JabRef, so he pushes the "Hide user comments" button. Then, JabRef does not display the comment field for koppor's user any more:
+
+<figure><img src=".gitbook/assets/image (7).png" alt=""><figcaption><p>JabRef's entry editor showing the general comment field and a comment of another user.</p></figcaption></figure>
+
+A bit later, koppor thinks, he wants to put comments again. To achieve that, he needs to navigate to File -> Preferences -> Entry editor. Then, he needs to add a checkmark to "Show user comment fields". then, he needs to press "Save" to save the preferences.
+
+<figure><img src=".gitbook/assets/image (8).png" alt=""><figcaption><p>Preference to enable user-specific comments</p></figcaption></figure>
+
+Then, JabRef's entry editor shows the field "Comment-koppor" again.
+