gitea/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-07-22 12:27:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update zh tw languages and fix some broken links (#455)

Browse Source 
---------

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: silverwind <2021+silverwind@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/455
Reviewed-by: silverwind <2021+silverwind@noreply.gitea.com>
This commit is contained in:
Lunny Xiao
2026-07-09 23:41:46 +00:00
parent c0f8a04185
commit 965c269495
652 changed files with 30864 additions and 30792 deletions
Download Patch File Download Diff File Expand all files Collapse all files

184
i18n/zh-tw/docusaurus-plugin-content-docs/version-1.24/administration/mail-templates.md
View File

@@ -6,110 +6,110 @@ aliases:
- /zh-tw/mail-templates
---
# 邮件模板
# 郵件模板
為了定制特定操作的电子邮件主题和内容，可以使用模板来自定义 Gitea。这些功能的模板位于 [`custom` 目錄](../administration/customizing-gitea.md) 下。
如果没有自定义的替代方案，Gitea 将使用内部模板作為默认模板。
為了定製特定操作的電子郵件主題和內容，可以使用模板來自訂 Gitea。這些功能的模板位於 [`custom` 目錄](../administration/customizing-gitea.md) 下。
如果沒有自訂的替代方案，Gitea 將使用內部模板作為預設模板。
自定义模板在 Gitea 启动时加载。对它们的更改在 Gitea 重新启动之前不会被识别。
自訂模板在 Gitea 啟動時加載。對它們的更改在 Gitea 重新啟動之前不會被識別。
## 支持模板的邮件通知
## 支援模板的郵件通知
目前，以下通知事件使用模板：
| 操作名稱 | 用途 |
| ---------- | ---------------------------------------------------------------------- |
| `new` | 建立了新的工單或合並請求。 |
| `comment` | 在現有工單或合並請求中建立了新的评论。 |
| `close` | 关闭了工單或合並請求。 |
| `reopen` | 重新打开了工單或合並請求。 |
| `review` | 在合並請求中進行审查的首要评论。 |
| `approve` | 对合並請求進行批准的首要评论。 |
| `reject` | 对合並請求提出更改請求的审查的首要评论。 |
| `code` | 关于合並請求的代码的單个评论。 |
| `assigned` | 使用者被分配到工單或合並請求。 |
| `default` | 未包括在上述类别中的任何操作，或者当对應类别的模板不存在时使用的模板。 |
| `new` | 建立了新的工單或合併請求。 |
| `comment` | 在現有工單或合併請求中建立了新的評論。 |
| `close` | 關閉了工單或合併請求。 |
| `reopen` | 重新打開了工單或合併請求。 |
| `review` | 在合併請求中進行審查的首要評論。 |
| `approve` | 對合併請求進行批准的首要評論。 |
| `reject` | 對合併請求提出更改請求的審查的首要評論。 |
| `code` | 關於合併請求的程式碼的單個評論。 |
| `assigned` | 使用者被分配到工單或合併請求。 |
| `default` | 未包括在上述類別中的任何操作，或者當對應類別的模板不存在時使用的模板。 |
特定消息類型的模板路径為：
特定消息類型的模板路徑為：
```sh
custom/templates/mail/{操作類型}/{操作名稱}.tmpl
```
其中 `{操作類型}` 是 `issue` 或 `pull`（针对合並請求），`{操作名稱}` 是上述列出的操作名稱之一。
其中 `{操作類型}` 是 `issue` 或 `pull`（針對合併請求），`{操作名稱}` 是上述列出的操作名稱之一。
例如，有关合並請求中的评论的电子邮件的特定模板是：
例如，有關合併請求中的評論的電子郵件的特定模板是：
```sh
custom/templates/mail/pull/comment.tmpl
```
然而，並不需要為每个操作類型/名稱组合建立模板。
使用回退系统来選择适当的模板。在此列表中，将使用 _第一个存在的_ 模板：
然而，並不需要為每個操作類型/名稱組合建立模板。
使用回退系統來選擇適當的模板。在此列表中，將使用 _第一個存在的_ 模板：
- 所需**操作類型**和**操作名稱**的特定模板。
- 操作類型為 `issue` 和所需**操作名稱**的模板。
- 所需**操作類型**和操作名稱為 `default` 的模板。
- 操作類型為` issue` 和操作名稱為 `default` 的模板。
唯一必需的模板是操作類型為 `issue` 操作名稱為 `default` 的模板，除非使用者在 `custom` 目錄中覆盖了它。
唯一必需的模板是操作類型為 `issue` 操作名稱為 `default` 的模板，除非使用者在 `custom` 目錄中覆蓋了它。
## 模板语法
## 模板語法
邮件模板是 UTF-8 编码的文本文件，需要遵循以下格式之一：
郵件模板是 UTF-8 編碼的文本文件，需要遵循以下格式之一：
```
用于主题行的文本和宏
用於主題行的文本和宏
------------
用于邮件正文的文本和宏
用於郵件正文的文本和宏
```
或者
```
用于邮件正文的文本和宏
用於郵件正文的文本和宏
```
指定 _主题_ 部分是可選的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。
指定 _主題_ 部分是可選的（因此也是虛線分隔符）。在使用時，_主題_ 和 _郵件正文_ 模板之間的分隔符需要至少三個虛線；分隔符行中不允許使用其他字符。
_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text/template/) 解析，並提供了為每个通知组装的 _元数据上下文_。上下文包含以下元素：
_主題_ 和 _郵件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text/template/) 解析，並提供了為每個通知組裝的 _元資料上下文_。上下文包含以下元素：
| 名稱 | 類型 | 可用性 | 用途 |
| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 |
| `.Subject` | string | 僅在正文中可用 | 解析后的 _主题_。 |
| `.Body` | string | 始终可用 | 工單、合並請求或评论的消息，从 Markdown 解析為 HTML 並進行了清理。請勿与 _邮件正文_ 混淆。 |
| `.Link` | string | 始终可用 | 源工單、合並請求或评论的地址。 |
| `.Issue` | models.Issue | 始终可用 | 产生通知的工單（或合並請求）。要获取特定于合並請求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工單 _不是_ 合並請求，则該字段将為 `nil`。 |
| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工單或合並請求的评论，则其中包含有关评论的信息。 |
| `.IsPull` | bool | 始终可用 | 如果邮件通知与合並請求关联（即 `.Issue.PullRequest` 不為 `nil` ），则為 `true`。 |
| `.Repo` | string | 始终可用 | 存放庫的名稱，包括所有者名稱（例如 `mike/stuff`） |
| `.User` | models.User | 始终可用 | 事件来源存放庫的所有者。要获取使用者名（例如 `mike`），可以使用 `.User.Name`。 |
| `.Doer` | models.User | 始终可用 | 執行触发通知事件的操作的使用者。要获取使用者名（例如 `rhonda`），可以使用 `.Doer.Name`。 |
| `.IsMention` | bool | 始终可用 | 如果此通知僅是因為在评论中提到了使用者而生成的，並且收件人未订阅源，则為 `true`。如果收件人已订阅工單或存放庫，则為 `false`。 |
| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工單或合並請求建立之外的其他内容，则為 `Re：`；否则為空字符串。 |
| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作類型_ 对應，与選择的模板無关。 |
| `.ActionName` | string | 始终可用 | 它将是上述操作類型之一（`new` ，`comment` 等），並与選择的模板对應。 |
| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 |
| `.FallbackSubject` | string | 始終可用 | 預設主題行。參見下文。 |
| `.Subject` | string | 僅在正文中可用 | 解析後的 _主題_。 |
| `.Body` | string | 始終可用 | 工單、合併請求或評論的消息，從 Markdown 解析為 HTML 並進行了清理。請勿與 _郵件正文_ 混淆。 |
| `.Link` | string | 始終可用 | 源工單、合併請求或評論的地址。 |
| `.Issue` | models.Issue | 始終可用 | 產生通知的工單（或合併請求）。要獲取特定於合併請求的資料（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工單 _不是_ 合併請求，則該欄位將為 `nil`。 |
| `.Comment` | models.Comment | 如果適用 | 如果通知是針對添加到工單或合併請求的評論，則其中包含有關評論的資訊。 |
| `.IsPull` | bool | 始終可用 | 如果郵件通知與合併請求關聯（即 `.Issue.PullRequest` 不為 `nil` ），則為 `true`。 |
| `.Repo` | string | 始終可用 | 存放庫的名稱，包括所有者名稱（例如 `mike/stuff`） |
| `.User` | models.User | 始終可用 | 事件來源存放庫的所有者。要獲取使用者名稱（例如 `mike`），可以使用 `.User.Name`。 |
| `.Doer` | models.User | 始終可用 | 執行觸發通知事件的操作的使用者。要獲取使用者名稱（例如 `rhonda`），可以使用 `.Doer.Name`。 |
| `.IsMention` | bool | 始終可用 | 如果此通知僅是因為在評論中提到了使用者而生成的，並且收件人未訂閱源，則為 `true`。如果收件人已訂閱工單或存放庫，則為 `false`。 |
| `.SubjectPrefix` | string | 始終可用 | 如果通知是關於除工單或合併請求建立之外的其他內容，則為 `Re：`；否則為空字符串。 |
| `.ActionType` | string | 始終可用 | `"issue"` 或 `"pull"`。它將與實際的 _操作類型_ 對應，與選擇的模板無關。 |
| `.ActionName` | string | 始終可用 | 它將是上述操作類型之一（`new` ，`comment` 等），並與選擇的模板對應。 |
| `.ReviewComments` | []models.Comment | 始終可用 | 審查中的程式碼評論列表。評論文本將在 `.RenderedContent` 中，引用的程式碼將在 `.Patch` 中。 |
所有名稱区分大小写。
所有名稱區分大小寫。
### 模板中的主题部分
### 模板中的主題部分
用于邮件主题的模板引擎是 Golang 的 [`text/template`](https://go.dev/pkg/text/template/)。
有关语法的详细信息，請参阅链接的文檔。
用於郵件主題的模板引擎是 Golang 的 [`text/template`](https://go.dev/pkg/text/template/)。
有關語法的詳細資訊，請參閱鏈接的文件。
主题构建的步骤如下：
主題構建的步驟如下：
- 根据通知類型和可用的模板選择一个模板。
- 解析並解析模板（例如，将 `{{.Issue.Index}}` 转换為工單或合並請求的编号）。
- 将所有空格字符（例如 `TAB`，`LF` 等）转换為普通空格。
- 删除所有前导、尾随和多余的空格。
- 将字符串截断為前 256 个字母（字符）。
- 根據通知類型和可用的模板選擇一個模板。
- 解析並解析模板（例如，將 `{{.Issue.Index}}` 轉換為工單或合併請求的編號）。
- 將所有空格字符（例如 `TAB`，`LF` 等）轉換為普通空格。
- 刪除所有前導、尾隨和多餘的空格。
- 將字符串截斷為前 256 個字母（字符）。
如果最终结果為空字符串，**或者**没有可用的主题模板（即所選模板不包含主题部分），将使用 Gitea 的**内部默认值**。
如果最終結果為空字符串，**或者**沒有可用的主題模板（即所選模板不包含主題部分），將使用 Gitea 的**內部預設值**。
内部默认（回退）主题相当于：
內部預設（回退）主題相當於：
```
{{.SubjectPrefix}}[{{.Repo}}] {{.Issue.Title}} (#{{.Issue.Index}})
@@ -117,31 +117,31 @@ _主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text
例如：`Re: [mike/stuff] New color palette (#38)`
即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作為 `.FallbackSubject` 找到。
即使存在有效的主題模板，Gitea 的預設主題也可以在模板的元資料中作為 `.FallbackSubject` 找到。
### 模板中的邮件正文部分
### 模板中的郵件正文部分
用于邮件正文的模板引擎是 Golang 的 [`html/template`](https://go.dev/pkg/html/template/)。
有关语法的详细信息，請参阅链接的文檔。
用於郵件正文的模板引擎是 Golang 的 [`html/template`](https://go.dev/pkg/html/template/)。
有關語法的詳細資訊，請參閱鏈接的文件。
邮件正文在邮件主题之后進行解析，因此還有一个额外的 _元数据_ 字段，即在考虑所有情况之后实际呈現的主题。
郵件正文在郵件主題之後進行解析，因此還有一個額外的 _元資料_ 欄位，即在考慮所有情況之後實際呈現的主題。
期望的结果是 HTML（包括结构元素，如`<html>`，`<body>`等）。可以通過 `<style>` 块、`class` 和 `style` 属性進行样式设置。但是，`html/template` 会進行一些 [自动转义](https://go.dev/pkg/html/template/#hdr-Contexts)，需要考虑这一点。
期望的結果是 HTML（包括結構元素，如`<html>`，`<body>`等）。可以透過 `<style>` 塊、`class` 和 `style` 屬性進行樣式設定。但是，`html/template` 會進行一些 [自動轉義](https://go.dev/pkg/html/template/#hdr-Contexts)，需要考慮這一點。
不支持附件（例如图像或外部样式表）。但是，也可以引用其他模板，例如以集中方式提供 `<style>` 元素的内容。外部模板必須放置在 `custom/mail` 下，並相對於該目錄引用。例如，可以使用 `{{template styles/base}}` 包含 `custom/mail/styles/base.tmpl`。
不支援附件（例如圖像或外部樣式表）。但是，也可以引用其他模板，例如以集中方式提供 `<style>` 元素的內容。外部模板必須放置在 `custom/mail` 下，並相對於該目錄引用。例如，可以使用 `{{template styles/base}}` 包含 `custom/mail/styles/base.tmpl`。
邮件以 `Content-Type: multipart/alternative` 发送，因此正文以 HTML 和文本格式发送。通過剥离 HTML 标记来获取文本版本。
郵件以 `Content-Type: multipart/alternative` 發送，因此正文以 HTML 和文本格式發送。通過剝離 HTML 標記來獲取文本版本。
## 故障排除
邮件的呈現方式直接取决于邮件應用程序的功能。许多邮件客户端甚至不支持 HTML，因此显示生成邮件中包含的文本版本。
郵件的呈現方式直接取決於郵件應用程式的功能。許多郵件客戶端甚至不支援 HTML，因此顯示生成郵件中包含的文本版本。
如果模板無法呈現，则只有在发送邮件时才会注意到。
如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈現了任何内容，则将使用該内容，忽略其他内容。
如果模板無法呈現，則只有在發送郵件時纔會注意到。
如果主題模板失敗，將使用預設主題，如果從 _郵件正文_ 中成功呈現了任何內容，則將使用該內容，忽略其他內容。
如果遇到问题，請检查 [Gitea 的日志](../administration/logging-config.md) 以获取错误消息。
如果遇到問題，請檢查 [Gitea 的日誌](../administration/logging-config.md) 以獲取錯誤消息。
## 示例
## 範例
`custom/templates/mail/issue/default.tmpl`:
@@ -150,11 +150,11 @@ _主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text
{{if eq .ActionName "new"}}
建立了
{{else if eq .ActionName "comment"}}
评论了
評論了
{{else if eq .ActionName "close"}}
关闭了
關閉了
{{else if eq .ActionName "reopen"}}
重新打开了
重新打開了
{{else}}
更新了
{{end}}
@@ -175,7 +175,7 @@ _主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text
<body>
{{if .IsMention}}
<p>
您收到此邮件是因為 @{{.Doer.Name}} 提到了您。
您收到此郵件是因為 @{{.Doer.Name}} 提到了您。
</p>
{{end}}
<p>
@@ -187,16 +187,16 @@ _主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text
{{if eq .ActionName "new"}}
建立了
{{else if eq .ActionName "close"}}
关闭了
關閉了
{{else if eq .ActionName "reopen"}}
重新打开了
重新打開了
{{else}}
更新了
{{end}}
<a href="{{.Link}}">{{.Repo}}#{{.Issue.Index}}</a>。
</p>
{{if not (eq .Body "")}}
<h3>消息内容：</h3>
<h3>消息內容：</h3>
<hr>
{{.Body}}
{{end}}
@@ -209,17 +209,17 @@ _主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text
</html>
```
該模板将生成以下内容：
該模板將生成以下內容：
### 主题
### 主題
> [mike/stuff] @rhonda 在合並請求 #38 上進行了评论：New color palette
> [mike/stuff] @rhonda 在合併請求 #38 上進行了評論：New color palette
### 邮件正文
### 郵件正文
> [@rhonda](#)（Rhonda Myers）更新了 [mike/stuff#38](#)。
>
> #### 消息内容
> #### 消息內容
>
> \_**************\*\*\*\***************\_**************\*\*\*\***************
>
@@ -229,25 +229,25 @@ _主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text
>
> [在 Gitea 上查看](#)。
## 高级用法
## 高級用法
模板系统包含一些函数，可用于進一步处理和格式化消息。以下是其中一些函数的列表：
模板系統包含一些函數，可用於進一步處理和格式化消息。以下是其中一些函數的列表：
| 函数名 | 參數 | 可用于 | 用法 |
| 函數名 | 參數 | 可用於 | 用法 |
| ---------------- | ----------- | ---------- | ------------------------------------------------ |
| `AppUrl` | - | 任何地方 | Gitea 的 URL |
| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常為 "Gitea" |
| `AppDomain` | - | 任何地方 | Gitea 的主机名 |
| `EllipsisString` | string, int | 任何地方 | 将字符串截断為指定长度；根据需要添加省略号 |
| `SanitizeHTML` | string | 僅正文部分 | 通過删除其中的危险 HTML 標籤对文本進行清理 |
| `SafeHTML` | string | 僅正文部分 | 将输入作為 HTML 处理；可用于输出原始的 HTML 内容 |
| `AppName` | - | 任何地方 | 從 `app.ini` 中設定，通常為 "Gitea" |
| `AppDomain` | - | 任何地方 | Gitea 的主機名 |
| `EllipsisString` | string, int | 任何地方 | 將字符串截斷為指定長度；根據需要添加省略號 |
| `SanitizeHTML` | string | 僅正文部分 | 通過刪除其中的危險 HTML 標籤對文本進行清理 |
| `SafeHTML` | string | 僅正文部分 | 將輸入作為 HTML 處理；可用於輸出原始的 HTML 內容 |
这些都是 _函数_，而不是元数据，因此必須按以下方式使用：
這些都是 _函數_，而不是元資料，因此必須按以下方式使用：
```html
像这样使用： {{SanitizeHTML "Escape<my
>text"}} 或者这样使用： {{"Escape<my
>text" | SanitizeHTML}} 或者这样使用： {{AppUrl}} 但不要像这样使用：
像這樣使用： {{SanitizeHTML "Escape<my
>text"}} 或者這樣使用： {{"Escape<my
>text" | SanitizeHTML}} 或者這樣使用： {{AppUrl}} 但不要像這樣使用：
{{.AppUrl}}</my
></my
>