unicode-org / unicodetools

home of unicodetools and https://util.unicode.org JSPs
https://util.unicode.org
Other
51 stars 39 forks source link

instructions still not clear in unicodejsps #331

Open srl295 opened 2 years ago

srl295 commented 2 years ago
  1. There's a whole 'other' section that is not comprehensible to me.

https://github.com/unicode-org/unicodetools/blob/main/docs/unicodejsps/index.md#other

  1. https://github.com/unicode-org/unicodetools/blob/main/docs/unicodejsps/index.md#addingupdating-new-properties

How would I know what new properties there are or how to add them?

markusicu commented 2 years ago
  1. https://github.com/unicode-org/unicodetools/blob/main/docs/unicodejsps/index.md#addingupdating-new-properties

How would I know what new properties there are or how to add them?

For the UCD, you could compare the last/current versions of PropertyAliases.txt, but maybe the UCD properties are the ones that go into /props/?

For other specs, we don't have properties metadata files like this. (We have some AIs for this area.)

I don't remember adding new properties this time, except for Unihan. Do the JSPs include Unihan data?

From the JSP instructions, it sounds like you may be able to "Look at http://localhost:8080/UnicodeJsps/properties.jsp, and make sure that there aren't any Z-Other props at the bottom"

srl295 commented 2 years ago

3. https://github.com/unicode-org/unicodetools/blob/main/docs/unicodejsps/index.md#addingupdating-new-properties

How would I know what new properties there are or how to add them?

For the UCD, you could compare the last/current versions of PropertyAliases.txt, but maybe the UCD properties are the ones that go into /props/?

For other specs, we don't have properties metadata files like this. (We have some AIs for this area.)

I don't remember adding new properties this time, except for Unihan. Do the JSPs include Unihan data?

From the JSP instructions, it sounds like you may be able to "Look at http://localhost:8080/UnicodeJsps/properties.jsp, and make sure that there aren't any Z-Other props at the bottom"

That's helpful! ALthough actually right now https://util.unicode.org/UnicodeJsps/properties.jsp crashes, which probably indicates a problem…

macchiati commented 2 years ago

The 'other' section is just a TODO list (badly written).

macchiati commented 2 years ago

As for the property completeness, I'll check to see that there is a unitTest that:

  1. All PropertyAliases.txt and PropertyValueAliases.txt are covered. (That could fail if GenerateEnums isn't run).
  2. All the UTS #18 properties are covered. Sadly, that isn't an easy unit test, because the list of https://unicode.org/reports/tr18/#Full_Properties is not machine-readable. So one has to copy/paste.
  3. The ICU properties are covered.
  4. Exceptions: contributory properties, deprecated / stabilized properties, ICU-specific properties,

When I check the ICU props and the Regex props, I see:

ICU:

Couldn't get property from: IDS_Triary_Operator

Regex:

Couldn't get property from: Emoji_Keycap_Sequence

Couldn't get property from: RGI_Emoji_ZWJ_Sequence

Couldn't get property from: RGI_Emoji

I'll check up on those.

markusicu commented 2 years ago

As for the property completeness, I'll check to see that there is a unitTest that: 1. All PropertyAliases.txt and PropertyValueAliases.txt are covered. (That could fail if GenerateEnums isn't run).

We already have a CI test that fails when GenerateEnums writes something other than what's in the repo.

srl295 commented 2 years ago

Steven will:

  1. [ ] change other to a link to an issue to do the TODO list
  2. [ ] clean up the doc, take out anything unclear and make it an issue
  3. [ ] pass this ticket back to @macchiati