astrofrog / acknowledgment-generator Goto Github PK

Make sure we don't repeat 'This research made use of'

The Herschel acknowledgement (http://www.cosmos.esa.int/web/herschel/publishing-rules-guidelines) is complicated and can change depending on instruments used, etc. Any ideas on how to handle it?

At the moment items "Acknowledgement" are not separated at all, a period should be added to the end of each item.
"Bibtex" section became a flow of text, not very readable if I copy it to a bib file. Is there a way to preserve formatting from yaml file?

Simple issue, generates citation PER-GRA:2007 with a dash instead of an underscore, need to pick one or the other

For example, we can add a category for Python, one for IDL, etc. Along with #4 this will ensure that the user is not overwhelmed, and can just select what they need.

Should this be part of the acknowledgment text, or a separate entry?

A similar setup could be used to properly cite many of the projects/software/facilities listed here, as each of them is described in one or more papers which could be formally added to the reference list. So one idea worth considering is to provide a toggle which allows the user to choose between acknowledgment and formal citation. Either way, the proper cut-n-paste code would be generated.

For example, if 'Keck' is selected, then 'Mauna Kea Observatories' should also be selected. And the dependents should come after.

As we add more and more entries, we can make a better use of the horizontal span of the window by making the list wrap into multiple columns.

As time goes on, it is likely there will be hundreds of facilities and codes, so it would be a good idea to be able to filter down the number of options with a kind of search box.

When reviewing #81, I noticed that the tests are not run any longer. I think that's because we are still set up for Travis. But that also means that there is no automatic deployment after merging. Thus, even if I confirm #81 locally, I can't get it on the live site.

Since the deployment requires a GH secrect, I'm not sure I can actually do that. @astrofrog : Can you have a look?

Looking at Travis CI, it looks like the ":" in the LBT acknowledgment is giving the Python 3.5 test issues. Since the web page is working, should we just drop Python 3.5 fromTravis?

As more entries are present, we will need to make use of javascript to hide/show categories.

We don't want to necessarily have 'This research made use of...' repeated 20 times

We need to make sure that the output uses latex commands for non-ascii characters, and for URLs.

Many observatories requires or at least prefers to have a footnote to the title as part of the acknowledgement. Would be nice to generate this, too.

Some acknowledgments include citations - we should provide the BibTeX or AASTeX format for these.

It would be nice to have a "copy to clipboard" button, so there will be no need to select generated text manually.

(or even better, change URL in address bar if possible)

Ongoing here: https://github.com/onekiloparsec/acknowledgment-generator

Will do a PR once I get an iso-features state.

@astrofrog Let me know if you want to participate.

The current database just contains test entries, but we need to populate it! Any contributions welcome :)

If publishing a paper in an AAS journal (ApJ, ApJS, AJ), you may want to support the cut-n-paste of latex macros available in the AASTeX style: http://aas.org/aastex/facility-keywords

Astropy has two bibtex entries, which unfortunately get displayed without newlines under "bibtex".