Code

Opened 3 years ago

Closed 13 months ago

Last modified 13 months ago

#15379 closed Cleanup/optimization (fixed)

FAQ should include standard way to cite django

Reported by: csgreene Owned by: susan
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 russellm)

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.

Attachments (0)

Change History (13)

comment:1 Changed 3 years ago by russellm

  • Component changed from Uncategorized to Documentation
  • Description modified (diff)
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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.

comment:2 Changed 3 years ago by adrian

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 Changed 3 years ago by lrekucki

  • Severity set to Normal
  • Type set to Cleanup/optimization

comment:4 Changed 2 years ago by anonymous

  • Easy pickings unset
  • Resolution set to wontfix
  • Status changed from new to closed
  • UI/UX unset

Actually, I'm closing this because I've never heard of anybody else having this need for citation.

comment:5 Changed 2 years ago by adrian

Whoop, that was me.

comment:6 Changed 21 months ago by anonymous

  • Resolution wontfix deleted
  • Status changed from closed to 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 Changed 13 months ago by aaugustin

  • Status changed from reopened to new

comment:8 Changed 13 months ago by susan

  • Owner changed from nobody to susan
  • Status changed from new to assigned

comment:9 Changed 13 months ago by russellm

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 Changed 13 months ago by russellm

  • Easy pickings set

comment:11 Changed 13 months ago by susan

Pull request completed. See https://github.com/django/django/pull/974 . Let me know if further improvements need to be made.

Last edited 13 months ago by susan (previous) (diff)

comment:12 Changed 13 months ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

In 9916e69bf10ce80645c362edefa150ab70b532b4:

Fixed #15379 - Added "how to cite Django" to FAQ.

Thanks Russ and Susan Tan.

comment:13 Changed 13 months ago by Tim Graham <timograham@…>

In abaab6ef48f262d47f018eeae66ad616697d8479:

[1.5.x] Fixed #15379 - Added "how to cite Django" to FAQ.

Thanks Russ and Susan Tan.

Backport of 9916e69bf1 from master

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.