Google XML Document Format Style Guide Version 1.0

• 语言: 英语
• 格式: .pdf
• 来源: github.com/fgaray

摘要

该文档提供了设计新XML文档格式的指南，涵盖了模式语言选择、命名空间声明、元素和属性的使用规范，以及二进制数据和日期格式的处理。文档强调了兼容性、清晰度和一致性的重要性，并为设计提供了详细的规则和例外情况。

AI总结

# 《Google XML 文档格式样式指南 Version 1.0》摘要

## 1. 引言
本文档提供了一套设计 XML 文档格式时应遵循的指南，适用于新格式的设计，旨在确保格式的清晰性和机器可读性。指南强调复用现有格式，避免过度设计，并提倡通过模式语言（如 RELAX NG）进行约束。

---

## 2. 设计原则
1. **复用性**：尽量复用现有 XML 格式，避免创建全新格式；若需扩展现有格式，合理使用现有元素和属性。
2. **一致性**：保持格式的一致性，包括可扩展性和向后兼容性。
3. **简洁性**：避免不必要的复杂性，优先使用明确的元素和属性。

---

## 3. 模式（Schemas）
1. **模式语言**：推荐使用 RELAX NG compact syntax，可加入 Schematron 规则进行额外约束。
2. **样式**：模式应采用“Salami Slice”风格（每个元素一个规则），避免“Venetian Blind”风格。
3. **兼容性**：可提供 DTD 或 W3C XML Schema 以兼容现有工具。

---

## 4. 命名空间
1. **元素命名空间**：所有元素 MUST 位于命名空间中，建议使用默认命名空间。
2. **属性命名空间**：属性通常 SHOULD NOT 使用命名空间，除非涉及外部文档类型。
3. **命名空间 URI**：应采用 HTTPS URI 格式，包含年份以便版本控制。

---

## 5. 元素和属性设计
1. **元素**：
- 元素 MUST 只包含空内容、字符内容或子元素，不得使用混合内容。
- 避免使用仅包装重复子元素的无用元素。
2. **属性**：
- 属性顺序不可靠，不应依赖。
- 每个元素的属性数量 SHOULD 不超过 10个，复杂属性可用子元素替代。
- 属性值中 SHOULD 不包含换行符。

---

## 6. 值和数据表示
1. **数值**：
- 数值 SHOULD 使用 32/64 位整数或 64 位浮点数（base 10）。
- 布尔值 SHOULD 使用 `true`/`false`，而非 `1`/`0`。
2. **日期**：日期 SHOULD 使用 RFC 3339 格式，采用 UTC 时间。
3. **二进制数据**：
- 二进制数据 MUST 使用 Base64 编码， SHOULD OMIT Base64 的换行符。
- 在元素中使用 `xsi:type` 属性指明 Base64 编码。

---

## 7. 其他约定
1. **字符编码**：UTF-8 SHOULD 是默认编码。
2. **格式化**：
- namespace SHOULD 在根元素中声明。
- 使用 2 空格缩进，字符内容不应换行。
3. **注释**：SHOULD 避免使用注释传递数据，公共文档 SHOULD 不含注释。
4. **空白字符**：XML 解析器可能会对空白字符进行不同的处理，格式 SHOULD 明确空白字符的处理规则。

---

## 8. 代码示例（部分规则说明）

---

通过遵循这些指南，可以设计出清晰、简洁、易于扩展的 XML 文档格式。