This is a simple set of rules for inserting suggestions and comments in a text file. In principle, the scheme works for any text file but we find is most useful for either plain text files or LaTeX files. In MS Word, there are mechanisms to mark suggestions and comments.
To replace old_text with suggested_new_text:
[old_text|suggested_new_text]
To add something:
[|suggested_addition]
To remove something:
[removed_text|]
To add an explanatory comment to a change:
[old_text|suggested_new_text <explanatory_comment>]
or to a document without suggesting a change
[|<explanatory_comment>]
Note: the "|" (vertical bar) symbol is essential!
Including this in all markup makes it
very easy to find changes so please use it.
- created