Skip to content

Commit

Permalink
...
Browse files Browse the repository at this point in the history
  • Loading branch information
garethbilaney committed Sep 12, 2023
1 parent adae113 commit 4aa5b8c
Show file tree
Hide file tree
Showing 18 changed files with 490 additions and 154 deletions.
1 change: 0 additions & 1 deletion docs/fields/edition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import CiteDrive from '@site/src/components/CiteDrive';

In the academic and publishing world, the edition of a book signifies the version or form in which a work is published. The `edition` field in a BibTeX entry is used to specify this detail, often highlighting the revisions or updates that the work has undergone since its initial release. Including the edition is particularly pertinent when referencing textbooks or scholarly works that have undergone multiple iterations. Below, we elaborate on how to effectively use the `edition` field in your BibTeX entries.


<CiteDrive />

### Overview
Expand Down
84 changes: 38 additions & 46 deletions docs/fields/editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,83 +8,75 @@ sidebar_label: editor
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: editor
The `editor` field in BibTeX is used to specify the editors of a published work. This field is essential for reference types such as books, proceedings, or collections where the role of an editor is distinct from the author. Specifying the editors appropriately can ensure correct attribution and smoother referencing in academic papers and articles. Here, we delve deeper into the ways to indicate editors in BibTeX.

In the ``editor``-field, you can specify all editors to the work you want to cite. BibTeX has several ways of specifying editor names but expects in all cases a consistent and exact arrangement so that inaccurate information could lead to the unwanted output of the editor's name.
<CiteDrive />

**Notation: ``{Firstname Lastname}``**
### Formatting Rules

A natural indication such as ``{Firstname Lastname}`` is possible, but not vice versa, "Lastname Firstname."
In the `editor` field, various notation formats are accepted. However, the formatting should be consistent and precise to avoid incorrect representation of the editor's name. Here are the commonly used notations:

**Example, ``{Firstname Lastname}``**
#### Notation: `{Firstname Lastname}`

```tex
@article{ (...),
This is a straightforward method where you list the editor's first name followed by the last name. Note that the inverse, "Lastname Firstname", is not recommended.

...
editor={Isaac Newton}
**Example**

```bibtex
@book{Example2023,
...
editor={Isaac Newton},
...
}
```

#### Notation: `{Lastname, Firstname}`

**Notation: ``{Lastname, Firstname}``**
However, we recommend the following way ``{Lastname, Firstname}`` i.e., last name and first name separated by a comma. This way allows for more control to distinguish between the first and last name.

**Example, ``{Lastname, Firstname}``**
This is the recommended format as it provides clear differentiation between the first and last names, which is particularly beneficial for names with multiple components.

```tex
@article{ (...),
**Example**

```bibtex
@book{Example2023,
...
editor={Newton, Isaac}
editor={Newton, Isaac},
...
}
```

#### Notation: `{Lastname, Suffix, Firstname}`

**Notation: ``{Lastname, Suffix, Firstname}``**

If you want to specify any suffix, for example, Junior, Senior, the 5th (Jr. Sr. V), do so in the following way strictly in this order, separating each component with a comma:
For editors with suffixes (e.g., Junior, Sr., III), the name should be formatted with the last name first, followed by the suffix, and then the first name. All components should be separated by commas.

``{Lastname, Suffix, Firstname}``

**Example, ``{Lastname, Suffix, Firstname}``**

```tex
@article{ (...),
**Example**

```bibtex
@book{Example2023,
...
editor={King, Jr , Luther}
editor={King, Jr., Martin Luther},
...
}
```

**How to add multiple editors in BibTeX?**

You specify the individual editors in the manner described above. The separator, AND, divides multiple editors. So in this way:
``{Lastname, Firstname AND Lastname, Firstname AND Lastname, Firstname AND ...}``
### Adding Multiple Editors

To specify multiple editors, use the keyword `AND` between individual editor details formatted as above. This notation helps in listing several editors distinctly and accurately.

**Example, "How to add multiple editors?""**

```tex
@article{ (...),
**Example**

```bibtex
@book{Example2023,
...
editor={Fisher, James AND Clark, John}
editor={Smith, John AND Doe, Jane},
...
}
```

### Best Practices

1. **Consistency**: Maintain consistency in the notation format across all entries in your BibTeX file to ensure uniform representation.
2. **Suffixes**: Clearly specify suffixes to avoid confusion, especially in works with multiple editors having familial relations.

### Conclusion

The `editor` field is a critical component in BibTeX entries, especially for edited volumes, proceedings, and collections. Accurate and consistent notation ensures that editors receive proper attribution, thereby enhancing the credibility and readability of your citations. Remember to adhere to the recommended formats for a seamless citation experience.
48 changes: 31 additions & 17 deletions docs/fields/email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,47 @@ sidebar_label: email
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: email
The `email` field in BibTeX is used to include the email addresses of the authors in your citation. While not a commonly used field and possibly unsupported in various styles, it can sometimes be useful to provide a direct line of contact to the authors. Here, we explore how to appropriately integrate email addresses into your BibTeX entries.

Email includes the email address of the stated authors if you want to indicate them. It's not a common field and might not be supported.
<CiteDrive />

To specify email addresses, the following variants are recommended:
## Including Email Addresses

**As a note to display at the end of the reference:**
If you decide to specify email addresses in your BibTeX entries, here are two recommended methods:

### Display as a Note at the End of the Reference

```tex
@book{ ... ,
author = {Muller, John},
In this approach, the email address is added as a note that appears at the end of the citation. This way, it is distinctly separated from the author's name and other details, ensuring clarity.

...
note = "{\tt [email protected]}"
```bibtex
@book{Sample2023,
author = {Muller, John},
...
note = "{\tt [email protected]}",
...
}
```

**To display behind the family name:**

```tex
### Display Behind the Family Name

@book{ ... ,
author = {Muller {\tt [email protected]}, John },
...
Another method is to incorporate the email address directly behind the family name. This approach provides a direct association between the author and their email address, facilitating immediate contact.

```bibtex
@book{Sample2023,
author = {Muller {\tt [email protected]}, John},
...
}
```

## Guidelines for Including Email Addresses

1. **Privacy Considerations**: Before including an author's email address, ensure you have their permission to do so, respecting their privacy and adhering to ethical guidelines.

2. **Formatting**: Maintain a clear and readable format by using the Teletype (`\tt`) font style to differentiate the email address from other text elements.

3. **Compatibility**: Be aware that the `email` field is not standard and may not be supported in all BibTeX styles. Always check the compatibility with your chosen style to avoid formatting issues.


## Conclusion

While not common, including email addresses in your BibTeX entries can sometimes facilitate direct communication with the authors. Always adhere to ethical guidelines and verify compatibility with your chosen BibTeX style when using the `email` field. By following the recommended formats, you can integrate email addresses into your citations seamlessly.
14 changes: 10 additions & 4 deletions docs/fields/howpublished.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,20 @@ sidebar_label: howpublished
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: howpublished
The `howpublished` field is utilized in the `@misc` entry type, usually to address those source types that are not directly supported by BibTeX. This field comes in handy, especially when you are citing web pages and you want to provide a URL.

The `howpublished` field is used with the `@misc` entry, typically as a workaround for a source type BibTeX does not support. The most common example is when citing web pages and specifying a URL.
<CiteDrive/>

In your BibTeX entries, you can utilize the `howpublished` field to detail the publication medium or source of the reference. This field is highly useful when you need to incorporate non-traditional sources into your references, such as web pages or online reports.

```tex
Here is an example demonstrating how to use the `howpublished` field to specify a URL when citing a web page:

```bibtex
@misc{BibTeXeu,
title = {{Reference management with BibTeX: A short guide},
title = {{Reference management with BibTeX: A short guide}},
howpublished = {\url{https://bibtex.eu/}},
note = {Accessed: 2022-06-12}
}
```

In this example, the `howpublished` field is used to provide the URL of the web page being cited, offering readers a direct link to the source. Remember to include a `note` field to specify the access date, which is a common requirement when citing online sources.
12 changes: 9 additions & 3 deletions docs/fields/institution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,18 @@ sidebar_label: institution
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: institution
The `institution` field is designated to be used within the `@techreport` entry type, where it serves to denote the name of the institution that was responsible for issuing or publishing the report. This helps to give proper attribution and helps readers to find the original source more easily.

The `institution` field is used together with the `@techreport` entry to specify the name of the institution that issued the report.
<CiteDrive/>

Here is an example structure demonstrating how you might use the `institution` field in a `@techreport` entry:

```tex
```bibtex
@techreport{key,
institution = {...},
}
```

In this format, the "key" is a unique identifier for the BibTeX entry, and the "institution" field should contain the name of the institution that published the report. It is essential to provide accurate and detailed information in this field to facilitate proper citation and referencing.

Ensure to replace the `{...}` with the actual name of the institution when you are creating your BibTeX entries. This field helps to organize and categorize technical reports properly in your reference list.
25 changes: 20 additions & 5 deletions docs/fields/journal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,29 @@ sidebar_label: journal
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: journal
The `journal` field is utilized to specify the name of the journal where the article was published. This field is critical in differentiating articles from various publications and providing the correct context for the referenced work.

The name of the journal in which the journal was published.
<CiteDrive/>

Here is a template to demonstrate how you can use the `journal` field in a `@article` entry:

```tex
```bibtex
@article{ ... ,
journal = {2007},
journal = {Name of the Journal},
}
```

In the above format, replace "Name of the Journal" with the actual name of the journal where the article was published. It is important to enter this information accurately to ensure correct citations.

For instance, the following is an example showcasing a correct use of the `journal` field:

```bibtex
@article{smith2023effects,
title = {The Effects of XYZ on ABC},
author = {Smith, John},
journal = {Journal of ABC Research},
year = {2023},
}
```

38 changes: 31 additions & 7 deletions docs/fields/month.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,43 @@ sidebar_label: month
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: month
The `month` field in BibTeX is utilized to denote the month in which a particular work was published or created (if unpublished). This information assists in offering a detailed timeline of the piece and can be vital for certain types of academic or historical research.

The month of publication, or creation if unpublished.
<CiteDrive />

**Example**
In BibTeX entries, it's common to denote the month using either the numeric representation or a three-letter abbreviation. Using a standardized format can help maintain consistency in your bibliography. Here are a few formats that are generally accepted:

```tex
1. Numeric representation (01 to 12).
2. Three-letter abbreviation (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec).

@book{ ... ,
It's important to note that the month field should be used judiciously, especially when citing books or works without a specific publication month, to avoid inaccurate information.

month = {2007},
## Format

...
You can use the month field in various BibTeX entries like `@book`, `@article`, etc., as demonstrated in the following template:

```bibtex
@book{...,
month = {month representation},
...
}
```

In the above template, replace "month representation" with either the numeric representation or the three-letter abbreviation of the month.

## Example

Here is a practical example demonstrating how to use the `month` field in a `@book` entry:

```bibtex
@book{johnson2023deep,
title = {Deep Learning and its Applications},
author = {Johnson, Mark},
month = {mar},
year = {2023},
publisher = {Tech Publishing House},
}
```

In this example, the book was published in March 2023, providing a clear and specific timeline for the publication. Remember to verify the publication month from reliable sources to maintain the accuracy of your references.
48 changes: 42 additions & 6 deletions docs/fields/note.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,57 @@ sidebar_label: note
import CiteDrive from '@site/src/components/CiteDrive';
```

# BibTeX field type: note
The `note` field in a BibTeX entry is utilized to convey additional information regarding the cited work that doesn't fit into other standardized fields. This could include supplementary remarks, explanations, or clarifications that are pertinent for the reader to understand the context or the significance of the work in question. The `note` field proves to be a versatile tool in BibTeX, allowing for the inclusion of various kinds of information that could enhance the detail and depth of the citation.

The notes field can be used to store additional information about a particular BibTeX entry that may be relevant to the reader or that is needed for a particular entry type and citation style but does not fit in any other field.
<CiteDrive />

Utilizing the `note` field can often bring more depth to a reference by including additional context, remarks on the publication status, specific annotations, or any other relevant data that would benefit the reader. This might include links to supplementary materials, commentary on the work's influence or reception, or any other pertinent details.

## Format

```tex
@book{Mueller2014The,
To employ the `note` field, you would include it in your BibTeX entry as shown in the format below:

```bibtex
@entrytype{citationkey,
...
note={your note here},
...
}
note={ ... }
```

...
In the above format, replace "entrytype" with the appropriate type of work (e.g., @book, @article) and "citationkey" with a unique identifier for the entry. Then, you can insert your additional information in the `note` field.

## Examples

Here are a few practical examples showcasing how to use the `note` field in various entries:

### Example 1: Additional Information

```bibtex
@book{smith2023innovations,
title = {Innovations in Modern Technology},
author = {Smith, John},
year = {2023},
publisher = {Technology Press},
note = {Includes bibliographical references and index},
}
```
### Example 2: Supplementary Material

```bibtex
@article{johnson2023ai,
title = {AI and Its Future Applications},
author = {Johnson, Mark},
year = {2023},
journal = {Journal of Technological Advances},
volume = {5},
issue = {2},
pages = {123-135},
note = {Supplementary material available at: http://example.com/supplementary_material},
}
```

In these examples, the `note` field is used to indicate the inclusion of references and an index in a book and to provide a link to supplementary materials for an article, thereby offering the reader additional resources and information.
Loading

0 comments on commit 4aa5b8c

Please sign in to comment.