Skip to content
rfc-workflow Artifact [e639d653ba]
Login

Artifact [e639d653ba]

Artifact e639d653bab0739e1fca66fa4cbd257d3302124d6b69ab74f1fa3e610d5aaf2c:


# Template IETF Draft Metadata Defaults

Use this file for shared front-matter defaults after the project owner replaces every bracketed placeholder.

## Shared defaults

These are IETF-oriented placeholders, not real metadata for any specific project.

- **Submission type / stream:** `[replace: IETF | IAB | IRTF | independent | other valid stream choice]`
- **Category / intended status:** `[replace: std | info | exp | bcp | historic]`
- **Consensus / working-group state:** `[replace: if applicable]`
- **Public draft source:** `[replace: usually kramdown-rfc Markdown .md]`
- **Rendered deliverable(s):** `[replace: usually .txt; add HTML/PDF only if the project treats them as published outputs]`
- **Intermediate artifacts only:** `[replace: usually RFCXML .xml and validation scratch output]`
- **Reference pool source:** `references.md`

## Front-matter fields the project owner must decide explicitly

Do not leave these to tool defaults.

- `title`
- `submissiontype`
- `[replace: intended status field used by your draft style]`
- `[replace: document name / filename convention]`
- author names and affiliations
- date handling policy
- `[replace: workgroup, area, stream-specific boilerplate fields, or other project-required metadata]`

## Authorship and provenance boundary

Record the front-matter rules that belong to this project.

- The author block should reflect the real human authors/editors for the draft.
- If the project requires provenance, transformation, or ratification wording, record the exact allowed wording here rather than improvising it in each brief.
- If only some documents may carry special provenance text, list that boundary explicitly.
- If no special provenance text is allowed, say so here.

## Per-document metadata worksheet

Duplicate or extend this table for each real deliverable in the project.

| Document | Title | Abstract anchor | Special front-matter constraints |
| --- | --- | --- | --- |
| `[replace: document name]` | `[replace: full title]` | `[replace: one sentence describing what the abstract must promise]` | `[replace: status, provenance, boilerplate, or naming constraint]` |
| `[replace: document name]` | `[replace: full title]` | `[replace: one sentence describing what the abstract must promise]` | `[replace: status, provenance, boilerplate, or naming constraint]` |

## Optional shared metadata conventions

Use this section only if the suite truly shares these conventions.

- `[replace: keywords, area, workgroup naming, or document-family title prefix]`
- `[replace: whether requirement-keyword boilerplate is expected in all documents or only some]`
- `[replace: whether specific appendices, IANA section patterns, or security section patterns are expected]`

## What stays outside this file

Do not restate repo-level render mechanics here. For kramdown-rfc and xml2rfc structure, validation, warning triage, and rendered-example checks, use `../../toolchains/kramdown-rfc-mechanics.md`.