How to review markdown files in Oxygen XML Editor

Post here questions and problems related to editing and publishing DITA content.
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

How to review markdown files in Oxygen XML Editor

Post 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
Radu
Posts: 9059
Joined: Fri Jul 09, 2004 5:18 pm

Re: How to review markdown files in Oxygen XML Editor

Post 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
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Re: How to review markdown files in Oxygen XML Editor

Post by catherine »

Thanks, Radu.
I'm using Gitlab embedded comments to review the markdown files.

Best Regards,
Catherine
Radu
Posts: 9059
Joined: Fri Jul 09, 2004 5:18 pm

Re: How to review markdown files in Oxygen XML Editor

Post 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
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Re: How to review markdown files in Oxygen XML Editor

Post 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
Radu
Posts: 9059
Joined: Fri Jul 09, 2004 5:18 pm

Re: How to review markdown files in Oxygen XML Editor

Post by Radu »

HI Catherine,

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

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
galanohan
Posts: 115
Joined: Mon Jul 10, 2023 11:49 am

Re: How to review markdown files in Oxygen XML Editor

Post by galanohan »

Hey Cathy,

If you are using Gitlab, you can use the
image.png
image.png (7.92 KiB) Viewed 429 times
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
image.png (48.85 KiB) Viewed 429 times
Post Reply