32

我正在为 github 中的 repo 编写自述文件,并且我想添加对论文的引用。在引文中编码最合适的方法是什么?例如,作为块引用、代码、简单文本等?

建议?

4

3 回答 3

45

我同意 Horizo​​n_Net 的观点,这取决于个人喜好。我喜欢有一些看起来类似于 LaTeX 的东西。下面提供了一个示例。请注意,它演示了数字引用样式。字母或阅读风格也是可能的。对于数字引用风格,较大的数字应该出现在文本的后面,这会使令人满意的数字引用风格变得繁琐。为了避免这个问题,我通常使用字母引用样式。

"...the **go to** statement should be abolished..." [[1]](#1).

## References
<a id="1">[1]</a> 
Dijkstra, E. W. (1968). 
Go to statement considered harmful. 
Communications of the ACM, 11(3), 147-148.

“...... go to语句应该被废除......” [1]。

参考

[1] Dijkstra, EW (1968)。转到被认为有害的声明。ACM 通讯,11(3),147-148。

在 GitHub 风格的 Markdown 和大多数其他 Markdown 风格上,您实际上可以单击 [1] 跳转到参考。很抱歉将 Dijkstra 断章取义。完整的句子会使这个例子更难阅读。

编辑:如果引用都有一个稳定的链接,也可以使用这些:

The field of natural language processing (NLP) has become mostly dominated by deep learning approaches
(Young et al., [2018](https://doi.org/10.1109/MCI.2018.2840738)).
Some are based on transformer neural networks
(e.g., Devlin et al, [2018](https://arxiv.org/abs/1810.04805)).

自然语言处理 (NLP) 领域主要由深度学习方法主导 (Young et al., 2018 )。有些基于变压器神经网络(例如,Devlin 等人,2018 年)。

于 2019-11-04T12:35:23.317 回答
6

据我所知,没有内置机制。这会导致更多的主观意见,具体取决于个人喜好。我个人喜欢有一个单独的部分,称为references。一个示例如下所示

参考

  • 一些参考
  • 另一个参考

更新

另一种方法是使用 Markdown 中嵌入的简单 HTML。

于 2014-11-05T15:30:03.320 回答
2

替代方案(纯降价)是使用从 2021 年 8 月开始的新 GitHub 集成

增强了对 GitHub 上引用的支持

GitHub 现在内置了CITATION.cff文件的支持。

这一新功能使学者和研究人员能够让人们知道如何正确引用他们的工作,尤其是在学术出版物/材料中。

最初由研究软件工程社区提出,CITATION.cff文件是具有人类和机器可读引文信息的纯文本文件。
当我们在存储库中检测到 CITATION.cff 文件时,我们会使用此信息来创建方便的APABibTeX样式的引用链接,以供其他人引用。

这是如何工作的

在后台,我们使用ruby​​-cff RubyGem 来解析CITATION.cff文件的内容并构建一个引文字符串,然后当有人使用其中一个文件浏览存储库时,该字符串会显示在 GitHub 中1。

引文

现在,这正在帮助其他人使您的 Github 论文易于引用。

但是,如文件所述,“添加对论文的引用”:

引用软件以外的东西

如果您希望 GitHub 引文信息链接到其他资源(例如研究文章),则可以在 CFF 中使用以下类型的首选引文覆盖。

资源 类型
研究文章 文章
会议论文 会议论文

提炼

preferred-citation:
  type: article
  authors:
  - family-names: "Lisa"
    given-names: "Mona"
    orcid: "https://orcid.org/0000-0000-0000-0000"
于 2021-08-19T21:43:48.707 回答