This article will help you:
- understand the {{\comment}} command and how it can be used to
- include comments in Microsoft Word that are visible to module authors but not to users
You are able to include comments inside Microsoft Word documents. These are visible when viewing or amending the document template uploaded to BRYTER but are removed from the document entirely when the document is automated for the end-user.
Example use case
Leave 'readme' notes in the template document to collaborate with other authors
You may wish to leave notes or comments in your document template for other authors. E.g., so you can explain the document's content or how the automation and placeholders have been constructed. This helps other authors easily understand the document template if they need to amend it or use it in the future, with the nodes available in the document template itself using the comment function.
Procedure
Inside Microsoft Word, when adding placeholders to your document, simply include any comments you wish to include for other authors using the following command: {{\comment Insert Comment Here}}
For example, you could include a comment such as: {{\comment Dear Paula, feel free to reach out to me if you have questions around this section, it is based on a chat I've had with Chris the other day}}. You can (but don't have to) style the comment (e.g. yellow highlight).
The comment command needs to be in its own paragraph in your document. The comment will not be recognized as a placeholder when uploaded to BRYTER and will be removed entirely when the document is automated for frontend module users, but it will remain visible when authors download the template from the BRYTER.