3. To produce

Inline elements are accessible in the menu Content.

3.1. To insert a table

Use the icon bar Tables and images to insert a table.

Use the icons and to add or delete lines or columns.

Use the Table menu or the contextual menu (right click on the upper gray bar, in a cell or on the gray bar to the left of a row) to modify the structure of a table or the configuration of its elements:

Figure 1. Table context menu

Table context menu

Figure 2. Context menu of a cell

Context menu of a cell

Figure 3. Context menu of a line

Context menu of a line

The icon on top left displays identifiers of lines and columns: it’s especially useful to set up calculations (Variables and functions in a table).

3.1.1. Check conformity of tables

This feature checks the conformity of tables. This feature is especially useful when importing files with merged cells in tables.

Other problems may arise in the tables. Refer to Detect potential issues related to profiling.

Procedure 12. To detect a potential problem while saving a document

  1. Press . The following window appears:

  2. Press the message “Detect potential problems”. A list of errors is displayed.

Procedure 13. To detect a potential problem before the document is saved

  • In the menu Tools → Detect potential problems A list of errors is displayed.

Figure 4. List of potential problems in tables

List of potential problems in tables

The error messages and the explanations for verification and troubleshooting are described below.

3.1.1.1. Vertical Merge Error

This issue occurs if a row with vertical merge has been copied/pasted to the last row of the table:

The publication fails with the following error message:

Figure 5. Typical message in the logs of the failed publication

Typical message in the logs of the failed publication

It is necessary to repair the broken table (see Troubleshooting issues).

3.1.1.2. Missing column(s)

This issue appears if a row with vertical merge has been copied/pasted to a row in the table:

The publication fails with the following error message:

Figure 6. Typical message in the logs of the failed publication

Typical message in the logs of the failed publication

It is necessary to repair the broken table (see Troubleshooting issues).

3.1.1.3. Troubleshooting issues
[Important]

Those errors are not blocking for editing but they might be blocking for publishing: we strongly advice to resolve them when encountered.

Procedure 14. To resolve the issue:

  1. Select the cell in the row that has the problem:

  2. Remove the value for the morerows .

3.2. To insert an image

It is possible to insert images in contents. Different formats are supported:

  • JPG - compressed format, suitable for photos.

  • PNG or GIF - raster image, suitable for screenshots and graphics.

  • SVG - vector format, suitable for illustrations.

    [Tip]SVG and translations

    The SVG format is supported by translation tools: this allows a single image to be shared for all languages.

[Note]Other formats

Other formats such as PDF or TIFF can be used as images but are not recommended because not necessarily compatible with all your publication formats.

  1. Click on menu Tables and images, then choose Images or Inline media depending on the case:

    Media

    To insert a simple image;

    Figure With Title

    To insert an image with title ;

    Clickable Image

    To insert an image containing hotspots;

    Drawing

    To insert an image editable with the editor of images integrated to Calenco (SVG format);

    Inline Media

    To insert an inline media or an image in the text.

  2. Set the cursor where to insert and click on icon to choose the image to integrate and set up its publication:

    [Note]

    Preferably specify a relative size (as a percentage of the available space). In general, adjusting the width is enough, as height is adjusted proportionally.

    [Note]

    By selecting the empty option in the Alignment or Vertical alignment menu, the image will be aligned with one of the three options set by default in the style sheet.

  3. Click on Choose image.

    [Note]Selecting the import language

    Don’t forget that images like contents:

    • are broken down by language,

    • can be filtered by tag for easy finding.

  4. Click on Upload a file in this workspace if this image is not yet in Calenco:

    [Important]

    Uploaded images will be associated with tags selected when uploading.

You can also upload an image in Calenco from the editor:

  1. Open the image to embed on your computer.

  2. Copy the image in the clipboard (right-click on Ctrl+C).

  3. Choose the place where to insert the image.

  4. Paste (Ctrl+V or Cmd+V for users on macOS) the image in the area for editing.

    [Note]

    The image is saved in the language of the document.

3.2.1. Searching for a missing image

Sometimes, the document references images but they are not loaded by the editor. These missing images look like this:

The most likely cause of this behavior is the absence of images in the target language when the translation document is returned (see What is sent for translation?).

Procedure 15. To easily find missing images:

  1. Click in the menu Tools → Missing images. The following dialog opens:

  2. Click on the image to find its location in the document.

  3. Sort the list of missing images by the order in which they appear in the document or by their name if necessary.

3.2.2. Illustration editor

The illustration editor lets you create (see Create an annotated image) and edit images in SVG format.

To access the editor from an image, click Edit under the image name:

A new window appears:

The following features are available in the icon bar on the left:

  • Select (V)

  • Zoom

  • Panning

  • Pencil (Q)

  • Line/connection (L)

  • Rectangle (R)

  • Ellipse/Circle (E)

  • Text (T)

  • Library of shapes

  • Image

  • Star Tool

  • Eye dropper

[Note]Translation

The texts written with the drawing editor are supported by the translation tools: each text element is a translation segment.

3.2.3. To generate a QR code

A QR code is an image that contains coded information. Any QR code can be inserted as an image.

Calenco also allows you to dynamically create QR codes during publication: this avoids the creation of the image.

  1. Click on the menu Insert → Insert a QRCode.

  2. Place a URL link in the Text field and validate.

  3. Choose the location of the QR code in the document and give the name to this image.

3.3. To create equations

An equation is created with the menu Content → Equation with title.

Click on the element containing a question mark ? to edit the equation:

Build the equation with the different features.

Click on the equation to edit.

3.4. Create a bibliography

There are several methods for creating a bibliography.

Procedure 16. Creation in the Calenco interface

  1. Click on Create.

  2. Give a title to the bibliography.

  3. Choose the bibliography element in Type Reusable Content:

  4. Click on Create: the content editor opens the bibliography created in a new tab.

Procedure 17. Creation in an existing document

  1. Open the document.

  2. Click on the Structure → Bibliography menu.

  3. Add the bibliography element.

3.4.1. Edit a bibliography

The bibliography is made up of the bibliographic entry elements.

When created, the bibliographic entry element is composed of a few default elements: author, reference, bibliographic identifier, title, abstract etc.

It is possible to compose an entry from the combination of relevant items for a bibliography. These items are found in the Tools → Insert Item menu (To customize).

[Tip]

The description of the elements is available in the DocBook guide.

A bibliographic reference makes it possible to make the link between the bibliographic entry and its reference in the text.

  1. Place your cursor where you want to insert the bibliographic reference.

  2. Click on the Links and references → Bibliographic reference menu:

    [Note]

    The link between the reference and the bibliographic entry is made via the identifier of the latter.

    If the bibliographic entry does not have an identifier, Calenco generates one.

3.4.2. Reuse a bibliography

The bibliography can be modularized from the editor if it is created in an existing document To modularize content.

[Warning]

If the bibliography is modularized, only identified bibliographic entries are visible and selectable.

3.4.3. Publish a bibliography

It is recommended to set the publication with bibliography.numbered = 1 to publish a number corresponding to each bibliographic reference.

[Important]

A customization of the publication style sheet makes it possible to publish only the bibliographic entries cited in the document.

Please contact your usual NeoDoc contact () to activate it.

3.5. Create a glossary

There are several methods for creating a glossary.

Procedure 18. Creation in the Calenco interface

  1. Click on Create.

  2. Give a title to the glossary.

  3. Choose the glossary element in Type Reusable Content:

  4. Click on Create: the content editor opens the created glossary in a new tab.

Procedure 19. Creation in an existing document

  1. Open the document.

  2. Click on the Structure → Glossary menu.

  3. Add the glossary element.

Procedure 20. Creation of an automatic and filtered glossary

  1. Open the document.

  2. Click on the Structure → Glossary menu.

  3. Add the empty glossary element.

  4. In the Attributes → role menu (in the left area of the editor) place “auto”.

  5. Retrieve the url link of the glossary created beforehand, modify it by deleting a part:

  6. Place the link in the glossary.collection publication parameter (Publish a glossary).

    Glossary terms that are not cited in the document are not published.

3.5.1. Edit a glossary

The glossary consists of entry elements.

On creation, the input element is composed of the elements: term, definition.

It is possible to add other optional elements. These items are found in the Tools → Insert Item menu (To customize).

[Tip]

The description of the elements is available in the DocBook guide.

Using the term element for words or groups of words in the text of the document allows reference to glossary entries.

  1. Select the text to set as a term.

  2. Click on the Content → Term menu.

    [Note]

    Content defined as term appears in italics in the publication.

3.5.2. Reuse a glossary

The glossary can be modularized from the editor if it is created in an existing document To modularize content.

3.5.3. Publish a glossary

Using the glossterm.auto.link = 1 parameter creates a link between the word defined as term in the text and the corresponding entry in the glossary.

Using the glossary.sort = 1 parameter will publish glossary terms in alphabetical order.

Using the glossary.collection parameter allows you to publish only the terms cited in the document (Procedure 20, “Creation of an automatic and filtered glossary”).

3.6. To add a title

Titles are mandatory for structure elements.

In structured documentation, using a title when possible is strongly advised.

Click on contextual menu Add a title of the element or in the icon bar Content → Title → Add.

3.7. To specify information

The information element, located at the very beginning of the document, allows you to store information that is sometimes not published (author's name, reference number, product identifier, table of revisions, etc.). The commonly used elements are available in the menu information.

3.8. To insert a page of a PDF file

A page of a PDF file can be referenced for publication as an image.

A PDF must be stored in Calenco in the appropriate language.

[Note]

Once imported, the PDF file is only visible by administrators.

Syntax to point to the page is the following: file name.pdf #page=page number

Figure 7. Example of referencing a PDF page

Example of referencing a PDF page

3.9. To integrate audio or video

A PDF publication is not appropriate to integrate video and Calenco is not the place where your contents are stored.

The most effective way is to refer to a web address where the recording is stored and accessible to the target audience:

  1. Click on the Tables and images → Video menu.

  2. Insert the full url link in the fileref attribute.

Videos are published as a link (for PDF publications) or in an online player (for HTML publications).

3.10. To migrate content in Calenco

  1. Select the text from the source file, such as a Word document or a web page.

  2. Copy it (Ctrl+C).

  3. Paste it in the editing area where needed (Ctrl+V).

    Imported text keeps its original structure.

    [Tip]

    To paste the text without formatting, use the shortcut Shift+Ctrl+V.

3.10.1. Detect an error in the document

When opening a file with a text that is incorrectly placed in Calenco, the editor renders it in view “XML”, with the following error message:

Figure 8. Example of a misplaced text in the xml

Example of a misplaced text in the xml

The most common causes of this error:

  • import of a poorly structured file;

  • file when the translation comes back with problems on the tags.

[Important]

We remind you that structured writing requires you to place the content within the tags.

Procedure 21. To repair the imported document:

  1. Place the text inside an existing element:

    Figure 9. Example for the title

    Example for the title

    OR

  2. Add a necessary element for this text:

    1. Move the cursor as close as possible to where you want to add the item.

    2. Click Generic → Element:

    3. Enter the name of the DocBook item and confirm.

      [Tip]

      The names of the elements are available in the DocBook guide.

    4. Paste the misplaced text inside the tags:

    5. Save the document, close it, and reopen it in the editor to check its validity:

    OR

  3. Remove misplaced text if necessary.

Procedure 22. To repair the document when the translation returns:

  1. Check the tag match and the relevant content between the source language and the target language in the CAT tool editor. (see Assess the quality of the translation)

  2. Return the document to Calenco using the task's multiple validation procedure (see Manage the status of a translation job).

3.11. Insert a cross reference

A cross reference allows you to make a link in the document to another part of the same document.

  1. Position your cursor where you want to insert the cross-reference.

  2. Click the Links and References → Cross Reference, or use the quick tools on the left:

    1. The target elements with a title are listed in the dialog box that appears:

      [Tip]

      Learn how To add a title

      [Important]

      Titles without an identifier appear in gray with a floating message and are not clickable.

    2. If you want to refer to an element which is not listed, click on Cancel.

      Make sure that the target element is identified (To identify).

      Click on "_specify_" to open this dialog:

    3. Click onChoose to show the list of identified elements in the document:

    4. Select the target identifier.

An external link makes it possible to make a reference to a web address.

  1. Select the content for which you want to insert the external link.

  2. Click on External Link. A dialog box opens asking you to insert a url link in the dedicated field:

  3. Validate with OK.

    The link is automatically placed in the href attribute:

3.13. Adapt content (cut/copy/paste)

  1. Select the element.

  2. Use standard shortcuts (Ctrl+X or Ctrl+C and then Ctrl+V) to move or duplicate content.

[Tip]Multiple content selection

Click on the vertical bars of the elements to select maintaining the key Shift pressed. You can only select several elements at the same level of structure.

3.14. Text enrichment

The menu Inline allows associating semantics to words (element of user interface, name of product...).

It is possible to define some text enrichment options by selecting a text with the mouse:

[Tip]

Style hierarchy. To make a text in bold italics, it is necessary to place this text first in the bold tag, then in the italic tag.

3.15. Add Hard Page Break

Calenco publishes content following the logic of the style sheet: inserting a manual page break forces the behavior of the publication.

  1. Select the element before which you want to insert the manual page break.

  2. Insert → Insert a manual page break.

3.16. Insert a list

Calenco offers three types of lists ( Content Lists ):

  • Bulleted list: bullet characteristics are managed by the style sheet.

  • Ordered list: the type of numbering (numbers, letters, other) is managed by the style sheet.

  • List of definitions.

[Tip]

Continue numbering an ordered list. To continue numbering with the index following the last index of a previous list, the override attribute of the first listitem element of the second orderedlist must be set to the desired index.

3.17. Insert a footnote

  1. Position your cursor where you want to insert the footnote.

  2. Click the Content → Footnote menu.

  3. Type the text in the dedicated area.

It is possible to make a reference to the footnote in a document.

  1. Position your cursor where you want to insert the cross-reference.

  2. Make sure the target footnote is properly identified (To identify).

  3. Click the Links and References → Footnote Reference menu:

  4. Select the desired target and validate.

3.18. To insert a watermark

There are several methods to publish a document with a watermark.

Procedure 23. Method 1: Default “draft” watermark

  1. Select the document at the root element.

  2. Set the statusattribute to draft.

Procedure 24. Method 2: Custom watermark

  1. Import an image that contains the desired watermark (draft, preliminary, etc.) in .png format to your workspace:

    • in the Common language if the reference remains unchanged for the language versions of the documents;

    • in each of the languages if the mention is to appear translated into the respective language of the document.

      [Important]

      All images must have the same file name as the source language.

  2. In the publication, customize the style sheet settings:

    Setting the watermark mention

    • draft.watermark.image=draft.png, if the image is in the Common language.

    • draft.watermark.image=en/draft.png for publications in English (or language code equivalent to other languages needed).

    Activating the watermark

    • draft.mode=yes to publish the watermark on all pages of the document;

    • draft.mode=no to disable the watermark for the entire document;

    • draft.mode=maybe to publish the watermark only for structural elements of the document for which the status attribute is set to draft.

    Figure 10. Setting up the publication with the custom watermark

    Setting up the publication with the custom watermark