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.

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

Implement 2.01 "4. A consistent approach to multi-lingual names, descriptions and free text." #68

Closed
Bjwebb opened this Issue Apr 9, 2014 · 9 comments

Comments

Projects
None yet
3 participants

@Bjwebb Bjwebb added this to the 2.01 Iteration 1 milestone Apr 9, 2014

@bill-anderson

This comment has been minimized.

Contributor

bill-anderson commented Apr 23, 2014

NB. That http://iati.titanpad.com/72 deals with activity standard. Needs to be applied to organisation standard as well

@Bjwebb

This comment has been minimized.

Contributor

Bjwebb commented Jun 9, 2014

For anyone following this github issue who doesn't have access to the IATI Titanpads, the above link contains the list of elements that nows appears in the proposal at http://support.iatistandard.org/entries/56804973-Version-2-01-Iteration-1-4-Multi-lingual-text-fields

@Bjwebb Bjwebb changed the title from Implement 2.01 "A consistent approach to multi-lingual names, descriptions and free text." to Implement 2.01 "4. A consistent approach to multi-lingual names, descriptions and free text." Jun 11, 2014

@Bjwebb

This comment has been minimized.

Contributor

Bjwebb commented Jun 12, 2014

We created a list of elements we are removing text from, or changing the way multilingual text is done, and noted why they have an xml:lang attribute.
https://docs.google.com/spreadsheets/d/1mIcyBAkeOxUbU_EOK4vQI3uUnMIdI500TqlXVYhQtAM/edit#gid=0

We also plan to make all elements mixed="false". #112 (although what we will actually do is remove mixed="true"). This will help us enforce the requirement that most elements don't contain text directly.

This spreadsheet showed that we could make the required changes by:

Removing textAtts (from elements that do not require any text, only codes) from:

  • codeType
  • codeReqType
  • refType
  • policy-marker (NB this may need to be altered (RO option?))
  • recipient-region
  • recipient-country
  • related-activity

Adding the narrative element to elements that can have multilingual values

These elements currently reference textAtts or textType, so we can do this by...

  1. Creating a narrative element under the 'common elements' section of the common schema
  2. Removing textAtts, and adding a ref to the new narrative element:
    This involves changing a lot of
<xsd:sequence>
  <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attributeGroup ref="textAtts"/>

to

<xsd:choice minOccurs="0" maxOccurs="unbounded">
  <xsd:element ref="narrative" />
  <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>

...on these types and elements

  • textType
  • activity-date
  • reporting-org
  • participating-org
  • description
  • country-budget-items/budget-item/description
  • conditions/condition
  • sector
  • iati-organisation/name
  1. Using textType instead of textAtts:
  • contact-info/mailing-address
  1. Delete unused types/ attribute groups:
  • textAtts
  • indicatorOutcomeType [this wasn't used in 1.04... currently in activity schema at: https://github.com/IATI/IATI-Schemas/blob/version-1.04/iati-activities-schema.xsd#L1461]

Bjwebb added a commit to IATI/IATI-Standard-SSOT that referenced this issue Jun 12, 2014

@Bjwebb

This comment has been minimized.

Contributor

Bjwebb commented Jun 12, 2014

Outstanding questions/tasks:

  • policy-marker is currently planned to have text removed, but we're not sure whether this is correct, because like sector it can have a Reporting Org defined vocabulary.
  • Remove all mixed="true" #112
  • Update schema tests to support changes #120

Bjwebb added a commit that referenced this issue Jun 23, 2014

[#68] Add missing narrative elements
policy-marker/narrative
transaction/provider-org/narrative
transaction/receiver-org/narrative
transaction-date/narrative
@Bjwebb

This comment has been minimized.

Contributor

Bjwebb commented Jun 26, 2014

The following narrative elements have been added, which were missing from our previous list:

  • policy-marker/narrative
  • transaction/provider-org/narrative
  • transaction/receiver-org/narrative
  • transaction-date/narrative

@Bjwebb Bjwebb closed this Jun 26, 2014

@caprenter

This comment has been minimized.

Contributor

caprenter commented Aug 12, 2014

@bill-anderson

This comment has been minimized.

Contributor

bill-anderson commented Sep 2, 2014

@Bjwebb

This comment has been minimized.

Contributor

Bjwebb commented Sep 3, 2014

Following the change to the proposal, I have added narrative elements to all recipient-country and recipient-region elements.

BTW, @bill-anderson is transaction-date still missing from the list? It currently has a narrative subelement in the schema.

@caprenter

This comment has been minimized.

Contributor

caprenter commented Sep 9, 2014

I believe this is now complete.
transaction-date should not have had a narrative element and that has since been removed from the schema in this commit: 66e72a4

@caprenter caprenter closed this Sep 9, 2014

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