Skip to content

Commit 7c1f1a4

Browse files
authored
Update specification and readme for "Final Candidate" (#967)
* Update specification and readme for "Final Candidate" * Update intro.md * Update syntax.md * Update formatting.md * Match the TOC to the section head * Update document title to match TOC * Update errors.md * Update data model readme * Update appendices.md * Update formatting.md
1 parent 995a1bf commit 7c1f1a4

File tree

7 files changed

+32
-32
lines changed

7 files changed

+32
-32
lines changed

spec/README.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
11
# MessageFormat 2.0 Specification
22

3-
## Table of Contents
4-
5-
1. [Introduction](intro.md)
6-
1. [Conformance](intro.md#conformance)
7-
1. [Terminology and Conventions](intro.md#terminology-and-conventions)
8-
1. [Stability Policy](intro.md#stability-policy)
9-
1. [Syntax](syntax.md)
10-
1. [`message.abnf`](message.abnf)
11-
1. [Formatting](formatting.md)
12-
1. [Errors](errors.md)
13-
1. [Default Function Registry](registry.md)
14-
1. [`u:` Namespace](u-namespace.md)
15-
1. [Interchange data model](data-model/README.md)
16-
1. [Appendices](appendices.md)
17-
1. [Security Considerations](appendices.md#security-considerations)
18-
1. [Acknowledgements](appendices.md#acknowledgements)
3+
> [!IMPORTANT]
4+
> This page is not a part of the specification and is not normative.
195
206
## What is MessageFormat 2?
217

@@ -34,14 +20,15 @@ thus enabling gradual adoption by users of older formatting systems.
3420
The goal is to allow developers and translators to create natural-sounding, grammatically-correct,
3521
user interfaces that can appear in any language and support the needs of diverse cultures.
3622

37-
## MessageFormat 2 Specification and Syntax
23+
## Status of the documents in this repo
3824

39-
The current specification starts [here](#table-of-contents) and may have changed since the publication
40-
of the Tech Preview version.
41-
The Tech Preview specification is [here](https://www.unicode.org/reports/tr35/tr35-73/tr35-messageFormat.html)
25+
The editor's copy of the specification is found in this directory of this repo and starts [here](intro.md).
26+
The editor's copy may have changed since the publication of the most recent LDML version.
4227

43-
The current draft syntax for defining messages can be found in [spec/syntax.md](./syntax.md).
44-
The syntax is formally described in [ABNF](./message.abnf).
28+
The Final Candidate specification is in [LDML 46.1](https://www.unicode.org/reports/tr35/tr35-73/tr35-messageFormat.html)
29+
which is identical to the materials in the LDML 46.1 release in this repo.
30+
31+
## About
4532

4633
Messages can be simple strings:
4734

spec/appendices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DRAFT Appendices
1+
# Appendices
22

33
## Security Considerations
44

spec/data-model/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DRAFT MessageFormat 2.0 Data Model
1+
# MessageFormat 2.0 Data Model
22

33
This section defines a data model representation of MessageFormat 2 _messages_.
44

spec/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MessageFormat 2.0 Errors
1+
# Errors
22

33
Errors can occur during the processing of a _message_.
44
Some errors can be detected statically,

spec/formatting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DRAFT MessageFormat 2.0 Formatting
1+
# Formatting
22

33
## Introduction
44

@@ -534,7 +534,7 @@ according to their _key_ values and selecting the first one.
534534
> > * {{Only used by fractions in Polish.}}
535535
> > ```
536536
>
537-
> In the Tech Preview, feedback from users and implementers is desired about
537+
> During the Final Candidate review period, feedback from users and implementers is desired about
538538
> whether to relax the requirement that such a "fallback _variant_" appear in
539539
> every message, versus the potential for a _message_ to fail at runtime
540540
> because no matching _variant_ is available.

spec/intro.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# MessageFormat 2.0 Specification
22

3+
## Table of Contents
4+
5+
1. [Introduction](intro.md)
6+
1. [Conformance](intro.md#conformance)
7+
1. [Terminology and Conventions](intro.md#terminology-and-conventions)
8+
1. [Stability Policy](intro.md#stability-policy)
9+
1. [Syntax](syntax.md)
10+
1. [`message.abnf`](message.abnf)
11+
1. [Formatting](formatting.md)
12+
1. [Errors](errors.md)
13+
1. [Default Function Registry](registry.md)
14+
1. [`u:` Namespace](u-namespace.md)
15+
1. [Interchange data model](data-model/README.md)
16+
1. [Appendices](appendices.md)
17+
1. [Security Considerations](appendices.md#security-considerations)
18+
1. [Acknowledgements](appendices.md#acknowledgements)
19+
320
## Introduction
421

522
One of the challenges in adapting software to work for

spec/syntax.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
# DRAFT MessageFormat 2.0 Syntax
2-
3-
## Table of Contents
4-
5-
\[TBD\]
1+
# Syntax
62

73
### Introduction
84

0 commit comments

Comments
 (0)