sashahafner / BMP-methods

Free, open-source documents on biochemical methane potential measurement and calculations
7 stars 7 forks source link

Format for citations #6

Closed sashahafner closed 4 years ago

sashahafner commented 4 years ago

We should make a recommendation for users.

sashahafner commented 4 years ago

How about this?

Hafner, S.D., Lojborg, N. 2019. Calculation of methane production from volumetric measurements. DBFZ BMP methods collection document 201, version 1.4. URL: https://github.com/sashahafner/BMP-methods. Accessed 28 Feb. 2020.

sashahafner commented 4 years ago

Also where should this go? Just in a separate doc that can be linked on DBFZ site? On the site itself perhaps? Or within each document as a footnote? I vote for the last option.

sastals commented 4 years ago

Why not to check an style which they can download? and provide the link somewhere.

I personally like Water Research and Bioresource Technology citation style.

koechl commented 4 years ago

We usually follow DIN ISO 690. I have only the German version available, but they also have examples for websites, for instance. I can share it with you and we can chose the most suitable one for us

soerenweinrich commented 4 years ago

I like the example from Sasha. But of course, we can follow a specific style or DIN

Generally, I would include this information in each document as a footnote in the beginning, using the same citation style applied in the document itself.

sashahafner commented 4 years ago

Here is the ISO 690 approach for a report:

image

and e-book:

image

and website:

image

sashahafner commented 4 years ago

MDPI (thinking of it because of special issue) is similar for a website:

image

sashahafner commented 4 years ago

OK how about this (for MDPI)?

Hafner, S.D., Lojborg, N. 2019. Calculation of Methane Production from Volumetric Measurements. Standard BMP Methods document 201, version 1.4. Available online: https://www.dbfz.de/en/BMP. (Accessed 28 Feb. 2020).

And we can provide BibTeX entry (can be imported into e.g., EndNote, so templates for any journal can be used):

@misc{BSM_d201_v1.4, title = {Calculation of {Methane} {Production} from {Volumetric} {Measurements}. {Standard} {BMP} {Methods} document 201, version 1.4}, url = {https://www.dbfz.de/en/BMP}, urldate = {2020-02-28}, author = {Hafner, S. D. and Lojborg, N.}, year = {2019} }

A couple issues. . . apart from these documents essentially being self-published.

  1. The document number and the version number need to be clear. So I think they need to be in the title section.
  2. We should only provide one website. I think it should be DBFZ. In the documents themselves users can find the GitHub website.
soerenweinrich commented 4 years ago

Hm ok, "year published" appears twice in the Template of ISO 690. Despite of that the templates seem to include all information needed... Maybe use the website template with some modifications for stating the specific version and reference to "Standard BMP methods" (since we cannot really name a Publisher or City). I still like your example (2,nd comment above).

soerenweinrich commented 4 years ago

ah, ok I didn't update and just saw your last comment. Yes, I like your last example! I agree, reference to Version number is necessary. Only citing one website is good as well - this way we already promote the Standard BMP methods website...

sashahafner commented 4 years ago

Ok great @soweinrich . Just a comment I started anyway:

Maybe use the website template with some modifications for stating the specific version and reference to "Standard BMP methods" (since we cannot really name a Publisher or City).

BibTeX has a "journal" entry that could have "Standard BMP Methods" but it does not show up for all templates/style files (not for MDPI but yes for ISO 690). But even then the document/version numbers don't clearly fit anywhere. Unfortunately I think the best option is within the title block, which is a little awkward, but works.

sashahafner commented 4 years ago

Using the above BibTeX entry, this is what users would get (these are from Zotero):

MDPI:

  1. Hafner, S.D.; Lojborg, N. Calculation of Methane Production from Volumetric Measurements. Standard BMP Methods document 201, version 1.4 Available online: https://www.dbfz.de/en/BMP (accessed on Feb 28, 2020).

ISO 690: HAFNER, S. D. and LOJBORG, N., 2019. Calculation of Methane Production from Volumetric Measurements. Standard BMP Methods document 201, version 1.4. [online]. 2019. [Accessed 28 February 2020]. Available from: https://www.dbfz.de/en/BMP (Yes, repeated date is odd.)

Elsevier: Hafner, S.D., Lojborg, N., 2019. Calculation of Methane Production from Volumetric Measurements. Standard BMP Methods document 201, version 1.4 [WWW Document]. URL https://www.dbfz.de/en/BMP (accessed 2.28.20).

Good enough! Any remaining issues?

sashahafner commented 4 years ago

I will make a BibTeX file with citation info for all reports available on the GitHub repo, and we can add a link to the website, e.g., "Download a BibTeX file that can be imported into EndNote, Zotero, Mendeley, or other citation management programs to simplify citing these documents here." And we can include a suggested citation format on the site for those who don't use software.

koechl commented 4 years ago

This looks good to me. I think nowadays most people like to download the information to be processed by their reference management software, such as Zotero or Endnote.

soerenweinrich commented 4 years ago

Ok good. But it does not hurt to include an example on how to cite the individual document along with the download link to the Website...

sashahafner commented 4 years ago

Ok good. But it does not hurt to include an example on how to cite the individual document along with the download link to the Website...

I agree. See issue #8 -- I will add a new version there in a minute.

Ok good. But it does not hurt to include an example on how to cite the individual document along with the download link to the Website...

Good. So they will have the choice.

Thanks for the input guys!

sashahafner commented 4 years ago

I meant. . .

This looks good to me. I think nowadays most people like to download the information to be processed by their reference management software, such as Zotero or Endnote.

Good. So they will have the choice.

sastals commented 4 years ago

Guys,

No more comments from my end. I Agree!

BTW, how you make comments on old text?

sashahafner commented 4 years ago

Great. @sastals , just paste it after a ">" symbol of use the " button at the top. But I think you may have already figured it out.