Page 1 of 1

How to review markdown files in Oxygen XML Editor

Posted: Wed Nov 17, 2021 6:40 am
by catherine
Hi,
I am using Oxygen XML Editor to edit markdown files.
How to review or add comments to the markdown files?




Best Regards,
Catherine

Re: How to review markdown files in Oxygen XML Editor

Posted: Wed Nov 17, 2021 9:25 am
by Radu
Hi Catherine,

As far as I know there is no Markdown specific way to add comments.
You can use XML style comments like this:

Code: Select all

<!--please review-->
They should be ignored in the output.

Regards,
Radu

Re: How to review markdown files in Oxygen XML Editor

Posted: Thu Nov 18, 2021 12:58 pm
by catherine
Thanks, Radu.
I'm using Gitlab embedded comments to review the markdown files.

Best Regards,
Catherine

Re: How to review markdown files in Oxygen XML Editor

Posted: Thu Nov 18, 2021 1:01 pm
by Radu
Hi Catherine,

Gitlab seems to suggest using XML comments as well:
https://docs.gitlab.com/ee/development/ ... /#comments

or are you using another syntax?

Regards,
Radu

Re: How to review markdown files in Oxygen XML Editor

Posted: Thu Nov 18, 2021 2:24 pm
by catherine
Thanks, Radu
I am now using GitLab comment feature to review the markdown files.
Just wanna find a way to review markdown files like MS-Word.


Best Regard,
Catherine

Re: How to review markdown files in Oxygen XML Editor

Posted: Fri Nov 19, 2021 8:05 am
by Radu
HI Catherine,

I'm afraid we do not have such a feature.

Regards,
Radu

Re: How to review markdown files in Oxygen XML Editor

Posted: Mon Oct 30, 2023 1:18 pm
by galanohan
Hey Cathy,

If you are using Gitlab, you can use the
image.png
New Merge Request feature so that reviewers are able to comment by line. Highlight by word or character and comment aren't available but still you can leave comments to a specific line that needs improvement or rewriting.

Whenever you have a new commit from a branch, you can create a merge request to the owner or maintainer of the target branch, let's say, main or master or other destination branch. In this way, the owner or the maintainer will receive your request and review the committed content. Then, reviewers can add comments, approve or reject the merge request.


image.png