Draft:TechEditor

TechEditor is a professional environment for developing technical documentation, created by the Ukrainian team Dystlab. The program offers users the ability to create text and graphical documents, perform calculations and mathematical computations, develop specialized applications to enhance functionality, and more.

At its core, TechEditor aims to provide a unified, convenient, and reliable environment for working with technical documentation. The software's development began in 2018 by Ukrainian experts in engineering and scientific research under the Dystlab brand. Its purpose is to meet the needs of users working with technical data.

Areas of Application

Engineering and Scientific Research

TechEditor has found extensive application in engineering, design, and research fields. Engineers and scientific-technical professionals utilize TechEditor for developing various types of technical documentation, including explanatory notes for architectural and construction projects, reports on scientific research, technical specifications, professional articles, dissertations, and more. The program provides tools for constructing analytical diagrams and physical-mathematical models, ensuring accuracy and quality in working with technical data.

Construction and Mechanical Engineering

TechEditor is employed in construction projects, mechanical engineering, and other technical fields. It assists developers in creating textual technical documentation, including formulas, calculation tables, graphical materials, and ensures efficient work and high project quality.

Project Management

TechEditor can be used in project management. Project managers and executives can utilize the program to control design and standardize document flow within companies. The environment provides convenient tools for quantitative project evaluation and decision-making, contributing to successful project execution.

Education

TechEditor is a valuable tool for educational institutions. It aids students in completing coursework, diploma projects, calculation-graphic works, internship reports, and more. Instructors and department staff can apply TechEditor as a means to develop interactive guidelines, textbooks, teaching manuals, and other educational materials. The program can also serve as a testing and quality verification tool for material comprehension.

Software Features

TechEditor offers a wide range of capabilities for the simultaneous development of text and graphical documentation, as well as conducting calculations. The program supports various types of documents, including reports, diagrams, mathematical sheets, and applications, and provides essential options:

Text Editor

TechEditor features a multifunctional text editor specifically designed to meet the needs of engineers and technical specialists. It provides a convenient interface for creating and editing text, similar to popular editors. Users can typeset text, format it, insert formulas, tables, images, and more. For formula input, TechEditor includes a built-in editor with a large number of templates and snippets. It automatically generates mathematical expressions in the style of TeX/LaTeX, ensuring reliable interpretation and canonical representation of formulas in the document without unexpected shifts or artifacts.

Mathematics and Computations

Unlike office programs, TechEditor enables calculations and various physical and mathematical simulations, including unit measurements. Users can choose the type of document they prefer to work with. Analytical expressions in reports appear as naturally and canonically as in a book format. On the other hand, diagrams offer unlimited space for actions and allow free movement of text or graphical elements using the mouse cursor. In TechEditor diagrams, it is convenient to create calculation sheets similar to spreadsheets but in a more flexible mode, without traditional cell constraints. Additionally, TechEditor diagrams allow for the construction of multilevel analytical algorithms and schemes, which are characteristic of other modern mathematical programs. Each TechEditor document has its own mathematical model and can be used separately from other parts of the project or referenced to a global mathematical model shared across all documents.

Application Development

TechEditor provides a built-in development environment (IDE) that allows users to create their own mini-applications. These applications act as plugins and run directly within the program, eliminating the need for additional software or drivers. Applications can be implemented as console programs or programs with a full-fledged windowed interface. The IDE allows users to place text input fields, buttons, checkboxes, radio buttons, and other control elements on the form window. Each application can interact with the current report, enabling users to create calculators or mini-CAE systems with features for automatically resetting results to explanatory notes.

Unit of measurement support

The program supports units of measurement, enabling convenient work with different measurement systems and data conversion to the desired format. In addition to traditional Latin units (kN, mm, Pa), mathematical expressions in TechEditor can utilize their Ukrainian Cyrillic counterparts (кН, мм, Па, and so on). All mathematical expressions in TechEditor are written in plain text, for example, "A(t):=2.2*sin(f/10)". To specify a physical quantity, users simply add the corresponding units of measurement, separated by a space, for example, "F:=10 kN". TechEditor automatically verifies the consistency of units of measurement in all mathematical expressions and provides notifications if any inconsistencies are detected. The program supports a wide range of physical dimensions.

Export and Document Printing

TechEditor allows users to export and print documents, facilitating sharing of work with colleagues or saving them in a convenient format. Documents can be exported in formats such as PDF, DOCX, PNG, TIFF, and more.

Interface and Usage

TechEditor provides a comprehensive solution for documentation development, and it's important to consider its interface in relation to different document types.

The text editor in TechEditor is similar to popular programs like MS Word or Google Docs, while the calculations in diagrams resemble those in Mathcad. Users familiar with office suites such as MS Office, Open Office, or Google, as well as mathematical packages like Mathcad or SMath, will find many familiar features when transitioning to TechEditor. With an intuitive interface, users can format their documentation in a style they are accustomed to.

Document Types

TechEditor offers various document types to work with, including reports, diagrams, math sheets, and apps.

• Reports: TechEditor allows users to create technical reports, scientific articles, presentations, and other documents. The program provides advanced tools for text formatting, inserting charts, tables, and illustrations, enabling users to create professionally designed documents.
• Diagrams: TechEditor includes built-in tools for creating different types of diagrams, such as graphs, schemes, flowcharts, and flow diagrams. Users can easily create, edit, and customize diagrams without the need for separate software.
• Mathsheets: TechEditor integrates a mathematical system that enables users to perform complex mathematical calculations. The program supports various mathematical functions, symbolic calculations, numerical methods, and other mathematical operations. A math sheet is a text document where users can organize their mathematical calculations. If the automatic calculation option is enabled, the calculation results are displayed alongside the input expressions.
• Apps: One of TechEditor's key features is the ability to develop specialized applications to extend the program's functionality. Users can create their own extensions, apps, or plugins to tailor the program to their specific needs.

Interface Elements

The main interface elements of TechEditor include the Quick Access Toolbar, the Ribbon, the Project Explorer, the Workspace, the Message Bar, and the Status Bar.

• Quick Access Toolbar contains commonly used commands and components for accessing help information.
• Ribbon is the main component for managing TechEditor and contains commands for working with individual sections and the environment itself.
• Project Explorer helps display the project structure and includes commands for managing sections.
• Workspace is the primary area for working on the project, where users can perform calculations and format documents.
• Notification Bar displays system messages and provides information about the environment's operation.
• Status Bar shows extended tooltips and view control elements.

Interaction with Other Programs

(to-do)

Distribution Terms

(to-do)

System Requirements

To ensure effective performance with TechEditor, it is recommended to have the following technical specifications for your workstation:

• Operating System: Windows x86 or x64
• Processor: Intel Core i5 or equivalent
• RAM: 4 GB or more
• Graphics Card: Support for OpenGL 3.3 or higher
• Free Disk Space: At least 500 MB

Software Support and Development

TechEditor has been regularly updated since its initial release in 2019. Major versions are typically released once a year, while minor versions are released multiple times per quarter, often measured in weeks. Each new version of TechEditor brings improvements in functionality, bug fixes, and localization updates.

Minor versions may include interface updates or changes in the operation of specific program tools. Major versions, referred to as generations of TechEditor, represent significant changes and overall program development. According to the documentation, TechEditor has already progressed through three generations:

• TechEditor 0: Pilot version with a basic text editor and a Pascal Script engine for computational programming.
• TechEditor 1: Feature-rich WYSIWYG text editor, introduction of a new commercial script engine with Unicode support, and Pascal/Basic programming languages.
• TechEditor 2: Addition of mathematical objects to reports and diagrams, enabling mathematical computations directly within the document without programming.
• TechEditor 3: Redesigned interface, inclusion of separate mathematical sheets, transition to a single .tec file format, improved performance speed, and automation for drawing, among other enhancements.

Dystlab plans to release TechEditor 4 in 2023. This version is expected to feature multi-level design modules in the form of custom diagrams, support for the Python programming language, and an engine based on the finite element method. For further information on program updates or to report any issues, users can directly contact the developers.