Skip to content

Commit 1ca50f2

Browse files
authored
Merge pull request #60 from eea/fix/clms-filenaming-revision
2 parents 811f1dc + f5d4862 commit 1ca50f2

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

DOCS/filenaming/clms-filename-tree_v1.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ title: CLMS Filename Tree
1313
---
1414

1515
```
16-
CLMS_{CODE}-{VARIABLE}[-{SUBVARIABLE}]_{TEMPORAL}_{RES}_{EXTENT}_{EPSG}_{VERSION}-{RELEASE}.ext
16+
CLMS_{CODE}-{VARIABLE}[-{SUBVARIABLE}]_{TEMPORAL}_{RES}_{EXTENT}_{EPSG}_{VERSION}-{REVISION}.ext
1717
```
1818

1919
## By Product Code
@@ -192,13 +192,13 @@ CLMS_
192192
│ └── R20m_ raster 20m
193193
│ └── T38TKL_ MGRS tile
194194
│ └── 3035_ EPSG 3035
195-
│ └── V01-R00.tif version 1, release 0
195+
│ └── V01-R00.tif version 1, revision 0
196196
197197
└── EGMS-L2a-A_ European Ground Motion — L2a ascending
198198
└── T20190101P5Y_ 5-year timeseries
199199
└── R20-5m_ irregular grid 20x5m
200200
└── 054-0154-IW1_ IW burst
201-
└── V01-R00.tif version 1, release 0
201+
└── V01-R00.tif version 1, revision 0
202202
```
203203

204204
---

DOCS/filenaming/clms-filenaming-design-principles_v1.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The period `.` (ASCII 46) is reserved exclusively for the file extension separat
7575

7676
## Principle 4 — Delimiter: Underscore `_` between fields, hyphen `-` within fields
7777

78-
**Rule:** Use `_` to separate all top-level fields. The hyphen `-` is the **within-field separator**: it joins the variable (and sub-variables) to the product code (`VLCC-GRA`, `WSI-SP-SCD`), joins version to release (`V01-R00`), and appears where a notation itself requires it (e.g., `054-0154-IW1` for IW burst tile identifiers, `C2018-2021` for change periods). It is never a cross-field delimiter.
78+
**Rule:** Use `_` to separate all top-level fields. The hyphen `-` is the **within-field separator**: it joins the variable (and sub-variables) to the product code (`VLCC-GRA`, `WSI-SP-SCD`), joins version to revision (`V01-R00`), and appears where a notation itself requires it (e.g., `054-0154-IW1` for IW burst tile identifiers, `C2018-2021` for change periods). It is never a cross-field delimiter.
7979

8080
**Rationale:** Consistent underscore delimiters make tokenisation deterministic across all product families. The hyphen carries all intra-field structure, so splitting on `_` always yields the same field count within a product family.
8181

@@ -96,7 +96,7 @@ The period `.` (ASCII 46) is reserved exclusively for the file extension separat
9696
> **Canonical template:**
9797
>
9898
> ```
99-
> CLMS_{CODE}-{VARIABLE}[-{SUBVARIABLE}]_{TEMPORAL}_{RES}_{EXTENT}_{EPSG}_{VERSION}-{RELEASE}
99+
> CLMS_{CODE}-{VARIABLE}[-{SUBVARIABLE}]_{TEMPORAL}_{RES}_{EXTENT}_{EPSG}_{VERSION}-{REVISION}
100100
> ```
101101
102102
Sub-products within a family (e.g., SP, SWS, WDS within WSI) extend the compound with a further hyphen (`WSI-SP-SCD`, `WSI-WDS-SSC`). This keeps the underscore token count identical for every file in the family.
@@ -232,7 +232,7 @@ Spatial extent identifiers are `_`-separated from adjacent tokens. Never fuse th
232232
233233
## Principle 12 — Version: `V{XX}-R{YY}` single hyphenated field
234234
235-
**Rule:** A single compound token: `V{XX}` (major, 2-digit zero-padded), hyphen, `R{YY}` (release, 2-digit zero-padded). Never use packed `V{XXX}`.
235+
**Rule:** A single compound token: `V{XX}` (major, 2-digit zero-padded), hyphen, `R{YY}` (revision, 2-digit zero-padded). Never use packed `V{XXX}`.
236236
237237
**Compliant:** `V01-R00`, `V01-R01`, `V02-R00`
238238
@@ -328,7 +328,7 @@ Some aspects genuinely differ between product families and should not be forced
328328
| 1 | Filename structure | Fields separated by `_`, stem.extension |
329329
| 2 | Allowed characters | `A–Z`, `0–9`, `_`, `-` only; no lowercase, no spaces |
330330
| 3 | Max filename length | ≤255 chars stem+extension, recommend ≤100 |
331-
| 4 | Delimiter | `_` between fields; `-` within fields (code-variable compound, version-release, notations) |
331+
| 4 | Delimiter | `_` between fields; `-` within fields (code-variable compound, version-revision, notations) |
332332
| 5 | Field order | Variable hyphen-appended to product code at position 2; canonical template defines field sequence |
333333
| 6 | Prefix | `CLMS_` mandatory for all products, no exceptions |
334334
| 7 | Product code | Short, uppercase, registered in code registry |

0 commit comments

Comments
 (0)