Opened 10 years ago

Closed 3 years ago

#947 closed enhancement (fixed)

g.version: new flag for citation info

Reported by: hamish Owned by: grass-dev@…
Priority: major Milestone: 7.2.0
Component: Default Version: svn-trunk
Keywords: g.version, citation Cc: neteler
CPU: All Platform: All

Description

Hi,

it is proposed to add a new flag to print out "how to cite grass" information.

doing this in g.version means that the info would always be up to date and relevant for the software used.

the obvious choices for flag key -c (cite) -r (ref) -b (biblio) are already taken, so I propose -x for "cross-ref".

    cite_flag = G_define_flag();
    cite_flag->key = 'x';
    cite_flag->description =
        _("Display information on how to cite this software");

the text is currently at:

http://grass.osgeo.org/download/

Citing GRASS Software
Please cite GRASS when using the software in your work. Here are some choices depending on the version used:

    * GRASS Development Team, 2010. Geographic Resources Analysis
      Support System (GRASS) Software, Version 6.4.0. Open Source
      Geospatial Foundation. http://grass.osgeo.org
    * GRASS Development Team, 2009. Geographic Resources Analysis
      Support System (GRASS) Programmer's Manual. Open Source
      Geospatial Foundation. Electronic document:
      http://download.osgeo.org/grass/grass6_progman/

A BibTeX entry for LaTeX users is


@Manual{GRASS_GIS_software,
  title = {Geographic Resources Analysis Support System (GRASS GIS) Software},
  author = {{GRASS Development Team}},
  organization = {Open Source Geospatial Foundation},
  address = {USA},
  year = {2010},
  url = {http://grass.osgeo.org},
}

Of course the version and date, etc should be dynamically filled in by the program.

see also

http://grass.osgeo.org/wiki/GRASS_Documents#General http://grass.osgeo.org/wiki/GRASS_Citation_Repository http://grass.osgeo.org/wiki/Citations_for_specific_modules

thanks, Hamish

Change History (19)

comment:1 Changed 6 years ago by neteler

HAmish, do you plan to submit this enhancement?

comment:2 Changed 6 years ago by hamish

I would be happy if someone else took up the challenge.

regards, Hamish

comment:3 Changed 5 years ago by neteler

Milestone: 7.0.07.0.1

comment:4 Changed 4 years ago by neteler

Milestone: 7.0.17.0.2

Ticket retargeted after 7.0.1 milestone closed

comment:5 Changed 4 years ago by neteler

Milestone: 7.0.27.0.3

Ticket retargeted after milestone closed

comment:6 Changed 4 years ago by neteler

Milestone: 7.0.3

Ticket retargeted after milestone closed

comment:7 Changed 4 years ago by neteler

Milestone: 7.0.4

Ticket retargeted after 7.0.3 milestone closed

comment:8 Changed 4 years ago by martinl

Milestone: 7.0.47.0.5

comment:9 Changed 3 years ago by neteler

Milestone: 7.0.57.2.0
Priority: normalcritical

comment:10 Changed 3 years ago by neteler

Priority: criticalmajor

I have implemented citation support in r68657:

GRASS 7.3.svn (nc_spm_08_grass7):~ > g.version -x
GRASS 7.3.svn (2016)

The GRASS Development Team, the addon authors, further contributors and the user community have invested enormous efforts in making GRASS GIS available to you. Please give credit where credit is due and cite GRASS GIS and its addons when you use them for data analysis.

For generic citations see below; for citing a particular GRASS GIS module, you may refer to the main author(s) along with the GRASS Development Team.

Here are some choices depending on the version used:
* GRASS Development Team, YEAR. Geographic Resources Analysis Support System (GRASS) Software, Version 7.0. Open Source Geospatial Foundation. http://grass.osgeo.org
* GRASS Development Team, YEAR. Geographic Resources Analysis Support System (GRASS) Programmer's Manual. Open Source Geospatial Foundation. Electronic document: http://grass.osgeo.org/programming7

For other (scientific) references, see
* https://grasswiki.osgeo.org/wiki/GRASS_Citation_Repository

A BibTeX entry for LaTeX users is:

@Manual{GRASS_GIS_software,
  title = {Geographic Resources Analysis Support System (GRASS) Software},
  author = {{GRASS Development Team}},
  organization = {Open Source Geospatial Foundation},
  address = {USA},
  year = {YEAR},
  url = {http://grass.osgeo.org},
}

Please check it it works ok on MS-Windows, Mac OSX, etc.

If needed, we can adjust the wording. Then I will backport the outcome.

comment:11 Changed 3 years ago by neteler

Beautified in r68658.

comment:12 Changed 3 years ago by wenzeslaus

In 68659:

wxGUI: add g.version citation info to About dialog (see #947, r68657, r68658)

comment:13 Changed 3 years ago by neteler

Citation text improved (Addons now mentioned); added CITING file to packaging in r68662.

Backports

comment:14 Changed 3 years ago by wenzeslaus

In 68932:

wxGUI: use TextCtrl? in About, so that the text can be copied (backport r68660, improves citation from r68659, see #947)

comment:15 Changed 3 years ago by wenzeslaus

7.0.5 RC1 tested on MS Windows but I can't find binaries for 7.2 and 7.3 which should be tested because of the GUI changes.

comment:16 in reply to:  15 ; Changed 3 years ago by neteler

Replying to wenzeslaus:

7.0.5 RC1 tested on MS Windows but I can't find binaries for 7.2 and 7.3 which should be tested because of the GUI changes.

A Windows user: please make a test with the current 7.2.svn

comment:17 in reply to:  16 ; Changed 3 years ago by hellik

Replying to neteler:

Replying to wenzeslaus:

7.0.5 RC1 tested on MS Windows but I can't find binaries for 7.2 and 7.3 which should be tested because of the GUI changes.

A Windows user: please make a test with the current 7.2.svn

tested by

System Info                                                                     
GRASS version: 7.2.svn                                                          
GRASS SVN revision: r69794                                                      
Build date: 2016-11-13                                                          
Build platform: x86_64-w64-mingw32                                              
GDAL: 2.1.2                                                                     
PROJ.4: 4.9.3                                                                   
GEOS: 3.5.0                                                                     
SQLite: 3.14.1                                                                  
Python: 2.7.5                                                                   
wxPython: 2.8.12.1                                                              
Platform: Windows-8-6.2.9200   
g.version -x                                                                    
GRASS 7.2.svn (2016)
The GRASS Development Team, the addon authors, further contributors and the user community have invested enormous efforts in making GRASS GIS available to you. Please give credit where credit is due and cite GRASS GIS and its addons when you use them for data analysis.
For citation choices see below; for citing a particular GRASS GIS module, you may cite the main author(s) along with the GRASS Development Team.
Choices for citing the main GRASS GIS software (update YEAR and version number accordingly):
* GRASS Development Team, YEAR. Geographic Resources Analysis Support System (GRASS) Software, Version 7.2. Open Source Geospatial Foundation. http://grass.osgeo.org
* GRASS Development Team, YEAR. Geographic Resources Analysis Support System (GRASS) Programmer's Manual. Open Source Geospatial Foundation. Electronic document: http://grass.osgeo.org/programming7
Citing a GRASS GIS Addon (update AUTHOR(S), YEAR, Addon-NAME, and version number accordingly):
* AUTHOR(S), and GRASS Development Team, YEAR Addon-NAME. Geographic Resources Analysis Support System (GRASS) Software, Version 7.2. Open Source Geospatial Foundation. https://grass.osgeo.org/grass72/manuals/addons/Addon-NAME.html
For other (scientific) references, see
* https://grasswiki.osgeo.org/wiki/GRASS_Citation_Repository
A BibTeX entry for LaTeX users is:
@Manual{GRASS_GIS_software,
  title = {Geographic Resources Analysis Support System (GRASS) Software},
  author = {{GRASS Development Team}},
  organization = {Open Source Geospatial Foundation},
  address = {USA},
  year = {YEAR},
  url = {http://grass.osgeo.org},
}

comment:18 in reply to:  17 Changed 3 years ago by hellik

Replying to hellik:

Replying to neteler:

Replying to wenzeslaus:

7.0.5 RC1 tested on MS Windows but I can't find binaries for 7.2 and 7.3 which should be tested because of the GUI changes.

A Windows user: please make a test with the current 7.2.svn

tested by

System Info                                                                     
GRASS version: 7.2.svn                                                          
GRASS SVN revision: r69794                                                      
Build date: 2016-11-13                                                          
Build platform: x86_64-w64-mingw32                                              
GDAL: 2.1.2                                                                     
PROJ.4: 4.9.3                                                                   
GEOS: 3.5.0                                                                     
SQLite: 3.14.1                                                                  
Python: 2.7.5                                                                   
wxPython: 2.8.12.1                                                              
Platform: Windows-8-6.2.9200   

also the citation hint can be copied from the about window.

comment:19 Changed 3 years ago by neteler

Resolution: fixed
Status: newclosed

SO, everything seems to be done and working here, closing. Feel free to reopen if needed.

Note: See TracTickets for help on using tickets.