Skip to main content

How to create references in a document

A reference links a passage in your document to another entity. You can link to a whole entity, to a paragraph in another document, or to a paragraph in the same document.

Prerequisites​

  • The collaborator, editor, or admin role
  • An entity with at least one document, opened in the document viewer
  • At least one relationship type set up in your instance
note

If no relationship type exists, the connect buttons don't appear. Ask an admin to add a relationship type first.

Steps​

Open the entity in the document viewer. The document opens with the side panel on the right.

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 Connect to an entity.
  3. The Create Reference panel opens and lists every relationship type.
  4. Select a relationship type. A check mark marks your choice.
  5. Type a name in the search box, then select the target entity from the results. Leave the box empty to list every entity.
  6. Select Save.

Uwazi saves the reference and opens the References tab. Your selected text turns yellow in the document.

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 Connect to a paragraph.

  3. In the Create Reference panel, select a relationship type.

  4. Search for the target entity, then select it. Only entities that have a document appear here. To link within the same document, select the entity you're already viewing.

  5. Select Next. The target document opens beside yours. If you chose the same entity, the same document opens again.

  6. In that document, select (highlight) the target paragraph.

  7. Select Save.

    To stop and go back, select Back instead. This returns you to the single document view.

Uwazi saves the reference and highlights the text on both ends.

Delete a reference​

warning

Deleting a reference removes the connection for everyone, with no way to undo it.

  1. Open the References tab in the side panel.
  2. Point at the reference you want to remove.
  3. Select the trash button on its row.
  4. In the dialog, confirm the deletion.

Only editors and admins see the trash button.

Result​

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

tip

Select a reference in the References tab to jump to its highlighted text in the document.

See also​