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.

Sign up for GitHub

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

Jump to bottom

Allow some markup options in reviewer notes #842

Closed
anermina opened this issue Dec 15, 2023 · 6 comments
Closed

Allow some markup options in reviewer notes #842

anermina opened this issue Dec 15, 2023 · 6 comments
Assignees
@Intelligent2013
Labels
enhancement New feature or request

Comments

@anermina
Copy link

anermina commented Dec 15, 2023 •
edited
Loading

Can some markup options, such as items lists, be enabled for the reviewer notes?

Model International Standard ISO 17301-1 contains comments in the following form:
image

They are now rendered as follows:
image

Corresponding markup used for this comment was:

[reviewer=ISO,from=scope,to=scope]
****
* Mandatory clause
* Defines the subject of the document
* Used as a summary for the abstract
** ISO/IEC Directives, Part 2, 2021, Clause 14
****
@anermina anermina added the enhancement New feature or request label Dec 15, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Metanorma Dec 15, 2023
@anermina anermina mentioned this issue Dec 15, 2023
Merged
@ronaldtse
Copy link
Contributor

ronaldtse commented Dec 16, 2023 •
edited
Loading

I guess these are “annotations”?

We don’t need to render them in the same way but they would be useful to be encoded.

Agree with @anermina that markup be allowed inside annotations.

@ronaldtse ronaldtse moved this from 🆕 New to 🏔 High priority in Metanorma Dec 16, 2023
@opoudjis opoudjis moved this from 🏔 High priority to 🌋 Urgent in Metanorma Dec 18, 2023
@opoudjis opoudjis moved this from 🌋 Urgent to 🏗 In progress in Metanorma Dec 18, 2023
@opoudjis
Copy link
Contributor

The markup is being processed fine in Presentation XML

<review id="_6cdc7905-52e9-792a-cd6d-eb66ad6782ff" reviewer="ISO" date="2023-12-19T00:00:00Z" from="cl1" to="cl1"><ul id="_f0971edb-8922-0c00-455f-c29aa0b26721"><li><p id="_c8a5e2b7-aabd-32bb-48ae-9e83befcbece">Mandatory clause</p>
</li>
<li><p id="_0f4100e2-e40b-14b5-d0fc-96c588d75c91">Defines the subject of the document</p>
</li>
<li><p id="_1476525f-9f86-6aaa-591f-0434326bfbc9">Used as a summary for the abstract</p>
<ul id="_b3c044e5-ac10-79a9-6e67-f12111c0c37a"><li><p id="_3d5fb026-c318-e916-f182-8b7fbbb244bb">ISO/IEC Directives, Part 2, 2021, Clause 14</p>
</li>
</ul>
</li>
</ul>
</review>

and in Word:

Screenshot 2023-12-19 at 22 25 33

So this too is a PDF-specific issue.

@opoudjis opoudjis assigned Intelligent2013 and unassigned opoudjis Dec 19, 2023
@opoudjis
Copy link
Contributor

Archive 3.zip

@Intelligent2013
Copy link
Contributor

Generated XFDF contains paragraphs p:

<?xml version="1.0" encoding="UTF-8"?>
<xfdf xmlns="http://ns.adobe.com/xfdf/">
	<annots>
		<text color="#FFC333" opacity="0.600000" flags="nozoom,norotate" date="2023-12-19T00:00:00Z" page="4" rect="70.866,89.076" title="ISO">
			<contents-richtext>
				<body xmlns="http://www.w3.org/1999/xhtml">
					<p dir="ltr">Mandatory clause</p>
					<p dir="ltr">Defines the subject of the document</p>
					<p dir="ltr">Used as a summary for the abstract</p>
					<p dir="ltr">ISO/IEC Directives, Part 2, 2021, Clause 14</p>
				</body>
			</contents-richtext>
			<popup flags="nozoom,norotate" open="yes" page="4" rect=""/>
		</text>
		<text color="#FFC333" opacity="0.600000" flags="nozoom,norotate" date="2023-12-19T00:00:00Z" page="5" rect="249.809,91.709" title="ISO">
			<contents-richtext>
				<body xmlns="http://www.w3.org/1999/xhtml">
					<p dir="ltr">ISO/IEC Directives, Part 2, 2021, Clause 19</p>
				</body>
			</contents-richtext>
			<popup flags="nozoom,norotate" open="yes" page="5" rect=""/>
		</text>
	</annots>
</xfdf>

but Adobe Acrobat renders as plain text:
image

@Intelligent2013
Copy link
Contributor

From PDF spec:
image

Intelligent2013 added a commit to metanorma/mn2pdf that referenced this issue Dec 25, 2023
@Intelligent2013
review formatting updated, metanorma/metanorma-standoc#842
205be85
Intelligent2013 added a commit to metanorma/mn2pdf that referenced this issue Dec 25, 2023
@Intelligent2013
Merge pull request #233 from metanorma/review_update
cb19302 
review formatting updated, metanorma/metanorma-standoc#842
@Intelligent2013
Copy link
Contributor

Fixed in https://github.com/metanorma/mn2pdf/releases/tag/v1.81.

image

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Metanorma Dec 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Intelligent2013 Intelligent2013

Labels
enhancement New feature or request
Projects
Metanorma
Archived in project
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ronaldtse @opoudjis @Intelligent2013 @anermina