[gnuastro-commits] master 8b7e8c10: Library (options.h): --cite now includes book (using Zenodo DOI)

[Mohammad Akhlaghi]

branch: master
commit 8b7e8c10e686cca72d2ea8f9463b5de15aee2b44
Author: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Library (options.h): --cite now includes book (using Zenodo DOI)
    
    Until now, in the citation outputs of the programs we had didn't guide the
    users on how to cite the book! Also, there was no clear explanation on why
    the NoiseChisel paper is suggested as the main citation!
    
    With this commit, the proper Zenodo DOI for this version of Gnuastro is
    being used for a BibTeX entry that is recommended to the users. Also, some
    explanation has been added for the main Gnuastro paper.
    
    This was done after a good discussion with Rahna Payyasseri Thanduparackal.
---
 NEWS                      |  5 +++++
 doc/release-checklist.txt | 15 ++++++++++++++-
 lib/options.c             | 25 ++++++++++++++++++++++---
 3 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/NEWS b/NEWS
index 025774f9..976fb80f 100644
--- a/NEWS
+++ b/NEWS
@@ -97,6 +97,11 @@ See the end of the file for license conditions.
 ** Removed features
 ** Changed features
 
+*** All programs
+
+  --cite: also prints the citation for the Gnuastro book/manual (using the
+    Zenodo DOI for that release).
+
 *** Library
 
   - gal_match_kdtree: a new 'arrange' argument has been added to define the
diff --git a/doc/release-checklist.txt b/doc/release-checklist.txt
index 9e7ee607..fd9b868f 100644
--- a/doc/release-checklist.txt
+++ b/doc/release-checklist.txt
@@ -143,6 +143,17 @@ all the commits needed for this release have been 
completed.
    Akhlaghi'.
 
 
+ - [STABLE] Click on the "New version" button of Gnuastro's page on Zenodo
+   (https://doi.org/10.5281/zenodo.3483064), and click on the "Get a DOI
+   now!" button at the start of the "Basic information" section. Using
+   this, you need to update the information for the "Gnuastro book" section
+   of the string in 'gal_options_print_citation':
+     - year: set the year that you are making the release.
+     - doi: Copy the DOI from Zenodo here.
+   Later (when the new Gnuastro version is released) you can complete the
+   Zenodo submission (there is an item at the end of this list).
+
+
  - Commit all these changes:
 
      $ git add -u
@@ -288,13 +299,15 @@ all the commits needed for this release have been 
completed.
      $ git branch -D XXXX-dev
      $ git push fork --delete XXXX-dev
 
+   - In the Zenodo "New version" page that you made before, upload the PDF,
+     'tar.gz' and 'tar.gz.sig' and publish, so the DOI becomes active.
+
    - Update/edit the following URLs with the latest version (where
      necessary, may be updated already):
      - https://savannah.gnu.org/news/submit.php?group=gnuastro
        - After submitting, approve in this link:
          https://savannah.gnu.org/news/approve.php?group=gnuastro
      - https://directory.fsf.org/wiki/Gnuastro
-     - https://doi.org/10.5281/zenodo.3483064
 
    - Open 'configure.ac' and increment 'GAL_CURRENT' for the next
      release. See the 'Updating library version information' section of the
diff --git a/lib/options.c b/lib/options.c
index 906c341f..c734c61e 100644
--- a/lib/options.c
+++ b/lib/options.c
@@ -274,8 +274,16 @@ gal_options_print_citation(struct argp_option *option, 
char *arg,
   struct gal_options_common_params *cp=(struct gal_options_common_params *)pa;
   char *gnuastro_acknowledgement;
   char *gnuastro_bibtex=
-    "First paper introducing Gnuastro\n"
-    "--------------------------------\n"
+    "Main Gnuastro paper\n"
+    "-------------------\n"
+    "The paper below was the first published resource that introduced "
+    "Gnuastro. Its focus is only three of the Gnuastro programs "
+    "(NoiseChisel, Segment and MakeCatalog), but we have not yet had "
+    "time write a dedicated paper for Gnuastro. Until a high-level "
+    "paper that describes the whole of Gnuastro is published, this is "
+    "the main paper that Gnuastro's citations will be counted against. "
+    "Therefore, please cite this, even if you have not used those "
+    "programs.\n\n"
     "  @ARTICLE{gnuastro,\n"
     "     author = {{Akhlaghi}, Mohammad and {Ichikawa}, Takashi},\n"
     "      title = \"{Noise-based Detection and Segmentation of Nebulous "
@@ -295,7 +303,18 @@ gal_options_print_citation(struct argp_option *option, 
char *arg,
     "        doi = {10.1088/0067-0049/220/1/1},\n"
     "     adsurl = {https://ui.adsabs.harvard.edu/abs/2015ApJS..220....1A},\n";
     "    adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n"
-    "  }";
+    "  }\n\n\n"
+    "Gnuastro book\n"
+    "-------------\n"
+    "If you want to cite any part of the book (in any of the programs), "
+    "please use the BibTeX entry below:\n\n"
+    "  @BOOK{gnuastrobook,\n"
+    "     author = {{Akhlaghi}, Mohammad},\n"
+    "      title = {GNU Astronomy Utilities (version "PACKAGE_VERSION")},\n"
+    "       year = 2024,\n"
+    "  publisher = {Free Software Foundation},\n"
+    "        doi = {10.5281/zenodo.12738457}\n"
+    "  }\n";
 
 
   /* Print the statements. */