Documentation¶
Create a new project¶
Find the project selection dropdown on the top left.
Select "Create new project", then enter a unique name for your new project.
Upload references¶
Drag and drop PDFs or .docx files directly from your file browser.
Or use our upload manager.
We extract and populate metadata automatically for all uploaded documents. However, our AI may not get everything right immediately. Please review the metadata and confirm that your metadata is indeed correct.
Import/export references using BibTeX¶
You can manually add a reference by providing its BibTeX entry.
This is a work in progress, we are fixing a few bugs discovered recently; this section will be updated once the feature is fully functional again.
Collections¶
Collections work similarly to bookmarks in various popular web browsers. Documents belonging to a child collection will automatically be associated with all of its parents. For example, in the following hierarchy, documents in “Child collection L2” will also belong to “Child collection L1” and “Root collection”, which are all part of “All documents” that you have uploaded into the “Sample project”. Note that the same document can belong to multiple, same-level collections.
The following diagram illustrates the above data structure.
Create collections¶
Create a new folder by clicking on the associated icon on the left sidebar.
If you want to create sub-folders, simply hover your mouse over the parent folder and select “create new folder” in the context menu.
Add to collection¶
You can add documents via multi-select (hold shift) then drag & drop.
Remove from collection¶
If you want to remove a document from collection, select “Remove from collection” under the context menu of that document.
Note that this removes the document from its current collection, as well as all associated parent collections. If you would like to move it from current collection to a parent collection instead, simply drag & drop it from its current collection into the target parent collection.
Browse and edit metadata¶
There are two ways you can edit the metadata of your references.
You can select a single document and view/edit its metadata on "Properties" tab on the right sidebar (You can show empty metadata fields on the “Show” dropdown menu at the right). Clicking the "..." icon on a document in list view would direct you to the "Properties" tab.
Or you can switch to "Grid view" and edit metadata the same way you would on a spreadsheet.
You can add or remove custom metadata fields by selecting “Add or remove metadata fields” from the designated dropdown menu.
While in grid view, if you would like to hide/show existing metadata columns, you can select "Grid view column visibility".
Search and in-document lookup¶
You can search for a reference using the search bar at the top of the app (enclose phrases in quotation marks to treat phrase as a single search term).
You can adjust the search type and search scope via dropdowns attached to the search bar.
- Metadata search looks through only the metadata associated with your references (e.g. title, author, abstract, etc.) and ignores full-text. You may only conduct metadata search within the current project.
- Full-text search looks through the full-text of your references. You may conduct full-text search either within the current project or across all your projects.
You can search within the current project, or across all projects in your library.
If you would like to see how your search query appears within a document, select the "Lookup" tab on the right sidebar. It should appear once you have entered a search query under “Full-text” scope setting.
The chart represents occurrence frequency of specific lookup terms across pages. Lookup results display snippets encapsulating one or more of your lookup terms. You can change the ordering from "relevance" to "page order" manually using the "Sort by" dropdown.
Tags¶
Add tags¶
Or by selecting the document and navigating to "Properties" tab on the right sidebar.
Our NLP engine will generate recommended tags for your reference based on the full-text, as well as any documents you have tagged in the past.
Editing tags¶
If you would like to edit an existing tag, simply click on it wherever you see it. You can edit the tag in the popup dialog afterwards. Note that editing an existing tag will update all instances of that tag across all documents within your current project.
Removing tags¶
If you would like to remove a tag, click on the “pencil” icon, then click the “x” or backspace to remove it from the selected document’s current list of tags.
Document viewer¶
To view the full-text of any selected document in our Document Viewer, simply double-click any text-free area on the document card. A new browser tab should open, and you should see your selected document displayed in the app’s built-in document viewer.
Alternatively, you can select the document, go to the “Preview” tab, and click “Open new tab at current page”.
Annotation¶
Our app currently supports two types of annotations: the highlight annotation and the snippet annotation.
Create annotation¶
In the document viewer, select the type of annotation you want to create by clicking on the downward arrow.
Select text or draw a bounding box around the annotation region, then provide an (optional) insight/description and select a color.
Click “Save” when you are finished.
Browse annotation¶
You can browse the annotations you (or project collaborators) created for the current document in the “annotations” sidebar.
You can browse annotations across all documents within the project in the “annotations view” accessible in the Project Browser.
Customizing the UI¶
Reposition sidebar tabs¶
You can reposition any tab by drag & dropping it on any valid region.
To resize tabs:
You can now view two tabs side by side.
Show/hide sidebar tabs¶
You can show/hide any sidebar tabs using the dropdown menu on the top navigation bar.
Collapse sidebars¶
You can collapse either the left or the right sidebar by clicking the arrows attached to the edge of each sidebar.
Choose displayed citation style¶
You can select how metadata is displayed on each document card by specifying your preferred citation style.
Once a style has been chosen, you can review and copy citation information by clicking on the citation text itself.