Notebooks

Overview

Notebooks contain RSpace documents arranged in a chronological sequence. In the context of a Notebook, RSpace documents are often referred to as Entries. RSpace Notebooks are designed to reproduce the structure of a traditional lab notebook and tell the story of your research by recording a linear sequence of events in such a way as to preserve the historical order of actions performed by one or more users. In order represent your story clearly and accurately, certain restrictions and rules apply to Notebooks. For example, since linear time cannot be broken into subfolders, your Notebook entries can only be arranged in a linear sequence. You can read about how to share or edit permissions of a shared Notebook in Sharing Content.

Creating a Notebook

To create a Notebook:

  1. On the Workspace, click on Create
  1. Select Notebook

  1. Give the notebook a name, and click on Create.

Adding a New Entry

The Create button will only be visible if you are the owner of the Notebook. See Moving Documents into a Shared Notebook below if you want to add an entry to a shared Notebook.

To add a new entry to a notebook:

  1. Click on Create when viewing the Notebook.
  1. Select whether you want to create a New Basic Document entry, or use a Template, Form, or import from Protocols.io or Word.

  1. You can then edit and save the document as you normally would; entries can be as long as you like. You can change the entry Name and Tags using the edit icons.
  1. You also have the Save & New option, which will save your current entry and directly open up a new one.

Moving Documents into Notebooks

If you prefer to watch a video, the process is explained at [Video] Sharing or moving Documents into Notebooks.

Moving Documents into an Unshared Notebook

  1. You can only MOVE documents into a Notebook if you are the owner of the Notebook and the document you want to move. In the Workspace, select the checkbox of the Document
  1. Select the Move in the context menu

  1. Select the desired destination Notebook, then click on Move.
  1. When you open the Notebook, the moved Document is there.
Moving a Document into a Notebook does not change its creation date or other metadata. The Notebook pages will remain ordered by their creation date, rather than the date they were added to the Notebook.

Moving Documents into a Shared Notebook

Follow the instructions for sharing a Document with a group in Sharing Content. After selecting Share with Group, select your Notebook as the destination to share into.

Unsharing a Document from a Notebook

Similarly to Documents, unsharing can be done under My RSpace > Shared Documents (read more at Sharing Content).

If a shared Notebook owner deletes your Document from the Notebook, this will only unshare it. You will still have access to this Document in your Workspace.

Moving Documents Between Notebooks

You can only MOVE documents between Notebooks if you are the owner of the both source Notebook and the document you want to move. To move a Document between unshared Notebooks, use the Move command.

To move a Document between shared Notebooks, or to move a Document out of a shared Notebook, you will first need to unshare it, then share it into the desired new location.

Notebooks are designed to tell a historically accurate narative story of actions performed over time. A shared Notebook is trying to tell a story that may involve more than one contributor, but the arbiter of the accuracy of that story is the Notebook owner. If you are NOT trying to record the historical narative of a study, then you may be better of organising your shared documents into folders, as these are easier for the PI or the LabAdmins to reorganise later.

Sharing a Notebook

The steps to share and unshare a Notebook are the same as for a Document, see Sharing Content. However, permissions work slightly differently with Notebooks.

Permissions Within Shared Notebooks

Notebooks created within RSpace are owned first and foremost by their creator. It is possible to share your Documents into other people's Notebooks, but this causes you to lose some control over the Document.

The sharing behaviour is as follows:

  • All entries within a Notebook are shared with the same read/write permissions as the Notebook, and the Notebook owner can re-share the Notebook with read/write permissions with other users. The Notebook owner can edit any of the entries in the Notebook, both their own and those shared into the Notebook.
  • Both the shared Notebook owner and Document owner can delete and unshare individual entries within the Notebook.
  • The Document owner can unshare to remove the Document from the Notebook.
  • PIs and LabAdmins can unshare the entire Notebook, but not individual Documents within the Notebook.
  • The Document cannot be moved to another Notebook or Folder from within the shared Notebook; it will need to be unshared first. When sharing, the Document metadata and history remains intact.

Viewing and Navigating Notebooks

Notebook View

In the Workspace, click on the Notebook icon to open the Notebook view.

You can then navigate the chronological entries using the arrows, swiping on a tablet, or using the entries bar.

You can show/hide the entries bar using Show All Entries/Hide All Entries.

You can also see the Notebook in Folder view by clicking on the breadcrumb.

Folder View

If you want to perform a bulk operation such as sharing (see Adding, Moving and Sharing Documents into Notebooks), deleting, exporting several entries (see Export Options), or want to view all entries at once, you can click on the Notebook name in the Workspace.

This will open your Notebook as if it was a folder. Clicking on an entry will open it in Notebook view.

Searching a Notebook

When viewing entries, you can use the search bar on the top-right, which supports full-text search of the content of entries, searching by name, and by tags.


How did we do?


Powered by HelpDocs (opens in a new tab)