clean up

citedrive · Sep 12, 2023 · adae113 · adae113
1 parent 920c050
commit adae113
Show file tree

Hide file tree

Showing 47 changed files with 75 additions and 111 deletions.
diff --git a/docs/biblatex.mdx b/docs/biblatex.mdx
@@ -8,8 +8,6 @@ sidebar_position: 4
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Getting Started with BibLaTeX: A Quick Guide
-
 The following guide is still in the works, but since BibLaTeX is seen by many as the BibTeX killer (and we do not disagree), we thought it would be helpful to give you a head start. Please keep in mind that many options and customizations are available in BibLaTeX, and we will gradually expand the section.
 
 1.  Install BibLaTeX: Before you can use BibLaTeX, you must first install it on your computer. This is usually accomplished by installing a LaTeX distribution that includes BibLaTeX, such as MikTeX or TeX Live, or by using Overleaf, which, like many other packages, includes everything, including styles, out of the box. 

diff --git a/docs/fields/doi.mdx b/docs/fields/doi.mdx
@@ -8,27 +8,34 @@ sidebar_label: doi
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# BibTeX field type: doi
+The `doi` field is an integral part of modern referencing, allowing for a seamless and permanent method to locate digital objects such as journal articles, research reports, and data sets in an online environment. Here, we delve deeper into the functionality and significance of the `doi` field in BibTeX, as well as provide guidance on its correct usage.
 
-``doi`` is used to store any DOI (Digital Object Identifier of the International DOI Foundation). DOI is a digital identifier that is intended to be permanent and unique. It is used, among other things, and mostly for articles from scientific journals. It can be used in ``article``, but more rarely also in ``chapter``, ``book``, or ``inproceedings`` / ``conference``. This field is optional in all cases.
+<CiteDrive />
 
-## Format
+### Overview
 
-```tex
-@article{Mueller2014The,
+A Digital Object Identifier (DOI) is a unique alphanumeric string assigned to a digital object, facilitating a persistent link to its location on the internet. As a standardized method for identifying electronic resources, the DOI remains stable even if the URL of the item changes, ensuring the longevity of references.
 
-  ...
+The `doi` field in BibTeX serves to record this identifier, allowing for precise and permanent citations. While it is predominantly found in the `article` entry type, it can also be used in other types such as `book`, `chapter`, `inproceedings`, or `conference` entries, albeit less frequently. Regardless of the entry type, the `doi` field is optional.
 
-  doi={ https://doi.org/xxxxx }
+### Syntax and Structure
 
-  ...
+To correctly incorporate a DOI into your BibTeX entry, adhere to the following format:
 
+```bibtex
+@entrytype{citationkey,
+  ...
+  doi={https://doi.org/xxxxx},
+  ...
 }
 ```
+The `doi` field encapsulates the full DOI URL, which typically starts with "[https://doi.org/](https://doi.org/)" followed by a unique identifier string.
+
+### Example
 
-## Example
+Here's an exemplar BibTeX entry that includes a DOI:
 
-```tex
+```bibtex
 @article{steinbeck2003chemistry,
   title={The Chemistry Development Kit (CDK): An open-source Java library for chemo-and bioinformatics},
   author={Steinbeck, Christoph and Han, Yongquan and Kuhn, Stefan and Horlacher, Oliver and Luttmann, Edgar and Willighagen, Egon},
@@ -37,7 +44,22 @@ import CiteDrive from '@site/src/components/CiteDrive';
   number={2},
   pages={493--500},
   year={2003},
-  publisher={ACS Publications}
-  doi={https://doi.org/10.1021/ci025584y}
+  publisher={ACS Publications},
+  doi={https://doi.org/10.1021/ci025584y},
 }
 ```
+
+In this example, the `doi` field houses the permanent URL that leads directly to the referenced article.
+
+### Utilization Tips
+
+1. **Finding DOIs**: For scholarly articles, DOIs can often be found on the first page of the article or in the online database where the article is housed.
+2. **Cross-Referencing**: Utilize the `doi` field for cross-referencing in your paper, offering readers a direct route to the original source material.
+3. **Optional but Beneficial**: While the `doi` field is optional, including it enhances the reliability and traceability of your references.
+
+### Conclusion
+
+The inclusion of the `doi` field in your BibTeX entries represents best practice in scholarly writing, offering a steadfast link to the digital objects you reference. By adopting the DOI system, you promote the accessibility and permanence of scientific knowledge, supporting the global research community in their scholarly endeavors.
+
+As you build your bibliography, remember to capitalize on the capabilities of the `doi` field, fostering a richer, more reliable, and interconnected academic discourse.
+
diff --git a/docs/fields/edition.mdx b/docs/fields/edition.mdx
@@ -8,21 +8,55 @@ sidebar_label: edition
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# BibTeX field type: edition
+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.
 
-The edition of a book, e.g. "edition = {First}" Entering an ordinal number is recommended by default, and the first letter is usually capitalised.
 
+<CiteDrive />
 
-**Example**
+### Overview
 
-```tex
+The `edition` field is utilized to denote the edition of a book. This information is essential when the book you are citing has been published in various editions, each potentially having different contents or pagination. Indicating the edition helps in providing a clear and accurate reference, aiding readers in locating the exact version of the work you used.
 
-@book{ ... ,
+### Guidelines
 
+1. **Formatting**: It is recommended to enter the edition as an ordinal number (e.g., "First," "Second," "Third," etc.) with the first letter capitalized.
+2. **Spelling Out**: Instead of numerical representations (1st, 2nd, 3rd), spelling out the ordinal numbers is favored for better readability.
+3. **Language Adaptation**: For works in languages other than English, the edition can be indicated in that language (e.g., "Erste" for first in German).
 
- edition = {First},
+### Syntax and Structure
 
- ...
+The syntax for the `edition` field is straightforward, as shown below:
 
+```bibtex
+@book{citationkey,
+  ...
+  edition={OrdinalNumber},
+  ...
 }
 ```
+
+### Example
+
+Here's an example of a BibTeX entry incorporating the `edition` field:
+
+```bibtex
+@book{author2023title,
+  title={The Title of the Book},
+  author={Author, A.},
+  year={2023},
+  publisher={Publishing House},
+  edition={First},
+}
+```
+
+In this example, the `edition` field clearly indicates that the cited work is the first edition of the book.
+
+### Additional Tips
+
+1. **Revised Editions**: For books with revised editions, you might also use terms like "Revised" or "Updated" along with the edition number (e.g., "Second, Revised").
+2. **Later Editions**: If citing from a much later edition, it might be pertinent to include a note in your citation explaining the choice if the edition contains significantly different or updated content.
+
+
+### Conclusion
+
+Properly specifying the `edition` field in your BibTeX entries ensures a more accurate and trustworthy citation process. It helps in steering your readers towards the exact version of a source material that you referred to, thereby promoting clarity and scholarly integrity. Utilize this field wisely to enhance the quality and reliability of your bibliographic references.
diff --git a/docs/intro.mdx b/docs/intro.mdx
@@ -10,8 +10,6 @@ slug: "/"
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# BibTeX Guide: Harnessing the Power of Reference Management
-
 For those diving into academic or technical writing, **BibTeX** is an indispensable ally. Despite the intricate details surrounding LaTeX packages, citation styles, and formatting, with a structured approach, BibTeX can be easy to grasp.
 
 <CiteDrive />

diff --git a/docs/natbib.mdx b/docs/natbib.mdx
@@ -9,8 +9,6 @@ sidebar_position: 3
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# A Comprehensive Guide to Reference Management using natbib with BibTeX
-
 Managing bibliographic references in LaTeX becomes streamlined and efficient with the `natbib` package. Whether you're working with the traditional `\cite{*}` command or diving deep into advanced citation methods, this guide provides foundational insights to get you started.
 
 <CiteDrive />

diff --git a/docs/overleaf.mdx b/docs/overleaf.mdx
@@ -9,8 +9,6 @@ sidebar_position: 8
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Overleaf: Online LaTeX Editor
-
 **Overleaf.com**, created from the merger of **WriteLaTeX** and **ShareLaTeX**, is a cloud-based LaTeX editor tailored for collaborative creation and publication of academic documents. 
 
 With more than 10 million users worldwide, it is a top editor for academics. It features a wide range of pre-installed tools that can be easily activated. Overleaf offers a wide range of templates that meet the design guidelines of most academic journals. This is complemented by a range of templates for university journals, compiled from the user-maintained collection in the Overleaf Gallery.

diff --git a/docs/quarto.mdx b/docs/quarto.mdx
@@ -9,8 +9,6 @@ sidebar_position: 5
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Reference management in Quart (RStudio/Posit) with BibTeX: A short guide
-
 Quarto is an excellent tool for producing reproducible reports, papers, and presentations, among other things. One of the features that distinguishes Quarto is its ability to integrate with other tools and software. BibTeX, a reference management system for LaTeX documents, is one such tool. BibTeX makes it simple to cite sources and create a bibliography in your document.
 
 <CiteDrive />

diff --git a/docs/rmarkdown.mdx b/docs/rmarkdown.mdx
@@ -9,8 +9,6 @@ sidebar_position: 6
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Reference management in R Markdown with BibTeX: A short guide
-
 R Markdown is an great tool for creating reproducible reports, papers, presentations, and more. One of the things that makes R-Markdown so powerful is its ability to integrate with other tools and software. One such tool is BibTeX, which is a reference management system for LaTeX documents. BibTeX allows you to cite sources easily in your document and create a bibliography.
 
 <CiteDrive />

diff --git a/docs/types/article.mdx b/docs/types/article.mdx
@@ -7,8 +7,6 @@ sidebar_label: article
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Introduction to BibTeX and the Article Type Entry
-
 BibTeX is a reference management system used to format lists of references in a document. It is commonly used in academic writing, particularly in scientific and technical fields. In this guide, we will introduce you to the `article` entry type in BibTeX and show you how to use it in your LaTeX documents.
 
 <CiteDrive/>

diff --git a/docs/types/booklet.mdx b/docs/types/booklet.mdx
@@ -7,8 +7,6 @@ sidebar_label: booklet
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Introduction to BibTeX and the Booklet Type Entry
-
 BibTeX is a reference management system for formatting lists of references in a document. It is widely used in the academic community, especially in the fields of science, technology, and mathematics.
 
 One of the many types of entries that can be included in a BibTeX file is the `booklet` entry type. In this guide, we will introduce you to the `booklet` entry type, and show you how to use it to manage your references in your LaTeX documents.

diff --git a/docs/types/conference.mdx b/docs/types/conference.mdx
@@ -7,8 +7,6 @@ sidebar_label: conference
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Introduction to BibTeX and the Conference Type Entry
-
 BibTeX is a reference management system used to format lists of references in a document. It is widely used in academic writing, particularly in scientific and technical fields. In this guide, we will introduce you to the `conference` entry type in BibTeX and show you how to use it in your LaTeX documents.
 
 <CiteDrive/>

diff --git a/docs/types/inbook.mdx b/docs/types/inbook.mdx
@@ -7,8 +7,6 @@ sidebar_label: inbook
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Introduction to BibTeX and the Inbook Type Entry
-
 BibTeX is a reference management system used to format lists of references in a document. It is widely used in academic writing, particularly in scientific and technical fields. In this guide, we will introduce you to the `inbook` entry type in BibTeX and show you how to use it in your LaTeX documents.
 
 <CiteDrive/>

diff --git a/docs/types/incollection.mdx b/docs/types/incollection.mdx
@@ -7,8 +7,6 @@ sidebar_label: incollection
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Introduction to BibTeX and the Incollection Type Entry
-
 BibTeX is a reference management tool that is commonly used in LaTeX documents. It allows you to create a bibliographic database and easily include references in your LaTeX documents. In this guide, we will introduce BibTeX and explain the "incollection" type entry.
 
 <CiteDrive/>

diff --git a/docs/types/inproceedings.mdx b/docs/types/inproceedings.mdx
@@ -7,8 +7,6 @@ sidebar_label: inproceedings
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Guide to BibTeX Type "Inproceedings"
-
 BibTeX is a reference management tool that is commonly used in LaTeX documents. The "inproceedings" BibTeX type is used for papers published in conference proceedings. In this guide, we will explain the required and optional fields for the "inproceedings" BibTeX type.
 
 <CiteDrive/>

diff --git a/docs/types/manual.mdx b/docs/types/manual.mdx
@@ -7,8 +7,6 @@ sidebar_label: manual
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Guide to BibTeX Type "Manual"
-
 BibTeX is a reference management tool that is commonly used in LaTeX documents. The "manual" BibTeX type is used for technical manuals or user guides. In this guide, we will explain the required and optional fields for the "manual" BibTeX type.
 
 <CiteDrive/>

diff --git a/docs/types/mastersthesis.mdx b/docs/types/mastersthesis.mdx
@@ -7,9 +7,6 @@ sidebar_label: phdthesis
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-
-# Guide to BibTeX Type "MasterThesis"
-
 BibTeX is a reference management tool that is commonly used in LaTeX documents. The "masterthesis" BibTeX type is used for master's theses. In this guide, we will explain the required and optional fields for the "masterthesis" BibTeX type.
 
 <CiteDrive/>

diff --git a/docs/types/misc.mdx b/docs/types/misc.mdx
@@ -7,8 +7,6 @@ sidebar_label: misc
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# How to Use an misc in LaTeX: BibTeX Reference Type for Citations
-
 There are a variety of entry types in BibTeX, and sometimes you will come across a source that doesn't quite match any of the predefined types. In these cases, you can use the misc type. This type is for anything that doesn't fit into one of the other categories. This could be pieces of music or lecture slides, but mostly it is to cite web pages. These unsupported source types are created with workaround fields from `note` and `howpublished`. If you frequently cite source types not supported by BibTex, you should look at BibLaTex, which offers a superset in terms of fields and types.
 
 <CiteDrive/>

diff --git a/docs/types/phdthesis.mdx b/docs/types/phdthesis.mdx
@@ -6,9 +6,6 @@ sidebar_label: phdthesis
 ```mdx-code-block
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
-
-# Guide to BibTeX Type PhdThesis
-
 BibTeX is a reference management tool that is commonly used in LaTeX documents. The "phdthesis" BibTeX type is used for PhD dissertations or theses. In this guide, we will explain the required and optional fields for the "phdthesis" BibTeX type.
 
 <CiteDrive/>

diff --git a/docs/types/proceedings.mdx b/docs/types/proceedings.mdx
@@ -7,8 +7,6 @@ sidebar_label: proceedings
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Guide to BibTeX Type "Proceedings"
-
 BibTeX is a reference management tool that is commonly used in LaTeX documents. The "proceedings" BibTeX type is used for conference proceedings, such as a collection of papers presented at a conference. In this guide, we will explain the required and optional fields for the "proceedings" BibTeX type.
 
 <CiteDrive/>

diff --git a/docs/types/techreport.mdx b/docs/types/techreport.mdx
@@ -7,8 +7,6 @@ sidebar_label: techreport
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Understanding the "techreport" Entry Type in BibTeX
-
 BibTeX is a well-known bibliographic management system that researchers and scholars use to organize and format their bibliographies. It is especially useful in computer science, but it can also be used in other fields. "techreport" is an entry type in BibTeX that is used to cite technical reports.
 
 Technical reports are documents that contain in-depth technical information about a specific subject or project. They are frequently created by organizations, institutions, or researchers and are intended for distribution to a specific group of people. Technical reports are rarely formally published, but they are a valuable source of information and should be cited in academic work.

diff --git a/docs/types/unpublished.mdx b/docs/types/unpublished.mdx
@@ -7,8 +7,6 @@ sidebar_label: unpublished
 import CiteDrive from '@site/src/components/CiteDrive';
 ```
 
-# Understanding the `unpublished` Entry Type in BibTeX
-
 BibTeX is a popular bibliographic management system that assists researchers and academics in organizing and formatting their bibliographies. It is widely used in computer science, but it is also useful in many other fields that require citation of sources. The "unpublished" entry type in BibTeX is used to cite sources that have not been officially published, such as theses, dissertations, and technical reports.
 
 The "unpublished" entry type is a versatile entry type that allows authors to include all relevant information about an unpublished source, such as the author's name, title, institution, and date. An example of a BibTeX entry for an unpublished source is as follows:

diff --git a/i18n/cs/docusaurus-plugin-content-docs/current/intro.mdx b/i18n/cs/docusaurus-plugin-content-docs/current/intro.mdx
@@ -6,8 +6,6 @@ sidebar_position: 1
 slug: "/"
 ---
 
-# BibTeX Literární správa v LaTeXu
-
 Pro začátečníky může **BibTeX** kvůli svým mnoha specifikům a formátům vypadat náročně. Tento průvodce vám však nabízí zjednodušený přehled a ukazuje, jak efektivně využívat BibTeX v LaTeXu.
 
 <iframe width="560" height="315" src="https://www.youtube.com/embed/bHD94qM0vyg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

diff --git a/i18n/cs/docusaurus-plugin-content-docs/current/natbib.mdx b/i18n/cs/docusaurus-plugin-content-docs/current/natbib.mdx
@@ -5,8 +5,6 @@ sidebar_label: "Natbib (Podrobný návod)"
 sidebar_position: 3
 ---
 
-# Komplexní průvodce správou referencí pomocí natbib s BibTeXem
-
 Správa bibliografických referencí v LaTeXu je jednoduchá a efektivní díky balíčku `natbib`. Ať už pracujete s tradičním příkazem `\cite{*}` nebo se zabýváte pokročilými metodami citace, tento průvodce poskytuje základní vhledy pro vaše začátky.
 
 ## Úvod do `natbib` a jeho předností

diff --git a/i18n/cs/docusaurus-plugin-content-docs/current/rmarkdown.mdx b/i18n/cs/docusaurus-plugin-content-docs/current/rmarkdown.mdx
@@ -5,8 +5,6 @@ sidebar_label: Using R Markdown (Quick start)
 sidebar_position: 2
 ---
 
-# Reference management in R Markdown with BibTeX: A short guide
-
 :::note
 Tato stránka je v současné době k dispozici pouze v angličtině, ale velmi bychom potřebovali vaši pomoc s jejím překladem do vašeho jazyka! Pokud máte zájem, podívejte se na naše úložiště GitHub, kde najdete další informace o tom, jak přispět.
 :::

diff --git a/i18n/da/docusaurus-plugin-content-docs/current/intro.mdx b/i18n/da/docusaurus-plugin-content-docs/current/intro.mdx
@@ -6,8 +6,6 @@ sidebar_position: 1
 slug: "/"
 ---
 
-# BibTeX Litteraturhåndtering i LaTeX
-
 For nybegyndere kan **BibTeX** synes udfordrende på grund af dens mange specifikationer og formater. Denne vejledning giver dog en forenklet oversigt og viser, hvordan du kan bruge BibTeX effektivt med LaTeX.
 
 <iframe width="560" height="315" src="https://www.youtube.com/embed/bHD94qM0vyg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

diff --git a/i18n/de/docusaurus-plugin-content-docs/current/intro.mdx b/i18n/de/docusaurus-plugin-content-docs/current/intro.mdx
@@ -6,8 +6,6 @@ sidebar_position: 1
 slug: "/"
 ---
 
-# BibTeX Literaturverwaltung in LaTeX
-
 Für Einsteiger kann **BibTeX** aufgrund seiner vielen Besonderheiten und Formate herausfordernd erscheinen. Dieser Leitfaden bietet jedoch einen vereinfachten Überblick und zeigt, wie Sie BibTeX effizient mit LaTeX nutzen können.
 
 <iframe width="560" height="315" src="https://www.youtube.com/embed/bHD94qM0vyg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,8 +5,6 @@ sidebar_label: Using R Markdown (Quick start) @@
     sidebar_position: 2
     ---
-    # Reference management in R Markdown with BibTeX: A short guide
     :::note
     Tato stránka je v současné době k dispozici pouze v angličtině, ale velmi bychom potřebovali vaši pomoc s jejím překladem do vašeho jazyka! Pokud máte zájem, podívejte se na naše úložiště GitHub, kde najdete další informace o tom, jak přispět.
     :::
@@ Expand Down @@