Skip to content

Commit

Permalink
GITBOOK-268: Add development hint
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor authored and gitbook-bot committed Apr 11, 2024
1 parent 7cd5938 commit d24614a
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 6 deletions.
Binary file added en/.gitbook/assets/image (5) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/.gitbook/assets/image (5).png
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 en/.gitbook/assets/image (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/.gitbook/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions en/advanced/commandline.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,13 @@ Show debug level messages. The log files are stored in an internal file. See FAQ
### Display output in the console: `--console`

Show info and error messages in the console.

## Development

As developer, you pass arguments to the app using gradle's `--app` switch. Enclose the arguments in quotes. For instance `--args="--debug"` turns on debug mode.

<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>

You can then view the event log in JabRef as follows:

<figure><img src="../.gitbook/assets/image (9).png" alt=""><figcaption></figcaption></figure>
10 changes: 5 additions & 5 deletions en/advanced/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To enable auto save, JabRef adds `% DBID: <id>` to the header. This helps JabRef

<div align="center">

<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption><p>A BibTeX "Entry"</p></figcaption></figure>
<figure><img src="../.gitbook/assets/image (5).png" alt=""><figcaption><p>A BibTeX "Entry"</p></figcaption></figure>

</div>

Expand All @@ -38,12 +38,12 @@ There is a lot of different fields in _BibTeX_, and some additional fields that

The following fields are recognized by the default bibliography styles:

* **bibtexkey** A unique string used to refer to the entry in LaTeX documents. Note that when referencing an entry from LaTeX, the key must match case-sensitively with the reference string. Some characters should not be used in bibtexkey as they are not compatible or not recommended:
* **bibtexkey** A unique string used to refer to the entry in LaTeX documents. Note that when referencing an entry from LaTeX, the key must match case-sensitively with the reference string. Some characters should not be used in bibtexkey as they are not compatible or not recommended:

Check failure on line 41 in en/advanced/fields.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers [Expected: 1; Actual: 3]

en/advanced/fields.md:41:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]

`{ } ( ) , \ " - # ~ ^ : '`
* **address** Usually the address of the `publisher` or other type of institution. For major publishing houses, you may omit the information entirely or give simply the city. For small publishers, on the other hand, you can help the reader by giving the complete address.
* **annote** An annotation. It is not used by the standard bibliography styles, but may be used by others that produce an annotated bibliography.
* **author** This field should contain the complete author list for your entry. The names are separated by the word _and_, even if there are more than two authors. Each name can be written in two equivalent forms:
* **author** This field should contain the complete author list for your entry. The names are separated by the word _and_, even if there are more than two authors. Each name can be written in two equivalent forms:

Check failure on line 46 in en/advanced/fields.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers [Expected: 1; Actual: 3]

en/advanced/fields.md:46:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]

Donald E. Knuth _or_ Knuth, Donald E.

Expand All @@ -61,7 +61,7 @@ The following fields are recognized by the default bibliography styles:
* **key** Used for alphabetizing, cross referencing, and creating a label when the \`\`author'' information is missing. This field should not be confused with the key that appears in the `\cite` command and at the beginning of the library entry.
* **month** The month in which the work was published or, for an unpublished work, in which it was written. You should use the standard three-letter abbreviation of the English names (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec).
* **note** Any additional information that can help the reader. The first word should be capitalized.
* **number**
* **number**

Check failure on line 64 in en/advanced/fields.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers [Expected: 1; Actual: 3]

en/advanced/fields.md:64:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]

The number of a journal, magazine, technical report, or of a work in a series. An issue of a journal or magazine is usually identified by its volume and number; the organization that issues a technical report usually gives it a number; and sometimes books are given numbers in a named series.
* **organization** The organization that sponsors a conference or that publishes a manual.
Expand Down Expand Up @@ -120,7 +120,7 @@ You can create new fields by [editing (or creating) entry types](../setup/custom
## Hints on fields

* Generally, you can use LaTeX commands inside of fields containing text. _BibTeX_ will automatically format your reference lists, and those fields that are included in the lists will be (de)capitalized according to your bibliography style. To ensure that certain characters remain capitalized, enclose them in braces, like in the word _{B}elgium_.
* An institution name should be inside `{}` brackets.
* An institution name should be inside `{}` brackets.

Check failure on line 123 in en/advanced/fields.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers [Expected: 1; Actual: 3]

en/advanced/fields.md:123:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]

If the institution name also includes its abbreviation, this abbreviation should be also in `{}` brackets.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ JabRef offers to separate comments from as well as user-specific comments field

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>
<figure><img src="../.gitbook/assets/image (5) (1).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:

Expand Down

0 comments on commit d24614a

Please sign in to comment.