Research Catalogue Extended Guide

May 2021

About the Research Catalogue

RC content presented through some of our portals is peer reviewed, while the remaining expositions and other information are quality controlled by the individual author(s) themselves. As a result, the RC is highly inclusive.

The open source status of the RC is essential to its nature and serves its function as a connective and transitional layer between academic discourse and artistic practice, thereby constituting a discursive field for artistic research.

The RC creates a link between:

  1. elaborated documentation of artistic work,
  2. expositions and comments that engage with the contribution of the work as research
  3. creation of individual profiles that present the researchers work.

It is believed that the reflective space provided by the RC constitutes an essential part of the research process by providing a suitable structure in which to develop the relationship between documentation and presentation, whilst also retaining congruence with art itself.

What is an RC Exposition ?

The RC allows the user to create custom designed webpages called expositions. These expositions can contain many types of media including: text, video, images, and audio recordings. The way in which these materials are presented is highly customizable by the user. Expositions can be edited either using a graphical drag-and-drop editor or written using a text-based editor. Various types of import formats are also supported. Collaboration of multiple authors on the development of a single exposition is also possible.

Connection between RC and JAR

The RC forms the technical backbone of the Journal for Artistic Research (JAR): potential JAR expositions emerge from the range of the artistic research activities taking place in the RC. Moreover, submissions and peer-reviewing for JAR takes place in the RC. Authors may nominate or JAR editors may select expositions for development as JAR contributions.

If you think that the RC software might also support your research database needs then explore the possibility of using the RC as your repository by contacting us.

The Research Catalogue is provided by the Society for Artistic Research (SAR).

Licenses

Authors can choose different licenses for both their expositions and media. A license can help make clear under what conditions you allow your material to be (re)used. All rights reserved is the most strict: it means that people have to get your permission to use any material. The motivation to publish works under a more liberal Creative Commons license, is that it makes it easier for your materials to be used and distributed by others.

The RC provides the following options:

The RC default is CC-BY-NC-ND.

You can get help choosing the right license on the Creative Commons website: https://creativecommons.org/choose/ and https://creativecommons.org/faq/.

My Profile Page

The RC profile page is both the central hub for your activities on the RC and a public presentation of your research activities. The RC allows you to create a detailed public profile containing biographical data, information on projects and events as well as a list of your RC objects such as media sets and expositions. The profile is divided into two sections, the upper sections contains an artist biography as well as information of research interests and the lower part, which is titled “Research” contains a list of RC works and exposition.

Profile Section

View Public Profile

You can switch between your profile’s editing mode (private) and your public profile, which is the profile as other users see it. Click on “my profile” for the editing mode and - below your image - click “view public profile” to hide all controls, grouping options and private research. You can thus control the public visibility of your RC objects.

view public profile
view public profile

Description

You can add a short text (for example a biography), that other RC users will see when they visit your profile. To edit this text, click “edit profile”, on your profile page and scroll down. Here you can also add a tagline, set your country of residence, and list your research interests.

Uploading a CV

In addition to the profile description, it is possible to upload a more extended CV as a PDF. To do so, click “upload cv” below your profile picture.

upload your cv
upload your cv

Member of

As a user you can request membership of (some of the) RC portals. Certain actions can only be done if one is a member of the portal. For example: for some application programs, it may be required that you are member of the portal before you are able to submit an application for a program.

In most cases however, it is the task of the portal admin to make you a member of their portal, most portals do theirfore not allow users to request membership themselves.

Click edit to ask for a request to become a portal member, or remove yourself from a portal.

Research Section

Grouping

When you create a new work or exposition the newly created objects appear in default groupings (“Sets” and “Expositions”). By using the “add grouping” button you can create custom groupings. You can arrange objects according to freely created categories.

To add a new group click “add grouping” and enter the name of the grouping. You can sort your objects within a group, arrange the groups themselves and move object between groups via drag and drop. Click and drag a grouping to change the order of the groups. On the right-hand side of a grouping’s title, there are a series of icons displayed. Here you can edit and delete the grouping and control its public visibility (using the circle icon).

Only custom grouping can be deleted. If you have only one grouping containing content, its title will not be shown on your public profile. Empty groups will also not be displayed on your public profile page.

Create Exposition

By clicking “Create exposition” you can create a new exposition object which will be opened in the RC exposition workspace editor. The title, copyright and abstract fields are obligatory. In most cases, the copyright field should be the same as the main author name (so you can write your own name). You can change these details later by choosing ☰ > edit details, or in the workspace editor by clicking the title of your research (at the top of you screen).

There are two types of exposition on the RC:

The graphical editor gives the user more control over position of objects and is best used for expositions wich require non-linear layouts. See comparison.

For more info on the text editor, see text based editor.

create exposition
create exposition

Add Work

Works are an older feature, which has now been replaced by media sets through the media repository. If you had created works previously, you can still edit or remove them.

Add Project

Projects were part of an external import of data, they are no longer available for users now.

Visibility Of Groupings

You can decide if you want a grouping to be visible in your public profile.

By default, new groupings are visible in your profile as soon as they contain an RC object. To hide groupings from your public profile click the small circle icon on the right hand side of the grouping’s name. If the circle is thin, the grouping will not be shown on your public profile.

Open Exposition

The button “open exposition” opens the first page (or “weave”) of your exposition. This is equivalent to the preview version in the exposition workspace.

Exposition Details Menu

object menu location
object menu location

To access the menu, click on the (“hamburger”) menu icon, located in the bottom right corner of an object (expositions or works). Some options are only available to the author of the object.

Change Layout

This dialogue gives you the option of choosing the size of the research description boxes on your profile page.

The 4 options for how to display research on your profile
The 4 options for how to display research on your profile

Depending on the length of the content, the abstract and additional information may be reduced or even hidden. Sizing objects differently allows to focus a reader’s attention to important objects as well as to improve the overall readability of your profile page.

Four layout-templates are possible:

  1. tall and across both columns

  2. tall but only one column wide

  3. short and only one column wide, the smalles possible size

  4. short and across both columns

Manage versions

It is possible to create a snapshot of your exposition, which you can restore later.

A snapshot is created by going to ☰ > versions and clicking add snapshot.

version dialog
version dialog

When you restore a snapshot, the original is not overwritten, instead a new exposition will be created from the snapshot.

There are three options for how to deal with the collaboration settings of a restored snapshot:

One can also restore as private and change the settings afterwards of course, through the collaboration and share menus.

Versions of published expositions

Published expositions cannot be changed in the RC (this is per definition, to allow referencing content within these expositions by other researchers), but duplicates can !

To get an editable duplicate of a published exposition one has to:

  1. make a snapshot of the published exposition.
  2. restore the snapshot.

This duplicate can now be edited, without the changes having effect on the original published exposition.

Edit Research

This dialog can be opened by ☰ > edit details or clicking the title of the exposition in the workspace editor.

Edit research dialog, showing meta page

Author Pseudonym field allows you to display the exposition under a different name. If one is provided, the author pseudonym will replace the authors names wherever the work is shown on RC (and in the DOI deposit, if the exposition is published). This can also be used if a group of author(s) wants to appear under a group name. The full list of authors will be shown on the metadata page.

At the bottom of the meta tab, one can also set the entry page: the weave that is the first page that the reader sees.

Choosing an Editor

There are two types of editors in RC, the graphical editor and the text-based editor. Both editors can be used to create expositions that can be published, reviewed and submitted for publication. However, the design, the writing process as well as the way in which exposition can be read are significantly different.

When creating a new exposition you are asked to choose a format to use. After the exposition has been created, one cannot change the format anymore. It is therefore important to make the right choice for a particular project at the outset.

choosing a format in the Create Exposition dialog
choosing a format in the Create Exposition dialog

The graphical editor, which is documented here, allows the author to set the position of each element in the page. This makes it easy to have non-linear formats or presentations in which the media, such as images, video and audio files, are as important, if not more important, as the text. The editor works by dragging and dropping. There is no predefined style or template and its possible to have the reader go through the content in a non-linear fashion. However, a consequence of absolutely positioning all elements is that the exposition cannot adjust to the size of a particular device, that is, these expositions are not “responsive”. If you want readers to be able to read your exposition on mobile device the text-based editor may be more suitable for your project.

The text-based, which is documented here, editor is designed for writing (and importing) texts, while supporting the embedding of media. The input is plain text, which is translated into HTML. The author can express the structure of the text using Markdown notation. Because the input is plain text, it can also be automatically imported and exported from and to various external formats, for example MS Word documents, Open office documents and LateX. Styling is applied using standard CSS. By default the structure of the exposition is maintained, while the sizes of the text will adjust for readability on different screen sizes. Text-based expositions are responsive.

For users that need more customization, there is an option to import static HTML website as a whole. The RC does not provide editors for HTML, so for that option an external editor is to be used. JavaScript is not supported.

Finally, there is an option to import an Research Video, from https://www.zhdk.ch/forschungsprojekt/research-video–549545

Comparison of RC Exposition Formats

Graphical format Text-based
non-linear linear
page can have any dimension vertical collumn
static responsive
slideshow, 3d-object, synchronized playback of different media limited to images, video, audio & pdf
similar to Powerpoint or Dreamweaver similar to a blog post
only editable in RC input is plain text, can be imported and exported to different formats
can exist of multiple pages single page
position-based links table of content generated from headers
drag and drop, mouse based Expositions are written by typing
reviewers can leave comments and notes no commenting functionality

Media Repository

The media repository allows RC users to navigate, organize and manage their media. Each user can browse the media that is used in their expositions (the simple media) or collect media files and texts with which to create an exposition later. Beyond organizing media, you can share it with other users of the RC. You can upload media, organize it into sets and share it with other users of the RC. It extends and replaces the older “Works” feature.

Media repository
Media repository

Browsing

The media browser contains three tabs:

There are two ways of displaying the media or sets:

The filter can be used to only show certain types of media. You can filter by tags, keywords, date and media type.

Creating new media

There are various ways to create new media:

Upload

Click “Upload media” to add a new file. Once you have select one or more files, you will be asked to provide at least copyright information. If you are the creator, you can fill in your own name here.

Accepted types:

Transcoding audio and video:

The Media Repository accepts all common audio and video formats and will automatically convert them to web compatible format. Audio is transcoded to 256 kbps mp3, video to mp4 with the original resolution.

Multi-upload

You can select multiple files to upload at once or a folder containing several files. You will be presented with a form block for each file. In order to ease such a workflow you can apply the copyright information and the set you want to add the media to from one form to all other forms.

Text

Text is a media type in the media repository.

You can also create snippets of text by using the “create text” button. You can select between three different types:

Metadata

Every album and media entry is linked to set of metadata that include copyright and licensing information as well as a title and the following fields:

Description

The description is not typically displayed for a reader of an exposition but allows the author to provide additional information.

Tags

Tags are meant for personal organization. Typical examples would be “todo”, “old”, “archive”, “new”, or “in progress”. They are private to your RC account, so no other users will see them.

Open Keywords

Open keywords are shared with the entire RC, any user can add any new term to the global namespace.

You can either search for existing open keywords or create your own, if the term has not been used before.

To prevent duplicates, the RC does not differentiate between upper and lower case, for example: “Art” and “art” are understood to be the same thing.

Closed Keywords

Closed keywords are part of a closed and controlled vocabulary administered and continuously extended by the RC. They are chosen so that we can more easily interact with other repositories. They cannot be extended by individual users.

License picker

see licenses

Sets and Sharing

Media can be organized in sets. Media can belong to multiple sets at once. You can create a new set and by clicking “select” you can choose the media belongs to a set.

Media sets can be shared with other users and in portals. Click share to open the share form. There are three sections in this form:

Graphical Editor - Views

Preview

The preview is the final result that the reader will see when he/she opens your exposition, for example by opening the exposition URL or when a user clicks “OPEN EXPOSITION” anywhere on the RC. All expositions have a navigation bar that shows if the user moves his/her mouse to the top. It contains a table of contents, abstract and other information.

While you are editing your exposition in the workspace editor, the Preview button (👁, right top corner) shows what the page will look like to the reader. If you already have a preview tab open, the second time you click Preview, it will simply refresh, instead of opening a new tab.

Note: while for the reader the exposition will always open the entry page of your exposition, clicking the PREVIEW button in the editor shows the page that you currently are working on in your workspace. Thus, you can also PREVIEW pages that are not yet listed in the table of contents.

Workspace View

workspace view of the graphical exposition format
workspace view of the graphical exposition format

The workspace editor is the editor of content on the RC. It can be opened by clicking ☰ > edit workspace on an exposition listed on your profile. If you are reading one of your own expositions, you can also open the editor by clicking EDIT in the navigation bar on top. Which editor will show will depend on the format.

Published epositions cannot be edited (by definition) and you need to be the author, co-author or editor of an exposition to be able to edit an exposition.

Within the workspace view, one can enable one of these two subviews:

Graphical Editor - Workspace

workspace view of the graphical exposition format
workspace view of the graphical exposition format

Editor Basics

When you open the editor you will see math-paper like area in the center, this is called the grid. Content is added by dragging-and-dropping “tools” from the toolbar onto the grid. You can preview what the exposition looks like to the reader by clicking the “preview” button: . This preview button is located at the top right.

The position of content in graphical expositions is determined by the author and absolute. This implies:

All of the above results in the graphical editor being most suitable for non-linear layouts. For simpler expositions, it can be worthwhile to consider using the text based editor ( see choosing an editor ).

On the right you will find the content manager, consisting of four tabs:

Tab Function:
overview map and list overview
media view the previously uploaded media files
footnotes footnotes
pages manage pages

Adding a Tool

A tool is created by dragging the icon onto the canvas.

If you click a tool once, it will open the default setting dialog.

Tools can be resized by clicking and dragging the green borders with the mouse.

Tools can be rotated by clicking and dragging the yellow dot.

The size of the current weave will automatically grow when tools are added.

Context Menu

context menu location
context menu location

The context menu of a tool is reached by clicking on the menu icon (see below), or right clicking (Apple: CTRL+click) inside a tool. The only exception is the text tool, see text tool.

context menu
context menu

Key Commands

There are a few useful key commands in the editor. Selected tools have a green border.

Key command: Action:
ctrl + c copy selected tools (*)
ctrl + v paste
⌘(Mac) + a or ctrl + a select all tools on current weave
⌘(Mac) + click or ctrl + click on object select multiple objects one by one
backspace, delete remove selected tools

* = Important: the object you copy, is duplicated at the moment you paste. This means that if you change an object after copying, the pasted object will also have these changes (!)

Defaults

Defaults for styling and options can be set for a tool, by clicking it in the toolbar.

Text Tool

A video tutorial about the text tool is found here

The text tool is designed for quickly adding text.

It has two states: when it is in active state you can change the text, if you click outside of the tool, you can move the tool and change its size. Double click inside of the tool to start editing the text again. Content is saved as soon as you exit the text editing state.

If you right-click the text tool, you can find some extra edit options under edit. You can also (while hovering over a text tool with your mouse) click the (☰) menu icon and choose edit.

In comparison to the HTML-tool, the text tool allows you to edit your text directly on the page. While the HTML-tool opens a new dialog window. If you need more styling options, or want change the HTML source code of text, use the HTML-tool. A text tool can be converted to an HTML-tool via the menu option convert to HTML tool.

Placing images on top of text tools

Never place other tools (like images) directly on top of long text tools. Because of small differences in how fonts are displayed within major browsers, and the fixed position of RC tools, this can result in text overflowing into those tools if the reader uses a different browser than the author that made the exposition.

The issue is easily avoided by keeping to this rule: always start a new text tool below an inline image or tool:

proper way of combining text with other tools
proper way of combining text with other tools

Scrollbars

If the text within a text tool is longer than the tool height, a scrollbar will appear and part of the text is cutoff. Therefore (especially when copying from external editors) it is important to check that the tool has a large enough size (unless you specifically want a scrollbar).

Style

See style options.

Options

If a text is longer than its frame on the weave, a scrollbar is generated automatically. You can control the visibility of the scrollbar in options. The default setting is automatic. Be careful setting this to never: if a text tool is too small to display all the text, it will be impossible for the reader to see all the text.

History

See history.

HTML-Tool

The HTML-tool is used for advanced text editing. It is a what-you-see-is-what-you-get rich text editor. Unlike the text tool, you can only edit its content in a dialog box.

You add the HTML Tool like any other tool: drag it with your mouse from the toolbar onto your canvas.

Media

html tool media tab
html tool media tab

Text is edited in the media tab. You can style your text using the buttons.

! important: If you copy-paste your text from Word, Pages, LibreOffice, Google Docs or any other text editor, note that not all fonts and styles will show the same on every computer. A safer practice is to import the text without any formatting, and format it within RC. This can be done either by exporting your text as plain text and copy pasting from that version, or importing your document using the document import

To enlarge the palette of text styling options, click on the first button, show/hide toolbars. Opening it will allow you to insert lists, enumerations, tables, citations.

Another commenly used feature is the hyperlink button (it looks like a chain link). This can be used to insert hyperlinks or footnotes into your text.

The top right button opens the editor in fullscreen. Note: you will have to exit full screen mode to submit your changes, using the same button.

html extended tool options
html extended tool options

A few tips:

Style

> See style options

Options

If a text is longer than its frame on the weave, a scrollbar is generated automatically. You can control the visibility of the scrollbar in options. The default setting is automatic. Be careful setting this to never: if a text tool is too small to display all the text, it will be impossible for the reader to see all the text.

Templates

If you want to reuse the content of an HTML-tool, you can create your own templates. This function can be found in the media tab. After finishing the edit of your template, click save as new template and give the template a name in the dialog box that appears. To load a template, click load template and choose one from the list in the dialog box.

Submit, Delete, Or Cancel

Finally, you need to exit the dialog window. If everything is the way you want it, choose submit and the text field will be loaded on the weave. To discard changes to the content, cancel the dialog box. If you want to delete the whole HTML field, including all content in it, click delete. Unintended deletions can be restored via commandsrestore deleted tools.

Picture Tool

To add a picture, drag and drop the picture icon from the tool palette onto the weave. As with all other tools, a pop-up dialog appears automatically and gives you the choice between “selecting” or “adding” an item.

You can upload image files in the following formats: jpg, png, tiff, gif, psd, tga, bmp. For uploading PDFs, please use the PDF-tool.

To add an item, choose “add” and upload the object from your desktop to the RC servers. Name the file and make a declaration of the copyright holder. Once an image is uploaded it is also automatically added to the simple media tab.

Style

> see style options

Options

There are options available to change how images are resized in relation to the green border containing the image. This is controlled by changing the size parameter, which can be set to:

You can also change the position within the border ie: top-left, right-bottom etc…

In settings you are able to lock the aspect ratio. And you can allow readers to enlarge the image by activating the checkbox “on click open image in popup.”.

If you want to use a picture as a hyperlink, paste a URL into the field on click open link.

You can also set a tooltip text (a text that shows when the user ‘hoovers’ his mouse over the picture) for the image. Set the show on hoover option to plain text and enter your text in the box below.

You can also make the tooltip display the copyright info, by setting the show on hoover option to copyright.

Please note, you can’t change the copyright information in the “edit picture” window. To change the name or the copyright text, close the current dialog and go to the item in simple media and click edit (also double click) to open the edit media dialog.

Audio Tool

> Audio tool tutorial

As with the other tools, use the audio tool by dragging and dropping the icon from the tool palette onto the weave. A pop-up dialog window appears automatically and gives you the choice between “selecting” or “adding” an item. Selecting is for previously uploaded media (either through other audio tools or the media manager). Adding allows you to upload a new file.

The following formats are supported: ogg, wav, mov, au, mp4 audio container formats; mp2, mp3, aac, pcm a-law, flac audio codec formats. All audio file formats will be transcoded to mp3s with 256kpbs.

Audio tool upload dialog
Audio tool upload dialog

To minimize loading times, audio files are automatically compressed. During the transcoding process, the name will be grayed out in the media list and a text will be shown in the preview.

RC encodes with a bitrate of 256 bits per second. For further information and technical questions see FAQ 2.6 or contact the RC User Support.

Style

> see style options

Options

The audio player has a number of settings:

As in the picture tool, if it is necessary to give textual information about the sound file, you can enter the text to be displayed when the mouse cursor hovers over the item.

Video Tool

Video tutorial

As with the other tools, you can use the video tool by dragging it from the tool bar and dropping it onto the weave.

In the dialog box that appears you have the possibility to add (i.e. upload) items from your computer or select items from the “simple media” folder. At the moment, the RC supports the following formats: avi, mov, mp4, mpg video container formats; dv1394, h.264, mpeg2, mpeg1, mjepeg video codec formats. Both VBR and CBR are supported.

The video tool currently supports resolutions up to 2048x1080. If the resolution is higher, transcoding will fail. Please keep this in mind while uploading videos shot on phones, which commonly provide up to 4k resolution.

To add an item, choose “add” and upload the file from your desktop to the RC servers. All videos uploaded in this way will also be added to the simple media tab. Name the file and make a declaration of the copyright holder.

After adding a video, the player will not appear in the workspace editor, to view it, please click PREVIEW at the top right corner of the editor.

All media will be compressed to a smaller size, this is called ‘transcoding’. This process takes time. During the ‘transcoding’ the file name is greyed out in your simple media. If you want, the RC can also sent you an email when transcoding has finished. You can find that option under profile, settings.

For further information and technical questions see FAQ or contact the RC User Support.

We highly recommend using smaller video files, for easier upload. If your file is extremely large, you may want to compress it before uploading using a program like Handbrake, FFMpeg or QuickTime (Mac).

Style

> see style options

Options

The video player has a number of options:

As in the picture tool, if it is necessary to provide textual information on the video file you can choose to display plain text or copyright information that will appear when the mouse cursor hovers over the item.

You can also use the play tool to synchronize selected video and audio tools.

Slideshow Tool

The slideshow tool allows you to create a gallery of images that can be displayed in a loop. You can choose to start the slideshow automatically and you can add an audio file to each picture of the slideshow.

Drag and drop the slideshow icon onto the weave and the dialog window will appear.

To be able to select media you first have to upload an item into simple media or select media files from your works. To add an item, choose add and upload the object from your desktop to the RC servers. Name the file and make a declaration of the copyright holder. After adding the file, you can edit the style of the picture with the html style standards. To add a sound file to the slide, the file first needs to be uploaded to simple media.

Style

> see style options

Options

In “options” you can define the position of the image within the frame. This is important when you are using images with different sizes and proportions. In settings it is possible to choose to loop the slideshow. If the loop option is enable, the slideshow will continue with the first slide once it reaches its last slide. You can choose to hide the navigation bar or give the reader the option to enlarge the picture with a click on the picture in your weave.

In automate you can set the autoplay options to:

When choosing autoplay you need to define the speed with which the slide will change. You can customise the duration of each slide (speed per slide) or let each slide change at the default speed.

As mentioned before, you can append audio files to each slide. Please note, you first have to upload the file into your simple media folder. In options, audio you can control the time of a crossfade (when one audio file fades out while a second fades in at a specified time). You can also choose the fade duration and the timeout of an audio file.

PDF Tool

The PDF tool gives you the possibility to add PDF documents containing texts, graphics or scores. By default the PDF is displayed as a small thumbnail showing a miniture of the first page. The reader of your exposition can load this PDF in a new tab by clicking the thumbnail. Alternatively, you can set the tool to display the PDF content directly embedded in the page (see options).

PDF is a suitable format for uploading (paper) based documents into your exposition. The limitation is that PDF files, by nature, only support static (printable) graphics and text, not video or audio. Although Abobe has started to support rich media embedding in their own PDF viewers, there is almost no support for this in other PDF viewers (like the one in browsers). In case text from a word processor needs to be combined with video and audio, use the HTML tool for the text and add the media separately using the other tools.

Uploading a pdf

After dragging the icon to the weave, a dialog will show.
Click the button ADD MEDIA to open the dialog for uploading a PDF.
Be sure to upload the PDF itself in the PDF field, not PREVIEW. One is also requested to add copyright information. When done, click submit and the file will begin uploading.

The pdf tool dialog
The pdf tool dialog

The PREVIEW field is for changing the image that represents the pdf in the exposition for the reader. If no preview image is provided, a miniturised copy of the first page will be used. You can later change the preview image, by selecting one from your media list.

Changing the PDF preview image

If you have an existing PDF tool, you can update the preview image with any image from your media list. If you want to use a completely new image, you will have to add it to your media list first.

A few notes

> see style options

Options

Play Tool

The play tool is designed to synchronize the playback of selected video and audio tools on the same weave. With this tool one can create a single control for playing back various media files at the same time. This can, for example, be used to document video installations with multiple screens and allows playing back synchronized combinations of musical voices and audio tracks. The play tool displays an image which can be clicked and functions as play and pause button. Clicking the image will start the playback of the selected audio and video files. While playing the tool another image will be displayed instead. Clicking this image will pause the players.

Media

In the media tab one can upload two image files. One image will be the play­-placeholder, i.e.clicking the image will initiate the playback of the selected files. The other image will be the pause­-placeholder, i.e. clicking this image will pause the selected audio and video files on the weave.

Options

In the options tab one can select from among all audio and video files on the weave. These must have been uploaded first with the audio and video tools. The selected files will be controlled with the play tool. The option “pause other players when playing” will ensure that only the selected media files will be played back.

Shape Tool

The Shape tool is designed for placing simple graphic elements such as arrows and lines in your exposition. You can generate forms to structure your layout or to help navigation. You can create rectangles, circles and lines. You can choose if they’re filled or not. You also have the possibility to specify the thickness of the frame and control the opacity of the elements. There are also four types of arrows (left, right, up, down). You can resize the elements on the weave by resizing the green frame displayed around the shape. By clicking and dragging the yellow point you can rotate an element.

Note Tool

The note tool allows you to organize your work on RC, comment on sections, and communicate with co-authors. Drag the note icon from the tool-pallett onto the weave. You can write directly into the note without opening a new edit-window. Each note has a time-stamp which is generated when the note is placed on the weave.

It is possible to define who is responsible for the content (a change or revision, correction) of the note and you can set a date for resolving the issue described in the note.

Notes are visible on the preview as well. Please check, that all notes have been removed from the exposition when you intend to share or publish it.

Notes and User Roles

If an exposition is submitted to a portal the notes created by the different users involved (authors, portal admins, editor, reviewers) have different visibilities. Notes left by the author are visible to the admin and to the editor. Notes left by the reviewer are visible to the admin (though not the author or editor) and notes left to the editor are visible to the author and admin (though not to the review).

Text Style Options

You can use the buttons to directly add the basic stylings, eg. highlight it with bold or italic font or structure it with numerations or lists. You can change the font-family and increase or decrease the indentation. You can also insert links.

History

“History” provides a log of all changes that have been made to the tool. If you have unintentionally deleted a tool, you can restore it using “restore deleted tools” in the commands.

Embed tool

The embed tool allows the integration of external content, such as videos or sounds, into RC expositions. Currently, the RC supports the following external content providers: Madek, Youtube, Vimeo, Soundcloud and Sketchfab.

The embed tool can be used by pasting the link from the page you want to embed in the URL field and clicking submit twice. The first submit initiates the processing of the link. How to retrieve the correct embedding link depends on the service. The main URL visible when opening the media content that is to be embedded can be used by the RC for the above mentioned services. Please contact support if you have trouble or questions regarding the necessary URL.

Content from Youtube and Soundcloud can be used in the play tool and the playback can be synchronized with native RC tools.

Content from Madek needs to have been made publicly visible before embedding is possible. Please copy the sharing link from Madek into the URL field of the embed tool.

Important: Some RC-based journals/portals do not allow the use of externally hosted materials. If you are making an exposition to be published in such a portal, please check their policy first.

Style Options

image showing the style tab of an html tool
image showing the style tab of an html tool

The style tab allows you to set the way a tool looks on the outside. There are two ways of reaching the style tab:

For all tools except the simple text tool, one can also open style:

Click on the small “>” to open one of these sections:

The style tab only sets the external style of the tool, text markup is done within the text or html tools.

Change tool defaults

It is possible to change the default styling settings for any tool, by double clicking the tool in the toolbar. After the default is changed, every newly created tool will initially use these new settings.

History

The history tab gives you the posibility to change the content within the tool to an older version. The versions of a text object are created each time you have clicked outside it (and the three animated dots show inside). With the html tool, a version is created each time you click submit.

Graphical Editor - Content Manager / Tabs

The content manager is a collection of tabs located on the right size of the graphical editor.

media, pages and footnotes tabs
media, pages and footnotes tabs

Overview

You can use the overview to see all objects in the exposition as both a miniature map and a list. This can also be useful to retrieve lost objects, or change the ordering (front to back). If you click on a tool in the list, the editor will automatically jump to its location, you can also double click a tool to edit the content of that tool.

Media tab

Media files can be found, uploaded, previewed and deleted in the “Media”-tab on the right hand side. There are subtabs: Simple Media, Sets and “+”, which allows the integration of external repositories, such as the Media Archive of the Arts of the ZHdK (Madek).

Simple Media

The simple media, which can be found within the “Media”-tab on right hand side of the editor. Images, videos, audio and other media that have been added in tools onto the canvas will automatically show up in simple media tab. You can click and drag files from the simple media tab onto your canvas in order to create tools.

You can also upload media here to use it as a background or preview image in tools like the video tool and the pdf tool.

The list of media files can be sorted by type, name, creation date and size and you can search for a file name by using the search field.

Files that are listed in gray are in the process of being transcoded.

There four buttons on top of the list of files, from left to right:

Simple media tab
Simple media tab

Each media file can be provided with a license, see licenses. The licenses of all used media in an exposition are shown on the META page.

Sets

You can view the media sets you created in the Media Repository. You have to click on the set to open and view the media. Once opened, you can drag media onto your page. An icon will indicate if the set is shared to you by others.

Works

“Works” are an older feature similar to media sets, if you had created works in the past you will find them under sets as well.

Import Word documents using Simple Media upload

It is possible to upload docx/odt/LaTeX documents and have the content automatically be turned into HTML tools and image tools.

To convert a document, open the Simple Media Tab and upload it in the “document” section of the upload dialog. It may take a few moments to convert after the upload has reached 100%.

media upload tab
media upload tab
upload doc dialog
upload doc dialog

Once converted, the document will show up as a folder within your simple media. You can drag the elements from this folder to their final desired location in the exposition and resize them to the size you desire.

To ensure maximum compatibility with RC fonts and styling, text-editor specific styling is automatically filtered, but the inner structure of the text is maintained. This includes: paragraphs, headers, bold, italics, footnotes, illustrations & tables. Footnotes are also converted into RC Footnotes/Popovers. Afterwards, one can use raw CSS (also see below for more details) to add styling again, without the need to style each structural element individually. It may thus still be necessary to import certain elements by hand after the import.

The document is split at illustrations, or after a significant amount of text. This to avoid extremely long text tools, which result in problems between browsers and are harder to handle in the graphical editor. The splitting should also make it easier to restructure the document a bit to a more fitting layout to the RC. Because of the graphic and non-linear nature of RC expositions, a 1 on 1 import does not make so much sense. If your documentation requires a more traditional text-based layout (think article/blog post), it may be better to use the text-based editor, which also supports importing from external text editors.

Important note regarding styling:

By default, RC has zero margin on all paragraphs, this will mean that there is no whitespace between paragraphs. To avoid this issue, I recommend adding the following style to your raw CSS settings of your page where you import word content. You can edit the “raw css” of a page by opening pages tab > ✎ edit settings > style > raw css.

#container-weave .html-text-editor-content p {
    margin: 1em 0; /* set top and bottom margin to 1 */ }

#container-editor .html-text-editor-content p {
    margin: 1em 0; /* do the same for the editor */ } 

This makes sure paragraph margins are displayed correctly.

Pages

Pages are managed in the pages tab of the content manager. An RC exposition can consist of one or more pages. A new exposition starts with a single page, called “default page”.

page tab
page tab

Creating a page

New pages are by default private, they have to be explicitely added to the table of content to be visible (or by making a hyperlink to the page in your own content). The order of pages cannot be changed in the pages list, but it can in the table of contents. The page will automatically change size based on the content.

Entry page

One can change the first page visible to the reader by changing the entry page. Go to the menu options and choose edit meta data. Scroll down to “entry page” (at the bottom of the dialog) and select the page you want as your start page for the reader.

Page settings

the page settings dialog]

In the page settings dialog, you can change the meta data of the page and control the appearance. It is opened by clicking the pencil button in the bar.

Page settings - Meta : title, description and iframe field

Page settings - Style

Here one can change:

raw CSS

You can set user defined CSS rules that are applied to the whole page. Cascading Style Sheets are the standard way of styling HTML documents. Although most styling can be directly edited through the style tab, it can sometimes be useful to specify your own CSS.

The CSS class for HTML tools is:

.html-text-editor-content {
/* put your styles here */
}

To style text within a simple text tool you have to use:

.tool-simpletext .tool-content * {
/* put your style here */   
}

Supplying your own fonts

You can include your own external fonts through CSS @import statements. Be aware that many (also fonts like “Arial”), cannot be self-hosted unless you have a license that allows that. Google Fonts has an overview of fonts that you can freely use. Here is an example of using the “Roboto” font:

@import url('https://fonts.googleapis.com/css2?family=Roboto:ital@1&display=swap');

.html-text-editor-content * {
    font-family: roboto;
}

.tool-simpletext .tool-content * {
    font-family: roboto;
}

Line-height

There is no way to control line height within the HTML or text tool, but you can change it using CSS:

.html-text-editor-content * {
    line-height: 2em;
}

.tool-simpletext .tool-content * {
    line-height: 2em;
}

“em” is a relative size unit, it measures the line-height ratio from the size of the ‘m’ character in the font.

Be aware that changing the CSS

Deleting a page

The page can be deleted by clicking the trashcan icon next to the page title. Deleted pages cannot be recovered. Of course, if you want to make a page invisible to the reader it may be prefered to just remove it from the table of content.

Graphical Editor - Footnotes and Popovers

It is possible to create footnotes and popover weaves in the text, HTML and picture tools. The terms “footnote” and “popover” are used almost interchangeably here. Footnote, however, refers rather to the textual concept of a footnote, i.e. a particular use of the functionality explained in this section, whereas popover is used when referring specifically to the appearing popover window. (There is a tutorial video explaining the footnote workflow on the RC Video Tutorials page) These are displayed when the RC user reading the exposition clicks the footnote link or, depending on the settings, when he or she mouse the mouse pointer over the link. This functionality makes it possible to create footnotes in texts, but also create popovers of any size containing RC objects of any type. There are a number of different ways of creating footnotes.

Creating a Simple Text Footnote

In order to create a footnote in the text or HTML tool one selects some text, which will be the footnote link and clicks the “Insert/Edit Link or Footnote” menu item (see image).

Selecting text as a footnote link
Selecting text as a footnote link

A new footnote can be created by using the left tab in the appearing dialog window. In this window one can set:

Finally, click “Add Footnote” to confirm and create the footnote, which will subsequently appear in the list of footnotes on the left side of the screen.

Preview of a footnote
Preview of a footnote

Editing a Footnote

All footnotes are listed in the “Footnotes” tab on the right hand side.

List of footnotes
List of footnotes

There are three icons displayed on the top of the list. The first icon opens the footnote workspace editor where you can edit the content of the footnote, the second icon opens a window which allows editing the title, size, and styling of the footnote. One can leave the footnote weave editor by clicking the link “back to main weave” displayed to the left of the main tab. (see image).

“simple text” footnotes are in fact automatically generated normal footnotes with your text inserted in a text tool. This has consequences if you want to adjust the size of a “simple text” footnote as a whole, since you would also need to change the size of the tool within that footnote after resizing. To edit a “simple text” footnote internal tools, simply double click it in the footnote list.

When you are done editing: you can return to your main weave through the link in the top of the editor.

Back to main weave link
Back to main weave link

Changing the position or display settings of a footnote

If you need to change the screen position or display settings of an existing footnote, the best way is:

  1. Go to the Footnote tab.
  2. Click the little blanc page icon next to the footnote you want to change.
  3. Go to the settings tab

Auto-Numbered Footnotes

Instead of using text as footnote links it is also possible to use numbered links. The numbers will be filled in and adjusted automatically. In order to create auto-numbered footnotes create a footnote in the text or HTML tool as described above but without selecting any text. An “x” will be inserted where the cursor is placed. This “x” will be replaced by the correct number when the text is displayed.

Auto-numbered footnote in the editor
Auto-numbered footnote in the editor

The numbering starts at 1 and encompasses all text and HTML objects on the weave. Numbering is performed by object and proceeds from the top and left to the bottom and right of the page.

Be aware that automatic numbering does not depend on creation order, it only depends on x and y position of the tools. This means that if the notes (1,2, 3 etc..) are in a vertical column, for example:

Footnote numbering in correctly vertically-aligned tools

When the tools are lined up like this, footnotes are correctly numbered. However, if one of the text tools containing an automatic footnote in a column is just a bit (even 1 pixel) to the left, like so (exaggeration):

Incorrect auto-numbering in non-aligned tools

Then rc will automatically number the notes in 2 first than 1 than 3. So in this case, it is very important to have the text tools exactly at the same x position (through right click -> style tab you can check this most easily).

Pictures

It is also possible to use images as links to footnotes. When clicking on the image or moving over it with the mouse cursor the popover will be show. In order to use an image as a footnote click the menu icon on the bottom right of the image (or right click the image) in order to open the context menu. Click the item “add footnote” from the context menu and fill in the appearing dialog window.

Graphical Expositions - Table of Content

See the video tutorial on this topic.

an example of a contents list, made through the table of content
an example of a contents list, made through the table of content

The table of content is designed to facilitate the navigation through an exposition. Both pages and locations within a page can be added in the table of content. In order to edit the table of content, go to the “Options” menu > “Edit Table of Content”.

Table of content dialog
Table of content dialog

To make a new entry, click on the index number and select the page (or “weave”) from the drop down menu and click submit.

There are two optional fields:

Tip: you can easily reorder the table of contents entries by clicking and dragging the boxes.

Static navigation bar

At the bottom of the table of content dialog, there is an option static menu bar to display the navigation bar continuously (instead of it automatically hiding).

TOC alignment

Choose wether the links in the content menu should be displayed horizontally or vertically.

Hyperlinking

See the video tutorial on this topic.

It is possible to create hyperlinks between pages (or “weaves”) of an exposition and within a single page. This process exists of two steps: fetch the link and creating the hyperlink.

In order to fetch a link to a different page within your exposition:

  1. open the page you want to link to in the editor (through the page tab on the right hand side).
  2. (optional) scroll the page to the position where you want the link to point to.
  3. go to options->show current position

This will display a URL of the target page with the current scroll location. Copy the URL into the clipboard (Ctrl-C/Cmd-C).

Now to turn a piece of text into a hyperlink:

  1. Create or open a Text or HTML tool and select a word or sentence that should become the link.
  2. Now click the hyperlink button (it looks like a chain link) and a dialog will be displayed. location of the hyperlink button in text tool location of the hyperlink button in the html tool
  3. Paste the link in the link URL field and click add link.
Hyperlink dialog window
Hyperlink dialog window

Dialog options:

Within the hyperlink dialog there are a couple of options:

Overview

Within the “Commands” tab on the right-hand side of the editor there is a checkbox labeled “Overview.” Clicking the checkbox will open and close a tab on the right-hand side of the editor. It contains both a map and a list of all objects in the exposition.

The overview map outlines all tools on the page, their size and position. By moving the red rectangle, one can jump to a specific position on the page.

Below the overview map, there is a list of all objects. If you click one of these tools, you go directly to that tools location. This can also be very useful when trying to find tools that have somehow become hidden, for example if another tool has been placed on top.

Graphical Editor - Menus

Edit menu

image showing the edit menu

Trivial copy paste functions:

Order functions:

These options change the order of objects if they overlap. Order can be important if you have tools with controls: for example, an audio player that is behind a text tool would need to be in front to allow the user to click the play button on it.

Locking:

Locking an object means it cannot be changed or moved in any way (until it is unlocked). This feature can also be used if only part of the exposition is to be moved (by locking the objects you do not want to move).

Arrange menu

These functions help with aligning (two or more) tools. To select multiple tools, click them one by one while holding ctrl/cmd key, then choose the function you want to apply from the arrange menu.

(!) Be careful when applying to many tools at once on a complex weave. The changes in position are not reversable (unless you copied the tools before).

Options menu

image showing options menu

Edit metadata

Here you can edit the Title, Abstract and Entry Page of the exposition.

Show tool borders

When this option is turned on, you will be able to see all borders of all tools (green dashed line) in the editor. This can be helpful searching for empty tools.

Edit table of content

Here you can set the contents of the “contents menu” that the reader uses to navigate between pages and position in your exposition.

See table of content.

Grid options

Objects will only move in grid-size steps

Show/hide the grid

Change the size of the grid

Set default position

Change the initial position that the reader starts at in the weave, to the current location of the editor view.

Show current position

This provides the X,Y offset of the editor and a position link. X,Y can be used in the Table of content. The position link in Hyperlinking, or simply to share a specific position through a position link.

Restore deleted tools

Restore recently deleted tools.

Restore deleted footnotes

Restore recently deleted tool.

Help menu

Get help!

Send Collaboration Message

When you are collaborating on an exposition, you can use the command “send collaboration message” to communicate with your collaborators.

Text Based Editor

First time user of the text editor? click here.

Overview

Click any element in the image to jump to the relevant section:

Upload media files Import external format (Word docx, Open office odt, Plain txt) Editor (using Markdown) (Live) preview of the exposition Export to other formats (Pdf, odt, docx etc.) Media list (edit metadata/display) Style tab Markdown Toolbar Help / Preview / Profile / Logout Saving

Introduction

The text-based editor is aimed at creating responsive RC expositions. Despite the “text” in the name, expositions made with this editor can also contain images, video, audio or PDF. “Text based” refers to the method of editing: through plain text. Because of this plain text input, text-based expositions can be easily imported or edited in external editors. The consequence is that editing the visual layout is less direct as in the graphical based editor. The structure of the exposition is expressed by using Markdown, the display of which can be customized through style sheets (css).

On desktop, the editor splits the screen in two: you can write your text on the left side editor while the result is shown as a preview on the right hand side. It is also possible to import the text from external formats like Word and Open Office. Formatting (bold,italic etc…) is added using markdown notation.

If you want to insert media, you can add these through the “upload media” button . When the upload has finished, the media edit dialog will automatically open, allowing you to edit and insert it.

Finally, the look of your text and media can be controlled through the media list and the style editor.

Creation and using a template

To create a text-based exposition, go to “my profile” and click create exposition, then select “text-based” for the editor type. Additionally, you can select a template, which will mean your new exposition will be pre-filled with the stylesheet and, depending on the template, some placeholder text.

Because the text-based and graphical formats are completely different, you can only change the editor type the moment you create a new exposition.

Portal admins can select any of their own expositions to become a template for their portal users, by going to the “template” tab in their portal settings.

Editor

The left hand side is where you can edit your text. The editor uses Markdown, which is a lightweight, human-friendly markup language. Because Markdown is expressed as plain text, you cannot directly change the styling of the text (font-size, color etc.. are edited in style ), but you can express the structure/markup of your text. See Markdown for a brief overview.

By default the editor uses colors to show the Markdown elements in your text, but you can also choose “plain txt” which allows your browsers spellchecker to work. 1.

Previews

Here you can see a preview of your exposition.

Because text based expositions are responsive (react to the size of the window), the result may change based on the width of the screen. For a full view preview, use the eye button in the toolbar.

Upload media

To add new media, click upload media. After the upload finishes, the media edit dialog opens. This allow you to edit its metadata, size and to insert the media at the current cursor position.

If you want to insert previously used media, you can use the “media button” in the toolbar.

Media list

All media that you uploaded will appear in the “media list”, where they can be edited or deleted.

The media list
The media list

Editing media

From within the media-list, if you click [edit], you will be able to change the name, metadata and display of a media file.

The media edit dialog
The media edit dialog

Insert media

Media is represented on the editor side using a !{media-name} tag. The easiest way of inserting such a media tag is throught the insert media toolbar button, which shows a list of available media that can be inserted. Double click any item to insert.

inserting media using the insert button
inserting media using the insert button

You can also write the media tags directly, for example: to insert a media named “myFile”, you can directly write !{myFile}. This !{myFile} tag will be the location in your text where myFile will be inserted.

A caption text can also be included, to get a caption you write [my caption text]{myFile}. The caption text is displayed underneath the media.

Import & export

You can import documents from text editors like Word (.docx), Libre/Open Office (.odt), HTML and several other formats. Not all styling is supported but images, footnotes, tables and most other structural features of the text are.

Edit style

Text based expositions are styled using CSS (Cascading Style Sheets), which is a standard way of styling web documents. The CSS of an exposition can be edited by going to the style tab. If you are not familiar with CSS, there is a good introduction here: https://www.w3schools.com/css/.

The structure of inserted media is as follows. You can use the outside class (rc-media-123455) to style an individual media element.

<figure id="media-1">
<img src="...">
    <figcaption>
        Caption text, which is taken from the tag -> ![caption text]{media1}
    </figcaption>
</figure>

Most templates will provide some basic formatting already, that you can adjust to your needs.

Toolbar

From left to right:

Markdown

Markdown is a human-friendly way of writing HTML webpages without using code. Markdown is written as plain text (like you would write on a typewriter), that is translated into HTML for you.

By surrounding your words with a few special characters you can inform markdown which styling you want it to use.

For example:
italic = *italic*
bold = __bold__

Instead of typing these characters, you can also select a piece of text and push the desired style button on top of the editor. This will insert the correct Markdown notation for you.

Paragraphs

When two blocks of text are separated by an empty line, it starts a new paragraph.

example a) an empty line starts a new paragraph:

a paragraph
some text
and some other text

another paragraph

results in:

a paragraph some text and some other text

another paragraph

example b) if lines are not separated by an empty line, they are combined:

This text 
will be joined together

results in:

This text will be joined together

You can force a newline by:

example c) two spaces at the end tells markdown to keep the newline

This line has two spaces at the end__
and it thus keeps the newline.

results in:

This line has two spaces at the end
and it thus keeps the newline.

example d) a newline can also be kept by appending a backslash

 
The same for the backslash\
also does the trick!

results in:

The same for the backslash 
also does the trick!

Headers

Headers are defined by using one or more "#" in front of the header name:

# header 1
## header 2
### header 3

There are six levels of headers. Header level 1, 2 and 3 (#,##,###) are automatically included in the contents menu, for easy navigation for the reader.

An alternative way of writing headers is by putting ===== or — below you header text.

Header 1
========

Header 2
----------

Lists

To get a bullet point list, write * before each item. Before the first item, keep an empty line. Thus, when you write:

* my first point
* another throught
* yet another thought

it will result in

To get ordered lists, write a number and a point, 1. , 2. , 3.

1. one
2. two 
3. three

Hyperlinks are written in the following manner: [linktext](http://example.com)
which results in:
linktext

You can also use create internal links, called anchors. The link is made by writing a hashtag (#) before the name of your anchor:

[link](#your-anchor-id)

The anchor itself is created like this:

<a id="your-anchor-id"></a>

Footnotes (text based)

The easiest way of inserting a footnote is using the footnote button: [ * ]. Footnotes consist of two parts, the reference, written like so:

[^1]

Then you define the footnote content at the bottom of your text with:

[^1]: This is my footnote.

It’s content is automatically moved to the bottom of the text. The footnote content is automatically moved to the bottom of the resulting text.

Quotation

A quotation is inserted by indenting your text with 4 spaces or 1 tab, like so:
`    quotation`
`    more quotation`

Quotations are not automatically formatted (they keep their newlines).

Tables (markdown)

Tables are written like this:

| Name    | Age | Species |
|---------|-----|---------|
| Harry   | 23  | Human   |
| Gerhard | 77  | Parrot  |
| Judith  | 6   | Cat     |
Name Age Species
Harry 23 Human
Gerhard 77 Parrot
Judith 6 Cat

You may also use HTML tables. There are also online tools that help you generate either of these

HTML Import

It is possible to import a website of static HTML into the RC. This feature is aimed at users that are familiar with HTML and want to use their own editor.

For security reasons, JavaScript is not supported, but CSS files, <img> <video> <audio> tags can be used. The folder containing your HTML and media files are to be uploaded as a single zip file (.zip). The maximum filesize is 10Gb, although for practical reasons it is probably more convenient to stay well below this.

Important: at this moment, the existing RC Journals do not accept submissions imported as HTML, because they do not fit in existing reviewing/editing workflows. If you are planning to submit your exposition to one of the journals in the RC, one should use the graphical or the text-based editor.

To create a HTML based exposition:

  1. Click [ Create Exposition ] on your profile page.
  2. Select “html based” as the editor, fill in required metadata fields and click submit.
selecting html import editor
selecting html import editor
  1. You will now enter an upload screen, where you can select your zip.
the upload screen
the upload screen
  1. Wait for upload to finish

    When the upload finished and there is no error, you can view the exposition by clicking the preview button (eye in the top right corner). If it is not succesful you can use the error message to see what changes you may need to make and try again.

Requirements for HTML expositions

There are a few requirements to the zip that is uploaded:

character encoding

The character encoding of the .html files should be UTF-8. You should specify the character encoding first (before <title>), for example like so:

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>my exposition</title>
</head>
<body>
etc... 

Example exposition

An example HTML-based exposition for use in the RC can be found on Github:

source: https://github.com/SocietyForArtisticResearch/rc-html-import-example

as zip: https://github.com/SocietyForArtisticResearch/rc-html-import-example/blob/master/DemoExposition.zip

Updating

Currently, it is not possible to update single files within your uploaded exposition. When something changes, you will have to upload the whole exposition again.

Navigation

When one moves the mouse cursor to the top of an exposition, a menu bar appears.

the RC navigation bar
the RC navigation bar

The navigation bar contains, from left to right:

Takes you to the metadata page, which shows the full set of metadata related to the exposition: author(s), keywords, abstract, creation date, publication date and copyright & licenses of all used media files.


There are a couple of functions available:
- hide notes (hide all notes) - show open notes (show only notes that are open) - show resolved notes (show the resolved notes) - add new note (open a note tool) - previous note (jump to previous note) - next note (jump to next note)

Comments

Shows the latest and previous comments on your exposition from the RC community.

Terms of use

This displays the terms of as set by the Society for Artistic Research (SAR).

Making expositions visible and working with others

By default, expositions are private: only visible to your account. These are the three options to make something visible to others:

An important feature of publication in the RC, is that it is permanent. This means that once an exposition is published, content will be locked forever. The idea behind this, is that the content of published expositions can be safely referenced by others, without risk of linking to something that has changed or dissapeared.

Collaborating on Research

The Research Catalogue allows you to work together on a research exposition with mulltiple users. This is called collaboration.

There are 3 types of collaborators:

Adding a Collaborator

An author of an exposition can invite collaborators through the collaboration tab of the exposition: click the menu icon (1) and ‘edit details’ (2) next to the research on your profile. If you are already in the workspace editor, you can also click on the title of your research at the top of the editor.

Location of the collaboration dialog
Location of the collaboration dialog

Choose ‘collaboration’, search for the user you want to cooperate with and add her or him by clicking on their name.

Inviting a supervisor by typing it into the supervisor box
Inviting a supervisor by typing it into the supervisor box

The users that were added will show up as a list below the field. After clicking submit, collaborators will receive an invitation from you in their message-box which they can accept or decline. When accepting the invitation, the collaborator will have access to your exposition workspace and he will be able to edit it.

Removing a Collaborator

If you want to remove a collaborator, click the “x” behind their name in the field they were added. If you remove a supervisor, the supervisor will receive a request to remove them (they have to approve the removal).

Collaboration tab
Collaboration tab

Note: If a users name in the list is enclosed in brackets ( [ name ] ), it means that the invitation is sent successfully, but has not been accepted yet by the receiver.

Communication with Collaborators

While collaborating on an exposition, there are several ways of communicating with each other

Instead of collaborating with RC users you can also publish an exposition or share share it with groups of people. The difference is when an exposition is shared, content can still be changed, and the mode of sharing can be changed at a later point.

Share

Share option can used to control visibility of works and expositions for groups of people. By default, your expositions are private, changing the mode allows others to see your work. Unlike publishing, you will still be able to change the content of an exposition when it is shared.

The share option can be found under the object menu (hamburger menu icon) of each object on your profile.

There are four modes of sharing:

Independent of the above choices there is a check box:

Link share can be combined with any of the other sharing modes (private, RC users, limited to portal, public). An exposition can for example be shared within a portal but simultaniously be accessible through the “secret” link.

sharing menu dialog
sharing menu dialog

Publication

Publication, is permanent. This means that once an exposition is published, all content will be locked. The idea behind this, is that the content of published expositions can be safely referenced by others, without risk of linking to something that has changed or dissapeared. You can self-publish an exposition, or request publication with one of the portals. Please consult the portal pages: (institutions or journals) to see what requirements there are for publication there.

Self-Publish

Self-publishing makes an exposition no longer editable and publicly visible. On publication you will get a (free) DOI. By design, publishing an exposition is not reversible (so others can use the exposition link as a reference).

Submit for Publication

Expositions can also be submitted to portals (such as journals) for publication. Most of the institutional portals will only accept requests from within the institution that is associated with it, in case you want to submit to one of those, be sure to check their instructions regarding submissions: (institutions or journals).

To request publication within a portal, click ☰ -> submit for publication. You can then select “submit for unlimited publication” and choose the portal to which the request is to be sent. After submitting, the exposition will show “in review” status.

While the exposition is “in review” state it can no longer be edited. The portal admin or editor will contact you regarding the reviewing process. The portal admin can unlock the exposition by putting it “in revision”, or rejecting the publication request. In the first case you or the admin can lock it again, in the second case you will have to resubmit it using the normal method.

After the portal admin accepts the publication request, you will receive a message and the content of the exposition will be premanently locked.

Connect to Portal

An exposition can be connected to a portal without being published by the portal. The portal admin will receive a notification and has to confirm the connection. Once the connection has been approved it will be shown in the object’s metadata and the object may appear on the portal page and portal feeds. Connected works may for example accompany a published exposition or represent a connected event. They have to be at least shared within the portal, private expositions cannot be connected to a portal.

Follow and Search

Follow

It is possible to “follow” other users, portals, and objects such as expositions and works. Once you are logged in you will see “follow” links in the bottom right corner of objects displayed on the front page, other user’s pages and other places on the RC. “Follow” links also appear on user and portal profile pages. Once you follow a user, portal, or object new publications, edits, comments etc. will be displayed on the “FEEDS” page. Clicking the wrench icon opens up a dialog in which you can adjust the precise information you want to see for each user, portal or object you follow.

You can search the RC by using the search field in the top right corner. Moreover you can use the “advanced search” functionality, which allows for filtered searches and and searches according to specific criteria such as object type, keywords, authors, etc.

Administration: Reviewing process

Introduction

This is a tutorial to describe how an RC Portal can be used for publication workflows. It is aimed at portal administrators. The process typically consists of 4 stages:

Setting up accounts

There are two ways of setting up accounts:

  1. The author can create an account for him/her self, by clicking REGISTER on the research catalogue homepage. After filling in the form the author will immediatly get a basic account. To gain a full account, which has the right to create content, the author will be requisted to send a proof of identity and signed SAR agreement letter.

  2. The portal admin creates the account(s) for the author(s). This option is common when a large number of users need be created at once. In this case, the responsibility of identification and making sure that the SAR agreement letter is signed lies with the portal administrator creating the account(s). The agreement letter can be found on basecamp or requirested through RC support. Please send the signed agreement letters to RC user support.

The administrator can create accounts by going to the admin section and opening the user page. Click + at the right top corner of the screen. After creating the account, the username (which is an email address) and password can be sent through email. Be sure that in the roles tab, the “basic account” option is turned off. This means the user will have a full account and is able to create content.

edit user roles dialog
edit user roles dialog

For safety, admins creating user accounts should:

Safer is to have the student make their own limited account (through normal registration) and add them to the portal afterwards. Alternatively, you could also generate a long random password and throw it away immediately, then ask the user to reset the password themselves using https://www.researchcatalogue.net/portal/forgotten-password.

Writing the exposition, collaboration

The next stage is the writing of the exposition itself. It is important to note that it has to be an exposition, a work object on its own cannot enter a review workflow on the RC. Works can however be embedded as part of an exposition to be reviewed & published. The author does not need to be a member of the portal user list in order to make a publication request to it.

During the writing stage, it is common that the exposition in progress is shared with one or more other readers or collaborators. These collaborators can use the notes system to leave feedback. There are three types of collaboration roles:

The author can invite RC users to these roles by going to edit details or clicking on the title of their exposition in the workspace editor and choosing “collaboration”. The collaborators will receive an invitation (in RC messages) that has to be accepted before they can start to collaborate.

collaboration tab
collaboration tab

Requesting publication

Once the writing is sufficiently progressed, the next step is that the author sents a request to publish the exposition. This is done through the ☰ menu, which is located on the “my profile” in the right bottom corner of the exposition summary. This will open a dialog where he/she can choose to which portal the exposition should be published. Within this dialog the author can also indicate weither the exposition should be published “limited to portal” or “unlimited to portal”. Limited to portal means that when the exposition is published, it is only visible to members of the portal.

Important: the choice by the author is only a suggestion, in the end, it will be the portal admin that decides in which way (limited or unlimited) an exposition is published.

publication dialog
publication dialog

Once the author has done this step, no further changes can be made to the exposition by the author. It will be listed on their profile under the status “in review”.

The portal admin will receive a message from the RC that a new work is ready for review. It will also be available under the “reviewing” section in the admin section.

The expositions content is locked for the author(s) during the review process, only the portal admin can edit. If the author needs to revision the content, it is possible to temporarely open for editing by clicking the “in revision” button . This will open a dialog where you can put the exposition “in revision”. During revision, the exposition will remain listed in the reviewing page. Once the author is done, they can either resubmit themselves from their profile page, or the administrator can use the button in the “reviewing” page to change the status back to “in review”.

If the publication was by accident or to the wrong portal, the publication request can be declined by the portal administrator. He/she can also do this under administration > reviewing and clicking the X next to the research title. This will also open the exposition for editing again.

Reviewing, assigning reviewers

The most common next step is to assign reviewers to this research. However, for a person to be available as reviewer, they first have to:

  1. have an RC account
  2. added to the reviewer pool of the portal.

The reviewer role does not require a full RC account, it is enough to be a limited RC user.

For the second requirement, the user has to be added to the reviewer pool of the portal. This can be done by going to the Portal page of the admin section and then choosing edit. Under the ROLES tab, RC users can be added as reviewers for that particular portal.

Once a reviewer is part of the review pool, they can be added to the research exposition. To do this, go to review tab of the administration part of the RC, and click the edit page. Here you can add (or remove) reviewers to the research. Reviewers can be either added single blind (they cannot see each other), or double blind (they cannot see the author’s name).

the edit request page, found when clicking edit icon on an exposition in review
the edit request page, found when clicking edit icon on an exposition in review

The reviewers will see a list of expositions that they are reviewers of on top of their “my profile” page. Within the exposition they can use the “REVIEW” menu to leave notes to themselves, which are only visible to them and the portal administrator. Typically further communication between the portal admin and the reviewer takes place through the messaging system or by e-mail.

Final publication or rejection

Once the review process has been completed, the portal can choose to either publish or dismiss the exposition. If the exposition is dismissed, this means that the editing rights are returned to the author. The author can resubmit the same exposition later, at which point the review process starts again. Instead of rejecting, one can also put the exposition “in revision”, which means the author can make changes, while the exposition is still listed on the “reviewing” tab of administration.

If the exposition is accepted, the exposition will be frozen permanently from further changes. Depending on the portal settings at this point also a DOI will be deposited through cross-ref. Please note that publishing is meant as a one way step, unpublishing is to be used only as a very last resort measure. If one does not expect to have a research be published perminately, it should not be published.

Immediately after publication the exposition will show up on the RC frontpage and visible to any visitor to the RC website (so also non-RC users). It is recommended that keywords are added to publications, so they can more easily be retrieved. Keywords can also be added after publication, on the research list. If this is not desired, one can also choose to publish an exposition “limited to the portal”, this means only members of the portal can see the exposition.

Administration reference guide

Administration Main Page

To reach the administration functionalities of the RC website, click on administration, located in the top right corner. To return to your own profile, you can click on the Research Catalogue logo. Only portal admins have access to these pages.

admin main page
admin main page

There are 5 pages to manage content for portal admins:

Multiple Portals:

If you are an admin in multiple portals, you can switch between them in the top right corner of the site, through the drop down menu.

User Page

admin user page
admin user page
Action Icon
Add a user
Edit a user
Remove a user
Login as a user

Add / Edit A User Dialog

Important: when you type a new user name, the RC tries to find if the user exists already. If it does, the RC will show a dialog requesting if you want to add the existing user to the portal instead of creating a new account. It is highly discouraged for a single person to have two accounts on the RC, so normally admins are expected to simply add this existing account.

Profile

user profile dialog
user profile dialog

Change the name, alias, email and password (optional). An administrator can also change these fields without having to change the password (by leaving the field empty).

Portal

user portal settings dialog
user portal settings dialog

This controls to which portals a user is added. A user can be added to multiple portals at once. Portals which are selected are marked by a gray background.

Roles

user role settings dialog
user role settings dialog

When the option is turned on, the user cannot create any content. This is the default when a user has registered an account by themselves. Limited users can still become supervisors, read expositions or added as reviewers. To allow users to create expositions, works and applications, you have to turn this option OFF.

Before a portal admin upgrades a user to a full account, the user will have to have read and signed the “terms of use” agreement letter. This is available for download from the portal partner basecamp or directly from SAR.

Settings

user email settings dialog
user email settings dialog

Here you can set which emails the user should receive.

Log in as a user

The admins can log in as another user, for example to help resolve issues with a specific account. While logged in as another user, you will see a red bar on the top of your window that shows who you are and enables you to switch back to your own account. This feature is useful while helping somebody with issues specific to their account.

Keep in mind: you become this user in all the tabs of your browser window, so you would temporarly loose some of you admin permissions while navigating as this user.

Portal page

The portal tab shows you which users are administrators on the portal. It has 3 actions:

Action Icon
Portal mail
Edit portal settings
Delete a portal

Portal mail

portal mail dialog
portal mail dialog

For advanced layout, you can use the HTML button. Images need to be small and embedded as URI

Note that for RC wide mailings, one should always use the JAR Template and type = Announcement setting. This makes the mailing include an unsubscribe link, that is required by EU law. All other combinations of settings will currently not include this link !

The JAR Template includes several standard fields (title, contact and a banner image), be sure to check that you are not adding duplicates in the email body text itself. One should always test before requesting it to be sent out.

The announcement option has to be scheduled at least 1 day in advance. The sending of the email will have to be approved by SAR.

Portal Edit Screen

Common

portal edit common screen
portal edit common screen

Here you can edit the basic information of the portal, which is displayed on the RC’s internal page. You can also replace this internal page with an external page if desired. See external link option

View text allows you to change the template that is used in the navigation bar of expositions: this is the quotation information the reader sees when they move their mouse to the top of the screen. available placeholders:

Roles

portal edit roles
portal edit roles

Here you can edit the various roles of the portal:

Templates

Portal admins can select any of their Text based expositions to be available as templates for users within their portal. This allows users to start with a predifined CSS sheet or even content.

Portal Settings

portal edit submissions
portal edit submissions

Here you can set which objects can be submitted to the portal.

allow

allow connection of

allow publishing

Research page

Here you can manage all research connected to the portal. Expositions are sorted per issue. Those without a publishing date, have not been published yet. There are a number of actions available:

Action Icon
Edit
Unpublish
Comment
Block

Unpublishing an exposition

The unpublishing of expositions is not encuraged. Published expositions are supposed to be a permament reference, never to be deleted or changed. If an exposition is to be continuously changed or temporary, it is better to not publish, but simply set its sharing settings to public. When unpublishing an exposition make sure with the author of the exposition that there are no connected works that have been deleted since, otherwise it may be impossible to reconstruct the publication.

Connection Requests

It is possible for users to connect a work or exposition to a portal. The works that have been accepted by an admin of the portal will be listed here. Requests can be accepted with: V or rejected with: X.

Once research is connected, the portal admin can add an Editor role to the expositions. The editor is than able to change the content within the exposition.

They can also add Supervisor role, which can only read the exposition.

Reviewing (admin)

The reviewing page allows managment of expositions that have been applied for publication by the author. Reviewers or editors can be assigned to these works. When a reviewer is added they will automatically recieve a notification from RC that they have been added. Reviewers can leave notes only visible to themselves (so not to other reviewers) and the portal admin(s).

Actions that are available:

Action Icon Description
edit Add reviewers and/or editors
accept Accept publication request
reject Reject publication request
change status Put exposition in revision
export Export the exposition as zip

In revision

It is possible to put an exposition “in revision”, this means the author can change the content again, but the exposition remains in the list on the reviewing page (so the admin can keep track of the progress).

You will be able to include a message to author, so they are informed that they can edit the exposition again.

During revision, reviewers will not be able to access the exposition. They will regain access when the status is changed back to “in review”. This to ensure that no reviewer is reading an exposition that is currently being edited. Reviewers’ comments (“yellow sticky notes”) will be invisible to the author; notes from the portal admin and editors will be visible to the author.

Either the author can resubmit the exposition using the hamburger menu, or the portal admin can change the status using the change status action button:

Publication dialog

When a publication request is accepted, the portal admin can choose to which issue it belongs and if the publication should be local to the portal (limited publication) or public (the whole world). Issues can be created using the issue page. You can also write a custom message to the author.

publication dialog
publication dialog

Issue page

The Issue page is an overview page within the RC that shows all published expositions that are part of an issue.

An Issue page consists of the title and description of the issue itself and a gridded preview of all the expositions (title, author, abstract and a thumbnail). This page is responsive so is easy to read on a phone as well.

Issues names are managed on this here.

In the issue section (between “portal” and “research”) of the administration interface, the number, title and description of issues can be edited.

edit issue dialog
edit issue dialog

For the reader, issues can be found through the portals front page.

More help

Changelog

In development

For the latest updates on RC development, visit: https://societyforartisticresearch.github.io/rclogbook/


  1. It is not possible to have both at the same time.