#15379 closed Cleanup/optimization (fixed)
FAQ should include standard way to cite django
Reported by: | csgreene | Owned by: | Susan Tan |
---|---|---|---|
Component: | Documentation | Version: | 1.2 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description (last modified by )
Many open source projects have a standard way to cite their use in publications. R has, for example, the citation command:
"""
> citation()
To cite R in publications use:
R Development Core Team (2010). R: A language and environment for
statistical computing. R Foundation for Statistical Computing,
Vienna, Austria. ISBN 3-900051-07-0, URL http://www.R-project.org.
A BibTeX entry for LaTeX users is
@Manual{, title = {R: A Language and Environment for Statistical Computing}, author = {{R Development Core Team}}, organization = {R Foundation for Statistical Computing}, address = {Vienna, Austria}, year = {2010}, note = {{ISBN} 3-900051-07-0}, url = {http://www.R-project.org}, }
We have invested a lot of time and effort in creating R, please cite it
when using it for data analysis. See also ‘citation("pkgname")’ for
citing R packages.
"""
It would be nice if Django had a similar command or (and this is the easiest solution) if the FAQ addressed this. This would help academic users of django.
Change History (13)
comment:1 by , 14 years ago
Component: | Uncategorized → Documentation |
---|---|
Description: | modified (diff) |
Triage Stage: | Unreviewed → Accepted |
comment:2 by , 14 years ago
I'm all for adding this to the FAQ (even though it's not really frequently asked, but I can't think of another place to put it). Any suggestions on what the actual citation should be? Here is a stab at it, given your example, but I have no idea whether it's legit.
Django core team (2011). Django: A Web framework for the Python programming language. Django Software Foundation, Lawrence, Kansas, U.S.A. URL http://www.djangoproject.com
comment:3 by , 14 years ago
Severity: | → Normal |
---|---|
Type: | → Cleanup/optimization |
comment:4 by , 13 years ago
Easy pickings: | unset |
---|---|
Resolution: | → wontfix |
Status: | new → closed |
UI/UX: | unset |
Actually, I'm closing this because I've never heard of anybody else having this need for citation.
comment:6 by , 12 years ago
Resolution: | wontfix |
---|---|
Status: | closed → reopened |
There are more people that need a citation than you think, there are several people in my academic office that use Django.
comment:7 by , 12 years ago
Status: | reopened → new |
---|
comment:8 by , 12 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:9 by , 12 years ago
It's difficult to give an official citation format, for two reasons: citation formats can vary wildly between publications, and citation standards for software are still a matter of some debate.
APA style, for example, would dictate something like:
Django (Version 1.5) [Computer Software]. (2013). Retrieved from http://djangoproject.com
However, the only true guide is what your publisher will accept. I'd suggest getting hold of your publishers guidelines, and filling in the gaps as best you can.
If your referencing style guide requires a publisher name, use "Django Software Foundation".
If you need a publishing location, use "Lawrence, Kansas".
If you need a web address, use http://djangoproject.com
If you need a name, just use "Django", without any tagline.
If you need a publication date, use the year of release of the version you're referencing (e.g., 2013 for v1.5)
Beyond, that, fill in as seems appropriate for your needs.
comment:10 by , 12 years ago
Easy pickings: | set |
---|
comment:11 by , 12 years ago
Russell,
I'll add an additional section to the FAQ with your suggested comments and then get a pull request ready by end of Sunday this week. It is time for me to learn Sphinx.
comment:12 by , 12 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
Technically, that BibTeX entry is for the R manual, not for R itself. We haven't got an ISBN for our manual, because we've never tried to formally print and publish it.
Accepting as a reasonable addition to the FAQ.