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.

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

name versus nameMap clarification #616

Open
1 of 5 tasks
JacksonBailey opened this issue Sep 13, 2024 · 9 comments
Open
1 of 5 tasks

name versus nameMap clarification #616

JacksonBailey opened this issue Sep 13, 2024 · 9 comments
Labels
Needs primer page Need to add a page at https://www.w3.org/wiki/Activity_Streams/Primer on this topic Next version Things that should probably be resolved in a next version of AS2

Comments

@JacksonBailey
Copy link

JacksonBailey commented Sep 13, 2024

Please Indicate One:

  • Editorial
  • Question
  • Feedback
  • Blocking Issue
  • Non-Blocking Issue

Please Describe the Issue:

Activity Vocabulary Object only mentions name, but Activity Streams Object mentions both name and nameMap. The Activity Vocabulary name property shows an example where the property is named name (example 117) and one where it is named nameMap (example 118).

  1. Should the Activity Vocabulary Object specify that it has both name and nameMap instead of only name?
  2. If it is correct that Object has both of these properties, is name meant to always be xsd:string and nameMap meant to always be rdf:langString?
@evanp
Copy link
Collaborator

evanp commented Sep 13, 2024

This is somewhat confusing. When we were creating the AS2 docs, we considered nameMap to be a minor structural variation on the name property, and similarly with other *Map properties. That said, it probably would be useful to include the *Map properties in the full list of Object properties on the Vocabulary doc, and to have an entry in the Properties section for each one.

The question now is whether this rises to the level of an error, requiring an Erratum, or if this is the kind of clarification that we would do in a next version. I think this is some significant text, and probably should be part of a next version's clarifications.

@evanp evanp added Needs primer page Need to add a page at https://www.w3.org/wiki/Activity_Streams/Primer on this topic Next version Things that should probably be resolved in a next version of AS2 Needs erratum We need to add an erratum labels Sep 13, 2024
@evanp
Copy link
Collaborator

evanp commented Sep 13, 2024

@trwnh suggests that this also might be a good candidate for a Primer page, to cover the basics how to use these properties.

@evanp
Copy link
Collaborator

evanp commented Sep 13, 2024

If it is correct that Object has both of these properties, is name meant to always be xsd:string and nameMap meant to always be rdf:langString?

No, the nameMap should only be in the mapping format shown in Natural Language Values in AS2 Core.

@trwnh
Copy link

trwnh commented Sep 13, 2024

The difference between name and nameMap is that name has no @language declaration, while nameMap does have a @language declaration:

https://json-ld.org/playground/#startTab=tab-expanded&json-ld=%7B%22%40context%22%3A%22https%3A%2F%2Fwww.w3.org%2Fns%2Factivitystreams%22%2C%22name%22%3A%22Sally%22%2C%22nameMap%22%3A%7B%22und%22%3A%22Sally%22%7D%7D

From the N-Quads and Table views, you can see the difference between "Sally" and "Sally"@und


I don't think there should be both x and xMap properties on the same object, but it is probably going to be something that some producers are going to do for nonspecific compatibility reasons.

@JacksonBailey
Copy link
Author

As an aside, thank you for mentioning the primer. I did not know that exists. (And for others who may not know it exists, https://w3c.github.io/activitystreams/, https://www.w3.org/wiki/Activity_Streams/Primer)

@JacksonBailey
Copy link
Author

Relates to #486

@sebilasse
Copy link

just wanted to mention, the sentence " that name has no @language declaration" might be misleading.
If the JSON LD root has a @language ("the default language of a JSON-LD document") then this is the language of the name otherwise it has none.

From the bottom of my heart, encouraging anyone to be ActivityPub conformant and support "the entirety"-
When you consume e.g. data from news agencies or wikidata it will end up with a super-nice nameMap, summaryMap, contentMap

@evanp
Copy link
Collaborator

evanp commented Dec 20, 2024

I think this error of omission is too big to be covered by an erratum, which is usually something we do for an error of commission, that is, textual or example errors. In this case, I'm going to take off the Needs erratum tag, and leave the Needs primer and Next version. I think the best outcome would be to fully document *Map in the Vocabulary doc in the next version of the standard.

@evanp evanp removed the Needs erratum We need to add an erratum label Dec 20, 2024
@sebilasse
Copy link

sebilasse commented Dec 20, 2024

just btw; as:nameMap is mostly covered in the core specs. :
https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
ff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs primer page Need to add a page at https://www.w3.org/wiki/Activity_Streams/Primer on this topic Next version Things that should probably be resolved in a next version of AS2
Projects
None yet
Development

No branches or pull requests

4 participants