10.14489/vkit.2024.11.pp.035-045

DOI: 10.14489/vkit.2024.11.pp.035-045

Polishchuk Yu. V., Goncharova Ya. V.
THE METHOD FOR SYNTHESIS OF MULTI-VARIANT DOCUMENTS USING LUALATEX
(с. 35-45)

Аннотация. При разработке документации может возникать ситуация, когда документация имеет несколько вариантов представления. В этом случае ее контент формируется из двух видов фрагментов: общих, присутствующих во всех вариантах документации, и вариативных, включенных только в варианты документации, для которых он предназначен. Разработка и модернизация такой документации без применения специализированных инструментов – трудоемкий процесс, который может сопровождаться появлением ошибок, обусловленных необходимостью внесения корректировок во все дублированные фрагменты контента документации. В рамках данного исследования сформулировано определение «мультивариантный документ», предложена его формальная модель и алгоритм синтеза в LuaLaTeX, которые стали основой для разработанного прототипа системы реализации автоматизированного синтеза мультивариантных документов в LuaLaTeX. Практическая значимость полученного решения состоит в возможности формирования улучшенной документации, которая не содержит избыточной информации, а также в минимизации вероятности появления ошибок, вызванных ее модификациями.

Ключевые слова: документация; мультивариантный документ; публикация из единого источника; LuaLaTeX.

Полищук Ю. В., Гончарова Я. В.
СПОСОБ СИНТЕЗА МУЛЬТИВАРИАНТНЫХ ДОКУМЕНТОВ С ПРИМЕНЕНИЕМ LUALATEX
(pp. 35-45)

Abstract. When developing documentation, a situation may arise when the documentation has several options for its presentation. In this case, its content is formed from two types of fragments: general  present in all documentation options and variable  included only in the documentation options for which it is intended. Development and modernization of such documentation without the use of specialized tools is a laborintensive process, which may be accompanied by errors due to the need to make adjustments to all duplicate fragments of documentation content. The work is devoted to the development of documentation that has several options for its presentation, and its modification. As part of the study, the definition of “multivariant document” was formulated, its formal model and synthesis algorithm in LuaLaTeX were proposed, which became the basis for the developed prototype system for implementing the automated synthesis of multivariant documents in LuaLaTeX. In the framework of the current work, by “multivariant document” we will understand a document that has many options for its presentation, differing from each other in the composition of the fragments that form their content. To achieve the goal of the work, the following were used: graph theory to develop a formal model of a multivariate document, desktop publishing system LuaLaTeX to format documentation content, and the Lua scripting language to implement the possibility of reusing content fragments. The practical significance of the solution obtained in the work is the possibility of generating improved documentation that does not contain redundant information, as well as minimizing the likelihood of errors caused by its modifications. As a demonstration example, the synthesis of a multivariate document is considered using the example of the “Maintenance” section from the passenger car operating manual. Analysis of the results of testing the proposed method demonstrated that the generation of separate operating manuals minimizes the volume of their content and reduces the number of pages in the documentation, which increases the ease of use by the user and minimizes the cost of its production. Thus, for the practical example considered, the content of the documentation was minimized by more than 20 %, which contributed to a reduction in the volume of its publication by 25 %.

Keywords: Documentation; Multivariate document; Single source publishing; LuaLaTeX.

+ - Информация об авторах (About the Authors) Click to collapse

Рус

Ю. В. Полищук, Я. В. Гончарова (Московский технический университет связи и информатики, Москва, Россия) E-mail: Этот e-mail адрес защищен от спам-ботов, для его просмотра у Вас должен быть включен Javascript

Eng

Yu. V. Polishchuk, Ya. V. Goncharova (Moscow technical university of communications and Informatics, Moscow, Russia) E-mail: Этот e-mail адрес защищен от спам-ботов, для его просмотра у Вас должен быть включен Javascript

+ - Библиографический список (References) Click to collapse

Рус

1. Дмитриев П. И. Автоматизация процесса формирования комплектов технической документации на основе онтологического подхода // Информация и космос. 2011. № 1. С. 90–93.
2. Полищук Ю. В., Черных Т. А. О способах реализации концепции единого источника // Информационные технологии. 2014. № 7. С. 37–41.
3. Полищук Ю. В., Черных Т. А. Моделирование документов средствами Adobe FrameMaker // Вестник компьютерных и информационных технологий. 2011. № 5. С. 35–40.
4. Колобова Е. А., Чигирева И. В., Шигина Н. А. Экспериментальные исследования в области создания автоматизированной информационной системы для управления компонентами учебно-методического комплекса дисциплины // Вестник НГУЭУ. 2019. № 2. С. 212–225. DOI: 10.34020/2073-6495-2019-2-212-225
5. Брезгин Р. В., Самуйлова В. С., Сергеев М. В. Обзор спецификации DITA как средства разработки текстовой конструкторской документации для изделий приборостроения // Системы управления и обработки информации. 2020. № 4(51). С. 61–65.
6. Миндалев И. В. Разработка ЭУМК с помощью Docbook // Естественные и математические науки в современном мире. 2016. № 39. С. 73–78.
7. Ozerova M. I., Zhigalov I. E., Vershinin V. V. Comparison of Document Generation Algorithms Using the Docs-as-Code Approach and Using a Text Editor // Advances in Intelligent Systems and Computing. 2020. Т. 1294. С. 315–326. DOI: 10.1007/978-3-030-63322-6_25
8. Скорнякова Р. Ю. Методы и инструменты, используемые при подготовке публикаций научных статей в формате HTML // Электронные библиотеки. 2023. Т. 26. № 2. С. 252–302. DOI: 10.26907/1562-5419-2023-26-2-252-302
9. Львовский С. М. Набор и верстка в системе LATEX. 3-е изд., испр. и доп. М.: МЦНМО, 2003. 448 с.
10. Романовский К. Ю. Метод повторного использования документации семейств программных продуктов: специальность 05.13.11 «Математическое и программное обеспечение вычислительных машин, комплексов и компьютерных сетей»: дис. … кандидата физ.-мат. наук / Романовский Константин Юрьевич; Санкт-Петербургский государственный университет, Санкт-Петербург, 2010. 110 с.
11. Montijano J., Perez M., Rández L., Varona J. L. Numerical methods with LuaLaTeX // TUGboat. 2014. V. 35. № 1. P. 51–56.
12. Herbert V. Using OpenType and TrueType fonts with XeLaTeX and LuaLaTeX // TUGboat. 2022. V. 43. № 3. P. 295–299. DOI: 10.47397/tb/43-3/tb135voss-unifont
13. Свидетельство о государственной регистрации программы для ЭВМ № 2024610486 Российская Федерация. Программа реализации автоматизированного синтеза мультивариантных документов в LuaLaTeX: / Я. В. Гончарова, Ю. В. Полищук; правообладатель Московский технический университет связи и информатики: № 2023689411/69; заявлено 27.12.2023; опубл. 11.01.2024, Бюл № 1. 11 с. Зарегистрировано в Реестре программ для ЭВМ.

Eng

1. Dmitriev P.I. (2011). Automation of the process of generating sets of technical documentation based on the ontological approach. Informatsiya i kosmos, (1), 90 – 93. [in Russian language]
2. Polishchuk Yu.V., Chernyh T. A. (2014). On ways to implement the single source concept. Informatsionnye tekhnologii, (7), 37 – 41. [in Russian language]
3. Polishchuk Yu.V., Chernyh T. A. (2011). Document modeling using Adobe FrameMaker. Vestnik komp'yuternyh i informatsionnyh tekhnologiy, (5), 35 – 40. [in Russian language]
4. Kolobova E. A., Chigireva I. V., Shigina N. A. (2019). Experimental research in the field of creating an automated information system for managing the components of the educational and methodological complex of the discipline. Vestnik NGUEU, (2), 212 – 225. [in Russian language] DOI: 10.34020/2073-6495-2019-2-212-225
5. Brezgin R. V., Samuylova V. S., Sergeev M. V. (2020). Review of the DITA specification as a means of developing text-based design documentation for instrumentation products. Sistemy upravleniya i obrabotki informatsii, 51(4), 61 – 65. [in Russian language]
6. Mindalev I. V. (2016). Development of EUMK using Docbook. Estestvennye i matematicheskie nauki v sovremennom mire, 39, 73–78. [in Russian language]
7. Ozerova M. I., Zhigalov I. E., Vershinin V. V. (2020). Comparison of Document Generation Algorithms Using the Docs-as-Code Approach and Using a Text Editor. Advances in Intelligent Systems and Computing, 1294, 315 – 326. DOI: 10.1007/978-3-030-63322-6_25
8. Skornyakova R. Yu. (2023). Methods and tools used in preparing publications of scientific articles in HTML format. Elektronnye biblioteki, 26(2), 252 – 302. [in Russian language] DOI: 10.26907/1562-5419-2023-26-2-252-302
9. L'vovskiy S. M. (2003). Typesetting and layout in the LATEX system. 3rd ed. Moscow: MTsNMO. [in Russian language]
10. Romanovskiy K. Yu. (2010). A method for reusing documentation within software product families. Saint Petersburg: Sankt-Peterburgskiy gosudarstvenniy universitet. [in Russian language]
11. Montijano J., Perez M., Rández L., Varona J. L. (2014). Numerical methods with LuaLaTeX. TUGboat, 35(1), 51 – 56.
12. Herbert V. (2022). Using OpenType and TrueType fonts with XeLaTeX and LuaLaTeX. TUGboat, 43(3), 295 – 299. DOI: 10.47397/tb/43-3/tb135voss-unifont
13. Goncharova Ya. V., Polishchuk Yu. V. A program for implementing automated synthesis of multivariate documents in LuaLaTeX. Certificate of state registration of a computer program No. 2024610486 Russian Federation. [in Russian language]

+ - Заказать электронную версию статьи (Purchase digital version of a single article) Click to collapse

Рус

Статью можно приобрести в электронном виде (PDF формат).

DOI: 10.14489/vkit.2024.11.pp.035-045

Скопируйте DOI статьи и перейдите по ссылке https://id-spektr.ru/product/pokupka-elektronnoy-stati-iz-zhurnala-vestnik-kompyuternyh-i-informatsionnyh-tehnologiy

В комментарии к заказу обязательно укажите DOI статьи.

Eng

This article is available in electronic format (PDF).

DOI: 10.14489/vkit.2024.11.pp.035-045

Copy the article DOI and follow the link https://id-spektr.ru/product/pokupka-elektronnoy-stati-iz-zhurnala-vestnik-kompyuternyh-i-informatsionnyh-tehnologiy

Please specify the article DOI in the order comments.