# Спецификация XML-формата табличного документа (SpreadsheetDocument) Формат файла `Template.xml` для макетов типа `SpreadsheetDocument` (табличный документ / MXL). ## Namespace ```xml ``` ## Структура документа Элементы внутри `` идут в фиксированном порядке: ``` — языковые настройки ... — наборы колонок (один или несколько) ... — строки с данными (повторяются) ... — рисунки (опционально, повторяются) true — признак макета — индекс формата по умолчанию — общее количество строк — видимых строк (обычно = height) ... — объединения ячеек (повторяются) ... — отмена объединений (опционально) ... — именованные области (повторяются) ... — стили линий (повторяются) ... — шрифты (опционально, повторяются) ... — форматы (повторяются) ... — ресурсы картинок (опционально) ``` ## Индексация Все палитры (линии, шрифты, форматы) — **плоские массивы**, на элементы которых ссылаются по индексу. | Палитра | Индексация | Индекс 0 означает | |-----------|------------|--------------------------------------| | `` | 0-based | Первый элемент `` | | `` | 0-based | Первый элемент `` | | ``| **1-based**| 0 = «формат по умолчанию» (не задан) | Формат с индексом N — это N-й элемент `` в документе (считая от 1). ## Языковые настройки ```xml ru ru ru Русский Русский ``` Языков бывает несколько, и объявленный набор НЕ выводится из того, на каких языках лежит текст ячеек: на корпусе ERP объявлен один `ru` у 10 753 макетов, при том что текст в них лежит и под `ru`, и под `en`. Наборы: `[ru]` — 10 753, `[ru,en]` — 148, `[en,ru]` — 20. `id` и `code` всегда со значением; `description` бывает пустым и тогда пишется самозакрывающимся тегом `` (77 записей из 11 094). Из `id` эти поля не выводятся: у `en` описание бывает «Английский», пустым и «English». `currentLanguage` иногда отсутствует вовсе (3 макета), иногда указывает на необъявленный язык (8 макетов с `en` при объявленном одном `ru`). `defaultLanguage` во всех четырёх русских типовых равен `ru`, но это свойство конфигурации, а не формата. ## Колонки ### Основной набор ```xml 33 1 1 ... ``` Перечисляются колонки, у которых есть собственный формат. Обычно это ширина (`` в палитре форматов), но формат колонки несёт и оформление: шрифт (3 006 форматов на корпусе), выравнивания, рамки, `hidden`. Два случая, которые легко упустить: - `0` — колонка перечислена, а формата у неё **нет** (ноль здесь не индекс записи). Встречается у 4% макетов; - индекс колонки бывает **больше или равен ``** — платформа описывает колонки за пределами объявленной ширины сетки (25% макетов). ### Дополнительные наборы колонок Некоторые строки документа могут использовать **собственную сетку колонок**, отличную от основной. Каждый дополнительный набор имеет UUID: ```xml f01e015f-de4c-4f97-9fbe-a244c4c30c6c 17 0 12 ... ``` - Первый `` — основной набор (без ``) - Дополнительные наборы — с `` (UUID), могут иметь другое количество и ширину колонок - Строки, merge и namedItem ссылаются на набор через `` Типичное применение: сложные печатные формы (УПД, УКД), где шапка/подвал/табличная часть имеют разную разбивку на колонки. ## Строки и ячейки ### Строка ```xml 3 5 f01e015f-... 5 true ... ``` - `` объединяет подряд идущие **пустые** строки. Одинаковые НЕпустые строки платформа не схлопывает никогда: на корпусе ERP (10 924 макета) схлопнутых непустых нет ни одной, несхлопнутых одинаковых непустых — 98 153; несхлопнутых одинаковых пустых — тоже ни одной - `` привязывает строку к дополнительному набору колонок. Без него — используется основной набор - `` строки несёт не только высоту: в корпусе там `hidden` (17 423 вхождения), `font` (9 216), `backColor`, выравнивания, `protection`, рамки ### Ячейка Ячейки внутри `` — элементы `` (cell group), каждый содержит `` (cell content): ```xml 6 9 Имя Расш ru Итого: ``` **Правила позиционирования ``:** - Если `` указан — ячейка в этой колонке - Если `` не указан — колонка = предыдущая + 1 - Первая ячейка без `` идёт в колонку 0 Платформа пишет `` **только при разрыве последовательности**: у подряд идущей ячейки его нет. На корпусе ERP из 1 212 023 записанных номеров ни один не избыточен (счётчик начинается с −1, поэтому у ячейки в колонке 0 номера тоже нет). У текста ячейки ТРИ состояния, а не два: | запись | смысл | |---|---| | `` отсутствует | текста нет | | `` с элементами | текст по элементу на язык (содержимое бывает пустым) | | `` | тег есть, языков в нём нет | Третье — не редкость: 38 075 ячеек на 1200 макетов, встречается в 57% макетов корпуса. `0` означает, что формата у ячейки **нет вовсе** — это не индекс записи. Так записана ячейка без собственного оформления: 170 710 таких ячеек против 50 635, ссылающихся на формат по умолчанию; `0` встречается в 71% макетов. ### Типы заполнения ячеек Тип заполнения определяется свойством `fillType` в формате ячейки: | fillType | Данные ячейки | Описание | |-------------|-------------------------------|----------------------------------------| | `Parameter` | `Имя` | Значение подставляется программно | | `Template` | `Текст [Параметр]` | Шаблон — `[Имя]` заменяется на значение | | `Text` | `Текст` | Статический текст | | *(нет)* | — | Пустая ячейка или ячейка с форматированием | `` — имя параметра расшифровки (для навигации при клике на ячейку). ## Рисунки ```xml Picture 1 11 3 6 4 33 2 0 4 183 false Proportionally 1 1 ``` Позиция задаётся через начальную/конечную строку и колонку + смещения в пикселях. `pictureIndex` ссылается на ресурс из палитры ``. ## Объединения ячеек ```xml 3 1 1 30 f01e015f-... ``` Размер объединения: `(h + 1)` строк × `(w + 1)` колонок. Если `` не указан — объединение в пределах одной строки. `-1` — объединение действует для всех строк, использующих данный набор колонок (аналог объединения колонок на уровне всего документа). ### Отмена объединений `` отменяет вертикальное объединение для конкретной строки: ```xml 10 7 12 ``` Используется в сложных макетах, когда глобальное объединение колонок (`-1`) нужно разорвать в отдельных строках. ## Именованные области Именованные области — аналог «имён» в табличном документе 1С. Используются для программного вывода секций. Получение области: ```bsl // Горизонтальная область (диапазон строк) Область = Макет.ПолучитьОбласть("Заголовок"); // Пересечение горизонтальной и вертикальной областей Область = Макет.ПолучитьОбласть("ВысотаЭтикетки|ШиринаЭтикетки"); ``` Пересечение через `|` типично для этикеток и ценников, где нужна область фиксированного размера (высота × ширина). ### Тип Rows — горизонтальная область ```xml Заголовок Rows 1 4 -1 -1 ``` **Порядок элементов `namedItem` — по имени.** Платформа хранит их отсортированными, регистронезависимо: на выборке 541 макета ERP 8.3.24 с несколькими именованными элементами иного порядка не встретилось ни разу. Сортировка ординальная (латиница раньше кириллицы); случай с «ё» в выборке не встретился и не проверен. ### Тип Columns — вертикальная область ```xml ШиринаЭтикетки Columns -1 -1 1 5 ``` ### Тип Rectangle — прямоугольная область Область, ограниченная и по строкам, и по колонкам. Используется с дополнительными наборами колонок: ```xml ОбластьЗаписьДо Rectangle 22 22 5 17 c6cb0794-... ``` ### Привязка к набору колонок Именованные области могут ссылаться на дополнительный набор колонок через ``: ```xml НумерацияЛистов Rows 59 59 -1 -1 0adf41ed-... ``` ### Тип Drawing — именованный рисунок ```xml Штрихкод 1 ``` ## Стили линий Палитра линий для границ ячеек и рисунков. Индексация 0-based. ```xml Solid None ``` | xsi:type | Значения | |-------------------------------------------|----------| | `v8ui:SpreadsheetDocumentCellLineType` | `Solid`, `None`, `Dotted`, `ThinDashed`, `LargeDashed`, `ThickDashed`, `Double` | | `v8ui:SpreadsheetDocumentDrawingLineType` | те же | Атрибут `width` — толщина линии; в корпусе встречаются 0, 1, 2, 3. Атрибут `gap` на корпусе всегда `false`, но пишется всегда. ## Шрифты Палитра шрифтов. Индексация 0-based. ```xml ``` `kind` выводится из префикса ссылки: `style:` → `StyleItem`, `sys:` → `WindowsFont`. На корпусе ERP таких шрифтов 272 в 213 макетах из 10 924 (StyleItem 209, WindowsFont 63). Шрифт, на который не ссылается ни один формат, в палитру не попадает: у макета без оформления элемента `` нет вовсе. ## Устройство палитр Три правила, общие для всех палитр. Все проверены на корпусе ERP (10 924 макета) и на макетах, собранных вручную в Конфигураторе. **Порядок — документный.** Записи идут в том порядке, в каком встречаются при обходе документа сверху вниз: сначала форматы колонок (в порядке колонок), затем форматы строк и ячеек. Порядок НЕ зависит от того, в какой последовательности автор оформлял макет: контрольный опыт с оформлением снизу вверх дал палитру в порядке строк. **Формат по умолчанию — последняя запись.** На корпусе он последний в 8285 макетах из 10 863, первым — в 25. **Палитра форматов дедуплицирована по содержимому:** двух одинаковых записей в ней нет (10 804 макета из 10 924). Остальные 120 — накопленный мусор редактирования, там доходит до 583 записей при 130 уникальных. ## Форматы Палитра форматов — центральный элемент. **Индексация 1-based** (индекс 0 = формат не задан). ```xml 0 0 1 0 1 24 84 Center Center Wrap Parameter ru ЧЦ=15; ЧДЦ=2 1 ``` Все свойства опциональны. Формат может содержать только `` (для колонки) или только `` (для строки). ### Порядок тегов Внутри `` теги идут в строгой последовательности — от неё зависит побайтовое совпадение с выгрузкой. Порядок снят с корпуса ERP: 766 960 форматов, ни один его не нарушает. ``` print · drawingBorder · drawingHaveLeftBorder · drawingHaveTopBorder · drawingHaveRightBorder · drawingHaveBottomBorder · font · leftBorder · topBorder · rightBorder · bottomBorder · border · height · borderColor · width · autoWidthCalculation · widthWeightFactor · horizontalAlignment · verticalAlignment · textColor · backColor · patternColor · pattern · textPlacement · fillType · protection · hidden · textOrientation · detailsUse · bySelectedColumns · markNegatives · containsValue · valueType · format · controlType · hyperLink · autoMarkIncomplete · indent · autoIndent · editFormat · columnSizeChange · mask · picIndex · pictureSizeMode · picHorizontalAlignment · picVerticalAlignment · textPosition ``` Обрати внимание: `height` идёт РАНЬШЕ `width`, а `format` — после `valueType`. ### Ширина и высота Единица — **1/8 символа**: `72` = стандартные 9 символов, `240` = 30, `80` = 10. ### Рамка Четыре стороны и свёрнутый `` взаимоисключающи. Если все четыре стороны одинаковы, платформа пишет один ``; иначе — по сторонам. На корпусе: 70 265 свёрнутых форматов против 36 783 записанных по сторонам, и среди вторых нет ни одного с четырьмя совпадающими значениями; смешения `border` с посторонними тегами нет ни разу. ### Цвет Значение цвета (`backColor`, `textColor`, `borderColor`, `patternColor`) — строка с **префиксом пространства имён**, а не свободный текст: | Запись в XML | Смысл | |---|---| | `#RRGGBB` | RGB-hex | | `style:ИмяСтиля` | элемент стиля; префикс `style` объявлен в корне документа | | `d3p1:Имя` + `xmlns:d3p1=".../ui/colors/web"` на самом узле | цвет web-палитры | | `d3p1:Имя` + `xmlns:d3p1=".../ui/colors/windows"` на самом узле | системный цвет Windows | Корень `` объявляет только `style`, поэтому для web- и windows-палитр платформа дописывает объявление прямо на узел. Префикс всегда `d3p1` (1264 вхождения на корпусе без отклонений). В Form.xml те же цвета выглядят как `web:Имя` и `win:Имя` — там эти префиксы объявлены в корне. ### Связь формата с контекстом Один формат обслуживает всех: колонка, строка и ячейка ссылаются в одну палитру, и набор свойств у них общий (`hidden` встречается у ячеек 30 175 раз, у строк 17 423, у колонок 57; `protection` — 84 442 / 1 492 / 1 017). | Контекст | Ссылка | Свойства, специфичные для контекста | |------------------|------------------------|-------------------------------------| | Колонка | `` | `width` | | Строка | `` | `height`, `hidden` | | Ячейка | `` | `fillType`, `containsValue` | | Рисунок | `` | `drawingBorder`, `drawing*` | | По умолчанию | `` | `width` | Оформление, применённое к строке целиком, платформа записывает И в формат строки, И в формат каждой ячейки (`backColor`: 13 899 ячеек повторяют против 96). Исключение — `hidden`: оно остаётся только у строки (24 026 против 62 856). **Ловушка: `width` в формате ЯЧЕЙКИ не описывает ячейку.** Ссылка ячейки на запись палитры не обновляется при изменении ширины колонки, поэтому там остаётся ширина от прежнего состояния документа. Проверено на контролируемом стенде: в макете, где ширины колонок поменяли на обратные, ячейки продолжают ссылаться на записи со старыми ширинами. Из итогового XML это значение не выводится — воспроизводить его не нужно. ## Ресурсы картинок ```xml 0 ``` ## Типичная структура макета печатной формы Печатная форма обычно состоит из именованных горизонтальных областей: ``` Заголовок — шапка документа (название, номер, дата) Поставщик — реквизиты поставщика Покупатель — реквизиты покупателя ШапкаТаблицы — заголовок таблицы товаров Строка — строка товара (выводится в цикле) Итого — итоговая строка СуммаПрописью — сумма прописью Подписи — блок подписей ``` Каждая область — диапазон строк, получаемый через `ПолучитьОбласть("Имя")` и выводимый через `Вывести()`. Параметры в ячейках (``) заполняются программно: ```bsl Область = Макет.ПолучитьОбласть("Строка"); Область.Параметры.НомерСтроки = НомерСтроки; Область.Параметры.Товар = СтрокаТЧ.Номенклатура; ТабДок.Вывести(Область); ``` ## Совместимость версий платформы Проведено сравнение выгрузок конфигурации «Бухгалтерия предприятия 3.0» на трёх версиях платформы: 8.3.20, 8.3.24, 8.3.27. ### Template.xml (табличный документ) Содержимое `Template.xml` **побайтно идентично** на всех трёх версиях. Формат табличного документа стабилен — пространства имён, набор тегов и структура не менялись между 8.3.20 и 8.3.27. ### Метаданные (version в MetaDataObject) Атрибут `version` корневого элемента `` в XML-файлах метаданных (`.xml` объектов, форм, макетов): | Платформа | version | |-----------|---------| | 8.3.20 | 2.17 | | 8.3.24 | 2.17 | | 8.3.25 | 2.18 | | 8.3.26 | 2.19 | | 8.3.27 | 2.20 | ### Form.xml (управляемая форма) Содержимое `Form.xml` идентично между 8.3.20 и 8.3.24. Дальше различается **только** атрибут `version` в корневом элементе `
` (`2.17` → `2.18` → `2.19` → `2.20` по платформам). Пространства имён и структура не изменились. ### BSL-модули Модули на встроенном языке (`ObjectModule.bsl`) полностью идентичны на всех трёх версиях. ### Обратная совместимость Навыки генерируют XML с `version="2.17"`. Сборка EPF через `1cv8.exe` версии 8.3.27 проходит успешно — платформа принимает файлы с более старым номером версии без ошибок. Повышать `version` до `"2.20"` не требуется.