-
Notifications
You must be signed in to change notification settings - Fork 126
Update the documentation to consider the new types of group #602
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
Draft
ErwanGou
wants to merge
3
commits into
JabRef:main
Choose a base branch
from
ErwanGou:update-groups-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+5.39 KB
en/.gitbook/assets/groups-groupwindow-iconcolorhierarchy-jabref6.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+15.9 KB
en/.gitbook/assets/groups-groupwindow-typedirectorystructure-jabref6.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+17.2 KB
en/.gitbook/assets/groups-groupwindow-typefreeexpression-jabref6.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+21.7 KB
en/.gitbook/assets/groups-groupwindow-typespecifiedkeywords-jabref6.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,7 +49,7 @@ Just like directories, groups are structured like a tree, with the group _All En | |
|
|
||
| The properties of a group can be defined in the 'Edit group' dialog window (the same window is displayed when creating a new group). To modify the group properties, right-click on the group name in the group pane and select **Edit group** in the context menu. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ### Name | ||
|
|
||
|
|
@@ -63,7 +63,7 @@ A description of the group, to help you remember what it is about. This descript | |
|
|
||
| An icon can be displayed in front of the group name. Choose your favorite icon among the ones available at [https://materialdesignicons.com/](https://materialdesignicons.com), and enter its name of the field _Icon_ (replacing any hyphens (`-`) with underscores (`_`)). The color of the icon can be set in the field _Color_. | ||
|
|
||
| .png>) | ||
|  | ||
|
|
||
| ### Hierarchical context | ||
|
|
||
|
|
@@ -105,14 +105,16 @@ JabRef has five types of groups: | |
| * **Searching for a keyword**. The group contain entries in which a certain field (e.g. `author`) contains a certain keyword (e.g. `Smith`). This method does not require manual assignment of entries but uses information that is already present in the database. | ||
| * **Free search expression**. Similar to **Searching for a keyword**, but for several keywords in several fields. | ||
| * **Specified keywords**. This feature will gather all words found in a specific field of your choice, and create a group for each word. | ||
| * **Authors' last names**. Groups can be generated for each author's last name. | ||
| * **Authors' last names**. Groups can be generated for each author's last name. | ||
| * **Cited entries**. The group contains the entries cited in a LaTeX document, based on its _.aux_ file. | ||
| * **Date**. The group contains all entries that satisfy a certain date criteria. | ||
| * **Directory structure**. The group mirrors the local file system structure based on the root directory path specified. | ||
|
|
||
| #### Explicit selection | ||
|
|
||
| Groups based on explicit selection are populated only by manual assignment of entries. | ||
|
|
||
| .png>) | ||
|  | ||
|
Comment on lines
-115
to
+116
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| After creating an explicit-selection group, you select the entries to be assigned to it and use either drag-and-drop or the context menu **Add selected entries to this group** of the group interface. | ||
|
|
||
|
|
@@ -126,7 +128,7 @@ This method of grouping requires that all entries have a unique citation key. In | |
|
|
||
| This method groups entries in which a specified _field_ (e.g. _author_) contains a specified _keyword_ (e.g. _Smith_). The mentioned example will group all entries referring to the author _Smith_. | ||
|
|
||
| .png>) | ||
|  | ||
|
|
||
| The search can be case-sensitive or not (checkbox 'Case sensitive'). The search can either be done as a plain-text or a regular-expression search (checkbox 'Regular expression'). | ||
|
|
||
|
|
@@ -138,7 +140,7 @@ The content of the group is updated dynamically whenever the database changes: J | |
|
|
||
| This is similar to the above, but rather than search for a single search term on a single field, a [search expression syntax](search.md) can be used. It supports logical operators (`AND`, `OR`, `NOT`) and allows searching multiple fields. | ||
|
|
||
| .png>) | ||
|  | ||
|
|
||
| For example, the search expression `keywords=regression and not keywords=linear` groups entries concerned with non-linear regression. | ||
|
|
||
|
|
@@ -150,18 +152,35 @@ With the group type "Specified keywords", you can quickly create a set of groups | |
|
|
||
| You can also specify characters to ignore, for instance, commas used between keywords. These will be treated as separators between words, and not part of them. This step is important for combined keywords such as `laplace distribution` to be recognized as a single semantic unit. (You cannot use this option to remove complete words. Instead, delete the unwanted groups manually after they were created automatically.) | ||
|
|
||
| .png>) | ||
|  | ||
|
|
||
| The content of the group is updated dynamically whenever the database changes. | ||
|
|
||
| #### Using the cited entries of a LaTeX document | ||
|
|
||
| The group contains the entries cited in a LaTeX document, based on its '.aux' file. The .aux file has to be specified. | ||
|
|
||
| .png>) | ||
|  | ||
|
|
||
| The content of the group is updated dynamically whenever the `.aux` file changes. | ||
|
|
||
| #### Using the publication date | ||
|
|
||
| This feature groups entries based on the date of a selected field. | ||
|
|
||
|  | ||
|
|
||
| The field _Field to extract date from_ specifies the entry's field from which the date is extracted. | ||
| The field _Date grouping option_ specifies how the entries are grouped, either by year, by month or by both year and month. | ||
|
|
||
| #### Using the directory structure | ||
|
|
||
| This feature mirrors a local structure and imports its PDF files as entries in the library. The group structure is updated dynamically whenever there is a change in the system. | ||
|
|
||
|  | ||
|
|
||
| The folder icon at the right of the field _Root path_ allows browsing the file system to select the root directory. When the directory is selected, it automatically fills the field _Name_ with the directory name if it was empty. It also selects _Union_ as hierarchical context by default, since this is the most logical choice for this type of group. | ||
|
|
||
|
Comment on lines
+178
to
+185
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would remove this - and put it into a seperate PR |
||
| ## Group color bars in the entry table | ||
|
|
||
| To see easily to which groups an entry belongs to, the entry table has a column dedicated to groups. For each entry, a set of color bars is displayed. The number of bars and their colors depend on the groups to which the entry belongs to. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.

Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This explanation should be somewhere else. Probably line 155.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right this line wasn't well placed. I moved it to line 157. I also detailled the difference between the two text fields because I didn't find that very clear, I hope this is relevant; please tell me if it isn't.