Choose how to emit graynotes

graynotes

Use the graynotes option to specify whether or not comments, remarks, replies and placholders should be emitted to the output document.

Syntax

Graynotes are normally not written to the output document, but this can be changed using the graynotes option. When enabled, graynotes will appear in the output document using HTML comment tags.

Placeholders can be emitted as hidden comments or as visible text. Use the placeholders option to specify how they should be emitted.

!option --graynotes        // include graynotes in the output
!option --nograynotes      // do not include graynotes in the output

!option --placeholders={graynote|text|none|auto}

enabling and disabling graynotes in the output

Placeholders

When the placeholders option is graynote, the content of the placeholder will be emitted using HTML comment syntax.

When the placeholders option is text, the content of the placeholder will be visible in the output document as regular text.

When the placeholders option is none, the content of the placeholder will be completely omitted from the output.

When the placeholders option is auto and the graynotes option is specified, the content will be emitted using HTML comment syntax. When the placeholders option is auto and the nograynotes option is specified, the content of the placeholder will be completely omitted from the output.

Examples

Original BLUEPHRASE manuscript:

!option --graynotes

h1 Terms of Use        // Run this by legal dept

Please read the Agreements carefully.
You must agree with the Agreements, before using the service.

/* .tim Should we be capitalizing Agreements? */
/+ .mary Let's leave all those things up to legal dept +/

In order to use the service, either:
ol {
    You need to be 18 or older, or
    be 13 or older and have your parent’s consent.
    /- also – restrictions on foreign accts -/
}
Concerned about this? See https://bluephrase.com/tou

Sample with graynotes enabled

Compiled output document:

<h1>Terms of Use<!-- COMMENT Run this by legal dept --></h1>

<p>Please read the Agreements carefully.</p>
<p>You must agree with the Agreements, before using the service.</p>

<!-- REMARK by tim: Should we be capitalizing Agreements? --> 
<!-- REPLY by mary: Let's leave all those things up to legal dept --> 

<p>In order to use the service, either:</p>
<ol>
    <li>You need to be 18 or older, or</li>
    <li>be 13 or older and have your parent’s consent.</li>
    <!-- TODO also – restrictions on foreign accts --> 
</ol>
<p>Concerned about this? See https://bluephrase.com/tou</p>

Sample compiled output