Cite your research in SAMSON Elements


If a SAMSON Element corresponds to one or more research papers, you now have the possibility of letting users know about them.

First, add the SBGWindow::Citable tag in the getFormat function of your GUI (for example, the GUI of the app, or the property window of an interaction model):

int SEEMyModelProperties::getFormat() const { 
    return (SBGWindow::Savable | SBGWindow::Lockable | SBGWindow::Citable);

This adds a question mark to the window buttons:

Then, overload the SBGWindowWidget::getCitation function:

QString	SEEMyModelProperties::getCitation() const {
        "If you use this interaction model in your work, please cite:<br/>" 
        "[1] S. Artemova, L. Jaillet and S. Redon.<br/>" 
        "    Automatic molecular structure perception for the universal force field.<br/>" 
        "    J. Comput. Chem. 2016, 37, 1191-1205. DOI: 10.1002/jcc.24309.<br/>" 
        "[2] <a href=\"\"></a><br/>" 

Note that you may use the html subset supported by Qt, in particular to add links.

When clicking on the question mark button, this creates a modal popup which lets the user copy the string returned by the getCitation function to the clipboard:

Do you feel this should be used for something else? Providing help? Author information? Let us know in the comments below.


Leave a Reply

Your email address will not be published.

  • Subscribe

    Subscribe to make sure you receive all our updates, tips and tutorials