Skip to content

Commit 970539c

Browse files
SimonCroppSimonCropp
committed
docs
1 parent cef15ab commit 970539c

File tree

3 files changed

+65
-65
lines changed

3 files changed

+65
-65
lines changed

‎readme.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -446,36 +446,36 @@ await OfficeDocHelper.Patch(filePath, marking);
446446

447447
Values:
448448

449-
| Property | Type | Value |
450-
|----------|------|-------|
451-
| `Unofficial` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Unofficial)` |
452-
| `UnofficialEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=UNOFFICIAL` |
453-
| `UnofficialEmailSubjectSuffix` | `string` | `[SEC=UNOFFICIAL]` |
454-
| `UnofficialClassificationAndCaveats` | `string` | `UNOFFICIAL` |
455-
| `Official` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Official)` |
456-
| `OfficialEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=OFFICIAL` |
457-
| `OfficialEmailSubjectSuffix` | `string` | `[SEC=OFFICIAL]` |
458-
| `OfficialClassificationAndCaveats` | `string` | `OFFICIAL` |
459-
| `OfficialSensitive` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.OfficialSensitive)` |
460-
| `OfficialSensitiveEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=OFFICIAL:Sensitive` |
461-
| `OfficialSensitiveEmailSubjectSuffix` | `string` | `[SEC=OFFICIAL:Sensitive]` |
462-
| `OfficialSensitiveClassificationAndCaveats` | `string` | `OFFICIAL:Sensitive` |
463-
| `Protected` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Protected)` |
464-
| `ProtectedEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=PROTECTED` |
465-
| `ProtectedEmailSubjectSuffix` | `string` | `[SEC=PROTECTED]` |
466-
| `ProtectedClassificationAndCaveats` | `string` | `PROTECTED` |
467-
| `Secret` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Secret)` |
468-
| `SecretEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=SECRET` |
469-
| `SecretEmailSubjectSuffix` | `string` | `[SEC=SECRET]` |
470-
| `SecretClassificationAndCaveats` | `string` | `SECRET` |
471-
| `TopSecret` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.TopSecret)` |
472-
| `TopSecretEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=TOP-SECRET` |
473-
| `TopSecretEmailSubjectSuffix` | `string` | `[SEC=TOP-SECRET]` |
474-
| `TopSecretClassificationAndCaveats` | `string` | `TOP-SECRET` |
475-
| `ProtectedCabinet` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Protected){Caveats = new(){Cabinet = true}}` |
476-
| `ProtectedCabinetEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=PROTECTED, CAVEAT=SH:CABINET` |
477-
| `ProtectedCabinetEmailSubjectSuffix` | `string` | `[SEC=PROTECTED, CAVEAT=SH:CABINET]` |
478-
| `ProtectedCabinetClassificationAndCaveats` | `string` | `PROTECTED//CABINET` |
449+
| Property | Value |
450+
|----------|-------|
451+
| `Unofficial` | `new ProtectiveMarking(Classification.Unofficial)` |
452+
| `UnofficialEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=UNOFFICIAL` |
453+
| `UnofficialEmailSubjectSuffix` | string: `[SEC=UNOFFICIAL]` |
454+
| `UnofficialClassificationAndCaveats` | string: `UNOFFICIAL` |
455+
| `Official` | `new ProtectiveMarking(Classification.Official)` |
456+
| `OfficialEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=OFFICIAL` |
457+
| `OfficialEmailSubjectSuffix` | string: `[SEC=OFFICIAL]` |
458+
| `OfficialClassificationAndCaveats` | string: `OFFICIAL` |
459+
| `OfficialSensitive` | `new ProtectiveMarking(Classification.OfficialSensitive)` |
460+
| `OfficialSensitiveEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=OFFICIAL:Sensitive` |
461+
| `OfficialSensitiveEmailSubjectSuffix` | string: `[SEC=OFFICIAL:Sensitive]` |
462+
| `OfficialSensitiveClassificationAndCaveats` | string: `OFFICIAL:Sensitive` |
463+
| `Protected` | `new ProtectiveMarking(Classification.Protected)` |
464+
| `ProtectedEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=PROTECTED` |
465+
| `ProtectedEmailSubjectSuffix` | string: `[SEC=PROTECTED]` |
466+
| `ProtectedClassificationAndCaveats` | string: `PROTECTED` |
467+
| `Secret` | `new ProtectiveMarking(Classification.Secret)` |
468+
| `SecretEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=SECRET` |
469+
| `SecretEmailSubjectSuffix` | string: `[SEC=SECRET]` |
470+
| `SecretClassificationAndCaveats` | string: `SECRET` |
471+
| `TopSecret` | `new ProtectiveMarking(Classification.TopSecret)` |
472+
| `TopSecretEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=TOP-SECRET` |
473+
| `TopSecretEmailSubjectSuffix` | string: `[SEC=TOP-SECRET]` |
474+
| `TopSecretClassificationAndCaveats` | string: `TOP-SECRET` |
475+
| `ProtectedCabinet` | `new ProtectiveMarking(Classification.Protected){Caveats = new(){Cabinet = true}}` |
476+
| `ProtectedCabinetEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=PROTECTED, CAVEAT=SH:CABINET` |
477+
| `ProtectedCabinetEmailSubjectSuffix` | string: `[SEC=PROTECTED, CAVEAT=SH:CABINET]` |
478+
| `ProtectedCabinetClassificationAndCaveats` | string: `PROTECTED//CABINET` |
479479
<!-- endInclude -->
480480

481481
## Icon

‎src/Tests/Tests.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ await writer.WriteLineAsync(
4949
5050
Values:
5151
52-
| Property | Type | Value |
53-
|----------|------|-------|
52+
| Property | Value |
53+
|----------|-------|
5454
""");
5555

5656
var properties = typeof(CommonMarkings)
@@ -62,11 +62,11 @@ await writer.WriteLineAsync(
6262
if (property.Name == "ProtectedCabinet")
6363
{
6464
await writer.WriteLineAsync(
65-
"| `ProtectedCabinet` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Protected){Caveats = new(){Cabinet = true}}` |");
65+
"| `ProtectedCabinet` | `new ProtectiveMarking(Classification.Protected){Caveats = new(){Cabinet = true}}` |");
6666
}
6767
else
6868
{
69-
await writer.WriteLineAsync($"| `{property.Name}` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.{property.Name})` |");
69+
await writer.WriteLineAsync($"| `{property.Name}` | `new ProtectiveMarking(Classification.{property.Name})` |");
7070
}
7171

7272
await WriteMember(property, "EmailHeader");
@@ -80,7 +80,7 @@ Task WriteMember(PropertyInfo property, string suffix)
8080
var value = stringProperty.GetValue(null)?.ToString() ?? string.Empty;
8181

8282
// ReSharper disable once AccessToDisposedClosure
83-
return writer.WriteLineAsync($"| `{stringProperty.Name}` | `string` | `{value}` |");
83+
return writer.WriteLineAsync($"| `{stringProperty.Name}` | string: `{value}` |");
8484
}
8585
}
8686

‎src/common-markings.include.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@
44

55
Values:
66

7-
| Property | Type | Value |
8-
|----------|------|-------|
9-
| `Unofficial` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Unofficial)` |
10-
| `UnofficialEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=UNOFFICIAL` |
11-
| `UnofficialEmailSubjectSuffix` | `string` | `[SEC=UNOFFICIAL]` |
12-
| `UnofficialClassificationAndCaveats` | `string` | `UNOFFICIAL` |
13-
| `Official` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Official)` |
14-
| `OfficialEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=OFFICIAL` |
15-
| `OfficialEmailSubjectSuffix` | `string` | `[SEC=OFFICIAL]` |
16-
| `OfficialClassificationAndCaveats` | `string` | `OFFICIAL` |
17-
| `OfficialSensitive` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.OfficialSensitive)` |
18-
| `OfficialSensitiveEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=OFFICIAL:Sensitive` |
19-
| `OfficialSensitiveEmailSubjectSuffix` | `string` | `[SEC=OFFICIAL:Sensitive]` |
20-
| `OfficialSensitiveClassificationAndCaveats` | `string` | `OFFICIAL:Sensitive` |
21-
| `Protected` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Protected)` |
22-
| `ProtectedEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=PROTECTED` |
23-
| `ProtectedEmailSubjectSuffix` | `string` | `[SEC=PROTECTED]` |
24-
| `ProtectedClassificationAndCaveats` | `string` | `PROTECTED` |
25-
| `Secret` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Secret)` |
26-
| `SecretEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=SECRET` |
27-
| `SecretEmailSubjectSuffix` | `string` | `[SEC=SECRET]` |
28-
| `SecretClassificationAndCaveats` | `string` | `SECRET` |
29-
| `TopSecret` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.TopSecret)` |
30-
| `TopSecretEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=TOP-SECRET` |
31-
| `TopSecretEmailSubjectSuffix` | `string` | `[SEC=TOP-SECRET]` |
32-
| `TopSecretClassificationAndCaveats` | `string` | `TOP-SECRET` |
33-
| `ProtectedCabinet` | `ProtectiveMarking` | `new ProtectiveMarking(Classification.Protected){Caveats = new(){Cabinet = true}}` |
34-
| `ProtectedCabinetEmailHeader` | `string` | `VER=2024.1, NS=gov.au, SEC=PROTECTED, CAVEAT=SH:CABINET` |
35-
| `ProtectedCabinetEmailSubjectSuffix` | `string` | `[SEC=PROTECTED, CAVEAT=SH:CABINET]` |
36-
| `ProtectedCabinetClassificationAndCaveats` | `string` | `PROTECTED//CABINET` |
7+
| Property | Value |
8+
|----------|-------|
9+
| `Unofficial` | `new ProtectiveMarking(Classification.Unofficial)` |
10+
| `UnofficialEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=UNOFFICIAL` |
11+
| `UnofficialEmailSubjectSuffix` | string: `[SEC=UNOFFICIAL]` |
12+
| `UnofficialClassificationAndCaveats` | string: `UNOFFICIAL` |
13+
| `Official` | `new ProtectiveMarking(Classification.Official)` |
14+
| `OfficialEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=OFFICIAL` |
15+
| `OfficialEmailSubjectSuffix` | string: `[SEC=OFFICIAL]` |
16+
| `OfficialClassificationAndCaveats` | string: `OFFICIAL` |
17+
| `OfficialSensitive` | `new ProtectiveMarking(Classification.OfficialSensitive)` |
18+
| `OfficialSensitiveEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=OFFICIAL:Sensitive` |
19+
| `OfficialSensitiveEmailSubjectSuffix` | string: `[SEC=OFFICIAL:Sensitive]` |
20+
| `OfficialSensitiveClassificationAndCaveats` | string: `OFFICIAL:Sensitive` |
21+
| `Protected` | `new ProtectiveMarking(Classification.Protected)` |
22+
| `ProtectedEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=PROTECTED` |
23+
| `ProtectedEmailSubjectSuffix` | string: `[SEC=PROTECTED]` |
24+
| `ProtectedClassificationAndCaveats` | string: `PROTECTED` |
25+
| `Secret` | `new ProtectiveMarking(Classification.Secret)` |
26+
| `SecretEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=SECRET` |
27+
| `SecretEmailSubjectSuffix` | string: `[SEC=SECRET]` |
28+
| `SecretClassificationAndCaveats` | string: `SECRET` |
29+
| `TopSecret` | `new ProtectiveMarking(Classification.TopSecret)` |
30+
| `TopSecretEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=TOP-SECRET` |
31+
| `TopSecretEmailSubjectSuffix` | string: `[SEC=TOP-SECRET]` |
32+
| `TopSecretClassificationAndCaveats` | string: `TOP-SECRET` |
33+
| `ProtectedCabinet` | `new ProtectiveMarking(Classification.Protected){Caveats = new(){Cabinet = true}}` |
34+
| `ProtectedCabinetEmailHeader` | string: `VER=2024.1, NS=gov.au, SEC=PROTECTED, CAVEAT=SH:CABINET` |
35+
| `ProtectedCabinetEmailSubjectSuffix` | string: `[SEC=PROTECTED, CAVEAT=SH:CABINET]` |
36+
| `ProtectedCabinetClassificationAndCaveats` | string: `PROTECTED//CABINET` |

0 commit comments

Comments
 (0)