Skip to content

Commit 1b05063

Browse files
authored
Merge pull request #9 from tabbled/changedocument
Changedocument
2 parents d56013a + ad8b9d0 commit 1b05063

File tree

6 files changed

+183
-6
lines changed

6 files changed

+183
-6
lines changed

Diff for: ru/configuration/functions.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,24 @@
22
title: Функции
33
description: Документация Tabbled платформы | Функции
44
---
5-
# Настройка функций: Пошаговое руководство
5+
# Настройка функций: Пошаговое руководство
6+
7+
Функции необходимы необходимы для реализации логики на страницах при определенных событиях.
8+
9+
## Как настроить функции в Tabbled
10+
11+
**Для создания новой функции необходимо:**
12+
1. В вертикальном меню нажать на элемент бокового меню "Конфигурация".
13+
2. В открывшимся меню нажать на владку "Функции".
14+
3. Нажать кнопку "Добавить"
15+
4. Заполнить поля
16+
- `Заголовок`- используется для отображения функции в списках
17+
- `Псевдоним`- используется для вызова функции из кода по указанному псевдониму
18+
5. Написать код функции с помощью JavaScript
19+
6. Нажать "Сохранить"
20+
21+
**При необходимости работу кода можно сразу проверить**
22+
23+
1. На вкладке "Функции" двойным кликом провалиться в функцию
24+
2. Нажать на вкладку "Контекст"
25+
3. В блоке кода необходимо заполнить данные в формате JSON

Diff for: ru/configuration/general.md

+8
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,11 @@ description: Документация Tabbled платформы | Конфиг
55

66
# Общая конфигурация в Tabbled: Полное руководство
77

8+
9+
[Работа с страницами](https://docs.tabbled.org/ru/configuration/pages.html "Кликните для перехода на страницу")
10+
11+
[Работа с источниками данных](https://docs.tabbled.org/ru/configuration/datasources.html "Кликните для перехода на страницу")
12+
13+
[Работа с функциями](https://docs.tabbled.org/ru/configuration/functions.html "Кликните для перехода на страницу")
14+
15+
[Работа с пользователями](https://docs.tabbled.org/ru/configuration/functions.html "Кликните для перехода на страницу")

Diff for: ru/configuration/images/excel.jpg

97 KB
Loading

Diff for: ru/configuration/pages.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ description: Документация Tabbled платформы | Страни
1414
![Страница](images/pages1.jpg)
1515

1616
1. В вертикальном меню нажать на элемент бокового меню "Конфигурация".
17-
2. В открывшимся горизонтальном меню нажать на владку "Страницы".
17+
2. В открывшимся меню нажать на владку "Страницы".
1818
3. Нажать кнопку "Добавить".
1919
4. Будет доступно для выбора 2 вида шаблона страницы:
2020

@@ -37,18 +37,32 @@ description: Документация Tabbled платформы | Страни
3737
2. Перетащить элемент из списка в грид.
3838
3. Нажать "Сохранить".
3939

40+
## Виды элементов
41+
- `Table` - добавляет таблицу на страницу.
42+
- `Link select` - позволяет выбирать значения из выпадающего списка, источником для списка является либо поле с типом "link" или "enum".
43+
- `Checkbox` - добавляет поле-чекбокс.
44+
- `Input` - добавляет поле для введения текстовых или числовых значений.
45+
- `Datetime input` - добавляет поле для введения даты и времени.
46+
- `Image` - добавялет поле для размещения изображений.
47+
- `File` - добавляет поле для загрузки файлов в систему.
48+
- `Status filter` - позволяет добавить фильтр для таблицы, источник для значений фильтра является поле с типом "enum".
49+
- `Tree filter` - добавляет из источника данных выпадающий древовидный список.
50+
- `Rich Text Editor` - добавляет поле расширенный текстовый редактор, с возможностью изменения текста(шрифт, размер, подчеркивание)
51+
52+
4053
## Новое поле
4154

4255
**Для добавления поля из источника данных необходимо:**
4356

4457
1. В правом вертикальном меню в поле "Editing data source" выбрать необходимый источник данных.
4558
2. В верхней части страницы нажать "Добавить поле".
46-
3. Перетащить элемент из списка в грид.
59+
3. Перетащить элемент из списка в грид(все поля берутся из выбранного источника данных).
4760
4. Нажать "Сохранить".
4861

62+
4963
## Логика полей
5064

51-
**Все добавленные поля можно индивиуально настроить. Для этого существуют следующие настройки:**
65+
**Все добавленные элементы можно индивиуально настроить. Для этого существуют следующие настройки:**
5266

5367
- `Title` - название для поля. Автоматически подтягивается название с источника данных.
5468
- `Disabled` - блокирование поля.

Diff for: ru/configuration/settings.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,20 @@ description: Документация Tabbled платформы | Настро
55

66
# Настройка параметров в Tabbled
77

8-
## Конфигурирация ключевых параметров платформы
8+
## Конфигурирация ключевых параметров платформы
9+
10+
Вкладка необходима для добавления/редактирования вкладок в левом вертикальном меню.
11+
12+
## Как настроить рабочее пространство для пользователя в Tabbled
13+
1. В вертикальном меню нажать на элемент бокового меню "Конфигурация".
14+
2. В открывшимся меню нажать на владку "Настройки".
15+
3. Нажать кнопку "+" в правом углу.
16+
4. В открывшимся модальном окне заполнить данные
17+
5. Нажать кнопку "Сохранить".
18+
19+
20+
**Поля**
21+
- `Название` - отображаемое название страницы.
22+
- `Путь(url)` - путь страницы, записанный в настройке страницы в поле "Путь".
23+
- `Иконка` - иконка отображаемая слева от названия страницы, указывается код иконки с сайта https://icones.js.org/.
24+
- `Видимость` - выбор ролей которые будут видеть данную страницу.

Diff for: ru/configuration/templates.md

+120-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,123 @@ description: Документация Tabbled платформы | Настро
66
# Настройка шаблонов печати: пошаговое руководство
77

88
Основы настройки в видео уроке:
9-
[![Watch the video](https://img.youtube.com/vi/ZJwVLulb55A/0.jpg)](https://www.youtube.com/watch?v=ZJwVLulb55A)
9+
[![Watch the video](https://img.youtube.com/vi/ZJwVLulb55A/0.jpg)](https://www.youtube.com/watch?v=ZJwVLulb55A)
10+
11+
12+
Шаблоны используются для вывода информации в форматах PDF и Excel, обеспечивая структурированный и стандартизированный способ отображения данных.
13+
14+
## Как настроить шаблоны в Tabbled
15+
1. В вертикальном меню нажать на элемент бокового меню "Конфигурация".
16+
2. В открывшимся меню нажать на владку "Шаблоны отчетов".
17+
3. Нажать кнопку "Добавить".
18+
4. Заполнить поля
19+
- `Title` - название функции, которое будет отображено при выборе в источнике данных.
20+
- `Alias` - название функции латиницей, необходимо для обращения функции.
21+
- `Pages` - название страниц, в которых срабатывает функция ?.
22+
- `Template format` - выбор формата шаблона.
23+
- `Can view` - ограничения прав доступа на просмотр.
24+
5. Нажать "Сохранить".
25+
26+
## Шаблон HTML to PDF
27+
При данном формате используется язык разметки HTML.
28+
29+
Имеет следующий вид
30+
````html
31+
<style type="text/css">
32+
.tg {border-collapse:collapse;border-spacing:0;margin:0px auto;}
33+
.tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
34+
overflow:hidden;padding:2px 2px;word-break:normal;}
35+
.tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
36+
font-weight:normal;overflow:hidden;padding:2px 1px;word-break:normal;}
37+
.tg .tg-0pky{border-color:inherit;text-align:left;vertical-align:top}
38+
.tg .tg-0lax{text-align:left;vertical-align:top}
39+
</style>
40+
41+
{{#each products}}
42+
<table class="tg" style=" width: auto; margin: 0;">
43+
<colgroup>
44+
<col style="width: 400px">
45+
<col style="width: 50px">
46+
<col style="width: 300px">
47+
</colgroup>
48+
<thead>
49+
50+
<tr>
51+
<td class="tg-0lax">{{name}} </td>
52+
<td class="tg-0lax">{{qty}}</td>
53+
<td class="tg-0lax"><br><img src={{image_id}} alt="Image" width="100" height="100"></td>
54+
</tr>
55+
56+
</thead>
57+
</table>
58+
{{/each}}
59+
````
60+
Чтобы задать стиль шаблона в HTML, используется тег `<style type="text/css">`. Затем создана таблица с помощью тега `table`. Чтобы передать данные со страниц в шаблон, используем цикл `{{#each products}}` `{{/each}}`, созданный скриптами. Чтобы вставить нужное значение в шаблон, указываем его псевдоним, указанный в источнике данных, например, `{{псевдоним}}`.
61+
62+
**Скрипт**
63+
64+
Обязателен для заполнения для создания и возврата массива.
65+
Имеет следющий вид
66+
67+
````js
68+
async function prepare() {
69+
70+
let customers = await dataSources.getByAlias('customers');
71+
let products = await dataSources.getByAlias('products');
72+
let allDetails = {}
73+
74+
let dt = {
75+
customer: await customers.getById(ctx.item.client),
76+
moment: ctx.item.moment,
77+
num: ctx.item.number,
78+
status: ctx.item.status,
79+
note: ctx.item.note,
80+
products: []
81+
}
82+
83+
for(let i in ctx.item.details) {
84+
let item = ctx.item.details[i]
85+
let prod = await products.getById(item.product)
86+
87+
console.log(prod)
88+
89+
if (!prod)
90+
continue
91+
92+
if (prod.type == "product" && prod.manufacture_type === 'third_party') {
93+
let p = {
94+
id: prod.id,
95+
name: prod.name,
96+
qty: item.qty
97+
}
98+
dt.products.push(p)
99+
}
100+
}
101+
return dt
102+
}
103+
104+
return prepare()
105+
````
106+
107+
## Шаблон Excel
108+
При данном формате используется файл Excel c последующей загрузкой в систему.
109+
110+
Имеет следующий вид
111+
112+
![Шаблон excel](images/excel.jpg)
113+
114+
Создается необходимая таблица. Также, чтобы передать данные со страниц в шаблон, используем цикл `{{#each items}}` `{{/each}}`, созданный скриптами.
115+
116+
**Скрипт**
117+
118+
В данном случае скрипт не будет отличаться от шаблона HTML.
119+
120+
121+
Для проверки работы шаблонов на данной странице необходимо во вкладке "Контекст" добавить JSON.
122+
Может иметь следующий вид
123+
124+
````json
125+
{
126+
"selected": ["1722437299427348480"] // selected уникальный идентификатор документа в системе.
127+
}
128+
````

0 commit comments

Comments
 (0)