Drasil: Rename References in GlassBR

Created on 27 Jun 2018  路  23Comments  路  Source: JacquesCarette/Drasil

Similar to smiths/caseStudies#104, the ASTM references should potentially be updated in Drasil, although they are better than the ones in caseStudies were. The main problems are the author field (should be "ASTM") and the name of them (should be "ASTMyear").

https://github.com/JacquesCarette/Drasil/blob/bda79c7dae9c845c178e0c309dca68ec0f4bec4a/code/Example/Drasil/GlassBR/References.hs#L19-L43

@JacquesCarette @smiths Should I proceed with this? If so, this should be done before smiths/caseStudies#31.

All 23 comments

@samm82, I think you should proceed with this. I can't see any reason why the new bibliographic information isn't better than the old information.

@smiths Should I also rename this:

https://github.com/JacquesCarette/Drasil/blob/bda79c7dae9c845c178e0c309dca68ec0f4bec4a/code/Example/Drasil/GlassBR/References.hs#L45-L52

to wlBeasonEtAl1998, or is there some other convention you'd like me to use?

Yes, please rename the citation. I find it much easier to read citation names when a standard convention is followed.

@smiths The rename of glThick1998 to wlBeasonEtAl1998 (Beason, W. Lynn) causes the references to no longer be in alphabetical order:

Stable

[4]: Beason, W. Lynn, Kohutek, Terry L., and Bracci, Joseph M. Basis for ASTME E 1300 Annealed Glass Thickness Selection Charts. ASCE Library. February, 1998. doi.org/10.1061/(ASCE)0733-9445(1998)124:2(215).

Build

[8]: Beason, W. Lynn, Kohutek, Terry L., and Bracci, Joseph M. Basis for ASTME E 1300 Annealed Glass Thickness Selection Charts. ASCE Library. February, 1998. doi.org/10.1061/(ASCE)0733-9445(1998)124:2(215).

Is this an issue?

What determines the order of the references in the bibliography in the build version? With normal bibtex style files the order is a variability that the user can control. The order could be in the order of usage in the paper, or a sorted list. I don't think Drasil has a variability for the order, but some decision should be made. Sorted alphabetically come up most frequently. If the Drasil (build) order is just random, I would prefer that they be sorted alphabetically. Is that feasible?

This might be an oddity of the HTML printer, as opposed to the LaTeX -- am I right?

No - it occurs in the LaTeX too.

I'm assuming that the names of the references get alphabetized, so changing glThick1998 to wlBeasonEtAl1998 kicked it to the bottom of the list, when they should be alphabetized by author name - not sure how to do this/where this happens though.

That's weird. I suspect that something is odd with the wlBeason author that causes this glitch.

To stick with the consistent format, it should have been renamed to beasonEtAl1998 instead of wlBeasonEtAl1998, which fixes the issue.

The alphabetization should definitely be by author name and not by reference id. Look for uses of sortBy in the code. There are rather few left.

Nice hack. But we should figure out how to fix the deeper issue.

Is there a deeper issue though? The references should be sorted by last name, and the references themselves should prefaced by the last name, so there should never be this conflict. However, I agree that we should explicitly sort by author.

If changing wlBeasonEtAl1998 to beasonEtAl1998 fixed it, then yes, definitely. We shouldn't sort by uid!

Should this be a separate issue? I just pushed a change that addresses this issue. Should I just keep working on this issue on the same branch?

I'm also planning to work on smiths/caseStudies#31 on the GlassReferences branch as well - is that a good idea? @JacquesCarette

It is a separate issue, and should have been solved independently, so that it can be merged sooner rather than later. Just in case something happens and the branch that you are currently working on doesn't get merge for a long time. It is best to work on independent fixes in independent branches.

@JacquesCarette is correct, we cannot solve the problem by enforcing our convention that citation labels are made using the first author's last name. I like this convention, but others might not. It isn't enforced by Drasil. We should sort by the author's last name in the citation record, not by uid.

Closed with merge of #728

I agree that this issue can now be closed.

@smiths Can I merge the branch then? Or should I wait for @JacquesCarette to?

Oops. I thought it was already merged. I cannot see any reason why @JacquesCarette won't do the merge, but we better respect the process and give him a chance to do the merge.

Done.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

samm82 picture samm82  路  12Comments

samm82 picture samm82  路  12Comments

samm82 picture samm82  路  4Comments

samm82 picture samm82  路  3Comments

samm82 picture samm82  路  3Comments