Working with documents

This article describes how to create a document and how to add translations.

Overview

A document is a set of files for all the various translations of the same document. A document also has a set of metadata. When web viewer displays the document, the web viewer will display the translation based on the user's language setting in the browser (or a fall back translation if translation does not exist).

A document is a type of presentation, so a document may have all the metadata which a presentation may have.

Documents are typically in pdf format, but Signifikant handles any type of file. Ensure the file format chosen can be rendered in a browser. For files in html format, special handling of css files and referred images is needed.

Document files

Each document consists of a set of files. Each file may be valid for several languages or may be marked as invariant (all languages).

Example 1 - three translations

Web viewer will display the document file based on user's language selection, e.g French document for user's with French language setting.

Example 2 - invariant document

Web viewer will display the invariant document file regardless of user's language selection.

Example 3 - document for several languages

In this case the safety instruction in French and German are located in the same physical file. So, user's with German or French language setting will see the same document.

Documents that are URLs

In version 4.5.x and later it is possible to handle URLs as documents. When user clicks on a document, it will direct user to the URL.

To create these external documents follow the below steps:

1. Use document storage and create a new document

2. Check mode "ExternalDocumentURL"

3. In the list of languages add the URL to the document in the file column

Open

Create a document

1. Open document storage and add a new document.

2. Add metadata as name and permissions to the document.
   
   

   Open

   

3. Add the document files by clicking the

   1. Small yellow folder icon. This will allow to upload a new document file.
      
      

   2. Once at least one document has been uploaded it is possible to click on a small document icon with a yellow star on. This icon allows to make one language point to a file uploaded on another language (example 3 above).
      
      

4. A document file may be viewed by clicking the view icon. Note that this require a viewer (e.g. a pdf reader) to be installed on the computer.
    

5. A document file may be deleted by clicking the delete button. This will delete the database reference as well as the physical file on disk.
   
   

Related articles