Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Unique Localized Text Catalog Identification section to volume 3 #344

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Added Unique Localized Text Catalog Identification section to volume 3 #344

wants to merge 6 commits into from

Conversation

PeterKranich
Copy link
Collaborator

@PeterKranich PeterKranich commented Nov 29, 2024 •
edited
Loading

📑 Description

Added Unique Localized Text Catalog Identification section to volume 3.

Proposal is to add the text catalog id and version to the MDS/ProductionSpecification.

☑ Mandatory Tasks

The following aspects have been respected by the pull request assignee and at least one reviewer:

  • Changelog update (necessity checked and entry added or not added respectively)
    • Pull Request Assignee
    • Reviewer

@PeterKranich PeterKranich added the Volume 3 Volume 3 contents label Nov 29, 2024
@PeterKranich PeterKranich added this to the SDPi 2.0 Review milestone Nov 29, 2024
@PeterKranich PeterKranich self-assigned this Nov 29, 2024
@PeterKranich PeterKranich linked an issue Nov 29, 2024 that may be closed by this pull request
Unique identification of text catalog #256
Open
@PeterKranich
Copy link
Collaborator Author

PeterKranich commented Nov 29, 2024 •
edited
Loading

@d-gregorczyk: if you agree with my proposal, we need to define the codes for entries in the ProductionSpecification for the text catalog id and version. I have not found appropriate codes in the Rosetta DB. There are two codes which may fit for the text catalog id ... but I am not sure:

Status: Published
RefID: MDC_ATTR_LOCALIZN
Term Code: 1::2359
Context Free Code: 67895
Description/Definition:
DIM Name: Localization

Status: Published
RefID: MDC_ATTR_VMS_MDS_LOCALIZN
Term Code: 1::2470
Context Free Code: 68006
Description/Definition:
DIM Name: Mds_localization

Howerver, I didn't find anything for the text catalog version.

@ToddCooper
Copy link
Collaborator

SDPi Friday 2024.11.29 Review -

  1. @mfaughn verified that the two MDC_ codes above were in the first version of the -10101 nomenclature, but the definitions are ... thin.
  2. MDC_ATTR_VMS_MDS_TEXT_CAT (1::2472) - Annex B #defines of -10101 + in RTMMS ... but NO DEFINITION!
  3. Value: ID + version (e.g., OID/URN::OID::12345)

@PeterKranich - Propose a definition for the _TEXT_CAT term.

@ToddCooper
Copy link
Collaborator

SDPi Friday 2024.12.13 Review -

Discussion issues included:

  1. BICEPS does not have a concept of "text catalog", which should be added to this text
  2. Current content needs some editorial updates (e.g., capitalization, more detail in examples, etc.)
  3. Provide background for how this works in conjunction ("under the hood") with the LOCALIZATION SERVICE

d-gregorczyk
d-gregorczyk reviewed Dec 18, 2024
View reviewed changes
...oc/volume3/biceps-content-module/tf3-ch-8.3.2.9.8-localized-text-catalog-identification.adoc
@@ -0,0 +1,32 @@
[#vol3_clause_localized_text_catalog_identification]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In all those requirements, I do not see restrictions that help increasing or establishing interoperability. It currently boils down to "there is a code one can use in production specification to indicate use of text catalogs", however, there is no way of a general procedure as to how the use of text catalogs is globally applicable to all manufacturers. From this it follows that the requirements displayed herein have no effect of interoperability between manufacturers. Hence, I do not see a reason to craft requirements at all. We may rather sell this chapter as a good practice in case text catalogs are used.

"You are encouraged to signify the use of text catalogs by adding a production specification item to the affected MDSs"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it is more an optimization which helps the consumers when they have to manage devices which all use the same text catalog.
Where would you place recommendations? Also in Vol 3 same section?

...oc/volume3/biceps-content-module/tf3-ch-8.3.2.9.8-localized-text-catalog-identification.adoc Outdated
[#vol3_clause_localized_text_catalog_identification]
====== Unique Localized Text Catalog Identification

In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> Localization Service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> Localization Service.
In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> LOCALIZATION SERVICE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@d-gregorczyk d-gregorczyk d-gregorczyk left review comments

@ToddCooper ToddCooper Awaiting requested review from ToddCooper

At least 1 approving review is required to merge this pull request.

Assignees

@PeterKranich PeterKranich

Labels
Volume 3 Volume 3 contents
Projects
Gemini SDPi Releases
Status: No status
Milestone
SDPi 2.1 Review
Development

Successfully merging this pull request may close these issues.

Unique identification of text catalog
3 participants
@PeterKranich @ToddCooper @d-gregorczyk