[#98] Space character dropped at line break when converting to PDF #192

Eclipse-Dominator · 2023-06-14T03:48:14Z

Fixes #98

In the pdf version of UG, commands that span across more than one line when copied-pasted to the application will drop the line-break. As line-breaks will usually be formatted at spaces when converting to pdf, this will cause the space in command to be dropped when pasting into the application.

Therefore, let's update the UG to inform the users about this behavior.

canihasreview · 2023-06-14T03:48:17Z

Click here to submit a new iteration when this PR is ready for review.

See this repository's contribution guide for more information.

canihasreview · 2023-06-14T03:48:35Z

v1

@Eclipse-Dominator submitted v1 for review.

[v1 1/1] Update ug regarding copying commands

(📚 Archive)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/192/1/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

codecov · 2023-06-14T03:50:56Z

Codecov Report

Merging #192 (98173a1) into master (f0e9069) will not change coverage.
The diff coverage is n/a.

❗ Current head 98173a1 differs from pull request most recent head 2c3c057. Consider uploading reports for the commit 2c3c057 to get more accurate results

@@            Coverage Diff            @@
##             master     #192   +/-   ##
=========================================
  Coverage     72.06%   72.06%           
  Complexity      399      399           
=========================================
  Files            70       70           
  Lines          1235     1235           
  Branches        127      127           
=========================================
  Hits            890      890           
  Misses          314      314           
  Partials         31       31

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

dlimyy

Overall, LGTM! Just some suggestions below

dlimyy · 2023-06-14T05:58:45Z

docs/UserGuide.md

@@ -63,6 +63,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
  e.g. if the command specifies `help 123`, it will be interpreted as `help`.

+* Be careful when copy-pasting commands that cut across a single line from this user guide as `Sample commands` that span more than a single line may drop a space at the line-break when copied over to the application. 


Can consider shortening Sample commands ... to these commands to make it less verbose

Suggested change

* Be careful when copy-pasting commands that cut across a single line from this user guide as `Sample commands` that span more than a single line may drop a space at the line-break when copied over to the application.

* Be careful when copy-pasting commands that span more than a single line from this user guide as the space character at the line-break may be lost when these commands are copied over to the application.

damithc · 2023-06-14T06:56:14Z

docs/UserGuide.md

@@ -63,6 +63,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
  e.g. if the command specifies `help 123`, it will be interpreted as `help`.

+* Be careful when copy-pasting commands that cut across a single line from this user guide as `Sample commands` that span more than a single line may drop a space at the line-break when copied over to the application. 


Another alternative that mentions PDF files specifically.

Suggested change

* Be careful when copy-pasting commands that cut across a single line from this user guide as `Sample commands` that span more than a single line may drop a space at the line-break when copied over to the application.

* If you are using a PDF version of this document, be careful when copy-pasting commands that span multiple lines, as spaces surrounding line breaks can get omitted when copy-pasted from a PDF file.

canihasreview · 2023-06-14T07:28:40Z

v2

@Eclipse-Dominator submitted v2 for review.

[v2 1/1] Update ug regarding copying commands

(📚 Archive) (📈 Interdiff between v1 and v2) (📈 Range-Diff between v1 and v2)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/192/2/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc

commit message:
*span across more than one line -> span multiple lines

Try using ChatGPT to see if the commit message phrasing can be improved.

UserGuide.md: there is a typo

canihasreview · 2023-06-14T08:14:45Z

v3

@Eclipse-Dominator submitted v3 for review.

[v3 1/1] Update UG regarding copying commands

(📚 Archive) (📈 Interdiff between v2 and v3) (📈 Range-Diff between v2 and v3)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/192/3/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc · 2023-06-14T16:11:22Z

@se-edu/tech-team-level1 for your review ...
Remember to review commit-by-commit, and review the commit message as well.

jundatan · 2023-06-14T17:18:46Z

docs/UserGuide.md

@@ -63,6 +63,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
  e.g. if the command specifies `help 123`, it will be interpreted as `help`.

+* If you are using a PDF version of this document, be careful when copy-pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.


Imo, is quite odd to put this under the "notes about the command format" section as it does not fit well with the other pointers in it. Perhaps, it will be better to be put it in a separate section like the FAQ or below the features header outside of the "notes about the command format" section?

In my opinion, positioning this information here is beneficial as it pertains directly to the use of commands. From personal experience, I don't typically read through the entire User Guide before starting to use the commands. Therefore, having notes about potential pitfalls or issues within the command format section can be extremely useful.

Furthermore, I view the FAQ as an additional, somewhat less critical feature, which should not interfere with or impede the fundamental understanding and usage of the commands. As such, I believe it's acceptable to prioritize the 'Note about the command' section over the FAQ.

Thanks for inputs @jundatan @SPWwj
Yes it is a bit odd to have in under 'notes about the command format'. Just below it as a separate box is one viable option. Putting it in the FAQ is not a good idea, as @SPWwj mentioned. For now, let's keep it in the current place as it is less disruptive to the flow of the document.

SPWwj

The addition of a newline has resulted in the 'help' command being pushed to a new page in the command table, which unfortunately led to an overlap in the rendering. This issue needs to be addressed before proceeding with the merge.

By the way, using incognito mode might be helpful in debugging ;)

The commit message could be more precise and clearer.

Eclipse-Dominator · 2023-06-14T18:24:40Z

The addition of a newline has resulted in the 'help' command being pushed to a new page in the command table, which unfortunately led to an overlap in the rendering. This issue needs to be addressed before proceeding with the merge.
By the way, using incognito mode might be helpful in debugging ;)

The commit message could be more precise and clearer.

@SPWwj, I'm not sure how to get page like rendering when viewing user guide in browser.

But I wasn't actually able to replicate this when converting to PDF with both Github Pages and local jekyll server.
Conversion to pdf tested on:

Edge 114.0.1823.43 (Official build) (64-bit)
Chrome 114.0.5735.110 (Official Build) (64-bit)
Chrome 114.0.5735.134 (Official Build) (64-bit)

Update

I was able to replicate this issue. It seems to be related to the service that is used to convert the html to pdf.
If the option "Save as PDF" is selected, the table rendering will be normal like above.

However, the rendering issue seems to be caused by Microsoft's print to PDF service.

SPWwj · 2023-06-14T18:50:39Z

The addition of a newline has resulted in the 'help' command being pushed to a new page in the command table, which unfortunately led to an overlap in the rendering. This issue needs to be addressed before proceeding with the merge. By the way, using incognito mode might be helpful in debugging ;) The commit message could be more precise and clearer.

@SPWwj, I'm not sure how to get page like rendering when viewing user guide in browser.

But I wasn't actually able to replicate this when converting to PDF with both Github Pages and local jekyll server. Conversion to pdf tested on:

Edge 114.0.1823.43 (Official build) (64-bit)

Chrome 114.0.5735.110 (Official Build) (64-bit)

Chrome 114.0.5735.134 (Official Build) (64-bit)

Window:

Edge Version 114.0.1823.43 (Official build) (64-bit)
Chrome Version 114.0.5735.134 (Official Build) (64-bit)
The overlapping occur when paper size is set to Letter:

My bad, since the recommended setting is A4, this is not a issue...

SPWwj · 2023-06-15T02:53:54Z

docs/UserGuide.md

@@ -63,6 +63,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
  e.g. if the command specifies `help 123`, it will be interpreted as `help`.

+* If you are using a PDF version of this document, be careful when copy-pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.


A minor alteration suggestion:
It may be less confusing to users if we adjust the wording regarding the copy-pasting commands. Instead of suggesting that AB3 has a copy-paste command, we could articulate it as 'copying and pasting the command from the PDF version of the User Guide.'

SPWwj · 2023-06-15T03:11:44Z

Update ug regarding copying commands

Just a minor suggestion for the commit message: "Update UG with clarified instructions on copying commands". While the current commit message is effective, someone without any prior knowledge of the issue might question what 'regarding copying commands' refers to, as it is rather vague. Therefore, if it fits within the character limit, we should aim to enhance its conciseness.

Other than that this PR look good to me :)

In the PDF version of the UG, commands that span multiple lines lose their line breaks when copied and pasted into the application. Since line breaks are typically converted to spaces when the document is converted to PDF, this results in the omission of spaces within the command when pasted into the application. Therefore, let's update the UG to inform users about this behavior.

canihasreview · 2023-06-15T09:24:46Z

v4

@Eclipse-Dominator submitted v4 for review.

[v4 1/1] Update UG with clarified instructions on copying commands

(📚 Archive) (📈 Interdiff between v3 and v4) (📈 Range-Diff between v3 and v4)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/192/4/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

SPWwj

LGTM!

damithc · 2023-06-26T13:11:05Z

Merged with minor changes to the commit message (revised the subject, removed 'Therefore,').

Thanks for the PR, @Eclipse-Dominator and for the reviews @SPWwj @jundatan @dlimyy

canihasreview bot added the s.ToReview label Jun 14, 2023

dlimyy reviewed Jun 14, 2023

View reviewed changes

damithc reviewed Jun 14, 2023

View reviewed changes

Eclipse-Dominator force-pushed the 98-update-ug-to-handle-line-breaks branch from dd247f6 to a8834be Compare June 14, 2023 07:23

damithc requested changes Jun 14, 2023

View reviewed changes

canihasreview bot requested a review from damithc June 14, 2023 08:14

Eclipse-Dominator force-pushed the 98-update-ug-to-handle-line-breaks branch from a8834be to 98173a1 Compare June 14, 2023 08:14

jundatan reviewed Jun 14, 2023

View reviewed changes

SPWwj reviewed Jun 14, 2023

View reviewed changes

SPWwj reviewed Jun 15, 2023

View reviewed changes

Eclipse-Dominator force-pushed the 98-update-ug-to-handle-line-breaks branch from 98173a1 to 2c3c057 Compare June 15, 2023 09:24

damithc requested review from SPWwj, dlimyy and jundatan June 15, 2023 16:22

SPWwj approved these changes Jun 15, 2023

View reviewed changes

damithc merged commit c9c9512 into se-edu:master Jun 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#98] Space character dropped at line break when converting to PDF #192

[#98] Space character dropped at line break when converting to PDF #192

Eclipse-Dominator commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

codecov bot commented Jun 14, 2023 •

edited

Loading

dlimyy left a comment

dlimyy Jun 14, 2023

damithc Jun 14, 2023

canihasreview bot commented Jun 14, 2023

damithc left a comment

canihasreview bot commented Jun 14, 2023

damithc commented Jun 14, 2023

jundatan Jun 14, 2023 •

edited

Loading

SPWwj Jun 15, 2023

damithc Jun 15, 2023

SPWwj left a comment •

edited

Loading

Eclipse-Dominator commented Jun 14, 2023 •

edited

Loading

SPWwj commented Jun 14, 2023 •

edited

Loading

SPWwj Jun 15, 2023

SPWwj commented Jun 15, 2023

canihasreview bot commented Jun 15, 2023

SPWwj left a comment

damithc commented Jun 26, 2023

	* Be careful when copy-pasting commands that cut across a single line from this user guide as `Sample commands` that span more than a single line may drop a space at the line-break when copied over to the application.
	* Be careful when copy-pasting commands that span more than a single line from this user guide as the space character at the line-break may be lost when these commands are copied over to the application.

	* Be careful when copy-pasting commands that cut across a single line from this user guide as `Sample commands` that span more than a single line may drop a space at the line-break when copied over to the application.
	* If you are using a PDF version of this document, be careful when copy-pasting commands that span multiple lines, as spaces surrounding line breaks can get omitted when copy-pasted from a PDF file.

[#98] Space character dropped at line break when converting to PDF #192

[#98] Space character dropped at line break when converting to PDF #192

Conversation

Eclipse-Dominator commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

v1

codecov bot commented Jun 14, 2023 • edited Loading

Codecov Report

dlimyy left a comment

Choose a reason for hiding this comment

dlimyy Jun 14, 2023

Choose a reason for hiding this comment

damithc Jun 14, 2023

Choose a reason for hiding this comment

canihasreview bot commented Jun 14, 2023

v2

damithc left a comment

Choose a reason for hiding this comment

canihasreview bot commented Jun 14, 2023

v3

damithc commented Jun 14, 2023

jundatan Jun 14, 2023 • edited Loading

Choose a reason for hiding this comment

SPWwj Jun 15, 2023

Choose a reason for hiding this comment

damithc Jun 15, 2023

Choose a reason for hiding this comment

SPWwj left a comment • edited Loading

Choose a reason for hiding this comment

Eclipse-Dominator commented Jun 14, 2023 • edited Loading

Update

SPWwj commented Jun 14, 2023 • edited Loading

SPWwj Jun 15, 2023

Choose a reason for hiding this comment

SPWwj commented Jun 15, 2023

canihasreview bot commented Jun 15, 2023

v4

SPWwj left a comment

Choose a reason for hiding this comment

damithc commented Jun 26, 2023

codecov bot commented Jun 14, 2023 •

edited

Loading

jundatan Jun 14, 2023 •

edited

Loading

SPWwj left a comment •

edited

Loading

Eclipse-Dominator commented Jun 14, 2023 •

edited

Loading

SPWwj commented Jun 14, 2023 •

edited

Loading