Add line-numbers when wrapping is needed for printing by Tim-Siu · Pull Request #2431 · MarkBind/markbind

Tim-Siu · 2024-02-23T06:45:50Z

What is the purpose of this pull request?

Overview of changes:
Make code wrapping the default behavior for printing. Add line numbers when wrapping does happen.
Related PR: #2413
Related Issue: #2404

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Automatically enforce soft-wrapping and add line-numbers when code is cut off

Checklist: ☑️

Updated the documentation for feature additions and enhancements
Added tests for bug fixes or features
Linked all related issues
No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

Major (when you make incompatible API changes)
Minor (when you add functionality in a backward compatible manner)
Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

what was the old feature that was made obsolete

any replacement feature (if any), and

how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

codecov · 2024-02-23T06:48:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.92%. Comparing base (e1ba80e) to head (cd664e8).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2431   +/-   ##
=======================================
  Coverage   48.92%   48.92%           
=======================================
  Files         124      124           
  Lines        5245     5245           
  Branches     1110     1110           
=======================================
  Hits         2566     2566           
  Misses       2371     2371           
  Partials      308      308

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

EltonGohJH · 2024-02-23T10:13:55Z

@Tim-Siu
It generally looks good to me. Thanks for implementing this.
There is a concern on my end tho.

It seems like once you trigger printing then the CSS remains thus the line numbers. In my opinion, it is not easy to undo it. (Prob hacky to undo it). What do you think? If it is too hard and not worthwhile, maybe can ask damith what he thinks about this side effect.

Do add documentation. (Also this side effect if we are going with this)

Tim-Siu · 2024-02-23T10:45:02Z

@Tim-Siu It generally looks good to me. Thanks for implementing this. There is a concern on my end tho.

It seems like once you trigger printing then the CSS remains thus the line numbers. In my opinion, it is not easy to undo it. (Prob hacky to undo it). What do you think? If it is too hard and not worthwhile, maybe can ask damith what he thinks about this side effect.

Do add documentation. (Also this side effect if we are going with this)

Sorry I overlooked the bug. It should be fine now. I will write the documentation for this new property right now.

Tim-Siu · 2024-02-23T10:53:06Z

Currently, we don't have existing documentation for printing optimisation. Should we add such a section under reference?

EltonGohJH · 2024-02-23T11:07:26Z

@Tim-Siu
Do add that. Do add that in the code block section too.

…code blocks

Tim-Siu · 2024-02-24T12:21:15Z

I have added a printing optimization section under the code. I am not too sure about adding a dedicated section about Printing Optimisation under reference though. Most optimizations we do seem quite natural and are quite unlikely to cause too much surprise.

I will raise a dedicated PR to add a Printing Optimisation section about all the optimizations if it is considered useful and appropriate.

* enable markdown formating for content in annotate point * add slot for header and label in annotation point * add documentation on using markdown in content label and header * add functional test * add test cases for annotation

There is no checking of proposed commit message presence. PR authors may forget to include proposed commit message. Adding a check using GitHub Actions will help remind and ensure that authors don't miss out on filling in the commit message. Let's add a job to the a new workflow, pr-message-reminder.yml file to help automate checking and reminding of filling in the proposed commit message for each PR. This approach automates the process, without having to have other users check and remind PR authors themselves. Adding the new job to a new workflow will allow greater control of job triggers while maintaining clean code.

yucheng11122017 · 2024-02-25T05:53:45Z

I have added a printing optimization section under the code. I am not too sure about adding a dedicated section about Printing Optimisation under reference though. Most optimizations we do seem quite natural and are quite unlikely to cause too much surprise.

I will raise a dedicated PR to add a Printing Optimisation section about all the optimizations if it is considered useful and appropriate.

Hi @Tim-Siu, I think there is already an section dedicated to printing in the user guide! Although it is very small...
Could you just add what you wrote to this part?

Tim-Siu · 2024-02-25T06:41:19Z

Sure! I have added a brief overview of other printing optimisations at that section.

yucheng11122017 · 2024-02-25T06:59:02Z

Hi @Tim-Siu thanks for the work so far!

One thing I noticed was when I tried to print, there seems to be a new line

Example:
Code

<tag>
    <diafsdfjnsdkjfnsdkjfskjdfnksjdfnkdfjsdkjfnsdjfksdfjksndfkjsndkfjnsdkjfnksjdnfkjsndfkjsndfknsdjkfnksjdfnkjsdnfjksdfknsdfkjsndf>
    </diafsdfjnsdkjfnsdkjfskjdfnksjdfnkdfjsdkjfnsdjfksdfjksndfkjsndkfjnsdkjfnksjdnfkjsndfkjsndfknsdjkfnksjdfnkjsdnfjksdfknsdfkjsndf>
</tag>

Output:

Could you take a look to see what is causing the issue and see if there is a fix for it?

Tim-Siu · 2024-02-25T07:00:57Z

Hi @Tim-Siu thanks for the work so far!

One thing I noticed was when I tried to print, there seems to be a new line

Example: Code
<tag>
    <diafsdfjnsdkjfnsdkjfskjdfnksjdfnkdfjsdkjfnsdjfksdfjksndfkjsndkfjnsdkjfnksjdnfkjsndfkjsndfknsdjkfnksjdfnkjsdnfjksdfknsdfkjsndf>
    </diafsdfjnsdkjfnsdkjfskjdfnksjdfnkdfjsdkjfnsdjfksdfjksndfkjsndkfjnsdkjfnksjdnfkjsndfkjsndfknsdjkfnksjdfnkjsdnfjksdfknsdfkjsndf>
</tag>
Output:

Could you take a look to see what is causing the issue and see if there is a fix for it?

That's a great catch! Sorry for the overlook. I will look into this.

Tim-Siu · 2024-02-25T07:37:27Z

Hi @Tim-Siu thanks for the work so far!

One thing I noticed was when I tried to print, there seems to be a new line

Example: Code
<tag>
    <diafsdfjnsdkjfnsdkjfskjdfnksjdfnkdfjsdkjfnsdjfksdfjksndfkjsndkfjnsdkjfnksjdnfkjsndfkjsndfknsdjkfnksjdfnkjsdnfjksdfknsdfkjsndf>
    </diafsdfjnsdkjfnsdkjfskjdfnksjdfnkdfjsdkjfnsdjfksdfjksndfkjsndkfjnsdkjfnksjdnfkjsndfkjsndfknsdjkfnksjdfnkjsdnfjksdfknsdfkjsndf>
</tag>
Output:

Could you take a look to see what is causing the issue and see if there is a fix for it?

HI @yucheng11122017 ,

It should be good now. Thank you for pointing this out!

yucheng11122017 · 2024-02-25T09:21:52Z

+##### Printing optimization
+
+Markbind automatically enhances the readability of your code blocks when printing:
+- **Light theme for clarity**: Ensures optimal contrast by switching code blocks to the light theme when printing.


Hi @Tim-Siu, where did you see this? Because the printing still seems to be in dark theme if the code is in dark theme

Hi @yucheng11122017 It does work like that on my side. But indeed this seems to be undefined behaviors. I will look into this. I will set the PR to draft for now until I thoroughly understand the CSS for the site. Sorry for the overlook.

Hi no worries @Tim-Siu! I think for now, this PR can just focus on adding the line numbers, which is what you already did. You can just clean up the documentation to not include these undefined behaviors first, add an issue, and then fix it in the future if you are interested!

Merge the latest from master

Tim-Siu · 2024-02-25T16:13:48Z

HI @yucheng11122017 ,

The code block should now be of a light theme. However, I realized that line highlighting (on both the master and this branch) doesn't seem to work. I am not sure if this is the problem of my system or the code.

yucheng11122017 · 2024-02-26T01:44:51Z

        height: 100%;
    }
+
+    /* CSS from codeblock-light.min.css */


Rather than copying the CSS, it might be better to add the class name to the code block? What do you think

Tim-Siu · 2024-02-26T05:46:08Z

Hi @yucheng11122017 ,
Thank you for your advice. I have cleaned up the PR of unrelated changes. I will investigate other printing-related issues and raise issues in separate issues.

Utilise content reuse for the documentation Co-authored-by: Chan Yu Cheng <77204346+yucheng11122017@users.noreply.github.com>

yucheng11122017 · 2024-02-26T06:00:57Z

Hi @Tim-Siu i think there is some issues with the relative file path! sorry i didn't try it out - i just wrote out the idea

Tim-Siu · 2024-02-26T06:05:21Z

Hi @Tim-Siu i think there is some issues with the relative file path! sorry i didn't try it out - i just wrote out the idea

Understood! It should be working now. Thank you for your patience.

yucheng11122017 · 2024-02-26T06:30:05Z

@Tim-Siu hmm the check still seems to be failing

Tim-Siu · 2024-02-26T06:42:37Z

@Tim-Siu hmm the check still seems to be failing

Hi @yucheng11122017

The Netify test seems to be passing on my side. Are there any additional tests that I have overlooked?

yucheng11122017

Sorry I think I saw the old check run!

LGTM thank you for the work :)

Add line-numbers when wrapping is needed for printing

bc46082

Fix the bug that line-numbers persist after printing

a82ebb7

yucheng11122017 mentioned this pull request Feb 24, 2024

Automatically add line-numbers when soft-wrapping (#2404) #2413

Closed

14 tasks

Tim-Siu added 2 commits February 24, 2024 19:28

Add documentation for printing optimisation for fenced code blocks

9d4bd23

[correct typo]Add documentation for printing optimisation for fenced …

09494d0

…code blocks

yucheng11122017 and others added 5 commits February 24, 2024 23:16

v5.3.0

2b08801

add LamJiuFong as a contributor for code (MarkBind#2433)

c7d33ca

Merge branch 'master' into soft-wrap-print

75e0b01

Tim-Siu marked this pull request as draft February 24, 2024 15:25

Tim-Siu marked this pull request as ready for review February 24, 2024 15:28

Add additional documentation for printing optimization

e7dc013

Fix mistake in wrapping

a3a86da

yucheng11122017 reviewed Feb 25, 2024

View reviewed changes

Tim-Siu marked this pull request as draft February 25, 2024 10:09

Tim-Siu added 3 commits February 25, 2024 23:47

Switch to light-theme for printing

246cb3e

Merge branch 'master' into soft-wrap-print

40fb889

Merge the latest from master

Remove faulty documentation about features not in place

b245546

yucheng11122017 reviewed Feb 26, 2024

View reviewed changes

Clean-up unrelated changes

a5af40e

Tim-Siu marked this pull request as ready for review February 26, 2024 05:46

yucheng11122017 reviewed Feb 26, 2024

View reviewed changes

Comment thread docs/userGuide/syntax/code.md

Comment thread docs/userGuide/reusingContents.md

Apply suggestions from code review

1bd6093

Utilise content reuse for the documentation Co-authored-by: Chan Yu Cheng <77204346+yucheng11122017@users.noreply.github.com>

Correct link

1fc2a4b

Add the missing empty line

cd664e8

yucheng11122017 approved these changes Feb 26, 2024

View reviewed changes

yucheng11122017 merged commit 990d613 into MarkBind:master Feb 28, 2024

yucheng11122017 mentioned this pull request Feb 28, 2024

Support soft-wrapping for code blocks #2404

Closed

Incogdino mentioned this pull request Feb 10, 2025

Text Wrap wraps by character instead of word #2600

Open

Conversation

Tim-Siu commented Feb 23, 2024 • edited by yucheng11122017 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automatically enforce soft-wrapping and add line-numbers when code is cut off

Uh oh!

codecov Bot commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

EltonGohJH commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tim-Siu commented Feb 23, 2024

Uh oh!

Tim-Siu commented Feb 23, 2024

Uh oh!

EltonGohJH commented Feb 23, 2024

Uh oh!

Tim-Siu commented Feb 24, 2024

Uh oh!

yucheng11122017 commented Feb 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tim-Siu commented Feb 25, 2024

Uh oh!

yucheng11122017 commented Feb 25, 2024

Uh oh!

Tim-Siu commented Feb 25, 2024

Uh oh!

Tim-Siu commented Feb 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yucheng11122017 Feb 25, 2024

Choose a reason for hiding this comment

Uh oh!

Tim-Siu Feb 25, 2024

Choose a reason for hiding this comment

Uh oh!

yucheng11122017 Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

Tim-Siu commented Feb 25, 2024

Uh oh!

yucheng11122017 Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

Tim-Siu commented Feb 26, 2024

Uh oh!

Uh oh!

Uh oh!

yucheng11122017 commented Feb 26, 2024

Uh oh!

Tim-Siu commented Feb 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yucheng11122017 commented Feb 26, 2024

Uh oh!

Tim-Siu commented Feb 26, 2024

Uh oh!

yucheng11122017 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Tim-Siu commented Feb 23, 2024 •

edited by yucheng11122017

Loading

codecov Bot commented Feb 23, 2024 •

edited

Loading

EltonGohJH commented Feb 23, 2024 •

edited

Loading

yucheng11122017 commented Feb 25, 2024 •

edited

Loading

Tim-Siu commented Feb 25, 2024 •

edited

Loading

Tim-Siu commented Feb 26, 2024 •

edited

Loading