From 4aa5b8c94f3b8dedb0f418ce90052de19af00aa7 Mon Sep 17 00:00:00 2001 From: garethbilaney Date: Tue, 12 Sep 2023 21:28:03 +0200 Subject: [PATCH] ... --- docs/fields/edition.mdx | 1 - docs/fields/editor.mdx | 84 ++++++++++++++++-------------------- docs/fields/email.mdx | 48 +++++++++++++-------- docs/fields/howpublished.mdx | 14 ++++-- docs/fields/institution.mdx | 12 ++++-- docs/fields/journal.mdx | 25 ++++++++--- docs/fields/month.mdx | 38 +++++++++++++--- docs/fields/note.mdx | 48 ++++++++++++++++++--- docs/fields/number.mdx | 58 ++++++++++++++++++++++--- docs/fields/organization.mdx | 52 +++++++++++++++++++--- docs/fields/pages.mdx | 45 ++++++++++++++++--- docs/fields/publisher.mdx | 53 ++++++++++++++++++++--- docs/fields/school.mdx | 37 +++++++++++++--- docs/fields/series.mdx | 35 ++++++++++++--- docs/fields/title.mdx | 22 +++++++--- docs/fields/type.mdx | 18 +++++--- docs/fields/volume.mdx | 29 ++++++++----- docs/fields/year.mdx | 25 +++++++---- 18 files changed, 490 insertions(+), 154 deletions(-) diff --git a/docs/fields/edition.mdx b/docs/fields/edition.mdx index 5552846a14..a9d6a4b599 100644 --- a/docs/fields/edition.mdx +++ b/docs/fields/edition.mdx @@ -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. - ### Overview diff --git a/docs/fields/editor.mdx b/docs/fields/editor.mdx index 3fbabf995e..3056265d95 100644 --- a/docs/fields/editor.mdx +++ b/docs/fields/editor.mdx @@ -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. + -**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. \ No newline at end of file diff --git a/docs/fields/email.mdx b/docs/fields/email.mdx index ab0825fe22..09b14f4629 100644 --- a/docs/fields/email.mdx +++ b/docs/fields/email.mdx @@ -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. + -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 john.muller@example.com}" +```bibtex +@book{Sample2023, + author = {Muller, John}, + ... + note = "{\tt john.muller@example.com}", + ... } ``` -**To display behind the family name:** - -```tex +### Display Behind the Family Name -@book{ ... , - author = {Muller {\tt john.muller@example.com}, 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 john.muller@example.com}, 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. \ No newline at end of file diff --git a/docs/fields/howpublished.mdx b/docs/fields/howpublished.mdx index 5cffffe1f0..9beda21d43 100644 --- a/docs/fields/howpublished.mdx +++ b/docs/fields/howpublished.mdx @@ -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. + +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. diff --git a/docs/fields/institution.mdx b/docs/fields/institution.mdx index 48cb3bcf7a..41844b79d7 100644 --- a/docs/fields/institution.mdx +++ b/docs/fields/institution.mdx @@ -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. + +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. diff --git a/docs/fields/journal.mdx b/docs/fields/journal.mdx index fe8ea34f3e..27bf6eebfa 100644 --- a/docs/fields/journal.mdx +++ b/docs/fields/journal.mdx @@ -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. + +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}, } ``` + diff --git a/docs/fields/month.mdx b/docs/fields/month.mdx index 2a9a025c07..1714006c9c 100644 --- a/docs/fields/month.mdx +++ b/docs/fields/month.mdx @@ -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. + -**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. \ No newline at end of file diff --git a/docs/fields/note.mdx b/docs/fields/note.mdx index 91ef69c1e0..e14196460b 100644 --- a/docs/fields/note.mdx +++ b/docs/fields/note.mdx @@ -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. + +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. \ No newline at end of file diff --git a/docs/fields/number.mdx b/docs/fields/number.mdx index f62059fa7e..42d2d8ac48 100644 --- a/docs/fields/number.mdx +++ b/docs/fields/number.mdx @@ -8,13 +8,61 @@ sidebar_label: number import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: number +In BibTeX, the `number` field is used to specify the issue number of a journal, the number of a technical report, or other identifiers that are part of a larger series. This field helps to pinpoint the exact issue or edition of a series where the referenced work can be found, providing more precise information for locating the material. -Usually the issue number (or similar identifier) of a journal, magazine or the number of technical report. + +This field is commonly used in conjunction with the `volume` field, especially for journal articles and periodicals. For a technical report, the `number` field would typically contain the report number assigned by the institution or organization that published the report. -```tex -@article{key, - number={ 3 }, +## Format + +The format for the `number` field is relatively straightforward. In the context of an article entry, it would appear as follows: + +```bibtex +@article{citation_key, + ... + number={issue_number}, + ... +} + +``` + +Here, "citation_key" represents a unique identifier for the entry, and "issue_number" represents the number of the journal issue, technical report, or other publication. + +## Examples + +Below are some examples showcasing the application of the `number` field in different contexts: + +### Example 1: Journal Article + +```bibtex +@article{doe2023study, + author = {Doe, Jane}, + title = {A Comprehensive Study on Quantum Computing}, + journal = {Journal of Advanced Computing}, + year = {2023}, + volume = {29}, + number = {3}, + pages = {215-230}, } + ``` + +In this example, the `number` field specifies the third issue of the 29th volume of the "Journal of Advanced Computing". + +### Example 2: Technical Report + +```bibtex +@techreport{smith2022analysis, + author = {Smith, John}, + title = {An Analysis of Renewable Energy Trends}, + institution = {Energy Research Institute}, + year = {2022}, + number = {TR-2022-45}, + type = {Technical Report}, +} +``` + +In this case, the `number` field is used to indicate the specific report number assigned by the "Energy Research Institute". + +Utilizing the `number` field accurately can facilitate the reader in finding the source material more easily and verifying the cited information. It's an essential detail in scholarly writing and research documentation. \ No newline at end of file diff --git a/docs/fields/organization.mdx b/docs/fields/organization.mdx index 3c1a5f1b95..7fe02ca6e9 100644 --- a/docs/fields/organization.mdx +++ b/docs/fields/organization.mdx @@ -8,16 +8,54 @@ sidebar_label: organization import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: organization +The `organization` field in a BibTeX entry is used to specify the name of the organization responsible for publishing the document or hosting the event being cited. This could be a company, an institution, or a group that sponsored or organized a conference, workshop, manual, etc. Including the organization provides the reader with a clear context of the entity behind the document, which can be crucial for determining the reliability and authority of the source. -Usually, an institution, the name of the conference sponsor/organizer is used here. + -```tex -@proceedings{key, - organization={ ... }, +You will typically encounter this field in `@proceedings` and `@manual` entries, but it might appear in other types of entries as well, depending on the specific requirements of the bibliography style being used. + +## Format + +The format for specifying the `organization` field is as follows: + +```bibtex +@entry_type{citation_key, + ... + organization={Organization Name}, + ... } -@manual{key, - organization={ ... }, +``` + +Here, "entry_type" refers to the type of BibTeX entry (such as `@proceedings` or `@manual`), "citation_key" is a unique identifier for the entry, and "Organization Name" is the name of the organization involved. + +## Examples + +Here are a couple of examples demonstrating how to use the `organization` field in different contexts: + +### Example 1: Conference Proceedings + +```bibtex +@proceedings{ICML2023, + title = {Proceedings of the 40th International Conference on Machine Learning}, + year = {2023}, + organization = {International Machine Learning Society}, +} + +``` + +In this example, the `organization` field specifies the entity responsible for organizing the conference whose proceedings are being cited. + +### Example 2: Manual + +```bibtex +@manual{UserGuide2022, + title = {XYZ Software User Guide}, + year = {2022}, + organization = {XYZ Software Inc.}, } ``` + +Here, the `organization` field is used to indicate the company that published the software manual. + +Including the `organization` field in your BibTeX entries can help to provide a complete and detailed reference, facilitating more straightforward identification and retrieval of the source materials. \ No newline at end of file diff --git a/docs/fields/pages.mdx b/docs/fields/pages.mdx index 9d8ab2ba2b..d99976a959 100644 --- a/docs/fields/pages.mdx +++ b/docs/fields/pages.mdx @@ -8,20 +8,53 @@ sidebar_label: pages import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: pages +The `pages` field in a BibTeX entry denotes the specific pages that are being referred to within a larger work, such as a book or journal. This field can be essential when citing a chapter of a book or an article in a journal, helping to point readers directly to the pertinent section of the work. -Page range of, for example, a book. You can separate these either with commas or double dashes. + -```tex +## Formatting Guidelines + +You can specify a single page, a range of pages, or even non-consecutive pages. The recommended way to separate page numbers is either with commas or double dashes. Here are some guidelines to format the `pages` field properly: + +1. **Single Page:** If referring to a single page, you simply write the page number. + +2. **Range of Pages:** For a range of pages, you should use double dashes (--). This indicates a continuous range from the first number to the second. + +3. **Non-consecutive Pages:** If referring to non-consecutive pages, separate the different page numbers or ranges with a comma. + + +## Examples + +Here are some examples demonstrating how to use the `pages` field: + +```bibtex @book{key, - pages={33--44}, + title = {Title of the Book}, + author = {Author Name}, + year = {2023}, + pages = {33--44}, % Range of pages from 33 to 44 } +``` + +```bibtex @book{key, - pages={22,33--44}, + title = {Title of the Book}, + author = {Author Name}, + year = {2023}, + pages = {22, 33--44}, % Page 22 and a range from 33 to 44 } +``` +```bibtex @book{key, - pages={17}, + title = {Title of the Book}, + author = {Author Name}, + year = {2023}, + pages = {17}, % Single page } ``` + +## Note + +It is important to note that the `pages` field is not limited to `@book` entries, and can also be used in other entry types like `@article` or `@inbook` to denote the relevant pages in those contexts. Using the `pages` field correctly helps to create more accurate and helpful citations. \ No newline at end of file diff --git a/docs/fields/publisher.mdx b/docs/fields/publisher.mdx index a281291448..12638b3602 100644 --- a/docs/fields/publisher.mdx +++ b/docs/fields/publisher.mdx @@ -8,12 +8,55 @@ sidebar_label: publisher import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: publisher +The `publisher` field is used in various BibTeX entries such as `@book`, `@inbook`, or `@incollection` to specify the name of the publisher that published the referred work. Including the publisher in your citation helps to provide a comprehensive and precise reference, which can aid readers in locating the original source. -The name of the publisher of the book being cited. + -```tex -@book{key, - publisher={University of ...}, +When including a publisher in your BibTeX entry, be sure to use the full and official name of the publisher. This will ensure the citation is both professional and credible. Additionally, it helps to prevent confusion with other publishers that may have similar names. + +## Examples + +Here are a few examples demonstrating how to properly specify a publisher in different BibTeX entries: + +### Book + +```bibtex +@book{key1, + title = {The Art of Scientific Research}, + author = {John Doe}, + year = {2023}, + publisher = {Cambridge University Press}, +} + +``` + +### Inbook + +```bibtex +@inbook{key2, + title = {Chapter on Quantum Mechanics}, + author = {Jane Doe}, + year = {2023}, + publisher = {Oxford University Press}, + pages = {45--78}, + editor = {Sarah Smith}, + booktitle = {Modern Physics}, +} + +``` + +### Incollection + +```bibtex +@incollection{key3, + title = {Essay on Environmental Conservation}, + author = {Alex Johnson}, + year = {2023}, + publisher = {Springer}, + booktitle = {Sustainable Development: Theories and Practices}, + editor = {Mark Lee}, } + ``` + +Note that the `publisher` field is usually accompanied by other important fields such as `title`, `author`, `year`, etc., to provide a complete citation. It's also worth noting that depending on the citation style being used, the format and placement of the publisher field may vary, so always be sure to follow the guidelines of the specific style you are adhering to. \ No newline at end of file diff --git a/docs/fields/school.mdx b/docs/fields/school.mdx index a00f96d5a8..5caca10ad6 100644 --- a/docs/fields/school.mdx +++ b/docs/fields/school.mdx @@ -8,17 +8,40 @@ sidebar_label: school import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: school +In BibTeX, the `school` field is utilized predominantly within `@phdthesis` or `@mastersthesis` entries. This field is used to indicate the educational institution where the thesis or dissertation was written. It is a mandatory field for both entry types, helping to provide detailed information about the origin of the scholarly work, which can be important for readers who may want to seek out more information or reference the work in their own research. -`school` is specified when a `phdthesis` or `mastersthesis` is cited and is the educational institution where the student wrote the dissertation. This field is required in both entry types. + -```tex -@phdthesis{key, - school={University of ...}, +## Formatting Guidelines + +When entering the name of the school, it's advisable to use the full and official name of the institution to maintain a formal and standardized format in your references. Avoid using abbreviations unless they are widely recognized and accepted. + +## Examples + +Here are examples of how to use the `school` field for both `phdthesis` and `mastersthesis` entries: + +### PhD Thesis + +```bibtex +@phdthesis{doe2023, + author = {John Doe}, + title = {Explorations in Quantum Computing}, + year = {2023}, + school = {Massachusetts Institute of Technology}, } +``` +### Masters Thesis -@mastersthesis{key, - series={University of ...}, +```bibtex +@mastersthesis{smith2023, + author = {Sarah Smith}, + title = {A Comprehensive Study on Environmental Sustainability}, + year = {2023}, + school = {University of California, Berkeley}, } ``` + +## Note + +In your example, you used the `series` field instead of the `school` field for the `mastersthesis` entry. However, the `school` field should be used for specifying the institution in both `phdthesis` and `mastersthesis` entries, as shown in the examples above. \ No newline at end of file diff --git a/docs/fields/series.mdx b/docs/fields/series.mdx index f8d9a2fd15..bc858a2fe5 100644 --- a/docs/fields/series.mdx +++ b/docs/fields/series.mdx @@ -8,13 +8,38 @@ sidebar_label: series import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: series +The `series` field in BibTeX is used to denote the series to which a book, report, or other publication belongs. Specifying the series can offer additional context for the reader, as it may relate to a broader thematic or scholarly discourse. -The field can, for example, optionally be used to specify the book series in which the book (or similar) was published. + +This field is optional and can be employed in various entry types including, but not limited to `@book`, `@inbook`, `@incollection`, and `@inproceedings`. It is particularly useful when the cited work is part of an ongoing series or a larger corpus of works that share a common theme, author, or publisher. -```tex -@book{key, - series={...}, +When inputting data into the `series` field, it is recommended to use the full official title of the series. If the series has an ISSN, it might also be relevant to include this for more precise referencing. + +## Format + +The general format for including a series in your BibTeX entry is as follows: + +```bibtex +@entrytype{key, + ... + series = {Name of the Series}, + ... } ``` + +## Example + +Here is an example of how to use the `series` field in a `@book` entry: + +```bibtex +@book{doe2023, + author = {John Doe}, + title = {Advanced Studies in Quantum Mechanics}, + year = {2023}, + publisher = {Scientific Publishing Ltd.}, + series = {Cambridge Advanced Series in Physics}, +} +``` + +In this example, the book is part of the "Cambridge Advanced Series in Physics," which might encompass various titles covering advanced topics in the field of physics. Including the series helps to locate the work within a larger academic conversation and can provide readers with additional resources on the topic. \ No newline at end of file diff --git a/docs/fields/title.mdx b/docs/fields/title.mdx index 8838f120a4..f067362106 100644 --- a/docs/fields/title.mdx +++ b/docs/fields/title.mdx @@ -8,21 +8,25 @@ sidebar_label: title import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: title +The `title` field in a BibTeX entry is used to specify the main title of the work you are referencing. It is one of the essential fields and is supported by almost all BibTeX entry types. Accurate capitalization and adherence to LaTeX syntax are critical when populating this field to ensure that the title is displayed correctly in the generated bibliography. -The title field is saved for the title of a work to be cited. LaTeX-specific writing, such as capitalisation, should be taken into account. + +To maintain proper formatting, LaTeX commands can be used within the `title` field to preserve the capitalization of certain words or phrases. Moreover, if the title contains special characters or mathematical symbols, they should be entered using the appropriate LaTeX commands. -## example +## Example -```tex +Here's a simple example showcasing how to use the `title` field: -@article{..., +```bibtex +@article{key, title={What is bioinformatics? An introduction and overview}, } ``` -## full example -```tex + +A more detailed example, including additional fields to provide a comprehensive reference, is given below: + +```bibtex @article{luscombe2001bioinformatics, title={What is bioinformatics? An introduction and overview}, author={Luscombe, Nicholas M and Greenbaum, Dov and Gerstein, Mark}, @@ -34,3 +38,7 @@ The title field is saved for the title of a work to be cited. LaTeX-specific wri publisher={Georg Thieme Verlag KG} } ``` + +In these examples, the `title` field is populated with the title of the article being cited. Note the use of braces `{}` to encapsulate the title text, which helps in maintaining the capitalization and formatting of the title as intended by the author. + +Remember, the `title` field is crucial in helping readers identify the specific work being referenced, so ensure that it is entered accurately and formatted correctly in your BibTeX entries. \ No newline at end of file diff --git a/docs/fields/type.mdx b/docs/fields/type.mdx index d185931624..ecc9bf6e5d 100644 --- a/docs/fields/type.mdx +++ b/docs/fields/type.mdx @@ -8,16 +8,24 @@ sidebar_label: type import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: type +The `type` field in a BibTeX entry is utilized to indicate the specific type or category of a publication. This field can be particularly useful when you are referencing reports, theses, or other documents that have more detailed categorizations. Indicating the specific type can provide the reader with more context about the nature of the document you are referencing. -Within the BibTeX entry, the type field is used to declare an explicit type, i.e. for technical report "Research Note", or "Government Report". + +Commonly used in conjunction with entries like `@techreport` or `@thesis`, it helps to denote a more specific sub-type of the publication, such as a "Research Note", "Government Report", "Master's Thesis", "PhD Dissertation", and so forth. This field can help in distinguishing the document from others of a similar category. -## example +When using the `type` field, it is advisable to use a descriptive and standardized terminology that aligns with the norms of the field or discipline you are working in. This promotes clarity and helps the reader in understanding the exact nature of the referenced document. -```tex +## Example -@techreport{..., +Here is an example demonstrating how to use the `type` field in a technical report entry: + +```bibtex +@techreport{key, type={Research Note}, } ``` + +In this example, the `type` field is populated with the descriptor "Research Note", indicating that the technical report is a note detailing some research findings. + +By utilizing the `type` field effectively, you can provide more detailed information about the documents you are referencing, facilitating a deeper understanding and smoother navigation of your bibliography for the reader. \ No newline at end of file diff --git a/docs/fields/volume.mdx b/docs/fields/volume.mdx index 7710a2d842..dc23edada3 100644 --- a/docs/fields/volume.mdx +++ b/docs/fields/volume.mdx @@ -8,21 +8,30 @@ sidebar_label: volume import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: volume +The `volume` field in a BibTeX entry is essential when you are referencing a part of a larger work, such as an article in a journal or a chapter in a multi-volume book. This field allows you to specify which volume of a journal or book you are citing, providing the reader with more precise information to locate the cited work. -The 'volume' field is used to enter the volume of a journal or multi-volume book. + +In many scholarly and academic publications, journals are published in volumes, often with several issues in each volume. The volume number usually indicates a collection of issues published within a specific time frame, typically a year. Similarly, multi-volume books or series are segmented into different volumes, each containing a portion of the entire work. -**Example** +The `volume` field is particularly crucial when citing journals, as it enables readers to find the specific collection of issues where the cited article was published. It is typically used in conjunction with the `number` field, which further specifies the issue within the volume where the article can be found. -```tex +Here's how you can use the `volume` field in a BibTeX entry: -@book{ ... , - - - volume = {5}, - - ... +## Example +```bibtex +@article{key, + title={Title of the Article}, + author={Author Name}, + journal={Journal Name}, + volume={5}, + number={3}, + pages={123-456}, + year={2022}, } ``` + +In this example, the `volume` field specifies that the article was published in volume 5 of the journal. Including this detail helps in providing a complete and precise citation, making it easier for readers to locate the cited work. + +Similarly, in multi-volume books or series, you can use the `volume` field to indicate the specific volume that contains the chapter or section you are citing. This usage again assists readers in finding the exact source material more efficiently. \ No newline at end of file diff --git a/docs/fields/year.mdx b/docs/fields/year.mdx index fc7ca87bff..e6c1a7f53c 100644 --- a/docs/fields/year.mdx +++ b/docs/fields/year.mdx @@ -8,19 +8,28 @@ sidebar_label: year import CiteDrive from '@site/src/components/CiteDrive'; ``` -# BibTeX field type: year +The `year` field is used in a BibTeX entry to indicate the year when the work was published or created, if it is unpublished. This is a vital field as it gives the reader an understanding of the timeframe in which the work was produced, and it can influence the way the information in the work is perceived or utilized. -The year of publication, or creation if unpublished. + -**Example** +This field is typically mandatory in most BibTeX entry types because it helps in accurately citing and referencing a piece of work. Including the publication year is a standard practice in scholarly writing, as it provides essential context regarding the timeliness and relevancy of the cited material. -```tex +The `year` field should be filled with a four-digit year format to maintain consistency and clarity in your references. This detail facilitates a chronological understanding and easy sorting of the references in a bibliography. -@book{ ... , +Here is how you can use the `year` field in a BibTeX entry: - year = {2007}, - - ... +## Example +```bibtex +@article{key, + author = {Author Name}, + title = {Title of the Article}, + journal = {Journal Name}, + volume = {3}, + number = {2}, + pages = {123-456}, + year = {2007}, } ``` + +In this example, the `year` field indicates that the article was published in the year 2007. It is a critical piece of information that helps readers to ascertain the temporal context of the cited work, which might be vital for historical or chronological analyses in research. \ No newline at end of file