Use a consistent way to cite/reference papers in documentation (either inline full-text or bibtex cite keys)

krishnakumarg1984 commented 4 years ago

This issue is just about making a consistent choice in the library for presenting reference material such as journal articles. In the master branch, most of the tutorials seem to use the bib/cite combination. However, I just stumbled upon this page (documentation of the FE_Nothing class) that inlines the reference to a full paper A. Cangiani, J. Chapman, E. Georgoulis, M. Jensen: Implementation of the Continuous-Discontinuous Galerkin Finite Element Method, arXiv:1201.2878v1 [math.NA], 2012 (see http://arxiv.org/abs/1201.2878).

If the maintainers think it is worth doing so, if I am happy to submit a PR with cite keys. However, I don't clearly know how to set up the doxygen system for this task.

bangerth commented 4 years ago

Yes, we switched to the @cite approach, but not all places have been converted. Help is certainly appreciated.

The file with the references is doc/doxygen/references.bib.

bangerth commented 4 years ago

For the one you cite, it might also be useful to find the actual paper (rather than preprint). I've generally used https://doi2bib.org to get standardized bibtex entries.

tamiko commented 4 years ago

Duplicate of #8152 closing in favor of the other issue :smiley_cat:

dealii / dealii

Use a consistent way to cite/reference papers in documentation (either inline full-text or bibtex cite keys) #9354