Glossary
A-C
- Bibliographic entry
The item
Bibliographic entryis a reference item that enables to create a bibliographic or webographic entry. In other words, it enables to specify the source of an information, a book title or a web site...The
Bibliographic entryitems held by a document automatically create the Bibliography / Webography, at the publication.- Business items
Business items are fundamentals in Dokiel, they have the majority of the content of a document. They are four and was designed in order to aswer the technical communication various needs.
- Chunk
A
Chunkitem is a reusable untitled set of intention blocks.- Client-server implementation
Using a publishing chain in client-server mode implies the storage of the content sources on a remote server, to allow several users to work in collaboration. In this case, the storage of sources and the publication of the various media is managed by the remote server.
- Comment
Annotation
A comment is a block of text inserted in the editor but which isn't publish in the document outputs (except in previews).
Comments allow you to create a discussion thread:
- Write down a remark on a precise tag of an item, for yourself or for another user.
- Discuss between authors on specific tags of the items.
- Computer language
Allows you to select the source code language from a list.
- Concept
The
Conceptitem enables to clarify a term or an important notion.- Condition
A
Conditioncan be linked to every tag in Dokiel (Text block, Procedure step, Part, Section, etc.).Before publishing a document the writer chooses to include or exclude the elements where a condition is linked (True / False) via a configuration frame available on all publication items.
The conditions linked in the
Questionnaireof a
Reference site publicationare not defined by the writer before publishing but their activation/deactivation depends on the configuration the reader sets. Thus, a writer can create a single document adaptable to the specific context of the reader.- Condition combinations
The
Condition combinationsitem enables to subject the display of some documentation elements to complex and calculated scenarios based on a set ofConditions(which can be true or false). To do so, it can be attached at the same level as the Conditions in the content.Inside the
Conditions combinationitem, the writer can define if the reader has to fill all the combination conditions (AND) or if only one is enough to determine the content display (OR).
D
- Definition
The
Definitionitem is a reference item that enables to explain a term or a notion.The
Definitionitems held by a document automatically create the Glossary, at the publication.- Depot
It is a resource distribution server which allows:
the creation of a file tree within a management interface and the uploading of documents in the various folders of this tree;
an online access to the documents from a web browser, through a URL.
- Digital accessibility
The digital accessibility means that disabled people (visual, hearing, physical, speaking, cognitive and neurological handicaps) can use the computing tool. More precisely, they can perceive, understand, browse and interact with those tools, and they can contribute to it.
Source: CAPA project (fr)
E-H
- Editing area
The editing area corresponds to the predefined form, made of tags, which is displayed when an item is opened. Using the various tags (authorized and/or mandatory) that an item type offers, the authors can create the content and define the document scenario.
- FAQ
The
FAQ- Full description
Allows the content and meaning of a complex resource to be described for users placed in contexts where the images are not perceptible.
- Google Analytics statistics
This option enables to add Google Analytics statistics system to a Web publication (http://www.google.com/analytics)
- Guide
The
Guideelement of Dokiel enables one to create user guides, documents with didactic scenario that the user can follow. The Guide element is based on the items:
Guide publications
Guide
Sections
I
- Image item
An
Imageitem can contain a resource in JPEG, JPG, PNG or GIF format. The file format associated with the item is automatically detected when you drag and drop the resource into the explorer. If you manually create the item, you must choose from the list of available formats the file you want to import.- Image sequence
The
Image sequenceitem allows you to link several images successively.In web publishing, these images are played in a loop, like a slideshow.
- Inline tags
An inline tag is an element inserted inside the editorial content of an item. It can be a link to an item (definition, internal reference, link to a file) or a semantic enrichment (with an associated formatting).
- Item
Items are chunks of content materialized in a workspace explorer; technically, they are XML files.
Depending on their type, the items are made of:
content internalized tags (text blocks, metadata, date fields,...);
and/or
links to other items:
to content items, to develop the outline of a document or add a content fragment,
to reference items (glossary, for instance) or resource items (multimedia or office files) to enrich the content.
The available types of items depend on the document model of the publishing chain.
J-L
- LaTeX
LaTeX is a writing language, derived from TeX, commonly used for the publication of scientific documents in particular for that it facilitates the writing and the formatting of mathematical formulas.
- LaTeX equation item
.mtex
Mathematical formula, written in laTeX language, one can link in a text block.
The equation can be edited directly in the item in Dokiel, which also offers a preview.
- Local implementation
The local use of the application means that the work environment corresponds to a section of the hard disk of a computer; this implies that all the data, sources, generations and publications are stored on this computer.
M-O
- Management title
Item name, not published, making the identification and management of some types of items easier in the author interface. It is useful especially for the search.
- Matomo Analytics statistics
This option enables to add the Matomo statistics system to a Web publication ( https://fr.matomo.org/ )
- MP4 video
MP4 is a popular video file format accepted in Dokiel. Only videos using H.264 / MPEG-4 AVC codec and AAC codec for audio are compatible.
- OpenDocument format item
A file item in
OpenDocument formatcan contain a resource in ODS (table) or ODG (graphic) format. The file format associated with the item is automatically detected when you drag and drop the resource into the explorer. If you manually create the item, you must choose from the list of available formats the file you want to import.- OpenDocument formula item
.odf
Mathematical formula, written in OpenDocument format, one can link in a text block. It can be edited using Libre Office, for instance.
An
OpenDocument Equationitem contains an ODF format formula. The file format is detected when you drop an odf file in the workspace and the corresponding item type is automatically created. If you create the item manually, then you have to import the odf file using the options of the item. To update an odf item: export the formula from the item's options, modify the file in Libre Office and then reimport it in the item.
P-Q
- Part
The
Partis a titled (or not) set of intention blocks and business items; it is also used for:reuse a fragment of content in various
Sections,structure a
Section, without adding levels in the document outline (when it is titled).
The
Partsare attached to theSections, they also can be interlocked with each others and can be reused in theTrainingelement.Portable Document Format
PDF is a printable document format that preserves the formatting and content of the source document, regardless of the software, operating system, and computer used to print or view it.
It is a very widespread format, therefore readable on most computers.
- Pedagogical block
Intention block
Pedagogical blocks are content tags that support the largest amount of the editorial content in Dokiel. Several types of pedagogical blocks exist in order to enable the writer to clarify the type of information shared. They can be composed of textual content, multimedia resources, links,...
- Procedure
The
Procedureitem enables one to explain in details a succession of actions (as a step list, on a screenshot or a descriptive text) leading to a result.- Proofreading dynamic publication
A dynamic publication allows to preview a document as it will look when published and offers the possibility to read and add comments on this document.
- Questionnaire
The
Questionnaireitem enables:the writer to make a set of unique choice questions defining the various situations in which the document site user can be;
the final reader to customize the displayed document by answering the questionnaire, since its answers activate (or not) the
Conditionsitems used by the writer in the document site content.
R
- Reference document
The
Reference documentelement of Dokiel enables to create multi-entries document web sites in order to allow an user to quickly access the information they are searching for. For that, the reference site multiplies the entry points in the document: the scenario theme entries, the integrated search engine, the procedure index or the concepts glossary. Adding a Questionnaire makes the document customizable by the final user in order to adapt it to its profile/context. A reference Site designed by a writer can contain in fact several documents, from only one generating item.The reference document is based on the items:
ThemesHeadings, which enable to reuse qui the business items and theSections.
- Reference item
A reference item allows to create content, rather short, meant to be reused in several places of the document (a definition or a bibliographic entry, for example).
When published, the reference items of a same type allow to automatically generate indexes (glossary, bibliography,...).
A reference item must be linked to a content item to be integrated into the scenario of a document and to be published.
- Remote resources
Remote resourcesitems (Document,Picture,Video,...) allow to reference in your content multimedia files stored on a remote server.- Remote web module
The
Remote Web Module- Replacement text
Allows to identify the content of the resource in a synthetic way for users placed in contexts where the images are not perceptible.
- Resource item
A resource item is a container; it contains a multimedia file (image, video, web resource...) or an office resource (PDF document, OpenDocument...) as well as metadata (title, properties.,..)
S
- Scenari publishing chain
A publishing chain is a professional ‘single sourcing' authoring tool that offers:
writing XML content using a user-friendly editor,
managing content components and composing documents,
managing the work and collaboration of a team of writers,
publishing created documents in several output formats,
broadcasting easily the published documents.
- SCENARIchain-server
SCENARIserver is the server that allows to add advanced collaborative features to the editorial functions, making easier the production process.
It is a business application based on a database, which implies transactional saving issues on disk and guarantee of data consistency. Its installation and operation requires the intervention of a system administrator perfectly mastering the technical environment.
- Scenarisation
The Scenarisation is the particular assembly of multiple content fragments (items) that forms the outline of a document.
- SCORM
Sharable Content Object Reference Model
SCORM is a standard for the exchange of training media between production and learning management systems (LMS). It specifies how the course should be structured, how the datas produced during the course should be exchanged and archived as well as how the files should be put together in a zip archive.
- Screen
The
Screenitem enables to give a detailled description of a screenshot with graphically defined areas.- Semantic markup
The semantic markup is the use of XML elements (semantic tags) that allow one to give meaning to the content.
In a WYSIWYM editor, the writer clarifies the structure of a document and the intention associated to each element of its content by choosing semantic tags that describe the content they hold.
The list of semantic tags, their arrangement and their look in publication depend on the publishing chain (its XML schema).
- Short version / Standard version filters
Filters for
Short version
Standard versionBefore generating a document, choose the version to publish via the setting
Select the contentimplemented on all publication items. As a consequence, all the elements filtered for this version (= whose icon is checked
or 
) will be excluded from the generated document.- Simple title
A simple title enables to enter the name an item or tag has in a document.
- Source code
Technical resource for entering a piece of computer code and specifying the type of language. The syntactic colorization of the code is automatic on publication and in preview.
- Source code
Allows you to enter (or paste) a fragment of computer code.
- Static alternative (or textual alternative)
Information used for non interactive publications (paper), that allows you to describe the resource and/or add a link to the resource online.
- SVG image item
An
SVG image- Synoptic tree
The
Synoptic treeitem enables to create a mind map tree type; i.e. a diagram which enables to visually represent and to follow the mind associative progression.It is made of
Nodeswhich form the tree level and which can be enriched with details and resources.The
Synoptic treestructure is recursive and enables to interlock the nodes endlessly.
T-V
- Tag
A tag is a label associated to a content to specify its meaning. In practical terms, in the editor, it can correspond to a section of the editing area (such as an information block, a link to an external item, an input field or a list of choices...) or to inline tags used to mark and enrich the text (such as semantic highlights, internal or external references, etc.).
- Tasks
The built-in tasks management system allows to lead the production work and the contents update. You can create tasks and link items to them, involve other users in the tasks realization, set a due date,...
Each user find their tasks in the
My taskstab of the workspace.- Text (rich)
The term
Rich textrefers to a type of tag in the editor which allows typing the writing content and whose distinctive feature is that it can be enriched with word highlighting, lists, tables, external links, links to references (glossary...), multimedia resources, etc. Basically, it is materialized by a multi-paragraph input field in the editor.The various enrichments available are accessible via the buttons displayed in the editing bar when you click in a text area.
We find the rich text mainly in the intention blocks (Information, Attention, Example...).
- Training
The
Trainingelement of Dokiel enables to create several types of document media answering the needs of onsite and/or remote formation.The training element is based on the
Module
Onsite training publications
Training web publicationsThe
The
AssessmentThe items that compose the
- Variable
A variable injects a string of characters into a text at publishing time. An option defines whether its value is static or whether it should be able to be modified at the time of publication. In this case, before publishing the writer can keep the default value or personalize each variable used in the document via a configuration frame available on every publication items.
W-Z
- Web address
Web address is an item that enables to enter a web site address or a mail in order to reuse it in several places in the content.
The point of this item lies in the possibility to update this address in only one place, if it were to change, but that this action correct simultaneously all the address occurrences in the content.
- Web options
Web tools
Enables to add statistics features to your web site.
- WYSIWYG
What You See Is What You Get, "What you see [on the screen] corresponds to what you will get [when printed]"
Refers to a software interface where the user has to create the document's content and its formatting simultaneously. In other words, it is an interface which doesn't make a distinction between meaning and layout (e.g. text processing software).
- WYSIWYM
What You See Is What You Mean
The expression WYSIWYM refers to a user interface based on the principle of medium/message separation. A WYSIWYM content editor enables single sourcing and allows the writer to focus on the task of writing content.
- XML
Extensible Markup Language
Generic markup language used to express specific markup languages such as XHTML, SVG or OpenDocument formats.
The XML document format is definable and validatable by a schema (a vocabulary and a grammar). Any XML is fully convertible into another XML document (as long as the schema consistency is respected).
This syntax is recognizable by its brackets < and > surrounding the tags.
Sources: en.wikipedia.org.
- Zoned image item
A
Zoned image