How to cite in documentation¶

To cite a paper or work, first ensure the citation is in a bibliography (.bib) file in the /bibliographies/ directory. For example, in the bibliographies/spoofax.bib file, we find:

@inproceedings{KatsV10,
  title = {The {Spoofax} language workbench: rules for declarative specification of languages and {IDEs}},
  author = {Lennart C. L. Kats and Eelco Visser},
  year = {2010},
  doi = {10.1145/1869459.1869497},
  url = {https://doi.org/10.1145/1869459.1869497},
  pages = {444-463},
  booktitle = {Proceedings of the 25th Annual ACM SIGPLAN Conference on Object-Oriented Programming, Systems, Languages, and Applications, OOPSLA 2010},
}

Adding References

To add a reference, add it on Researchr to the Spoofax bibliography. Then on the command-line, invoke the following to regenerate the spoofax.bib file:

make bib

Do not change the spoofax.bib file manually, it is generated and updated through Researchr.

Then reference the work like this:

The Spoofax language workbench[@KatsV10] is vital to declarative language development.

Finally, add a place for the bibliography footnotes to be added (usually at the end of the file) by adding the following line to the file:

\bibliography

The line will be rendered as:

The Spoofax language workbench¹ is vital to declarative language development.

And the references will be at the bottom of this page.

If the citation appears rendered as Spoofax language workbench[^1], then you might have forgotten to add a place for the bibliography.

Lennart C. L. Kats and Eelco Visser. The Spoofax language workbench: rules for declarative specification of languages and IDEs. In William R. Cook, Siobhán Clarke, and Martin C. Rinard, editors, Proceedings of the 25^th Annual ACM SIGPLAN Conference on Object-Oriented Programming, Systems, Languages, and Applications, OOPSLA 2010, 444–463. Reno/Tahoe, Nevada, 2010. ACM. URL: https://doi.org/10.1145/1869459.1869497, doi:10.1145/1869459.1869497. ↩

Last update: October 17, 2024
Created: October 17, 2024