Prepare a Publication

Oftentimes one of the end products of a collaboration is a manuscript for the wider scientific community. Typically this might be an article for a scientific journal or a poster at a conference. Sometimes this might be a short article for general distribution. The public portal of HISE is the perfect destination to either provide supporting materials for a journal publication or public a general interest article. To release something to the public portal, you use the publications functionality in your HISE study.

A publication minimally consists of a report and supporting metadata such as title, authors and a hero image. In addition, you can provide a visualization, file set, notebook file, or associated Github links.

Create

You can start a publication directly from the page of the report you want to include in your publication, or by selecting from a dropdown of available reports from the "Publications" page of your study.

The requirements for starting a publication include a title, summary, author info, and a title image; these items can all be changed later but are required at initiation.

At any time during the editing process, you are able to click the "Preview" button available in the editor to see how your publication will look on the public portal.

When you are ready to publish the publication in accordance with the internal asset release review process, you can submit a request for approval. At this point a dedicated publication reviewer will receive the request and can approve or reject the publication. Once approved, the publication will appear on the public portal.

Note: if the publication needs to be retracted after publication, this action can also only be taken by the publication reviewer.

Edit

There are several sections of the publication editor that allow you to add/edit the various components to your publication.

Section: Publication

In this section, you are able to edit the metadata (title, summary, author info, title image, visibility, funders) of your publication, as well as the written body report that is associated with your publication.

Section: Report

If you make changes to the format and content of the associated report during the assembly process, you must click the "refresh" button afterwards to synchronize the latest changes to your publication.

On the public portal, the report will be rendered as HTML.

Section: File Set

In this section, you are able to add/change the file set associated with your publication.

If you make changes to the file set at any time during the assembly process, you must click the "refresh" button afterwards to synchronize the latest changes to your publication.

On the public portal, the file set will be presented as download links.

Section: Visualization

In this section, you are able to add/change the visualization associated with your publication.

If you do not see a visualization in the selection list that you expect to be there, it may be that the visualization has not yet been marked "final" in your study. You are able to change your intended visualization to "final" in the "Visualization" tab of your study.

On the public portal, the visualization will be rendered as HTML.

Section: Notebook

In this section, you are able to add/change the notebook associated with your publication.

First, you must associate an IDE saved to your study that you used to develop the notebook. Then, you are able to upload the notebook file you want to share, but there are some requirements for the notebook:

• The content of the notebook must be sanitized in that the notebook does not contain any references to the HISE SDK and can run without errors outside of HISE.
• Any associated and required data for the notebook can be included in the file set associated with the publication.

On the public portal, if the uploaded notebook is a Jupyter notebook file, it will be presented as a download link; if the uploaded notebook is a HTML-export of a notebook, it will be rendered as HTML.

Modify

You are able to make small changes to a publication after publishing it to the public portal.

The following items are able to be modified:

• Metadata (title, summary, author info, title image, visibility, funders)
• Report written body

You can switch your publication into a modifiable state by clicking the "Modify" button at the top of the Publication Editor page.
After making your intended changes, you will have to "request approval".
Upon approval, the changes will be pushed to the public portal.

Set Visibility

You have the option of changing your publication to be unlisted, in that the publication will not be readily available in the list of publications on the public portal but can still be accessed via direct link from the DOI.

If you are currently assembling the initial publication, you can change the visibility in the "Publication" section of the Publication Editor.
If you are trying to unlist a published publication, you can change the visibility after setting your publication to "modify".