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

Consolidation of the draft #33

Merged
merged 6 commits into from
Aug 16, 2017
Merged

Conversation

iherman
Copy link
Member

@iherman iherman commented Aug 15, 2017

* Refer to the publishing and linking document for references (see [resolution](https://www.w3.org/publishing/groups/publ-wg/Meetings/Minutes/2017/2017-08-07-minutes#resolution3))
* Usage, in preference, of URL-s (see [resolution](https://www.w3.org/publishing/groups/publ-wg/Meetings/Minutes/2017/2017-08-14-minutes#resolution3)). This also include the incorporation (manually) of the changes in PR #31.
* Reconciling the terminology section, after taking on board PRs #28 and #17
* Incorporated the content of the [separate document](https://rawgit.com/w3c/wpub/manifest-consensus-proposal/index-manifest-proposal.html#abstract-versus-concrete-manifest) as discussed on the [meeting at 2017-08-14](https://www.w3.org/publishing/groups/publ-wg/Meetings/Minutes/2017/2017-08-14-minutes) (see [resolution](https://www.w3.org/publishing/groups/publ-wg/Meetings/Minutes/2017/2017-08-14-minutes#resolution2)). In doing so, some earlier explanations on identifiers have been removed and/or moved elsewhere, to avoid duplication.
* Refreshed the list of participants in the acknowledgement section.
@iherman
Copy link
Member Author

iherman commented Aug 15, 2017

This is just a draft consolidation. It will need lots of care from @mattgarrish !

@iherman iherman requested a review from llemeurfr August 15, 2017 11:23
@iherman
Copy link
Member Author

iherman commented Aug 15, 2017

The text can be seen rendered through proper HTML (and respec) at:

https://rawgit.com/w3c/wpub/6f47335caf1c02fb97b4be100f2f5fd366bf3c70/index.html

Copy link
Member

@rdeltour rdeltour left a comment

Choose a reason for hiding this comment

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

LGTM, with pending editorial comments (see details in the review)

index.html Outdated
<dt><dfn>URL</dfn></dt>
<dd>
<p>
In this specification, the general term URL is used as defined and used in other W3C specification like HTML&nbsp;[[html51]], and is defined by the relevant WhatWG document&nbsp;[[url]].
Copy link
Member

Choose a reason for hiding this comment

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

  • editorial comments:
    • s/is used as defined and used/is used as/
    • s/in other W3C specification/in other W3C specifications/
    • s/the relevant WhatWG document/the URL Standard from WhatWG/
  • the ref to the URL standard is normative, so it should be [[!URL]], no?
  • shouldn't we use an unversionned reference to the HTML spec? (https://www.w3.org/TR/html/).

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks. Comments on comments:

  • I have changed to "Standard from WhatWG", we shall see what the W3C publishing rules will say about this.
  • The reference to URL is in a non-normative section, hence the reference itself cannot be normative (per pubrules...)

Otherwise done.

Copy link
Member

Choose a reason for hiding this comment

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

The reference to URL is in a non-normative section, hence the reference itself cannot be normative (per pubrules...)

ah, of course :) thanks!

index.html Outdated
<p>
In this specification, the general term URL is used as defined and used in other W3C specification like HTML&nbsp;[[html51]], and is defined by the relevant WhatWG document&nbsp;[[url]].
In particular, such a URL allows for the usage of characters from Unicode following&nbsp;[[rfc3987]].
See <a href="https://www.w3.org/TR/html51/references.html#biblio-url">the note in the HTML5 document</a> for further details.
Copy link
Member

Choose a reason for hiding this comment

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

same question about using an unversionned reference

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@iherman
Copy link
Member Author

iherman commented Aug 15, 2017

Regenerated a new preview, to include the changes for @rdeltour

https://rawgit.com/w3c/wpub/816fee6c3c8ba834dd0e22adc11e380e69950cae/index.html

Copy link
Contributor

@TzviyaSiegman TzviyaSiegman left a comment

Choose a reason for hiding this comment

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

thank you. this looks good.

Copy link
Contributor

@llemeurfr llemeurfr left a comment

Choose a reason for hiding this comment

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

The WP identification still needs discussion (as all other aspects for sure), but it represents the state of the discussion.

@mattgarrish
Copy link
Member

One general comment is to try and reduce the acronymizing of the document. WP, UA, TOC might make typing easier, but they don't enhance the readability.

I also don't see adding "Web Publication" before some of the terms adds anything, and only leads to trying to shorten (A Web Publication has an address, for example, or do we intend to write somewhere about the Web Publication's Web Publication Address?)

I would argue, in fact, that the "WP" definitions (Canonical Identifier, Identifier and Address) don't belong in the terminology at all, but should be defined where they are first used, especially since canonical identifier introduces normative requirements into terminology. We're not creating these terms, only explaining their relationship to a web publication.

But these nits can all be smoothed out later.

I don't have anything to add to the substance of the PR.

@mattgarrish mattgarrish merged commit cf293a1 into master Aug 16, 2017
@mattgarrish mattgarrish deleted the consolidation-july-august-17 branch October 10, 2017 02:02
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

Successfully merging this pull request may close these issues.

5 participants