Справочное руководство
Введение
Спецификация выполнена в виде текстового документа и оформлена согласно
требованиям ЕСКД.
Документ построен таким образом, чтобы максимально упростить процесс заполнения
спецификации и основной надписи:
-
документ содержит макросы, позволяющие автоматически построить спецификацию и заполнить основную надпись (информация об элементах схемы и содержимое основной надписи извлекается из списка цепей проекта KiCad);
-
имеется возможность обновить раздел Прочие изделия не затрагивая содержимое других разделов;
-
имеется возможность добавить/удалить лист регистрации изменений;
-
автоматически подстраивается высота строк таблицы спецификации;
-
автоматически подстраивается масштаб текста по ширине графы спецификации или основной надписи;
-
стили элементов документа имеют древовидную структуру, что позволяет изменять форматирование сразу группы однотипных элементов.
-
графы таблицы имеют собственные автообновляемые стили, что позволяет применять форматирование ко всей графе сразу;
-
в документ встроены необходимые шрифты.
Чтобы получить спецификацию для проекта KiCad нужно пройти следующие шаги:
1) заполнить поля компонентов схемы должным образом и обновить список цепей;
2) на основе шаблона документа создать новую спецификацию и сохранить её в
каталоге проекта KiCad;
3) настроить параметры формирования спецификации;
4) запустить макрос построения спецификации;
5) запустить макрос заполнения основной надписи;
6) при необходимости, поправить форматирование и содержимое спецификации.
Поля компонентов схемы
При формировании спецификации для неподготовленного проекта KiCad будут использованы только два стандартных поля компонентов:
- Обозначение
-
помещается в графу Примечание
- Значение
-
помещается в графу Наименование
!
|
Если поле компонента, соответствующее параметру Поля→Наименование, пусто или отсутствует, то вместо него используется поле Значение. |
Для получения полноценной спецификации, компонентам схемы следует добавить несколько пользовательских полей. Количество дополнительных полей и их содержимое зависит от типа компонента и от данных, которые должны быть отображены в спецификации. По умолчанию макросами используются следующие поля компонентов:
- Обозначение
-
стандартное поле компонента, помещается в графу Примечание.
- Тип
-
пользовательское поле, в котором хранится описание типа компонента, например, Резистор {Резисторы}. Значение этого поля указывается в графе Наименование и выступает в виде заголовка однотипных компонентов.
В зависимости от параметров построения спецификации, тип компонента может указываться как в единственном, так и в множественном числе, поэтому формат поля Тип имеет сложный вид:
Тип в единственном числе {Тип в множественном числе}
Сначала указывается форма в единственном числе, за которой через пробел и в фигурных скобках следует форма в множественном числе. Если содержимое не соответствует описанному формату, то оно будет использовано полностью, как в единственной, так и в множественной формах. Но при активном режиме совместимости с kicadbom2spec, будет предпринята попытка найти формы единственного и множественного числа в словаре групп из конфигурационного файла приложения kicadbom2spec. - Наименование
-
пользовательское поле, в котором содержится полное наименование компонента. Содержимое этого поля помещается в графу Наименование. Если поле пусто или отсутствует, то вместо него используется стандартное поле Значение.
- Документ
-
пользовательское поле, в котором указывается ГОСТ, ТУ или другой документ, относящийся к компоненту. Так как в зависимости от параметров построения спецификации Документ может указываться как после Наименования компонента, так и в заголовке после Типа, то это значение хранится в отдельном поле.
- Примечание
-
пользовательское поле, содержимое которого помещается в одноимённую графу спецификации после перечня обозначений компонентов.
- Исключить
-
пользовательское поле. Если поле с указанным именем содержится в компоненте, то такой компонент будет исключён из спецификации. Значение самого поля не используется.
Предложенные наименования полей можно изменить на вкладке Поля диалогового окна параметров макросов.
Значение поля компонента может включать содержимое других полей этого же компонента. Это реализуется с помощью Шаблонов — текстовых конструкций, которые обрабатываются особым образом.
Шаблоны
Шаблоном называется строка текста, содержащая как минимум одну конструкцию следующего вида:
${поле}
или
${префикс|поле|суффикс}
- префикс
-
символы между
{
и|
будут добавлены к значению поля в виде префикса - поле
-
наименование поля, значение которого должно быть подставлено вместо конструкции
${}
- суффикс
-
символы между
|
и}
будут добавлены к значению поля в виде суффикса
Внутри конструкции ${}
символы {
, |
и }
нужно экранировать с помощью
обратной косой черты: \{
, \|
или \}
. За пределами конструкции ${}
экранирование не требуется. Например, в шаблоне
| ${\{|Посад.место|\}} |
вертикальная черта в начале и конце строки экранирования не требует, так как
находится за пределами конструкции ${}
, а вот фигурные скобки в качестве
префикса и суффикса нужно экранировать.
Шаблон может содержать несколько конструкций вида ${}
.
Если указанное поле пусто или отсутствует, то конструкция ${}
просто
удаляется из текста.
Поле, указанное в конструкции ${}
, тоже может содержать шаблон. Но эти
шаблоны не должны ссылаться друг на друга, иначе возникнет рекурсивное
зацикливание.
Доступ к стандартным полям производится с помощью следующих имён:
-
Обозначение
-
Значение
-
Посад.место
-
Документация
Шаблоны в стандартных полях тоже обрабатываются.
Рассмотрим пример шаблона для поля Наименование резистора:
МЛТ-0,5-${Значение}${-|Класс точности|}-В
Здесь имеются две конструкции ${}
, т.е. будут подставлены значения двух
полей Значение и Класс точности. Значение не имеет ни префикса, ни
суффикса, а к классу точности будет добавлен префикс -
.
Предположим, сопротивление резистора равно 4,7кОм
, а класс точности ±5%
,
тогда шаблон будет преобразован в строку следующего вида:
МЛТ-0,5-4,7кОм-±5%-В
Если класс точности не указан или такое поле отсутствует в компоненте, то строка будет следующей:
МЛТ-0,5-4,7кОм-В
т.е. класс точности и его префикс отсутствует в итоговом значении.
Параметры
- Оптимальный вид документа
-
Если отмечено, то при открытии документа параметры отображения будут настроены для обеспечения наилучшего вида содержимого:
-
Границы текста — скрыть
-
Границы таблиц — скрыть
-
Затенение полей — отключить
-
Скрытые абзацы — скрыть
-
Подробные всплывающие подсказки — включить
-
Панель инструментов — расположить под стандартными
-
Спецификация
- Файл с данными о схеме
-
Источником данных о схеме является файл списка цепей KiCad.
Если файл не указан, то при запуске макросаПостроить специф.
илиЗаполнить осн. надпись
будет предпринята попытка найти файл списка цепей по имени файла проекта (ищется файл *.pro, заменяется расширение pro на net и проверяется наличие файла с полученным именем и расширением). Если файл списка цепей найти не удастся, будет показан диалог выбора файла.
Поддерживаются файлы с расширением:-
*.net — формат Pcbnew
Eeschema → Экспорт → Экспорт списка цепей…
-
*.xml — вспомогательный
Eeschema → Инструменты → Сформировать перечень элементов…
-
!
|
Вспомогательный файл списка цепей создаётся перед формированием перечня элементов средствами Eeschema и остаётся в каталоге проекта как побочный. В *.net-файле и *.xml-файле содержатся одни и те же данные, только в разных форматах. |
- Количество пустых строк между компонентами разного типа
-
Указанное количество пустых строк будет вставлено между компонентами различного типа в разделе Прочие изделия.
- Минимально допустимый масштаб по ширине (%)
-
Если текст не помещается в графе таблицы, то уменьшается масштаб символов по ширине. Когда масштаб становится меньше указанного значения, текст разбивается на части и размещается на последующих строках.
- Разделитель диапазона обозначений
-
Параметр позволяет выбрать один из двух возможных разделителей для диапазона обозначений компонентов:
-
дефис
-
-
многоточие
…
-
- Добавить единицы измерения
-
Если для резисторов, конденсаторов или индуктивностей указаны только значения и данная опция включена, то к значениям будут добавлены соответствующие единицы измерения (Ом, Ф, Гн). При этом, множители приводятся к общему виду:
На схеме | В спецификации |
---|---|
Конденсаторы |
|
1.2 |
1,2мкФ |
1200 |
1200пФ |
1н2 |
1,2нФ |
12 μF |
12мкФ |
120u |
120мкФ |
Резисторы |
|
4.7 |
4,7Ом |
4R7 |
4,7Ом |
R47 |
0,47Ом |
470 |
470Ом |
4,7k |
4,7кОм |
4.7 kOhm |
4,7кОм |
4,7 kΩ |
4,7кОм |
4M7 |
4,7МОм |
Дроссели |
|
910 |
910мкГн |
910u |
910мкГн |
910мк |
910мкГн |
9m1 |
9,1мГн |
910 uH |
910мкГн |
- Вставить пробел перед единицами измерения
-
Если отмечено, то между цифровой частью значения и единицами измерения (включая множитель) будет вставлен пробел.
- Формировать отдельную группу для каждого документа
-
По умолчанию, группы компонентов формируются по их типу, например: Резисторы, Конденсаторы и т.д.
Если отмечено, то группы компонентов будут разбиваться ещё и по документу, например: Резисторы ГОСТ…, Резисторы ТУ… и т.д. - Указать документ в заголовке группы
-
По умолчанию, в качестве заголовка группы компонентов выступает Тип в множественном числе.
Если отмечено, то в заголовке, после Типа, будет указан Документ (ГОСТ, ТУ, …). Если в группе компоненты имеют разные документы, то перед каждым документом в заголовке будет указана часть наименования, необходимая для идентификации соответствующих компонентов. - Формировать заголовок для каждой группы
-
По умолчанию, заголовок формируется только если группа содержит более чем один компонент.
Если же группа состоит из одного компонента, заголовок не формируется, а Тип, в единственном числе, указывается перед Наименованием. Если отмечено, то заголовок будет сформирован для каждой группы, даже если она состоит из одного компонента. - Резервировать номера позиций
-
По умолчанию, позиции в спецификации увеличиваются на единицу.
Если отмечено, то для пустых строк, вставляемых между группами компонентов, будут зарезервированы номера позиций. - Добавить пустую строку после заголовка группы
-
Если отмечено, то между заголовком и первым компонентом группы будет вставлена одна пустая строка.
- Добавить лист регистрации изменений, если количество листов больше …
-
Если отмечено и при автоматическом построения таблицы количество листов документа превысит указанное число, то в конец документа будет добавлен лист регистрации изменений.
- Запретить заголовки групп внизу страницы
-
Если отмечено, то заголовки групп, находящиеся внизу страницы без единого элемента, будут перемещены на следующую страницу.
- Запретить пустые строки вверху страницы
-
Если отмечено, то пустые строки вверху страницы будут удалены.
Разделы
- Документация
-
Если отмечено, то при формировании спецификации будет создан раздел Документация.
- Сборочный чертёж
-
Если отмечено, то при формировании спецификации в разделе Документация будет указан сборочный чертёж.
- Схема электрическая принципиальная
-
Если отмечено, то при формировании спецификации в разделе Документация будет указана принципиальная схема.
Если имя файла схемы совпадает с именем файла списка цепей (отличаются только расширением), то формат страницы и децимальный номер будут изъяты из файла схемы и помещены в графы Формат и Обозначение соответственно.
- Перечень элементов
-
Если отмечено, то при формировании спецификации в разделе Документация будет указан перечень элементов.
Для перечня элементов всегда указывается формат А4.
В графе Обозначение указывается децимальный номер схемы с добавлением буквы
П
перед кодом документа.
- Сборочные единицы
-
Если отмечено, то при формировании спецификации будет создан раздел Сборочные единицы.
- Детали
-
Если отмечено, то при формировании спецификации будет создан раздел Детали.
- Плата печатная
-
Если отмечено, то при формировании спецификации в разделе Детали будет указана печатная плата.
Если имя файла платы совпадает с именем файла списка цепей (отличаются только расширением), то формат страницы и децимальный номер будут изъяты из файла платы и помещены в графы Формат и Обозначение соответственно.
- Стандартные изделия
-
Если отмечено, то при формировании спецификации будет создан раздел Стандартные изделия.
- Прочие изделия
-
Если отмечено, то при формировании спецификации будет создан раздел Прочие изделия.
- Материалы
-
Если отмечено, то при формировании спецификации будет создан раздел Материалы.
Поля
- Тип
-
Значение поля с указанным именем будет использовано для обозначения типа компонента, например, Резистор {Резисторы}.
- Наименование
-
Значение поля с указанным именем будет помещено в графу Наименование.
- Документ
-
Значение поля с указанным именем будет добавлено к Наименованию, указывая на ГОСТ, ТУ или прочий документ.
- Примечание
-
Значение поля с указанным именем будет помещено в графу Примечание.
В обозначенных выше полях допускается использование шаблонов. Благодаря этому можно комбинировать значения нескольких полей.
Если значение, указанное в поле параметра, не содержит конструкций ${}
, то
оно воспринимается как наименование поля и в спецификации будет использовано
значение данного поля.
Если же в значении параметра имеется хотя бы одна конструкция ${}
, то такое
значение будет обработано как шаблон и в спецификацию попадёт преобразованный
текст с подставленными значениями указанных полей.
Примечание: если значение для поля Тип указано в виде шаблона, то к
единственному/множественному числу будет приведено каждое значение из указанных
полей. Если содержимое поля не соответствует формату тип в единственном числе
{тип в множественном числе}
, то это содержимое будет использоваться полностью
как в единственном, так и в множественном числе.
Для примера можно рассмотреть Наименование в режиме совместимости с kicadbom2spec:
${|Марка|-}${Значение}${-|Класс точности|}${-|Тип|}
Здесь наименование состоит из нескольких частей, каждая из которых храниться в отдельном поле компонента.
Примечание: при нажатии кнопки Установить значения, совместимые с
kicadbom2spec
шаблон Наименования будет построен с учётом разделителей,
указанных в конфигурационном файле приложения kicadbom2spec (если он
существует).
Обратите внимание, значения:
Наименование
и
${Наименование}
в итоге дадут одинаковый результат — значение поля с именем Наименование. Но обработаны они будут по разному, в первом случае — значение воспринимается как название поля, а во втором — как шаблон.
- Исключить
-
Если компонент содержит поле с указанным именем, то он будет исключён из спецификации.
- Установить значения по умолчанию
-
Установить параметрам полей значения по умолчанию.
- Установить значения, совместимые с kicadbom2spec
-
Настроить параметры полей так, чтобы обеспечить формирование спецификации для проектов, оформленных с помощью приложения kicadbom2spec.
- Режим совместимости с kicadbom2spec
-
Если отмечено, то при формировании спецификации из файла настроек приложения kicadbom2spec будут использованы данные о разделителях и словарь наименований групп.
Основная надпись
- Преобразовать наименование документа
-
Если отмечено, тип схемы в наименовании документа будет удалён.
В противном случае, наименование останется без изменений. - Преобразовать обозначение документа
-
Если отмечено, тип схемы в обозначении документа будет удалён.
В противном случае, обозначение останется без изменений. - Автоматически заполнить графу Перв. примен.
-
Если отмечено, в графу первичной применяемости будет записано обозначение документа без кода документа.
В противном случае, графа останется без изменений.
Панель инструментов
- Построить специф.
-
запустить макрос построения спецификации. Содержимое таблицы будет перезаписано.
- Очистить специф.
-
запустить макрос очистки спецификации. Таблица будет удалена и построена заново.
- Обновить "Прочие изделия"
-
запустить макрос обновления раздела Прочие изделия. Раздел Прочие изделия будет полностью удалён и построен заново. Содержимое других разделов не затрагивается.
- Заполнить осн. надпись
-
запустить макрос заполнения основной надписи. Данные для заполнения будут взяты из файла списка цепей.
- Очистить осн. надпись
-
запустить макрос очистки основной надписи. Содержимое граф основной надписи и форматной рамки будет удалено, а форматирование установлено к значениям по умолчанию.
Графы Лист и Листов данным макросом не затрагиваются.
- Добавить/удалить лист рег. изм.
-
запустить макрос создания/удаления листа регистрации изменений.
Если лист регистрации изменений отсутствует в документе, то он будет создан в виде последней страницы и отделён от таблицы спецификации разрывом страниц.
В противном случае — лист регистрации изменений будет удалён из документа.
- Параметры
-
показать диалоговое окно для ввода параметров формирования спецификации.
- Справка
-
открыть справочное руководство в вэб-браузере.
Оформление документа
Стили страниц
Внешний вид первого листа можно изменить путём выбора стиля страницы.
В документе для этого имеется четыре специальных стиля:
-
Первый лист 1 — первый лист без дополнительных граф
-
Первый лист 2 — первый лист с дополнительными графами Справ. № и Перв. примен.
-
Первый лист 3 — первый лист с дополнительными графами заказчика
-
Первый лист 4 — первый лист со всеми дополнительными графами
Чтобы применить нужный стиль, нужно выполнить команду меню
Стили → Управление стилями (F11)
, выбрать Стили страниц
и двойным
щелчком левой кнопки мыши установить один из выше перечисленных стилей. При
смене стиля форматной рамки с заполненной основной надписью — данные
сохраняются.
Для второго и последующих листов всегда используется стиль Последующие листы.
Во всех перечисленных стилях страниц, в качестве форматной рамки выступает фоновое изображение.
Основная надпись и графы форматной рамки
Графы основной надписи и форматной рамки построены из врезок. Заголовки граф защищены от перемещения, изменения размера и редактирования. Графы, предназначенные для ввода текста, защищены только от перемещения и изменения размера. Не все графы форматной рамки имеют врезки для ввода текста. Например, графа Подп. основной надписи врезок для ввода текста не имеет.
Все врезки основной надписи и форматной рамки принадлежат нижнему колонтитулу и хранятся в стиле страницы. Каждый стиль первого листа имеет свой собственный набор врезок. При внесении изменений в графу основной надписи или форматной рамки, соответствующие врезки остальных стилей синхронизируются посредством макросов. Это позволяет изменять вид первого листа без потери данных.
Структура стиля второго и последующих листов аналогична. Но здесь все графы защищены от записи. Их значения синхронизируются с соответствующими врезками первого листа с помощью макросов.
Номера и количество страниц подставляются автоматически средствами LibreOffice (используются поля). Если в документе лишь одна страница, то графа Листов, основной надписи первого листа, остаётся пустой. Это реализовано на основе скрытого абзаца с условием.
Автоматический подбор масштаба шрифта по ширине работает как при заполнении
основной надписи с помощью команды Заполнить осн. надпись
, так и при вводе
текста вручную. Текст обрабатывается построчно.
Таблица спецификации
Спецификация представляет собой таблицу, которая занимает всю ширину документа. Количество строк таблицы зависит от количества элементов схемы. Если таблица не помещается на странице, то создаётся новый лист и она продолжается на новой странице. Заголовок таблицы повторяется на каждом листе. Это обеспечивается средствами LibreOffice.
С помощью макросов высота строк регулируется таким образом, чтобы нижняя линия обрамления последней строки на странице совпадала с верхней линией основной надписи.
В каждой графе таблицы используется отдельный стиль абзаца, соответствующий наименованию графы. Кроме того, для графы Наименование создано несколько стилей абзацев: Наименование, Наименование (заголовок группы) и Наименование (заголовок раздела). Это сделано для того, чтобы можно было задать форматирование заголовков отличное от остального содержимого.
Стили абзацев таблицы являются автообновляемыми. То есть, при изменении форматирования одной ячейки, автоматически изменяется форматирование остальных ячеек этой графы. Например, по умолчанию в графе Примечание текст выровнен по левому краю. Если установить курсор в одну из ячеек этой графы (любую) и задать выравнивание по центру, то все позиционные обозначения станут выровненными по центру.
Не все команды форматирования применяются к целому абзацу. К примеру,
подчёркивание применяется к символам. Чтобы подобные изменения были
автоматически отражены на остальных ячейках с таким же стелем, нужно применить
форматирование ко всему содержимому ячейки.
По умолчанию, наименование группы элементов (заголовок) имеет обычное
начертание. Чтобы сделать его подчёркнутым, нужно установить курсор в ячейку с
любым заголовком, выделить всё содержимое ячейки с помощью мыши или нажатием
комбинации клавиш Ctrl+A
и выполнить команду меню Формат → Текст →
Подчёркнутый (Ctrl+U)
. Заголовки всех групп элементов станут подчёркнутыми.
!
|
Открытый формат документов для офисных приложений (ODF) имеет несколько особенностей о которых стоит упомянуть. После таблицы обязательно должен быть как минимум один абзац. То есть, документ
не может заканчиваться таблицей. Ещё одна особенность была выявлена при создании шаблона. Если таблица находится
в самом начале документа и в ячейках используются автообновляемые стили
абзацев, то при первом же редактировании таких ячеек, стиль страницы
сбрасывается на стиль по умолчанию. |
Начертание текста
Графы таблицы спецификации и графы форматной рамки имеют собственные стили абзацев. Но все они происходят от одного общего стиля — Текст и наследуют его свойства.
Чтобы изменить начертание текста во всём документе необходимо открыть окно
управления стилями, выполнив команду меню Стили → Управление стилями (F11)
,
и нажать кнопку Стили абзацев
. В списке стилей нажать правой кнопкой мыши на
пункте Текст и в контекстном меню выбрать команду Изменить…
. В
открывшемся диалоговом окне, на вкладке Шрифт, можно установить необходимое
начертание текста в поле Стиль. Обычный стиль соответствует прямому
начертанию, а Курсив — наклонному. После применения изменений все надписи в
документе будут отображаться с указанным начертанием.
Размер шрифта таблицы
По умолчанию, размер шрифта заголовка и содержимого таблицы спецификации
составляет 16 пунктов.
При желании, размер шрифта содержимого таблицы можно изменить, например,
уменьшить до 14 пунктов. Для этого нужно открыть окно управления стилями,
выполнив команду меню Стили → Управление стилями (F11)
, и нажать кнопку
Стили абзацев
. В списке стилей нажать правой кнопкой мыши на пункте Значение
графы таблицы и в контекстном меню выбрать команду Изменить…
. В
открывшемся диалоговом окне, на вкладке Шрифт, можно установить желаемый
размер шрифта в поле Кегль.
Автоматическая подстройка ширины текста будет нормально работать с новым размером шрифта при вводе новых данных. Но если спецификация была построена до изменения размера шрифта, потребуется сформировать спецификацию заново, чтобы макрос автоматически подобрал масштаб шрифта по ширине, а при необходимости разбил содержимое на несколько строк.
Номера позиций
Номера позиций в спецификации выполнены с помощью полей. Значение поля
формируется с применением переменной Позиция. По умолчанию поле позиции имеет
значение Позиция+1
, то есть номер позиции увеличивается на единицу по
отношению к предыдущей. Если установлен параметр Резервировать номера
позиций, то позиция после нескольких пустых строк будет увеличена не на
единицу, на количество пустых строк плюс 1.
Чтобы исправить номер позиции нужно дважды щёлкнуть левой кнопки мыши по нему и в открывшемся диалоговом окне поправить инкремент в поле Значение.