Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better advice for referencing #1064

Closed
bangerth opened this issue Jun 30, 2016 · 16 comments
Closed

Better advice for referencing #1064

bangerth opened this issue Jun 30, 2016 · 16 comments

Comments

@bangerth
Copy link
Contributor

In section 1.1, do a better job at recommending how to reference ASPECT.

@bangerth
Copy link
Contributor Author

Also update the reference to the manual with the version of ASPECT. (Needs to go into the release task list as well.)

@bangerth
Copy link
Contributor Author

Same text exists on the website.

@jaustermann
Copy link
Contributor

The text on the website does not include the Acknowledgement section ... but it probably should?

@bangerth
Copy link
Contributor Author

Yes, it should.

@ljhwang
Copy link
Contributor

ljhwang commented Jul 1, 2016

Since you version the manual, I would suggest that you put the version number in the bibtek. Hence, I would also make this a required reference for now in lieu of properly mentioning version in the text.

Mentioning the website is perhaps redundant as if they have the manual, should the website not already be in the manual? What is the goal in mentioning the website?

@bangerth
Copy link
Contributor Author

bangerth commented Jul 1, 2016

Yes, I think we ought to get rid of the reference to the website.

@ghost
Copy link

ghost commented Jul 1, 2016

The library types would also recommend not referencing both the website AND the manual.

@ljhwang
Copy link
Contributor

ljhwang commented Jul 1, 2016

CLAIM: I will work on this ....

@jaustermann
Copy link
Contributor

jaustermann commented Jul 1, 2016

I would not put the version number in the bibtex because the version that might be used in the paper might not be the same version number in the manual. For example if someone doesn't update his/her code for a while but then checks the online manual on how to cite it. I would simply say that if Aspect is used the version number should be stated.
I agree that citing the website is redundant and I think some journals don't even allow citing websites anymore so I would just stick with recommending citing Kronbichler and the manual.

@bangerth
Copy link
Contributor Author

bangerth commented Jul 1, 2016

See #1087 and #1092. The same changes now also have to be done on the website.

@ljhwang
Copy link
Contributor

ljhwang commented Jul 1, 2016

Version number is now in the manual bibtek but @bangerth is there a way to automatically import from VERSION into the string? This will ensure that the bibtek stays in sync.
@jaustermann A user should download the manual with the package. I would hope most users would know to use the version of the manual they downloaded. This does happen and vice versa. Always best to check VERSION.

@tjhei
Copy link
Member

tjhei commented Jul 1, 2016

A user should download the manual with the package

We don't include the pdf inside the repository because it is a) big and b) changes too often.

@tjhei
Copy link
Member

tjhei commented Jul 1, 2016

Version number is now in the manual bibtek but @bangerth is there a way to automatically import from VERSION into the string?

I don't think this will work. We can not put the current RC (currently 1.5.0) into the manual, because that is not released yet. Version 1.5.0 might never exist if we go to 2.0 directly. That means importing it automatically won't work anyways.

@tjhei
Copy link
Member

tjhei commented Jul 1, 2016

Note: any change to the manual also needs to be done at http://aspect.dealii.org/publications.html

@tjhei
Copy link
Member

tjhei commented Jul 1, 2016

Finally, didn't we want to use cite.html exclusively? (see #1014)

@gassmoeller
Copy link
Member

We updated the manual with the canonical reference, so this is partially resolved. Lets discuss #1014 separately in that PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants