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

Payment Request Architecture glossary should include IG glossary #23

Closed
msporny opened this issue Dec 6, 2015 · 5 comments
Closed

Payment Request Architecture glossary should include IG glossary #23

msporny opened this issue Dec 6, 2015 · 5 comments
Assignees

Comments

@msporny
Copy link
Member

msporny commented Dec 6, 2015

The Payment Request Architecture glossary should import the Web Payments IG glossary. I have included all the terms in the PRA glossary in the Web Payments IG glossary and marked them as experimental.

An example of how to do this is in the Web Payments CG's Browser API spec:

https://github.com/WICG/web-payments-browser-api/blob/5034393370c54226eb13fbdacde2462ba5e11713/index.html#L170-L177

You will also need to include a script here:

https://github.com/WICG/web-payments-browser-api/blob/5034393370c54226eb13fbdacde2462ba5e11713/index.html#L13

which can be found here:

https://github.com/WICG/web-payments-browser-api/blob/5034393370c54226eb13fbdacde2462ba5e11713/utils.js

Spec refs:
http://wicg.github.io/paymentrequest/specs/architecture.html#glossary
http://wicg.github.io/web-payments-browser-api/#terminology

@msporny
Copy link
Member Author

msporny commented Dec 6, 2015

We should also decide where the glossary goes in each spec. I propose that we put it up top, right after the introduction (other groups have found that this approach works for most readers because it cuts down on the amount of jumping around you have to do when reading a spec).

@halindrome
Copy link

PFWG has some code that limits the contents of the included glossary to
only the terms that are used. That might be handy.

On Sun, Dec 6, 2015 at 1:02 PM, Manu Sporny notifications@github.com
wrote:

We should also decide where the glossary goes in each spec. I propose that
we put it up top, right after the introduction (other groups have found
that this approach works for most readers).


Reply to this email directly or view it on GitHub
#23 (comment).

Shane McCarron
halindrome@gmail.com

@ianbjacobs
Copy link
Contributor

A document should define the terms that it needs. Before a global import, I think the editor should create a list of the words that look like they need definitions. Then we can cross-check with the IG glossary and do whatever is appropriate (e.g., import some, make changes, etc.).

However, as with the discussion on the WG call the other day, I think it makes sense to allow the WG deliverables to evolve a bit first, so that we have some feedback on the definitions as needed in those docs. We can then align IG and WG terms as needed.

@msporny
Copy link
Member Author

msporny commented Dec 7, 2015

@ianbjacobs There is no global import, the example given above only imports the words that the document uses. Editors also have the option to define something locally and use it.

From a technical perspective, I think we're covered with the variety of ways this could play out.

@msporny
Copy link
Member Author

msporny commented Mar 14, 2016

Migrated to w3c/payment-request#43

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants