Skip to main content

How to create references in a document

Connect selected text in a document to another entity or to a specific paragraph in the Uwazi viewer.

A reference links a passage in your document to another entity. The interface calls it a relationship. You can link to a whole entity, or to an exact paragraph in any document.

Prerequisites​

  • The editor or admin role, or permission to edit this entity
  • An entity with at least one document
  • At least one relationship type set up in your instance
note

With no relationship type in your instance, Uwazi stops you at the Choose relation type step. Admins can add a type there. Everyone else reads "An admin needs to add relationship types before you can create a relationship."

Steps​

Open the entity. The document sits on the Document tab. The Relationships tab sits beside it and shows a count.

Reference another entity​

Use this path to link selected text to an entity as a whole. The target entity doesn't need a document of its own.

  1. In the document, select (highlight) the text you want to link.
  2. In the small menu that appears, select Create relationship.
  3. On the Select target entity step, type a name in the Search entities... box.
  4. Select the target entity from the results.
  5. If that entity has PDF files, the Select target document step opens. Select Connect to entity to skip it.
  6. On the Choose relation type step, select a type. Uwazi selects the first type for you, so change it if you need another one.
  7. Select Create relationship.

Uwazi saves the reference and flashes a "Relationship created" message. The reference joins the list on the Relationships tab.

Reference a specific paragraph​

Use this path to link your selected text to an exact paragraph. The target paragraph can sit in another entity's document or in the one you're reading.

  1. In the document, select (highlight) the text you want to link.
  2. In the small menu, select Create relationship.
  3. On the Select target entity step, search for the entity, then select it. Pick the entity you're reading to link within the same document.
  4. On the Select target document step, select the file that holds the paragraph. Only PDF files appear here.
  5. On the Choose relation type step, select a type, then select Continue.
  6. On the Select text in target document step, select (highlight) the target paragraph.
  7. Select Save.

To step back at any point, select Back. The Select target document step appears only for entities that have a PDF, so an entity without one can't be a paragraph target.

Create the target entity as you go​

  1. On the Select target entity step, select Create new entity from selection.
  2. Uwazi opens the New entity step and fills the title from your selected text. Edit the title if you want.
  3. Select a template.
  4. Select Create entity.

Uwazi creates the entity, then carries on with it as your target.

Find and read your references​

  1. Open the Relationships tab.
  2. Select a row to jump to its text in the document.
  3. Select one of the three view buttons beside the search box to switch between List, Tree, and Graph.
  4. Select Display options to group, sort, or resize the rows.
  5. Use the rail down the side of the document. Each marker stands for one reference. Select a marker to open its reference.

With no references yet, the tab reads No Relationships. When a search or a filter matches nothing, it reads No relationships found.

Delete a reference​

warning

Deleting a reference removes the link for everyone, and you can't undo it.

  1. Open the Relationships tab.
  2. Point at the reference you want to remove.
  3. Select the trash button on its row.
  4. In the Delete relationship dialog, select Delete.

To remove several at once:

  1. In the footer of the Relationships tab, select Edit.
  2. Select each row you want to remove, or use Select all.
  3. Select Delete.
  4. In the Delete relationships dialog, select Delete.
  5. Select Save to leave edit mode.

Deleting a reference needs the same access as creating one. Edit mode holds no draft, so each deletion takes effect as you confirm it.

Result​

Your document now links to the entity or paragraph you chose, and the reference appears on the Relationships tab.

See also​