The editor offers all the functions necessary for structured writing: it allows you to manipulate information and not formatting or layout:
As a writer, you associate semantics to groups of words.
Therefore, you don’t work on a document as it’ll be published.
The stylesheet of each publication takes advantage of the semantics to apply the expected formatting.
Data processing | |
---|---|
Structuring content also allows treating information for other goals than formatting, like compiling names of products mentioned in a document. |
Calenco editor has several areas:
We believe that you don't have to know the code in detail to produce your documentation. Nevertheless, documents delivered with Calenco are conform to the DocBook XML standard.
The editor guides you at each step ensuring this conformity.
When inserting elements, the editor proposes you options with the following icons. Click on the icon corresponding to your need:
Table 1. Insert options
|
The element is inserted at this place.
| |||
|
The inserted element encompasses the current element. | |||
|
The inserted element overwrites the current element. | |||
|
The element is inserted at this position in the text. |
Structured documents are made of elements nested in one another. Those elements are represented under different aspects:
You can select these elements by clicking on their representation to perform the desired actions.
The structure of the document is represented as a table of content in the area on the left. This view allows navigating through the document and modifying it.
This area can be hidden using located at the top left of the Calenco logo, to enlarge the editing area.
In the table of content, click on a title to quickly access the corresponding content.
Use the keyboard shortcut Alt+ to fold or unfold the structure. |
You can insert content-structuring elements in two ways:
Form the contextual menu of the table of content.
To reorganize the structure of the document sometimes implies to change the type of element.
The following features allow to turn elements (part
, chapter
, section
) into other elements depending on the need, promoting or demoting the element in the structure.
You just need to select the involved title and launch the command:
Create a new title | |
---|---|
a paragraph consists in turning it into a section. |
To divide a structure allows to create two structures of the same kind as the current structure: the content is divided in 2 structures from the cursor.
See the demonstration of the interface and the basic features of the editor:
It is possible to transform an entire file using a transformation style sheet.
In the menu
→ , choose the style sheet corresponding to the need:The editor closes the file and reopens it with the transformations. The version history is updated.
The transformations are completely personalized and are the result of development. Please contact your usual NeoDoc contact ( |
Inline elements are accessible in the menu
.Use the icon bar
to insert a table.Use the icons and to add or delete lines or columns.
Use the
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: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).
This feature checks the conformity of tables. This feature is especially useful when importing files with merged cells in tables.
Click on
→ .If there is at least an error in a table, a message describing the error found is displayed on the screen:
By clicking on the error, the corresponding table is displayed on the screen.
Validity of tables is automatically checked when saving. Those errors are not blocking for editing but they might be blocking for publishing: we strongly advice to correct them when encountered. |
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.
SVG and translations | |
---|---|
Translation tools support this format: it allows to share a unique picture through different languages. |
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. |
Click on menu
, then choose or depending on the case:Set the cursor where to insert and click on icon to choose the image to integrate and set up its publication:
Preferably specify a relative size (as a percentage of the available space). In general, adjusting the width is enough, as height is adjusted proportionally. |
By selecting the empty option in the or menu, the image will be aligned with one of the three options set by default in the style sheet. |
Click on
.Selecting the import language | |
---|---|
Don’t forget that images like contents:
|
Click on
if this image is not yet in Calenco:Uploaded images will be associated with tags selected when uploading. |
You can also upload an image in Calenco from the editor:
Open the image to embed on your computer.
Copy the image in the clipboard (right-click on Ctrl+C).
Paste (Ctrl+V or Cmd+V for users on macOS) the image in the area for editing.
Choose the place where to insert the image.
The image is saved in the language of the document. |
The imported text retains its original structure in accordance with the levels of titles present in the original document.
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
under the image name:A new window appears:
The following features are available in the icon bar on the left:
|
Translation | |
---|---|
The texts written with the drawing editor are supported by the translation tools: each text element is a translation segment. |
An equation is created with the menu
→ .Click on the element containing a question mark
Build the equation with the different features.
Click on the equation to edit.
There are several methods for creating a bibliography.
Procedure 15. Creation in the Calenco interface
Click on
.Give a title to the bibliography.
Choose the bibliography
element in :
Click on
: the content editor opens the bibliography created in a new tab.Procedure 16. Creation in an existing document
Open the document.
Click on the
→ menu.Add the bibliography
element.
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 To customize).
→ menu (A bibliographic reference makes it possible to make the link between the bibliographic entry and its reference in the text.
Place your cursor where you want to insert the bibliographic reference.
Click on the
→ menu: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. |
The bibliography can be modularized from the editor if it is created in an existing document To modularize content.
If the bibliography is modularized, only identified bibliographic entries are visible and selectable. |
It is recommended to set the publication with bibliography.numbered
= 1 to publish a number corresponding to each bibliographic reference.
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 ( |
There are several methods for creating a glossary.
Procedure 17. Creation in the Calenco interface
Click on
.Give a title to the glossary.
Choose the glossary
element in :
Click on
: the content editor opens the created glossary in a new tab.Procedure 18. Creation in an existing document
Open the document.
Click on the
→ menu.Add the glossary
element.
Procedure 19. Creation of an automatic and filtered glossary
Open the document.
Click on the
→ menu.Add the empty glossary
element.
In the “auto”.
→ menu (in the left area of the editor) placeRetrieve the url link of the glossary created beforehand, modify it by deleting a part:
Place the link in the glossary.collection
publication parameter (Publish a glossary).
Glossary terms that are not cited in the document are not published.
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 To customize).
→ menu (Using the term
element for words or groups of words in the text of the document allows reference to glossary entries.
Select the text to set as a term.
Click on the
→ menu.Content defined as |
The glossary can be modularized from the editor if it is created in an existing document To modularize content.
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 19, “Creation of an automatic and filtered glossary”).
Titles are mandatory for structure elements.
In structured documentation, using a title when possible is strongly advised.
Click on contextual menu
of the element or in the icon bar → → .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 .
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.
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
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:
Click on the
→ menu.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).
Select the text from the source file, such as a Word document or a web page.
Copy it (Ctrl+C).
Paste it in the editing area where needed (Ctrl+V).
Imported text keeps its original structure.
To paste the text without formatting, use the shortcut Shift+Ctrl+V. |
A cross reference allows you to make a link in the document to another part of the same document.
Position your cursor where you want to insert the cross-reference.
Click the
→ , or use the quick tools on the left:The target elements with a title are listed in the dialog box that appears:
Learn how To add a title |
Titles without an identifier appear in gray with a floating message and are not clickable. |
If you want to refer to an element which is not listed, click on
.Make sure that the target element is identified (To identify).
Click on "_specify_"
to open this dialog:
Click on
to show the list of identified elements in the document:Select the target identifier.
An external link makes it possible to make a reference to a web address.
Select the content for which you want to insert the external link.
Click on
→ → . A dialog box opens asking you to insert a url link in the dedicated field:Validate with OK.
The link is automatically placed in the href
attribute:
Select the element.
Use standard shortcuts (Ctrl+ or Ctrl+ and then Ctrl+ ) to move or duplicate content.
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. |
The menu
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:
Style hierarchy. To make a text in bold italics, it is necessary to place this text first in the |
Calenco publishes content following the logic of the style sheet: inserting a manual page break forces the behavior of the publication.
Calenco offers three types of lists (
):Continue numbering an ordered list. To continue numbering with the index following the last index of a previous list, the |
Position your cursor where you want to insert the footnote.
Click the
→ menu.Type the text in the dedicated area.
It is possible to make a reference to the footnote in a document.
Position your cursor where you want to insert the cross-reference.
Make sure the target footnote is properly identified (To identify).
Click the
→ menu:Select the desired target and validate.
Identifying an item is useful for reusing or referencing it.
There are several methods to identify an element:
Edit properties of the element and manually enter an identifier:
This feature allows taking an element (section, chapter, part) from your document to reuse it in other documents.
Select the element to modularize;
Click
:either in the Context with a right click on the selected element;
either in the table of contents with a right click on the selected element.
A new file is created in Calenco with this element and its content, in the language of the current document.
Background color highlights the inclusion.
To modify a module, right-click on the inclusion and click on
.The modules (Chapter, section, appendix etc.) do not need to be identified to be reused.
There are several ways to reuse modules.
Procedure 20. Method 1
In the editor, select the module to reuse.
Click on
then on .In the target document, indicate the insertion point and bring the inclusion with Ctrl+V.
Procedure 21. Method 2
In the editor, select the module to reuse.
In the Context, right click on the name of the selected element and click on
.In the target document, indicate the insertion point and bring the inclusion with Ctrl+V.
Procedure 22. Method 3
In the target document, click at the top right in the header to select a module.
Select the desired module and click OK.
It is possible to filter files thanks to tags. The drop-down menu Display allows showing name or label of files. |
In a new window that opens, click on the element and indicate the insertion point.
Insert the element using the arrow system Table 1, “Insert options”.
Elements as content fragments (single paragraph, image, table etc.) must be identified to be reused.
There are several methods of reusing fragments.
Procedure 23. Method 1
Make sure that the element to be reused is well identified (To identify). |
In the target document, click at the top right in the header to select a file containing reusable content.
It is possible to filter files thanks to tags. The drop-down menu Display allows showing name or label of files. |
Select the file and click on OK. A new window appears:
If the file contains a lot of reusable elements, you can filter them.
Click the element and specify the insertion point. Insert the element using the arrow system Table 1, “Insert options”.
Click on to update the list of items. |
A parameter allows using a value at different places in a document.
The value of the parameter is used when publishing: configuring content allows to maximize their reuse.
To insert a parameter:
Specify an identifier on the element containing the text to reuse. This is often an element of the document header such as a product name, version number, etc.
Place the cursor where you want to insert the parameter.
Click on
→ .Set the identifier (To identify) of the variable, in the black background of the element.
A calculation can be inserted with the feature
→ .To edit the formula, click on the “Σ” sign.
Content of the dialog box
A clickable list of variables that can be referenced in the formula.
For an element to appear in this list, the following conditions must be met:
Update calculations | |
---|---|
Formulas are evaluated in real time as the base numbers are being changed in the document. Use the icon to refresh the document if necessary. |
When writing the formula, the numeric constants must be written in the imperial format (the decimal point must be ".").
+
: Addition-
: Subtraction*
: Multiplication/
: Division%
: ModuloTable 2. Constants
Constant |
Description |
---|---|
E |
Euler's number, the base of natural logarithms, about 2.718. |
LN2 | Natural logarithm of 2, approximately 0.693. |
LN10 | Natural logarithm of 10, approximately 2.302. |
LOG2E | Base logarithm 2 of E, approximately 1.442. |
LOG10E |
Base 10 e logarithm, about 0.434. |
PI |
Quotient of the circumference of a circle by its diameter, about 3.14159. |
SQRT1_2 |
Square root of 1/2; equivalent of 1 on the square root of 2, about 0.707. |
SQRT2 |
Square root of 2, about 1.414. |
Precision | |
---|---|
The precision of mathematical functions depends on implementation. This means that different browsers may provide different results. One can even have a single JavaScript engine that, on different architectures and/or operating systems, provides different results. |
Functions
Returns the absolute value of a number.
Returns the cosine arc of a number.
Returns the hyperbolic cosine arc of a number.
Returns the sine arc of a number.
Returns the hyperbolic sine arc of a number.
Returns the tangent arc of a number.
Returns the hyperbolic tangent arc of a number.
Returns the tangent arc of the quotient of its arguments.
Returns the cubic root of a number.
Returns the smallest integer greater than or equal to the value passed as a parameter.
Returns the number of zeros that prefix a 32-bit integer.
Returns the cosine of a number.
Returns the hyperbolic cosine of a number.
Returns the exponential of a number (i.e. Enumbr) with E the Euler constant (2.718...).
Returns the result of 1 minus the exponential of a number.
Returns the largest integer less than or equal to the value passed as a parameter.
Returns the 32-bit floating point number closest to the argument.
Returns the square root of the sum of the squares of the arguments.
Returns the result of 32-bit integer multiplication.
Returns the natural logarithm (lodge) of a number.
Returns the natural logarithm of 1 + a number.
Returns the logarithm at base 10 of a number.
Returns the logarithm at base 2 of a number.
Returns the largest value of a list of numbers.
Returns the smallest value of a list of numbers.
Returns the calculation of x to the power y (x is the base and y is the exponent).
Returns a pseudo-random number between 0 (inclusive) and 1 (excluded).
Returns the rounding of a number.
Returns the sign of a number, indicating whether it is positive, negative, or zero.
Returns the sine of a number.
Returns the hyperbolic sine of a number.
Returns the square root of a number.
Returns the tangent of a number.
Returns the hyperbolic tangent of a number.
Returns the integer part of a number (the decimal part is removed).
If a calculation is inserted into an array, its formula can reference the numerical values present in the array. The cells in the table are identified by their coordinates. Columns are identified by capital letters. Lines are identified by numbers.
Click on the top left icon to display coordinates of cells.
For example, to add 1 to the number in the cell in the third column, second row:
C2 + 1
To obtain the square root of the number contained in the cell of the fourth column, second row:
sqrt(D2)
Sum function. The function sum (sum
) has as input coordinates of the first cell and the ones of the last cell, separated by ":". Examples:
sum(B2:B13)
sum(B3:C4)
cos(PI)
Result: -1
.
cos(PI) + myIdentifier
Result: 0
if the variable identified by myIdentifier
contains text "1".
Profiling makes it possible to specify the “context” relating to a specific content, the “profile” of this information. For example on the maintenance manual of a vehicle, a chapter can be specific to a variant (heat engine, electric or hybrid). Or even to specify that some information is confidential.
This makes it possible to manage all the variants of the same document from a single source, while leaving the possibility of generating a final publication for each variant.
Another use of this functionality is to modify the layout according to the profile of the information (confidential information will be framed in red for example).
Prepare profiling by reading To customize attributes.
To condition the publication of a content or specify it so that a specific treatment is applied when publishing:
Select the element and use contextual menu
:Check the use cases corresponding to the selected content:
You can find the list of profiling attributes in the official DocBook documentation. |
Profiled elements are represented with a colored background. Profiling attributes are indicated in the list of attributes by the same color background: |
It is not always possible to define a list of values for a given attribute. In this case, directly key-in values in the list of attributes or in the dialog To customize attributes). if the attribute had been selected to be quickly accessible (see |
Check out the Content Profiling video:
Calenco has a feature to comment documents, without impact on publication. This is especially useful with workflow, so that each involved user can contribute, without directly impacting the final result.
In the area of content management, you can comment elements to keep track of suggested-only or implemented modifications.
Select the content you want to comment on and click
.Complete the comment field. The information is saved automatically.
Double click on to modify an existing comment.
Click on the gray cross at the top right of a comment to delete it.
Click on to open the comments list.
Click on to locate the desired comment. The content affected by this comment appears on a yellow background for a few seconds.
Double click on to respond to a comment.
People working on a document can respond to comments in the following ways:
Answer in the dedicated field if necessary.
This feature is an option depending on subscription. Please contact your usual NeoDoc contact ( |
The editor allows collaborative mode of work. Several users can modify simultaneously the same file. Users editing a file are symbolized by a dot with the first 2 letters of the users' first name at the top right of the tab. For example, below Ma and Ly:
When hovering the pointer of the mouse on icons, the email address of the user is displayed in a tool tip.
When several users edit a file, they can modify simultaneously the same element. The presence of one of the users on a content block will gray it out and the gray vertical bar to the left of this block will turn purple, preventing any modification by other users: |
This feature is an option that works in conjunction with the account DocuSign of your company. Please contact your usual NeoDoc contact ( |
Calenco allows a maximum of 5 signatories to electronically sign a document, in connection with DocuSign.
You only need to insert in the text where required the following keywords: $$signature1$$
, $$signature2$$
, $$signature3$$
, $$signature4$$
or $$signature5$$
.
This feature distinguishes two documents with the same title.
Above Context, click the edit icon to the right of the content name:
Enter the name of the label.
The label of the document is updated.
You can populate the menu
with specific elements.Choose menu
→A search bar helps to quickly filter elements.
Click on icon on the right of the element to add in the menu
.To copy the reference of an element with choice when inserting
This feature is mandatory when pasting a reference near an inclusion. |
Remove inline tags.
Transforms an inlinemediaobject
into a mediaobject
.