Инструкция к чертежу

Большинство чертежей которые мы находим записаны в форме пошаговых инструкций. Это достаточно удобная форма, которая позволяет разобраться как чертеж работает, а так же, например, из нее построить чертеж в Валентине. Но что если вам достался уже готовый чертеж? Нельзя ли как то провести обратную операцию и трансформировать полученный чертеж в удобную текстовую форму для дальнейшего изучения? Мы задались этими вопросами и вот что у нас вышло.
Сам файл чертежа уже сейчас несет очень много информации о деталях построения. Какие точки с чем связаны, формулы длин и углов, как делятся кривые и список можно продолжать. Все это можно использовать для того что бы восстановить чертеж в текстовой форме.

Кому это будет полезно? Главным недостатком существующих инструкций, на наш взгляд, является слабая ориентация на программу. Много нужно переделывать, додумывать и передумывать. Многие аспекты построения рассчитаны на бумагу и достаточно не точные, с геометрической точки зрения.

Инструкции ориентированные на Валентину будут полезны в изучении конструирования и основ программы, а так же в качестве документации к чертежу.

Трудоемкость всего процесса создания значительно снизится, что позволит более легко вносить новые изменения в чертеж и быстро получать обновленную версию инструкции. 

Специально для этой цели мы создали наше приложение Chef. Главной задачей которого является приготовление для вас такой инструкции с "ингредиентов".

Главным ингредиентом здесь выступает файл с расширением .vpr (Valentina pattern recipe). Вы можете получить такой файл для вашего чертежа зайдя в меню История -> Экспортировать рецепт. В полученном вами файле будет хранится вся необходимая информация для создания инструкции. Сам файл является обычным текстовым файлом в формате XML. Любознательные могут открыть его с помощью любого текстового редактора и посмотреть что там внутри.

Давайте же на примере уже готового чертежа рассмотрим процесс и его результаты. Для этого я скачаю уже доступный чертеж timoMaleShirt.zip. В режиме Чертежа зайдя в меню История -> Экспортировать рецепт произведу экспорт рецепта. С помощью нашего приложения Chef произведу генерацию инструкции. С результатами вы можете познакомится если скачаете архив timoMaleShirt_instruction.zip. 

В основе процесса генерации инструкции лежит идея создания файла в одном из языков разметки. В качестве такого был выбран AsciiDoc. Это позволяет не думать о разметке, а переложить это на плечи посредника в лице Asciidoctor. Теоретически это позволяет конвертировать один и тот же исходный текст в разные форматы, например HTML5, DocBook, PDF и другие, а так же вручную дорабатывать за надобностью файлы. Например добавлять картинки, применять свои стили т.д. В архиве с примером вы найдете как файл оригинала, так и сгенерированный на его базе PDF файл.

Сама архитектура приложения позволяет добавлять и другие движки, заточенные под другие форматы разметки. AsciiDoc был выбран в качестве первого поскольку у нас имеется очень удачный опыт его применения для создания Руководства пользователя.

На этом плюсы не заканчиваются. Система позволяет генерировать инструкции на нескольких языках. На данный момент поддерживаются только два: русский и английский. Примеры для сравнения вы сможете найти в том же архиве. Если вы заинтересованы в расширении списка, свяжитесь с нами.

Если вы посмотрите на размер файла, то он "внушает", 27 страниц формата А4. Представьте себе сколько нужно времени потратить на то, что бы создать такие документы. А ведь по сути тогда будет проделана двойная работа. Не быстро, утомительно и не масштабируется.

Если вы опытный пользователь, то найдете стиль документа избыточным. Множество подсказок, длинные фразы. Если сделать лаконично, то можно добиться более компактной формы. Поэтому система позволяет описывать несколько форматов вывода для одного типа разметки. На данный момент поддерживается только литературный. Так же в планах создать компактный и табличный.

Теперь об ограничениях.

Не производится перевод формул. Даже если это технически возможно, такой перевод подвержен ошибкам. Английские варианты имен будут у вас прекрасно работать, а если перевод вам все же нужен, то после введения и сохранения, программа вам сумеет показать переведенную версию. В будущем, когда мы перейдем на один из скриптовых языков программирования, функция перевода будет утрачена, поэтому привыкать нужно уже сейчас.

Пока что невозможно передать логику конструирования наподобие той которую вы можете найти в авторских чертежах из книг. Валентина ничего не знает о логике построения чертежей, где линия талии или линия плеча. По этому используется более геометрический язык.

В будущем можно расширить Валентину большим количеством полей для информации. Например комментариев к инструментам.

В текущей версии не выводится информация о деталях, а так же финальных измерениях.

Не решена проблема с картинками. Теоретически возможно добавлять технический рисунок, изображение готового изделия, а так же изображения деталей.

Так же возможна функция сокрытия чувствительной информации, например некоторых или всех формул, оставив только значения.

Мы не планируем публиковать данное приложение. По этому оно не будет доступно для скачивания. Генератор планируется использовать в коммерческих целях. Если вам интересна тема генерации инструкций по ваших чертежам, вы можете заказать создание инструкции у нас. Мы открыты для предложений.