Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description (and blog post) on Editor comments #599

Open
ronaldtse opened this issue May 21, 2022 · 2 comments
Open

Add description (and blog post) on Editor comments #599

ronaldtse opened this issue May 21, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link
Contributor

Editor comments (EDITOR: ...) differ from Internal comments (i.e. TODO:...).

Editor comments are used to indicate notes to the reader of a published document (e.g. a stage deliverable) that requires attention. These differ from internal comments such as "TODO" that are only meant for the author or the editing team.

From @rplews (can quote):

i would use them when i want a reader to see at ballot stage but i would have cleared all ms-word comments before the ballot... just leaving the zz help comment
like "backwards compatibility annex will be developed after comment resolutions are cleared" this way we dont get a bunch of comments saying "you forgot the backwards compat annex or add to the annex, etc..."

This is the documentation task for metanorma/metanorma-iso#682

@opoudjis
Copy link
Contributor

Refer #602

@manuelfuenmayor
Copy link
Contributor

@ronaldtse, as in #701, there is already a blog post and a section in the Author's Documentation about this subject:
Annotations now available in all Metanorma outputs
Annotations (editor notes, reviewer notes, to-dos)

Is it still necessary to create another blog post?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🌋 Urgent
Status: 👀 In review
Development

No branches or pull requests

3 participants