Re: BP 8 - change update

Yves Savourel wrote:
> Hi all,
>
> During today's teleconf we discussed BP8, and we came up with some changes. When I started to implement them I realize that they
> don't seem right.
>
> We had:
>
> "Make sure the attributes its:locNote, its:locNoteType, as well as its:locNoteRef are available in your DTD or schema.
> Make also sure that the its:rules element is available somewhere in your documents, for example in the header part if there is one."
>
> We decided we could change to:
>
> "Make sure the attributes its:locNote, its:locNoteType, as well as its:locNoteRef are available in your DTD or schema.
> Make also sure that the its:rules element is available in your document or a separate file, for example in the header part if there
> is one."
>
> The idea was that its:rules can be outside the host document, and fill the same role. But I think we don't have the right wording
> for the audience of that BP (the developers)
>
>
> === First I think the first sentence needs to be more precise
>
> "Make sure the attributes its:locNote, its:locNoteType, as well as its:locNoteRef are available in your DTD or schema." I would use
> 'defined' instead of 'available':
>
> "Make sure the attributes its:locNote, its:locNoteType, as well as its:locNoteRef are defined in your DTD or schema."
>
>
> === Then for its:rules:
>
> "Make also sure that the its:rules element is available in your document or a separate file, for example in the header part if there
> is one."
>
> The developer of the schema (the audience here) cannot do anything about having an external its:rule in a separate file. He/she can
> only make sure it's defined in the schema so it can be used in the document.
>
> This said, as Christian noted, the its:rules can also be a separate file. To me it means having its:rules define in the schema is
> less important than the local locnote markup (since the author as a way to stll use it). We could mark than by different wording.
> Maybe something like this (all sentences):
>
> ---------------------------------
>
> "How to do this
>
> Make sure the attributes its:locNote, its:locNoteType, as well as its:locNoteRef are defined in your DTD or schema.
>
> It is also recommended to define the its:rules element in your DTD or schema, for example in a header if there is one. The its:rules
> element provides access to the its:locNoteRule element which can be used to specify localization-related notes and instruction at a
> more general level. The its:locNoteRule element also allows for specifying existing comments in an XML document via the
> locNotePointer attribute, or providing an existing reference to comments via the locNoteRefPointer attribute.
>
> Note: its:rules can be created in a separate file, but it is more efficient to allow the authors to include the rules directly into
> their documents.
>
> ----------------------------------
>
> What do you think?
>   

+1

Felix

Received on Wednesday, 27 June 2007 17:09:58 UTC