Skip to content

Update entry editor tabs docs for restored custom tabs #659

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

Open
koppor wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −5
Open

Update entry editor tabs docs for restored custom tabs #659

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
24 changes: 19 additions & 5 deletions en/setup/generalfields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# Entry editor tabs

{% hint style="info" %}
Since the entry editor's redesign, it is no longer possible to define custom tabs with an arbitrary set of fields. All fields of an entry are shown together in the entry editor's [Main tab](../advanced/entryeditor/#the-main-tab), grouped into collapsible sections (Identifiers, Files and links, Bibliometrics, Comments, Meta). The rest of this page describes the tabs that remain configurable.
{% endhint %}
You can configure the entry editor's tabs under **File → Preferences → Entry Editor → Editor tabs**. The configuration has two columns: **Tabs** and **Fields**.

You can choose which of the entry editor's built-in tabs are shown, and in which order, under **File → Preferences → Entry Editor → Editor tabs**. Untick a tab to hide it for all entry types; the tab list includes the Main tab, Bib(la)TeX source, Related articles, AI summary, AI chat, File annotations, LaTeX citations, Citations and Fulltext search results.
## Tabs

It does not matter how a field's name is capitalised. In the entry editor, normally a field's first letter is capitalised, i.e. _abstract_ is represented as _Abstract_, _KEYwords_ would be represented as _Keywords_ (_DOI_, _ISBN_, _URL_ are exceptions in that all letters are capitalised). In the bibtex code, all field names use lower case: _KEYwords_ is _keywords_ in the entry's bibtex code.
The **Tabs** column lists all tabs of the entry editor. There, you can

* untick a built-in tab (Main, Bib(la)TeX source, Related articles, AI summary, AI chat, File annotations, LaTeX citations, Citations, Fulltext search results) to hide it,
* reorder tabs by dragging them,
* add a custom tab by typing its name into the box below the list, and
* remove a custom tab via its delete icon.

Custom tabs are shown for all entry types. Note that all fields of an entry are always available in the entry editor's [Main tab](../advanced/entryeditor/#the-main-tab); custom tabs are an additional view on the fields you select.

Check warning on line 14 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.TooWordy] 'additional' is too wordy.

Raw Output:
{"message": "[write-good.TooWordy] 'additional' is too wordy.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 14, "column": 190}}}, "severity": "WARNING"}

Check warning on line 14 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'are shown' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 14, "column": 13}}}, "severity": "WARNING"}

## Fields

Selecting a custom tab in the **Tabs** column shows its fields in the **Fields** column. Fields can be added by name, removed, and reordered by dragging.

Check warning on line 18 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'be added' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 18, "column": 101}}}, "severity": "WARNING"}

A field name can also be a [regular expression](https://en.wikipedia.org/wiki/Regular_expression). For example, `comment-.*` shows all user-specific comment fields of an entry. A plain field name is always shown on the tab (even while the field is empty); a regular expression shows the matching fields that are set on the entry.

Check warning on line 20 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'are set' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 20, "column": 309}}}, "severity": "WARNING"}

If the same field is listed on more than one tab, a warning sign is shown next to it.

Check warning on line 22 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'is shown' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 22, "column": 66}}}, "severity": "WARNING"}

Check warning on line 22 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'is listed' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 22, "column": 19}}}, "severity": "WARNING"}

It does not matter how a field's name is capitalised. In the entry editor, normally a field's first letter is capitalised, i.e. _abstract_ is represented as _Abstract_, _KEYwords_ would be represented as _Keywords_ (_DOI_, _ISBN_, _URL_ are exceptions in that all letters are capitalised). In the bibtex code, all field names use lower case: _KEYwords_ is _keywords_ in the entry's bibtex code.

Check warning on line 24 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'be represented' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 24, "column": 187}}}, "severity": "WARNING"}

Check warning on line 24 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'is represented' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 24, "column": 140}}}, "severity": "WARNING"}

Check warning on line 24 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'is capitalised' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 24, "column": 108}}}, "severity": "WARNING"}

Check warning on line 24 in en/setup/generalfields.md

View workflow job for this annotation

GitHub Actions / vale-lint 

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

Raw Output:
{"message": "[write-good.Passive] 'is capitalised' may be passive voice. Use active voice if you can.", "location": {"path": "en/setup/generalfields.md", "range": {"start": {"line": 24, "column": 39}}}, "severity": "WARNING"}
Loading