README.md

Rubric for IDMIL Bibliography Formation:

1. How to add your references to this repository:

• Step 1: Go to this repository's "new-references" branch
• Step 2: Press the "." (dot) key on your keyboard to open the Visual Studio Code for the Web
• Step 3: Edit the new_references.bib file adding or editing your references in the formats explained in the next steps
• Step 4: Click in the "Source Control" icon on the left tool bar
• Step 5: Write a text briefly explaining your changes and click on "Commit & Push" button to send it to the Github server.

2. Conference or Journal Name Standards:

• Step 1: Identify the official full name of the new conference or journal.
• Step 2: Use an abbreviation (acronym) for the conference or journal name. Use uppercase letters and ensure that it is short, memorable, and as close to the commonly used acronym as possible.
• Step 3: Add the new conference or journal to the BibTeX file using the @string directive. Format the entry to match the existing examples:
  • Use @string{ACRONYM = "Full Name of the Conference or Journal"}.
  • Ensure that the full name of conference proceedings starts with "Proceedings of the" for consistency.
  • For journals, use curly braces {} if the title has special formatting needs; otherwise, use quotation marks "".
• Step 4: Place the new @string entry in the appropriate category.

Example:

@string{ACRONYM = "Proceedings of the New Example Conference"}

3. Adding New References:

• Step 1: Determine the type of reference you are adding (e.g., conference paper, journal article). Use @inproceedings for conference papers and @article for journal articles.
• Step 2: Construct the citation key for the new reference. Use the format "lastNameYearKeyword":
  • "lastName" is the last name of the first author.
  • "Year" is the four-digit publication year.
  • "Keyword" is a short, descriptive keyword from the title.
• Step 3: Fill in the reference details following the BibTeX format:
  • Use commas to separate each field within an entry.
  • Wrap the title of the work in double braces {{}} to preserve the case of the title.
  • List all authors in the format "Last, First and Last, First", using "and" between authors.
  • Specify the booktitle or journal field using the acronym defined by the @string directive.
  • Include page numbers, volume, number, and other relevant details as applicable.
• Step 4: Ensure that the reference adheres to formatting conventions, including the use of braces and quotation marks.
• Step 5: Place the new reference in the bibliography file, keeping the references within each category in alphabetical order based on the citation key.

Example:

@inproceedings{Naef2006VR,
	title        = {{A VR Interface for Collaborative 3D Audio Performance}},
	author       = {Naef, Martin and Collicott, Daniel},
	booktitle    = NIME,
	pages        = {57--60}
	year         = 2006,
}

General Guidelines:

• Consistency: Ensure that all entries in the bibliography file follow the same formatting and naming conventions.
• Review and Validation: Regularly review the bibliography for errors, duplications, or inconsistencies. Use a BibTeX validator to assist in finding and fixing issues.
• Documentation: Provide clear documentation and examples within the lab's guidelines to help new members understand how to correctly add references.
• Updates: Keep the bibliography file up-to-date by adding new references as they are used in lab publications or reports, and by updating existing references if errors are found.