ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls #3334

echeran · 2025-01-15T00:34:03Z

Add a how-to guide in the User Guide to show users how to try out MF 2.0 final candidate using the implementations in ICU (C++ and Java)

Checklist

Required: Issue filed: ICU-22921
Required: The PR title must be prefixed with a JIRA Issue number. Example: "ICU-1234 Fix xyz"
Required: Each commit message must be prefixed with a JIRA Issue number. Example: "ICU-1234 Fix xyz"
Issue accepted (done by Technical Committee after discussion)
Tests included, if applicable
API docs and/or User Guide docs changed or added, if applicable

echeran · 2025-01-15T00:47:00Z

Page preview in personal fork GH Pages site: https://echeran.github.io/icu/userguide/format_parse/messages/try-mf2.html

aphillips · 2025-01-15T19:01:26Z

docs/userguide/format_parse/messages/try-mf2.md

+       UParseError parseError;
+
+       icu::Calendar* cal(Calendar::createInstance(errorCode));
+       cal->set(2025, Calendar::JANUARY, 28);


The text on line 112 says the message will say "January 13", but this sets the calendar to the 28th???

Thanks, updated (created suggestion in my review)

aphillips · 2025-01-15T19:02:07Z

@mihnita Note that the same bug is in the Java instructions. The calendar is set to 2025, 0, 28 but the message supposedly rendered is for the 13th. Also, the imports should mention Calendar, not Date. What am I missing?

docs/userguide/format_parse/messages/try-mf2.md

mihnita · 2025-01-15T18:41:06Z

docs/userguide/format_parse/messages/try-mf2.md

+
+---
+
+# Hello `MessageFormat2`


Some style guides seem to prefer one single heading 1 in the whole document, as "the title of the page"

I don't feel strongly about that.

But in this case, looking at the rendered page that you shared, is this bringing anything extra?

What we have is basically:

Trying MF 2.0 Final Candidate

{TOC}

Hello MessageFormat2

Suggestion: just remove this heading

mihnita · 2025-01-15T18:46:03Z

docs/userguide/format_parse/messages/try-mf2.md

+    # end
+    ```
+
+1. This will output


I don't think this is a separate bullet.
Feels like a part of "Build your application and run it"

mihnita · 2025-01-15T18:47:06Z

docs/userguide/format_parse/messages/try-mf2.md

+
+    ```cmd
+    git clone https://github.com/unicode-org/icu.git
+


nitpick: remove trailing spaces

mihnita · 2025-01-15T18:47:16Z

docs/userguide/format_parse/messages/try-mf2.md

+    cd icu\icu4c
+    msbuild source/allinone/allinone.sln /p:Configuration=Release /p:Platform=x64 /p:SkipUWP=true
+    cd ..\..
+


nitpick: remove trailing spaces

docs/userguide/format_parse/messages/try-mf2.md

mihnita · 2025-01-15T19:22:35Z

docs/userguide/format_parse/messages/try-mf2.md

+       UParseError parseError;
+
+       icu::Calendar* cal(Calendar::createInstance(errorCode));
+       cal->set(2025, Calendar::JANUARY, 28);


Thanks, updated (created suggestion in my review)

docs/userguide/format_parse/messages/try-mf2.md

mihnita · 2025-01-15T19:38:28Z

@mihnita Note that the same bug is in the Java instructions. The calendar is set to 2025, 0, 28 but the message supposedly rendered is for the 13th. Also, the imports should mention Calendar, not Date. What am I missing?

Thank you for the catch!

I've updated the real code, but missed updating the .md
Suggested it in my review.

macchiati

It seems like:

We want a TOC, so that people can just jump to the case they are interested in, instead of scanning.
Instead of "create a minimal C++ file", can we put hello_mf2.cpp into the directory so people can just copy it? Then the instructions for all the C++ cases for that file are identical and simple.
Put the scarier cases after the simpler ones
- Move "From Visual Studio with minimal work" first under "C++ Windows with Visual Studio"

echeran · 2025-01-15T20:48:47Z

We want a TOC, so that people can just jump to the case they are interested in, instead of scanning.

Is already there.

Instead of "create a minimal C++ file", can we put hello_mf2.cpp into the directory so people can just copy it? Then the instructions for all the C++ cases for that file are identical and simple.

Put the scarier cases after the simpler ones

Move "From Visual Studio with minimal work" first under "C++ Windows with Visual Studio"

Done.

mihnita

Thank you very much!
M

macchiati · 2025-01-15T21:44:56Z

Looks like you can merge now if you squash with the right commit message. Please let me know when you do

See unicode-org#3334

jira-pull-request-webhook · 2025-01-15T21:54:35Z

Hooray! The files in the branch are the same across the force-push. 😃

~ Your Friendly Jira-GitHub PR Checker Bot

macchiati · 2025-01-15T21:58:07Z

I see the following message in the (failing) copyright scan. Is that due to a missing copyright in the .cpp file?

Run perl tools/scripts/cpysearch/cpyscan.pl
  perl tools/scripts/cpysearch/cpyscan.pl
  shell: /usr/bin/bash -e {0}
  env:
    SHARED_MVN_ARGS: --show-version --no-transfer-progress
Above files did not contain the correct copyright notice. at tools/scripts/cpysearch/cpyscan.pl line 54.
docs/userguide/format_parse/messages/hello_mf[2](https://github.com/unicode-org/icu/actions/runs/12797682110/job/35680111708?pr=3334#step:3:2).cpp
Error: Process completed with exit code 255.

See unicode-org#3334

jira-pull-request-webhook · 2025-01-15T21:58:51Z

Notice: the branch changed across the force-push!

docs/userguide/format_parse/messages/hello_mf2.cpp is different

View Diff Across Force-Push

~ Your Friendly Jira-GitHub PR Checker Bot

echeran · 2025-01-15T21:59:43Z

I see the following message in the (failing) copyright scan. Is that due to a missing copyright in the .cpp file?

Yes, indeed. Fixed now.

macchiati · 2025-01-15T22:01:48Z

🤞 on test completion

macchiati · 2025-01-15T22:05:03Z

The final landing URL will be https://unicode-org.github.io/icu/userguide/format_parse/messages/try-mf2.md, right? I'll update the blog post.

…

On Wed, Jan 15, 2025 at 2:00 PM Elango Cheran ***@***.***> wrote: I see the following message in the (failing) copyright scan. Is that due to a missing copyright in the .cpp file? Yes, indeed. Fixed now. — Reply to this email directly, view it on GitHub <#3334 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACJLEMDRT2V2G3IPJYEG7V32K3K6NAVCNFSM6AAAAABVGCBQFWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKOJUGAZDINBZGE> . You are receiving this because your review was requested.Message ID: ***@***.***>

macchiati · 2025-01-15T22:14:38Z

Just approved, so I think we are just waiting on the checks.

macchiati · 2025-01-15T22:22:51Z

I'm taking the liberty of punching the button...

macchiati · 2025-01-15T22:23:58Z

About how long do you think it is before it shows up on https://unicode-org.github.io/icu/userguide/format_parse/messages/?

echeran · 2025-01-15T22:25:31Z

About how long do you think it is before it shows up on https://unicode-org.github.io/icu/userguide/format_parse/messages/?

Should be very soon b/c the job is in progress. I'll keep a watch out.

echeran · 2025-01-15T22:34:18Z

Done! User Guide is updated. Be sure to update the URL to be this (your previous guesses had a typo somehow):
https://unicode-org.github.io/icu/userguide/format_parse/messages/try-mf2.html

macchiati · 2025-01-15T23:34:06Z

Great, thanks!

…

On Wed, Jan 15, 2025 at 2:34 PM Elango Cheran ***@***.***> wrote: Done! User Guide is updated. Be sure to update the URL to be this (your previous guesses had a typo somehow): https://unicode-org.github.io/icu/userguide/format_parse/messages/try-mf2.html — Reply to this email directly, view it on GitHub <#3334 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACJLEMBFR5GCS3TX6QE7MRL2K3PABAVCNFSM6AAAAABVGCBQFWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKOJUGA3TIOJTHA> . You are receiving this because you modified the open/close state.Message ID: ***@***.***>

echeran requested review from mihnita and macchiati January 15, 2025 00:34

echeran assigned mihnita Jan 15, 2025

macchiati previously approved these changes Jan 15, 2025

View reviewed changes

echeran dismissed macchiati’s stale review via 505f4b6 January 15, 2025 17:35

aphillips reviewed Jan 15, 2025

View reviewed changes

mihnita reviewed Jan 15, 2025

View reviewed changes

macchiati requested changes Jan 15, 2025

View reviewed changes

echeran requested a review from macchiati January 15, 2025 20:48

mihnita previously approved these changes Jan 15, 2025

View reviewed changes

macchiati previously approved these changes Jan 15, 2025

View reviewed changes

echeran added a commit to echeran/icu that referenced this pull request Jan 15, 2025

ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls

de912e2

See unicode-org#3334

echeran force-pushed the docs-try-mf2.0 branch from 535f6fd to de912e2 Compare January 15, 2025 21:54

ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls

5f26553

See unicode-org#3334

echeran dismissed stale reviews from mihnita and macchiati via 5f26553 January 15, 2025 21:58

echeran force-pushed the docs-try-mf2.0 branch from de912e2 to 5f26553 Compare January 15, 2025 21:58

macchiati approved these changes Jan 15, 2025

View reviewed changes

macchiati merged commit 2c5e021 into unicode-org:main Jan 15, 2025
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls #3334

ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls #3334

echeran commented Jan 15, 2025

echeran commented Jan 15, 2025

aphillips Jan 15, 2025

mihnita Jan 15, 2025

aphillips commented Jan 15, 2025

mihnita Jan 15, 2025

echeran Jan 15, 2025

mihnita Jan 15, 2025

echeran Jan 15, 2025

mihnita Jan 15, 2025

mihnita Jan 15, 2025

mihnita Jan 15, 2025

mihnita commented Jan 15, 2025

macchiati left a comment

echeran commented Jan 15, 2025

mihnita left a comment

macchiati commented Jan 15, 2025

jira-pull-request-webhook bot commented Jan 15, 2025

macchiati commented Jan 15, 2025

jira-pull-request-webhook bot commented Jan 15, 2025

echeran commented Jan 15, 2025

macchiati commented Jan 15, 2025

macchiati commented Jan 15, 2025 via email

macchiati commented Jan 15, 2025

macchiati commented Jan 15, 2025

macchiati commented Jan 15, 2025

echeran commented Jan 15, 2025

echeran commented Jan 15, 2025

macchiati commented Jan 15, 2025 via email

ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls #3334

ICU-22921 Add howto guide to try MF 2.0 final candidate draft impls #3334

Conversation

echeran commented Jan 15, 2025

Checklist

echeran commented Jan 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aphillips commented Jan 15, 2025

Choose a reason for hiding this comment

Trying MF 2.0 Final Candidate

Hello MessageFormat2

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mihnita commented Jan 15, 2025

macchiati left a comment

Choose a reason for hiding this comment

echeran commented Jan 15, 2025

mihnita left a comment

Choose a reason for hiding this comment

macchiati commented Jan 15, 2025

jira-pull-request-webhook bot commented Jan 15, 2025

macchiati commented Jan 15, 2025

jira-pull-request-webhook bot commented Jan 15, 2025

echeran commented Jan 15, 2025

macchiati commented Jan 15, 2025

macchiati commented Jan 15, 2025 via email

macchiati commented Jan 15, 2025

macchiati commented Jan 15, 2025

macchiati commented Jan 15, 2025

echeran commented Jan 15, 2025

echeran commented Jan 15, 2025

macchiati commented Jan 15, 2025 via email