silnrsi / sldr

SIL Locale Data Repository
MIT License
19 stars 11 forks source link

readme for langtags #13

Closed hatton closed 4 years ago

hatton commented 5 years ago

It would be super helpful if the langtags directory contained a README file explaining what each field means, what the source of this data is, how updates are created and when, etc.

In my code, I wanted to document, precisely, what the tag is. I assume it is IETF BCP 47, but it feels sloppy to have to assume that, rather than point to some documentation.

hatton commented 5 years ago

Aha, just found some documentation under doc (unfortunate, I think; I would have found it if it were in the same directly as the data). But I did not see in that documentation the kind of thing I'm needing, so I'll leave this as a request for expansion, assuming relocation isn't likely.

mhosken commented 5 years ago

The documentation for language.json may be found in the source repo for langtags, here: https://github.com/silnrsi/langtags/blob/master/doc/langtags.md Yes that is really quirky and I'm trying to think through the question of what should go where. We may move langtags.json as a result.

GB, Martin

On Mon, 5 Aug 2019, 20:58 John Hatton, notifications@github.com wrote:

Aha, just found some documentation under doc (unfortunate, I think; I would have found it if it were in the same directly as the data). But I did not see in that documentation the kind of thing I'm needing, so I'll leave this as a request for expansion, assuming relocation isn't likely.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/silnrsi/sldr/issues/13?email_source=notifications&email_token=ABLMO3OSXYTLFKNS5PZEDI3QDAWX5A5CNFSM4IJLPHDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3R4XZY#issuecomment-518245351, or mute the thread https://github.com/notifications/unsubscribe-auth/ABLMO3KXUD3QRZ7LUDON3JTQDAWX5ANCNFSM4IJLPHDA .

hatton commented 5 years ago

Thanks Martin. From that document:

tag The canonical tag for this set. full: The full tag for this set tags: A list of other tags that are equivalent

Perhaps because this isn't my field of expertise, I need definitions that are a lot more formal. E.g. could you name standard that each field adheres to?

names: Other alternative names for this language coming from the Ethnologue names list, including alternate names and names and alternate names from other regions.

It would be helpful to state whether pejorative names included.

thanks!

mhosken commented 5 years ago

Dear John,

All the tags conform to BCP47. That's what makes them a tag (short for language tag). I agree I could unpack canonical a bit better. Basically, use the tag field for the langtag you want to output. Use the full field if you want to unpack it and use the tags list for other tags that are equivalent, but that you would not want to output.

As stated in the readme for the project, every effort is expended to ensure there are no prejorative names anywhere.

HTH, GB, Martin

On Thu, 8 Aug 2019, 21:59 John Hatton, notifications@github.com wrote:

Thanks Martin. From that document:

tag The canonical tag for this set. full: The full tag for this set tags: A list of other tags that are equivalent

Perhaps because this isn't my field of expertise, I need definitions that area lot more formal. E.g. could you name standard that each field adheres to?

names: Other alternative names for this language coming from the Ethnologue names list, including alternate names and names and alternate names from other regions.

It would be helpful to state whether pejorative names included.

thanks!

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/silnrsi/sldr/issues/13?email_source=notifications&email_token=ABLMO3NAR4YT5LHEAIB4RC3QDQYERA5CNFSM4IJLPHDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD334WZA#issuecomment-519555940, or mute the thread https://github.com/notifications/unsubscribe-auth/ABLMO3PBK7KYIJUHHO2J6OLQDQYERANCNFSM4IJLPHDA .