content icon indicating copy to clipboard operation
content copied to clipboard

Adjust text formatting per CJK copywriting guidelines

Open ihavecoke opened this issue 1 year ago • 2 comments

Description

Refined text formatting to follow the recommendations from: https://sparanoid.com/note/chinese-copywriting-guidelines/

Motivation

This change aims to improve the readability and professionalism of the copy by following the best practices outlined in the CJK Copywriting Guidelines. Specifically, it addresses:

  • Adding spaces between English and Chinese words
  • Adding spaces between numbers and units
  • Using fullwidth punctuation for Chinese text
  • Using halfwidth Arabic numerals
  • Using halfwidth punctuation for English sentences
  • Using correct casing for proper nouns
  • Avoiding jargons and abbreviations

These adjustments will enhance the overall reading experience for both Chinese and English audiences.

Additional details

The changes are based on the guidelines provided at https://sparanoid.com/note/chinese-copywriting-guidelines/, which is a widely recognized resource for Chinese copywriting best practices.

ihavecoke avatar May 06 '24 15:05 ihavecoke

Preview URLs

Flaws (4)

URL: /en-US/docs/Web/CSS/text-decoration-skip-ink Title: text-decoration-skip-ink Flaw count: 2

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn//CSS
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn//Getting_started_with_the_web/CSS_basics

URL: /en-US/docs/Web/CSS/writing-mode Title: writing-mode Flaw count: 2

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn//CSS
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn//Getting_started_with_the_web/CSS_basics

(comment last updated: 2024-05-14 19:40:23)

github-actions[bot] avatar May 06 '24 16:05 github-actions[bot]

Thank you @yin1999 @Josh-Cena , for taking the time to review my pull request. Your suggestions were valuable and made a lot of sense. I have now made the necessary adjustments to the code based on your recommendations. Request you to review it once again. Thank you.

ihavecoke avatar May 07 '24 14:05 ihavecoke

cc @hochan222, @mfuji09 - Could you or someone from your teams please review the changes in this PR? Thank you!

dipikabh avatar May 14 '24 19:05 dipikabh

Thank you, @hochan222 and @mfuji09, for your prompt reviews and feedback!

dipikabh avatar May 15 '24 16:05 dipikabh