# @digital-blueprint/formalize-app 中文文档

规范地址：https://npmcn.com/package/%40digital-blueprint/formalize-app/

版本：1\.5\.1
npm 元数据更新时间：2026-11-10T14:37:42.747Z
中文译文更新时间：2026-11-12T09:22:21.457Z
软件包许可：LGPL-2\.1-or-later

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40digital-blueprint/formalize-app
原文对照：https://npmcn.com/package/%40digital-blueprint/formalize-app/?lang=original
项目主页：https://github.com/digital-blueprint/formalize-app#readme
源码仓库：https://github.com/digital-blueprint/formalize-app

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：35 MB，1279 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：22 个
- 首次发布：2023-02-07T10:35:24.813Z
- 最新版本发布：2026-11-10T14:37:42.335Z
- 近 30 天下载量：2836（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 3 个）

## 中文简介

[GitHub 仓库](https://github.com/digital-blueprint/formalize-app) | [npmjs 软件包](https://www.npmjs.com/package/@digital-blueprint/formalize-app) | [Upkg CDN (英语)](https://unpkg.com/browse/@digital-blueprint/formalize-app/) (https:

## 安装

```sh
npm install @digital-blueprint/formalize-app
```

也可以使用：`pnpm add @digital-blueprint/formalize-app`、`yarn add @digital-blueprint/formalize-app`、`bun add @digital-blueprint/formalize-app`

## README

# 应用程序正规化

[GitHub 仓库](https://github.com/digital-blueprint/formalize-app) | [npmjs 软件包](https://www.npmjs.com/package/@digital-blueprint/formalize-app) | [Upkg CDN (英语)](https://unpkg.com/browse/@digital-blueprint/formalize-app/) | [将套装正规化](https://github.com/digital-blueprint/relay-formalize-bundle)

[![Build, Test and Publish](https://github.com/digital-blueprint/formalize-app/actions/workflows/build-test-publish.yml/badge.svg)](https://github.com/digital-blueprint/formalize-app/actions/workflows/build-test-publish.yml)

通过外部系统创建的表格条目的管理.

## 先决条件

-   你需要那个 [API 服务器](https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template) 运行
-   你需要那个 [Dbp 中继模式](https://github.com/digital-blueprint/relay-formalize-bundle) 用于 API 服务器持续并获取提交

## 地方发展

```bash
# get the source
git clone git@github.com:digital-blueprint/formalize-app.git
cd formalize-app
git submodule update --init

# install dependencies
npm install

# constantly build dist/bundle.js and run a local web-server on port 8001
npm run watch

# constantly build dist/bundle.js and run a local web-server on port 8001 using a custom assets directory assets_local/
npm run watch-local

# run tests
npm test
```

跳转到 [https://localhost:8001 (英语)](https://localhost:8001/),您应该有一个登录页上的单一标记.

## 使用此应用程序作为预建软件包

### 安装应用

如果您要在新文件夹中安装 dbp 正规化应用程序 `formalize-app` 你可以打电话:

```bash
npx @digital-blueprint/cli install-app formalize formalize-app /
```

**警告:** 当您作为 root 用户运行这些命令时, 可能会有问题, 如 `www-data`。 。 。 . 要做到这一点, 例如您可以打开外壳 `runuser -u www-data -- bash`。 。 。 .

之后您可以将您的 Apache 网络服务器指向 `formalize-app/public`。 。 。 .

确保你允许 `.htaccess` 在您的 Apache 配置中的文件.

同时确保将您使用的所有资源( 如您的 API 和 Keycloak 服务器) 添加到 `Content-Security-Policy` 在你身边 `formalize-app/public/.htaccess`因此,浏览器允许访问这些网站.

您也可以直接使用此应用程序 [Upkg CDN (英语)](https://unpkg.com/browse/@digital-blueprint/formalize-app/) 比如说: [dbp-正规化/index.html](https://github.com/digital-blueprint/formalize-app/tree/main/examples/dbp-formalize/index.html)

请注意, 您将需要一个 Keycloak 服务器以及您运行的 html 域名的客户端 ID .

### 更新应用程序

如果您想要更新当前文件夹中的 dbp 正规化应用程序, 您可以调用 :

```bash
npx @digital-blueprint/cli update-app formalize
```

**警告:** 当您作为 root 用户运行这些命令时, 可能会有问题, 如 `www-data`。 。 。 . 要做到这一点, 例如您可以打开外壳 `runuser -u www-data -- bash`。 。 。 .

## 活 动

此应用程序有以下活动:

-   `dbp-formalize-manage-forms`
-   `dbp-formalize-manage-submissions`
-   `dbp-formalize-render-from`

您可以在 [正式确定活动文件](https://github.com/digital-blueprint/formalize-app/tree/main/src)。 。 。 .

## 适应应用程序

### 职能

您可以添加多个属性到 `<dbp-formalize>` 标签.

| 属性名称 | 价值 | 说明 |
| --- | --- | --- |
| `provider-root` | 布尔 | [应用壳](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell) |
| `lang` | 字符串 | [语言选择](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/language-select) |
| `entry-point-url` | 字符串 | [应用壳](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell) |
| `keycloak-config` | 对象 | [应用壳](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell) |
| `base-path` | 字符串 | [应用壳](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell) |
| `src` | 字符串 | [应用壳](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell) |
| `html-overrides` | 字符串 | [常见](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/common) |
| `themes` | 阵列 | [主题切换器](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/theme-switcher) |
| `darkModeThemeOverride` | 字符串 | [主题切换器](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/theme-switcher) |

#### 强制属性

如果你没有使用 `provider-root` 属性到“ 终止” 所有提供者属性 您需要手动添加这些属性,以使主题能够正常工作:

```html
<dbp-formalize auth requested-login-status analytics-event></dbp-formalize>
```

### 设计

对于前端设计定制,如标志,颜色,字体,favicon等,请查看 [主题文档](https://dbp-demo.tugraz.at/dev-guide/frontend/theming/)。 。 。 .

## "dbp-正规化"插槽

这些是应用壳的常见插槽. 您可以在 [app- shell 文档](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell)。 。 。 . 对于应用程序的特定插槽,请查看 [正式活动](https://github.com/digital-blueprint/formalize-app/tree/main/src)。 。 。 .

## 通知

我们正在使用自动生成的表格头来创建提交表格.

A 类 [获取查询](https://api-demo.tugraz.at/#operations-Formalize-getFormalizeSubmissionItem) 用于 dbp 中继. 这回是一个json。 这份json载有上一份提交材料的各种数据.

将表格贴入 Api , 请查看 : [行动 - 建立-建立](https://api-demo.tugraz.at/#operations-Formalize-postFormalizeSubmissionCollection)。 。 。 . 本文收录了表单"形式"和表单"dataFeedElement"的数据. 数据必须是一个有效的json作为字符串,即引用标记必须用". 同样"形式"名称的表格的数据密钥必须一致,否则新密钥不显示,旧密钥表头中也不会显示数据.

## 常见问题

### @digital-blueprint/formalize-app 是什么？

GitHub 仓库 \| npmjs 软件包 \| Upkg CDN \(英语\) \(https:

### 如何安装 @digital-blueprint/formalize-app？

在项目目录运行 npm install @digital-blueprint/formalize-app，或使用 pnpm add / yarn add / bun add。

### @digital-blueprint/formalize-app 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/digital-blueprint\_\_formalize-app 是否存在。

### @digital-blueprint/formalize-app 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @digital-blueprint/formalize-app 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @digital-blueprint/formalize-app 可以商用吗？

@digital-blueprint/formalize-app 使用 LGPL-2\.1-or-later 许可。弱 Copyleft：作为库被调用时通常不要求开源你自己的代码，但修改库本身需以 LGPL 开源；前端打包合并后的适用边界存在不同理解。以上为概括，不构成法律意见，请以许可原文为准。

### @digital-blueprint/formalize-app 的下载量有多少？

根据 npm 官方下载统计，@digital-blueprint/formalize-app 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,836 次，日均约 95 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @digital-blueprint/formalize-app 还在维护吗？

最新版本 1\.5\.1 发布于 2026/11/10（1 天前）；至今共发布 9 个版本，其中过去 12 个月发布了 3 个；首次发布于 2023/02/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。