-
Notifications
You must be signed in to change notification settings - Fork 0
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
Encoding Requirement Classes in Metanorma #2
Comments
No, although the documentation may not explain this well enough. "Target type" and "Dependency" in OGC requirement tables are not embedded requirements, they are requirement attributes, encoded with distinct attributes.
We clearly do need rendered examples of the OGC requirements in metanorma.org, to make this clear. |
@opoudjis, another question, for cases like this:
I'm doing this:
Is that ok? |
Another example:
I'm doing:
|
Another question: how would I encode Conformance Class blocks?
UPDATE Ok, now I know that I have to set
But how to encode the "Requirements class" part? |
Also, in regard to Abstract test blocks, I'm passing from this:
to this:
Is it ok to set Test Purpose, Requirement and Test Method as labels? |
Ok. I am going to describe here what I have implemented for rendering. If there is new stuff in the spec you are encoding that I have not implemented, it is because I have not seen it or been asked to implement it until now, and I am not going to implement open-ended requirement encodings: if OGC want to see these, they must provide us with a more comprehensive descriptions of requirements that encompass them. Which means, the answer for some of your questions is going to be, I don't know, we have not covered that yet, and that requires further input from OGC. A recommendation under OGC is rendered as follows:
|
So:
No. Whatever the "A" is doing there, it is not a label. The label spans across two columns.
But I have no idea what the "A" is supposed to be, and put there, it will not do anything useful. A nested requirement as you have it is only going to generate the requirement identifier and the requirement label, e.g. "Permission 1-1 | A"; it will NOT generate the permission content. Nested permissions are only intended for summary representation of permissions within a permission class. Looking at it is very clear that there is stuff in the requirements of OGC that we have never been told of, and we have never put into the gem. We do not have conditions as a distinct component (though it might be equivalent to verification), and we do not have any notion of requirement clauses being labelled with letters (if that's what's going on). The formatting distinction being made between
and
where the first does not have a separate row and the second does, appears utterly random. Metanorma does not do random. If this differentiation is to be preserved in Metanorma, someone is going to need to explain it to me. |
The type is just "class". Because it is a requirement, Metanorma will fill in the information that it is a Requirement Class on rendering. |
No. What these should be is:
And I cannot entertain a major refactor of how we process requirements right now, with my workload. I am certainly not going to entertain it without a specification from OGC of a controlled vocabulary of requirement components; and "Requirement", as a cross-reference to an existing requirement, is something I have not seen before either. |
@opoudjis, there are cases where the word "conditions" appears:
Not a label as well? |
Conditions, like test method and test purpose, are subcomponents of a requirement, which we have not seen before, and therefore will not recognise. I am trying to work out what a general solution looks like. |
What do you mean that the type is just "class"? Should I replace "conformanceclass" by "class" or do you refer to a nested block? |
The types we recognise are:
Requirement Class, Permission Class and Recommendation Class are all just "class" as far as we are concerned. conformanceclass is distinct from class. |
Ok, but clearly we are in a conformanceclass case, right? Here's another example:
I mean, the text "Conformance Class" is present as header. |
Oh, now I understand. We do not support that either. |
Manuel is going to keep tracking instances we don't cover here. The outcome of discussions here, and under opengeospatial#239, is that we will extend the coverage of requirements under OGC:
|
@opoudjis For example in: https://raw.githubusercontent.com/metanorma/ogcapi-processes/master/core/abstract_tests/core/ATS_job-results-success-async-document.adoc In my opinion, both the NOTE block and the table below of it should be inside the first table (or Abstract Test block). |
In addition, there are cases where a table (an Schema and Tests table) is added below the Abstract Test block. I'm not sure if this table should be part of the Abstract Test block. |
Ok, hopefully those were the last particular cases that (I think) we don't support. |
Remaining tasks:
|
Remaining tasks:
|
Deferring validation to metanorma/metanorma-ogc#242 |
@opoudjis , I've recently made an adjustment in all cases of this kind and @manuel489 told me that you've previously agreed on applying markup in accordance to this comment of yours.
This is in regard to PR opengeospatial#254. |
In relation to #1
I'm not sure how I should encode this Requirement Class in Metanorma:
Taking into account the documentation, maybe it should be something like this?
The text was updated successfully, but these errors were encountered: