This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 4069 - Updating References for Use of xml:id
Summary: Updating References for Use of xml:id
Status: RESOLVED FIXED
Alias: None
Product: WS-Policy
Classification: Unclassified
Component: Primer (show other bugs)
Version: LC
Hardware: PC Windows XP
: P2 normal
Target Milestone: ---
Assignee: Felix Sasaki
QA Contact: Web Services Policy WG QA List
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-12-11 17:02 UTC by Monica Martin
Modified: 2007-01-03 17:23 UTC (History)
2 users (show)

See Also:


Attachments

Description Monica Martin 2006-12-11 17:02:47 UTC
Target: Primer, Framework
**Note, there was no option for only Framework and Primer on Component list.

Description and Justification:
Issue #3752 and #3560 [1] introduced and clarified the use of xml:id. However, a few more areas exist where xml:id is available for use. This should be clarified in the Framework and Primer documents. Currently, no example using xml:id exists in the Framework and its use is missing in the Primer. With the addition of xml:id, its use should be described and exemplified.

Proposal:
1. Framework, Section 4.2 Policy Identification
[amend to end of this section]

The following example illustrates how to associate a policy expression with the IRI-reference |"#P1"| using xml:id:

  (01) <wsp:Policy
         xml:id="P1"
         xmlns:wsp="http://www.w3.org/@@@@/@@/ws-policy"
         xmlns:xml="|http://www.w3.org/XML/1998/namespace|" >
  (02)   <!-- Details omitted for readability -->
  (03) </wsp:Policy>

2. Primer
Section 2.8 Referencing Policy Expressions
a. Change from:
  A policy expression may be identified by an IRI and referenced for
  re-use as a standalone policy or within another policy expression.
  There are two mechanisms to identify a policy expression: the wsu:Id
  and Name attributes. A PolicyReference element can be used to
  reference a policy expression identified using either of these
  mechanisms.

Change to:
  A policy expression may be identified by an IRI and referenced for
  re-use as a standalone policy or within another policy expression.
  There are three mechanisms to identify a policy expression: the
  wsu:Id, xml:id and Name attributes. A PolicyReference element can be
  used to reference a policy expression identified using either of
  these mechanisms.

b. Change from: Example 2-14

Change to:
[new paragraph under Example 2-14]
In the examples 2-12, 2-13, and 2-14 Contoso could have used either the xml:id or wsu:Id.

Note: There is no change to Example 2-14 or the existing paragraph that follows: The |Name| attribute is an alternate mechanism to identify a policy expression....

Section 3.2 Normal Form for Policy Expressions (now Section 3.6)
[Note: As Issue 3965 was accepted, this text would be updated in new Section 3.6, Primer.]

Change from:
  If the referenced policy expression is in the same XML document as
  the reference, then the policy expression should be identified using
  the |wsu:Id| (XML ID) attribute and referenced using an IRI
  reference to this XML ID value.

Change to:
  If the referenced policy expression is in the same XML document as
  the reference, then the policy expression should be identified using
  the |wsu:Id|xml:id (XML ID) attribute and referenced using an IRI
  reference to this XML ID value.

  Reason: This is really clean up from Issue 3752,
  http://www.w3.org/Bugs/Public/show_bug.cgi?id=3752. This is also
  consistent with text in Section 4.3.4 Policy References in the
  Framework ("This attribute references a policy expression by an IRI.
  For a policy expression within the same XML Document, the reference
  SHOULD be an IRI-reference to a policy expression identified by an
  |ID|.").

Note: No changes are proposed for Guidelines, Section 5.1 although they may be considered in the future.

References:
[1] Issues list: http://www.w3.org/Bugs/Public/show_bug.cgi?id=3752, http://www.w3.org/Bugs/Public/show_bug.cgi?id=3560
[2] Primer, Framework (5 December 2006)
http://dev.w3.org/cvsweb/~checkout~/2006/ws/policy/ws-policy-framework.html?content-type=text/html;%20charset=utf-8
http://dev.w3.org/cvsweb/~checkout~/2006/ws/policy/ws-policy-primer.html?content-type=text/html;%20charset=utf-8
Comment 1 Monica Martin 2006-12-20 22:30:52 UTC
http://www.w3.org/Bugs/Public/show_bug.cgi?id=4069 (Original issue)

UPDATED ISSUE AND PROPOSAL
Note, the updated proposal only specifies changes in the Primer.

=============
Title: Updating References for Use of xml:id
Target: Primer [1]
Description and Justification:
Issue #3752 and #3560 [2] introduced and clarified the use of xml:id. Currently, no example using xml:id exists in any WG document, with only the reference in Framework, Section 4.2 Policy Identification. The use of xml:id could be clarified and properly constrained in the Primer document.  With the addition of xml:id, its use can be described there, and account for constraints and warnings. Any changes should taken into consideration expressed WG concerns raised in the resolution of #3560. [2]

Proposal:
Section 2.8 Referencing Policy Expressions

a. Change from:
A policy expression may be identified by an IRI and referenced for
re-use as a standalone policy or within another policy expression.
There are two mechanisms to identify a policy expression: the wsu:Id
and Name attributes. A PolicyReference element can be used to
reference a policy expression identified using either of these
mechanisms.

Change to:
A policy expression may be identified by an IRI and referenced for
re-use as a standalone policy or within another policy expression.
There are three mechanisms to identify a policy expression: the
wsu:Id, xml:id and Name attributes. A PolicyReference element can be
used to reference a policy expression identified using either of
these mechanisms.

b. Change from: 
See Example 2-12

Change to:
[Add new paragraph and example under Example 2-12 at the end of the sentence: "...|(|The absolute IRI is formed by combining the document IRI, |#| and the value of the |wsu:Id| attribute.)]

In addition in Example 2-12, Contoso could have used either the xml:id or wsu:Id. An example of the use of xml:id similar to that of wsu:Id is shown in Example 2-13.

   <Policy xml:id="common">
    <mtom:OptimizedMimeSerialization wsp:Optional="true"/>
    <wsap:UsingAddressing />
   </Policy>

Conditions and constraints on the use of the |xml:id| attribute in conjunction with Canonical XML 1.0 are specified in Appendix C of xml:id Version 1.0 [XML ID <http://dev.w3.org/cvsweb/%7Echeckout%7E/2006/ws/policy/ws-policy-framework.html?content-type=text/html;%20charset=utf-8#XMLID>] and are further detailed in [C14N 1.0 Note <http://dev.w3.org/cvsweb/%7Echeckout%7E/2006/ws/policy/ws-policy-framework.html?content-type=text/html;%20charset=utf-8#C14NNOTE>]. Significant care is suggested in the use of xml:id.

[Note: This new example would necessitate the renumbering of current Examples 2-13 to 2-16 in Section 2.8 to 2-14 to 2-17. There are no changes to any other examples in this section or the text other that specified above.]

Section 3.2 Normal Form for Policy Expressions (now Section 3.6)
Change from:
If the referenced policy expression is in the same XML document as
the reference, then the policy expression should be identified using
the |wsu:Id| (XML ID) attribute and referenced using an IRI
reference to this XML ID value.

Change to:
If the referenced policy expression is in the same XML document as
the reference, then the policy expression should be identified using
the |wsu:Id|xml:id (XML ID) attribute and referenced using an IRI
reference to this XML ID value.

Reason: This is really clean up from Issue 3752,
http://www.w3.org/Bugs/Public/show_bug.cgi?id=3752. This is also
consistent with text in Section 4.3.4 Policy References in the
Framework ("This attribute references a policy expression by an IRI.
For a policy expression within the same XML Document, the reference
SHOULD be an IRI-reference to a policy expression identified by an
|ID|.").

[Note: As Issue 3965 was accepted, this text would be updated in new Section 3.6, Primer.]

Guidelines Document
No changes are proposed for Guidelines, Section 5.1 although they may be considered in the future.

References:
[1] Primer
http://dev.w3.org/cvsweb/~checkout~/2006/ws/policy/ws-policy-primer.html?content-type=text/html;%20charset=utf-8#Referencing_Policy_Expressions
[2] Issues list: http://www.w3.org/Bugs/Public/show_bug.cgi?id=3752, http://www.w3.org/Bugs/Public/show_bug.cgi?id=3560










Comment 2 Monica Martin 2007-01-03 17:23:16 UTC
Resolved 3 January 2007 as proposed (updated proposal):
http://lists.w3.org/Archives/Public/public-ws-policy/2006Dec/0081.html