Skip to content

Commit

Permalink
Docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Mar 26, 2024
1 parent 31f6e1b commit 05a6821
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ See "Subject Field Marking" in [PSPF: Sensitive and classified information - An
### Minimum content

<!-- snippet: RenderEmailSubjectSuffixMinimum -->
<a id='snippet-renderemailsubjectsuffixminimum'></a>
<a id='snippet-RenderEmailSubjectSuffixMinimum'></a>
```cs
var marking = new ProtectiveMarking
{
Classification = Classification.TopSecret
};
var result = marking.RenderEmailSubjectSuffix();
```
<sup><a href='/src/Tests/Samples.cs#L9-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-renderemailsubjectsuffixminimum' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L9-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-RenderEmailSubjectSuffixMinimum' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand All @@ -75,7 +75,7 @@ Results in:
### Full content

<!-- snippet: RenderEmailSubjectSuffixFull -->
<a id='snippet-renderemailsubjectsuffixfull'></a>
<a id='snippet-RenderEmailSubjectSuffixFull'></a>
```cs
var marking = new ProtectiveMarking
{
Expand All @@ -99,7 +99,7 @@ var marking = new ProtectiveMarking
};
var result = marking.RenderEmailSubjectSuffix();
```
<sup><a href='/src/Tests/Samples.cs#L25-L49' title='Snippet source file'>snippet source</a> | <a href='#snippet-renderemailsubjectsuffixfull' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L25-L49' title='Snippet source file'>snippet source</a> | <a href='#snippet-RenderEmailSubjectSuffixFull' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand Down Expand Up @@ -132,15 +132,15 @@ See "Internet Message Header Extension" in [PSPF: Sensitive and classified info
### Minimum content

<!-- snippet: RenderEmailHeaderMinimum -->
<a id='snippet-renderemailheaderminimum'></a>
<a id='snippet-RenderEmailHeaderMinimum'></a>
```cs
var marking = new ProtectiveMarking
{
Classification = Classification.TopSecret
};
var result = marking.RenderEmailHeader();
```
<sup><a href='/src/Tests/Samples.cs#L57-L65' title='Snippet source file'>snippet source</a> | <a href='#snippet-renderemailheaderminimum' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L57-L65' title='Snippet source file'>snippet source</a> | <a href='#snippet-RenderEmailHeaderMinimum' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand All @@ -157,7 +157,7 @@ VER=2018.4, NS=gov.au, SEC=TOP-SECRET
### Full content

<!-- snippet: RenderEmailHeaderFull -->
<a id='snippet-renderemailheaderfull'></a>
<a id='snippet-RenderEmailHeaderFull'></a>
```cs
var marking = new ProtectiveMarking
{
Expand All @@ -181,7 +181,7 @@ var marking = new ProtectiveMarking
};
var result = marking.RenderEmailHeader();
```
<sup><a href='/src/Tests/Samples.cs#L73-L97' title='Snippet source file'>snippet source</a> | <a href='#snippet-renderemailheaderfull' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L73-L97' title='Snippet source file'>snippet source</a> | <a href='#snippet-RenderEmailHeaderFull' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand All @@ -200,7 +200,7 @@ VER=2018.4, NS=gov.au, SEC=TOP-SECRET, CAVEAT=C:LOBSTER, CAVEAT=FG:USA caveat, C
Extension method to apply protective markings to a [MailMessage ](https://learn.microsoft.com/en-us/dotnet/api/system.net.mail.mailmessage)

<!-- snippet: ApplyProtectiveMarkings -->
<a id='snippet-applyprotectivemarkings'></a>
<a id='snippet-ApplyProtectiveMarkings'></a>
```cs
var marking = new ProtectiveMarking
{
Expand All @@ -220,7 +220,7 @@ var mail = new MailMessage(
body: "The body");
mail.ApplyProtectiveMarkings(marking);
```
<sup><a href='/src/Tests/Samples.cs#L150-L170' title='Snippet source file'>snippet source</a> | <a href='#snippet-applyprotectivemarkings' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L150-L170' title='Snippet source file'>snippet source</a> | <a href='#snippet-ApplyProtectiveMarkings' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand Down Expand Up @@ -250,7 +250,7 @@ Results in:
See: [PSPF: Sensitive and classified information - Applying text-based protective markings](https://www.protectivesecurity.gov.au/system/files/2023-11/policy-8-classification-system-pspf_0.pd#C.5.1.1)

<!-- snippet: RenderDocumentHeaderAndFooter -->
<a id='snippet-renderdocumentheaderandfooter'></a>
<a id='snippet-RenderDocumentHeaderAndFooter'></a>
```cs
var marking = new ProtectiveMarking
{
Expand All @@ -264,7 +264,7 @@ var marking = new ProtectiveMarking
};
var (header, footer) = marking.RenderDocumentHeaderAndFooter();
```
<sup><a href='/src/Tests/Samples.cs#L190-L204' title='Snippet source file'>snippet source</a> | <a href='#snippet-renderdocumentheaderandfooter' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L190-L204' title='Snippet source file'>snippet source</a> | <a href='#snippet-RenderDocumentHeaderAndFooter' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand Down Expand Up @@ -294,11 +294,11 @@ Also useful for when a protective marking needs to be store in a configuration f
### Minimum content

<!-- snippet: ParseEmailHeaderMinimumOmit -->
<a id='snippet-parseemailheaderminimumomit'></a>
<a id='snippet-ParseEmailHeaderMinimumOmit'></a>
```cs
var protectiveMarking = Parser.ParseProtectiveMarking("SEC=OFFICIAL:Sensitive");
```
<sup><a href='/src/Tests/Samples.cs#L105-L109' title='Snippet source file'>snippet source</a> | <a href='#snippet-parseemailheaderminimumomit' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L105-L109' title='Snippet source file'>snippet source</a> | <a href='#snippet-ParseEmailHeaderMinimumOmit' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand Down Expand Up @@ -326,22 +326,22 @@ Results in:
The version and namespace is hard coded in the spec. Both can be omitted when parsing.

<!-- snippet: ParseEmailHeaderMinimumOmit -->
<a id='snippet-parseemailheaderminimumomit'></a>
<a id='snippet-ParseEmailHeaderMinimumOmit'></a>
```cs
var protectiveMarking = Parser.ParseProtectiveMarking("SEC=OFFICIAL:Sensitive");
```
<sup><a href='/src/Tests/Samples.cs#L105-L109' title='Snippet source file'>snippet source</a> | <a href='#snippet-parseemailheaderminimumomit' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L105-L109' title='Snippet source file'>snippet source</a> | <a href='#snippet-ParseEmailHeaderMinimumOmit' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


### Full content

<!-- snippet: ParseEmailHeaderFull -->
<a id='snippet-parseemailheaderfull'></a>
<a id='snippet-ParseEmailHeaderFull'></a>
```cs
var protectiveMarking = Parser.ParseProtectiveMarking("VER=2018.4, NS=gov.au, SEC=TOP-SECRET, CAVEAT=C:CodeWord, CAVEAT=FG:USA caveat, CAVEAT=RI:AGAO, CAVEAT=SH:CABINET, CAVEAT=SH:EXCLUSIVE-FOR person, CAVEAT=RI:REL AFG/DZA, EXPIRES=2020-10-01, DOWNTO=OFFICIAL, ACCESS=Legal-Privilege, NOTE=the comments, [email protected]");
```
<sup><a href='/src/Tests/Samples.cs#L178-L182' title='Snippet source file'>snippet source</a> | <a href='#snippet-parseemailheaderfull' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L178-L182' title='Snippet source file'>snippet source</a> | <a href='#snippet-ParseEmailHeaderFull' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Results in:
Expand Down Expand Up @@ -387,7 +387,7 @@ Results in:
For readability, newlines are allowed to delineate key value pairs:

<!-- snippet: ParseEmailHeaderFullNewlines -->
<a id='snippet-parseemailheaderfullnewlines'></a>
<a id='snippet-ParseEmailHeaderFullNewlines'></a>
```cs
var protectiveMarking = Parser.ParseProtectiveMarking(
"""
Expand All @@ -407,7 +407,7 @@ var protectiveMarking = Parser.ParseProtectiveMarking(
[email protected]
""");
```
<sup><a href='/src/Tests/Samples.cs#L216-L236' title='Snippet source file'>snippet source</a> | <a href='#snippet-parseemailheaderfullnewlines' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L216-L236' title='Snippet source file'>snippet source</a> | <a href='#snippet-ParseEmailHeaderFullNewlines' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand All @@ -418,27 +418,27 @@ Protective markings can be applied to an office document (docx, xlsx, pptx) usin
A custom property named `X-Protective-Marking` will be added.

<!-- snippet: OfficeDocHelperStream -->
<a id='snippet-officedochelperstream'></a>
<a id='snippet-OfficeDocHelperStream'></a>
```cs
var marking = new ProtectiveMarking
{
Classification = Classification.TopSecret
};
await OfficeDocHelper.Patch(stream, marking);
```
<sup><a href='/src/Tests/Samples.cs#L280-L288' title='Snippet source file'>snippet source</a> | <a href='#snippet-officedochelperstream' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L280-L288' title='Snippet source file'>snippet source</a> | <a href='#snippet-OfficeDocHelperStream' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

<!-- snippet: OfficeDocHelperFile -->
<a id='snippet-officedochelperfile'></a>
<a id='snippet-OfficeDocHelperFile'></a>
```cs
var marking = new ProtectiveMarking
{
Classification = Classification.TopSecret
};
await OfficeDocHelper.Patch(filePath, marking);
```
<sup><a href='/src/Tests/Samples.cs#L294-L302' title='Snippet source file'>snippet source</a> | <a href='#snippet-officedochelperfile' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Samples.cs#L294-L302' title='Snippet source file'>snippet source</a> | <a href='#snippet-OfficeDocHelperFile' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

<img src="/src/docxWithProps.png" width="400px">
Expand Down

0 comments on commit 05a6821

Please sign in to comment.