bugGNU Octave - Bugs: bug #47058, CITATION should have URL link to...

 
 

bug #47058: CITATION should have URL link to specified version of manual + a DOI field

Submitter:  CH <atcl>
Submitted:  Wed 03 Feb 2016 11:13:57 PM UTC
 
Category:  Documentation Severity:  2 - Minor
Priority:  3 - Low Item Group:  Documentation
Status:  Fixed Assigned to:  siko1056
Originator Name:  Open/Closed:  * Closed
Release:  * dev Operating System:  * Any
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

( Jump to the original submission )

Thu 02 Mar 2017 04:46:26 PM UTC, comment #8: 
Kai Torben Ohlhus <siko1056>
Project Member
Tue 21 Feb 2017 02:20:30 PM UTC, comment #7: 

To finish this discussion, I suggest the following: As explained in comment #5 and comment #6, having a permalink is desirable. We already have this mechanism, for example https://www.gnu.org/software/octave/doc/v4.2.0 will forever point to the same manual.

==> No need for a DOI. Just replace the symlink to the latest manual https://www.gnu.org/software/octave/doc/interpreter/ by the link above.

If no one disagrees, I'll provide a CSET starting next week.

Kai Torben Ohlhus <siko1056>
Project Member
Thu 08 Sep 2016 04:15:42 PM UTC, comment #6: 

Good point.  The URL field in the CITATION always points to the latest version of the documentation which may not be appropriate.

I'm re-opening and re-titling the report, but I don't have the time right now to get a DOI.

Rik <rik5>
Project Administrator
Wed 07 Sep 2016 02:35:40 PM UTC, comment #5: 

For academic publications a digital object identifier (DOI) is useful, which could be obtained for example from: http://zenodo.org . The DOI is a perma-link to a document that fixes the citation to the intended version of Octave's pdf of the documentation. This may be advantageous if the citation references a to-be-removed function.

CH <atcl>
Wed 07 Sep 2016 01:56:00 PM UTC, comment #4: 

I updated the CITATION text to use @manual since that appears more correct.  According to BiBtex a manual could use the following syntax.

@manual{manual,
  title        = {The title of the work},
  author       = {Peter Gainsford},
  organization = {The organization},
  address      = {The address of the publisher},
  edition      = 3,
  month        = 7,
  year         = 1993,
  note         = {An optional note}
}

I used

  @manual{,
    title     = {{GNU Octave} version 4.2.0 manual: a high-level interactive language for numerical computations},
    author    = {John W. Eaton, David Bateman, S\oren Hauberg, and Rik Wehbring},
    year      = {2016},
    url       = {http://www.gnu.org/software/octave/doc/interpreter},
  }

I think this should be good enough, but I don't write academic papers.  If someone who does feels it is important to have the organization, address, and edition fields then they can prepare a cset for that.

Rik <rik5>
Project Administrator
Mon 28 Mar 2016 03:27:55 PM UTC, comment #3: 

While it would be nice to earn a few dollars for Octave, I don't think anyone actually buys printed manuals much anymore.  And then there are all those trees that die for hard copy that becomes out-of-date in a year.  I, myself, much prefer pdf manuals that I can search through with the find feature and that have clickable hyperlikns.  Unless there is an objection, I would change the Bibtex type to @manual and update the fields.

Rik <rik5>
Project Administrator
Sat 06 Feb 2016 11:00:15 PM UTC, comment #2: 

Would it make sense to make the Manual more
widely available, including some of the online
formats and possibly offer it on Amazon?

This would require some work due in part to the
current texinfo flow. But, it would, I think,
be helpful to have a version of the Manual with
helpful hyperlinks, etc.

Michael Godfrey <godfrey>
Project Member
Sat 06 Feb 2016 09:12:55 PM UTC, comment #1: 

The URL is actually pointing to the 4.0.0 manual, as the PDF does:

http://web.cvs.savannah.gnu.org/viewvc/octave/doc/interpreter/?root=octave

only the date is "wrong", wasn't changed from 2013 to 2015.

I think the @book bibtex code is due to the previous publishing as real book, therefore the publisher would be "Network Theory Ltd":

http://www.network-theory.co.uk/octave/manual/

@jwe: are there any plans for a fourth real book version? Otherwise I suggest that I change it to @booklet or @manual.

Kai Torben Ohlhus <siko1056>
Project Member
Wed 03 Feb 2016 11:13:57 PM UTC, original submission:  

The citation command without argument returns bibtex code for a "@BOOK" entry but misses the required "publisher"-key. Should this rather be a "@BOOKLET" which has a "how-published"-key that could hold the URL?

Secondly, the URL provided in the "url"-key ( http://www.gnu.org/software/octave/doc/interpreter/ ) leads to page which has an outdated copyright year. I propose to use the link to the pdf here ( http://www.gnu.org/software/octave/octave.pdf ) that is up to date.

CH <atcl>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by mtmiller (Updated the item)
  • -email is unavailable- added by godfrey (Posted a comment)
  • -email is unavailable- added by siko1056
  • -email is unavailable- added by siko1056 (Posted a comment)
  • -email is unavailable- added by atcl (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only project members can vote.

     

     

     

     

    Follow 18 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2017-03-02 siko1056 StatusNeed Info Fixed
        Open/ClosedOpen Closed
    2017-02-21 siko1056 StatusConfirmed Need Info
    2016-09-08 rik5 StatusFixed Confirmed
        Open/ClosedClosed Open
        Summarycitation command: @book or @booklet ? CITATION should have URL link to specified version of manual + a DOI field
    2016-09-07 rik5 StatusNeed Info Fixed
        Open/ClosedOpen Closed
    2016-03-21 mtmiller Severity3 - Normal 2 - Minor
        Priority5 - Normal 3 - Low
        Release4.0.1-rc1 dev
        SummaryCitation command citation command: @book or @booklet ?
    2016-02-06 siko1056 StatusNone Need Info
    2016-02-06 siko1056 Carbon-Copy- Added jwe
    2016-02-06 siko1056 CategoryNone Documentation
        Item GroupInaccurate Result Documentation
        Assigned toNone siko1056
        Release4.0.0 4.0.1-rc1

    Back to the top


    Powered by Savane 3.9