Issue Details (XML | Word | Printable)

Key: OFFICE-1809
Type: Bug Bug
Status: Applied Applied
Resolution: Fixed
Priority: Major Major
Assignee: Svante Schubert
Reporter: Robert Weir
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
OASIS Open Document Format for Office Applications (OpenDocument) TC

ISO/IEC JTC 1/SC 34 N 1078 : DEFECT REPORT NUMBER JP2-17

Created: 28/May/09 04:24 PM   Updated: 11/Nov/10 08:56 PM
Component/s: None
Affects Version/s: ODF 1.0, ODF 1.0 (second edition), ODF 1.0 Errata 02
Fix Version/s: ODF 1.0 Errata CD 5

Resolution:
8.4.3 Detective
Replace:
"The <table:detective> element has two purposes. One the one hand, it contains information about relations that exist between table cells because of formulas and that should be highlighted in the UI. On the other hand, the element contains information about cells that are highlighted currently in the UI either because of the relations mentioned above or because of error conditions."
with
"The <table:detective> element contains information about what relationships between the current cell and other cells are revealed in the presentation of the table."

8.4.4 Detective Operation
Replace:
"The <table:operation> element specifies that certain relations that exist between the cell the element is a child of and other cells should be made visible or invisible in the UI. One and the same detective operation can be applied multiple times to the same cell. In this case, the second operation is applied to the resulting cells of the first operation and so on. This means that an operation not necessarily is applied to the cell the operation is defined in, but also to other cells, and that it therefor can interact with operations defined in other cells. This especially applies to operations that make relations invisible. To get a determinate behavior, operations have an index and are applied in the order of that index. The attributes associated with the <table:operation> element are:"
with
"The <table:operation> element specifies both the type of detective operation that leads to the discovery of relationships between cells (table:name attribute) and the order which those operations are applied (table:index attribute). Once relationships between cells have been discovered, those cells are highlighted to show those relationships. The attributes associated with the <table:operation> element are:"

8.4.4 Name
Replace
"The table:name attribute specifies the name of the detective operation. Possible names are trace-dependents , remove-dependents, trace-precedents, remove-precedents and trace-errors. trace-dependents and remove-dependents displays or hides cells that use the value of the current cell in their formula. Trace-precedents and remove-precedents displays or hides cells whose value is used in the formula of the current cell. Trace-errors displays cells that cause an error while calculating the result of the current cell's formula."
with
"The table:name attribute specifies the name of a detective operation.
The defined values for the table:name attribute are:
* remove-dependents: removes highlighting from cells that use the value of the current cell in their formula.
* remove-precedents: removes highlighting from cells whose values are use in the formula of the current cell.
* trace-dependents: highlights cells that use the value of the current cell in their formula.
* trace-errors: highlights cells that cause an error while calculating the result of the current cell's formula.
* trace-precedents: highlights cells whose values are use in the formula of the current cell.
The nature of the highlighting imposed or removed from cells as the result of detective operations is implementation dependent."

Sub-Tasks  All   Open   
 Sub-Task Progress: 

 Description  « Hide
Transcribed from http://www.itscj.ipsj.or.jp/sc34/open/1078.htm

Original author: "MURATA Makoto (FAMILY Given)" <eb2m-mrt@asahi-net.or.jp>
DEFECT REPORT NUMBER JP2-17

QUALIFIER clarification required

REFERENCES IN DOCUMENT Clauses 8.4.3 thru 8.4.5

NATURE OF DEFECT In our opinion, subclauses 8.4.3 thru 8.4.5 are underspecified and incomprehensible. They do not provide enough background information or examples. Moreover, the semantics of trace-dependents, remove-dependents, trace-precedents, remove-precedents, trace-errors. trace-dependents and remove-dependents are not specified at all.

SOLUTION PROPOSED BY THE SUBMITTER


 All   Comments   Change History      Sort Order: Ascending order - Click to sort in descending order
Patrick Durusau added a comment - 06/Jul/09 01:15 PM
Even in the current text this is still confused. Detective operations are spoken of as hiding/visible cells results and yet there is also a notion those operations highlighting cells. Needs work.

Michael Brauer added a comment - 07/Jul/09 10:08 AM
Assigned to Eike.

Eike Rathke added a comment - 15/Jul/09 05:24 AM
Patrick, we had some discussion via EMail, I think this issue is resolved and a resolution can be applied.
Please assign back to me if this isn't the case and you have further questions.

Dennis Hamilton added a comment - 22/Mar/10 02:25 PM
There is no resolution provided in this JIRA issue and the Description Line "SOLUTION PROPOSED BY THE SUBMITTER" makes no sense - the defect report has no solution proposal.

This defect item covers a substantial amount of text, and the proposed repair is extensive.

I think the repair to section 8.4.3 Detective might be improved by simplifying even further:

"""
The <table:detective> element determines how relationships between the current cell and other cells are to be revealed in presentation of the table.
"""

It is possible to go farther, but that seems unnecessary for the errata. E.g.,

"""
Note: <table:detective> elements are useful for presenting the dependencies among cells on which calculated results and propogated errors are based.
"""

The substantial changes made to 8.4.4 might benefit from similar simplification.

I suppose, after being clear how the element is interpreted we will then end up saying that the actual behavior that results is definitely implementation-dependent.


Dennis Hamilton added a comment - 22/Mar/10 05:14 PM - edited
I note that the defect report includes section 8.4.5 in the issue posed by the defect item.

Section 8.4.5 is not addressed in the proposed resolution in ODF 1.0 Errata CD04.

For 8.4.4, the description of the table:name attribute in the table:operation element is changed. This is a great improvement that includes elimination of the notion of something going invisible. This can be tightened a little and probably should be if this defect is re-visited to complete the coverage. [MY OVERSIGHT: I overlooked the Errata CD04 treatment of 8.4.4 Detective Operation, the top-level paragraph. The changed form remains obscure, relying on some undiscribed discovery process, detective operations and unnamed relationships. Furthermore, the role of the table:index, if any, in reconciling collisions with detective "operations" on other involved cells is now removed.]

I suspect there are defect-report concerns that remain to be addressed in sections 8.4.3-8.4.5.

Svante Schubert added a comment - 18/May/10 10:37 AM - edited
Dennis,
I have added the resolution to the JIRA issue, after having reviewing it again due to your comments.
I assume 8.4.5 was named in the report as it refered to the previous hard readable explanation and was therefore related. As the previous text becomes much more clearer after the fix, I believe 8.4.5 do not need a fix itself. From my point of view it is easier understandable now.

Frankly speaking, the other concerns you mention are hard to follow. You could help me understanding your concerns, if you suggest a wording to fix the problem you still see (as you did successfully several times before).

Thanks,
Svante

Eike Rathke added a comment - 18/May/10 02:49 PM
Regarding 8.4.3 Detective
"The <table:detective> element determines how relationships between the current cell and other cells are to be revealed in presentation of the table."
versus
"The <table:detective> element contains information that is used by an UI to determine the highlighting of relationships between cells or cells that are highlighted due to error conditions."

The element does not determine how the relationships are to be presented, e.g. an implementation may use arrows or colors or a dialog or something different. A possible change, if needed, could be
"
The <table:detective> element contains information about the highlighting of relationships between the current cell and other cells or error conditions.
Note: <table:detective> elements are useful for presenting the dependencies among cells on which calculated results and propagated errors are based.
"

Regarding 8.4.4 Detective Operation:
I don't think that can be tightened further. We'd have to ask Patrick why he removed the description of the recursive nature of the discovery process. I think that should had gone into a note instead, e.g. "Note: The same detective operation can be applied multiple times ...". This may also be useful for v1.2-part1.

Regarding 8.4.5 Highlighted Range, I second Svante's opinion that the current text is sufficient.

Dennis Hamilton added a comment - 18/May/10 04:02 PM
[I finally figured out what "SOLUTION PROPOSED BY THE SUBMITTER." It is not a statement, but a title, and it is inclued whether there is any following material or not.]

Eike, I agree it may be valuble to abstract further.

"The <table:detective> element determines how relationships between the current cell and other cells are to be revealed in presentation of the table."

Perhaps

"The <table:detective> element portrays relationships between the current cell and other cells in a manner that may be useful in presenting a visualization of those interdependencies among the cells."

 - - - - -
PS: I also wonder whether there needs to be something said about what this is in terms of a producer and whether, if present, it SHALL represent those relationships as they apply to the document at the point it was produced. I can't imagine that we have anything to say about a transient document and its presentation that is being manipulated by a consumer-producer and has not yet been made persistent in its latest state.

Svante,

I am not sure what part doesn't make sense. I will wait to see your improvement and will then comment further as appropriate.

Svante Schubert added a comment - 19/May/10 08:49 AM
@Dennis:
Eike and I worked out an answer on this we changed the resolution for <table:detective> to:
"The <table:detective> element contains information about what relationships between the current cell and other cells are revealed in the presentation of the table."

We dropped error conditions in the wording as they are only a special type of relationship and therefore redundant.
Take over your presentation wording, but do not use your suggested:
"The <table:detective> element determines how relationships..."
As the element is not explaining HOW the relationships are being shown, but only WHAT relationships are shown.

Your thoughts on SHALL are not applicable for an errata, but IMHO could be reconsidered for ODF NEXT.

Thanks for your help,
Svante

Dennis Hamilton added a comment - 11/Nov/10 07:05 PM - edited
Errata 02 - ODF 1.2 Reconciliation.

For <table:detective> ODF 1.2 has some useful improvements but still references UI behavior. Reconciliation of that aspect is called for.

For <table:operation> the ODF 1.2 definition can be harmonized with Errata 02 in an useful way.

The <table:highlighted-range> element was also questioned in the original defect report, but that was neglected in Errata 02. Seeing them togetther in ODF 1.2 makes it clear that the relationship needs to be drawn a little more closely, perhaps related to the Errata 02 handling of table:name as well.

Finally, Errata 02 and ODF 1.2 are already reconciled in the definition of the values of the <table:operation> table:name attribute.