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

Using dictionary pairs for requirement history #710

Open
carlwilson opened this issue Sep 7, 2023 · 7 comments
Open

Using dictionary pairs for requirement history #710

carlwilson opened this issue Sep 7, 2023 · 7 comments
Assignees

Comments

@carlwilson
Copy link
Collaborator

Record the version of the specification in which a requirement was introduced. The validation developers have requested the field. Implementation could be fairly simple, again the examples have had the current XPath and Cardinality information removed see #707 :

<requirement ID="CSIP112" REQLEVEL="MUST" EXAMPLES="structMapExample2">
    <description>
        <head>Type of locator</head>
        <p xmlns="http://www.w3.org/1999/xhtml">The locator type is always used with the value "URL" from the vocabulary in the attribute.</p>
        <dl xmlns="http://www.w3.org/1999/xhtml">
            <dt>since</dt><dd>v2.1.0</dd>
        </dl>
    </description>
</requirement>
@karinbredenberg
Copy link
Contributor

The issue is going to be discussed by the DILCIS Board

@jmaferreira
Copy link

I have nothing to opose to this suggestion. Its just better documentation.

@karinbredenberg
Copy link
Contributor

The DILCIS Board have agreed to approve this suggestion on its meeting 2023-12-06.

@carlwilson
Copy link
Collaborator Author

This can go ahead then. This will need a proper pass over the specifications but @stephenmackey and I should be able to get it done for some time in Feb 2024.

@stephenmackey
Copy link

stephenmackey commented Jan 9, 2024 via email

@karinbredenberg
Copy link
Contributor

karinbredenberg commented Jan 22, 2024

The suggestion is:

  • Include the version the requirement was added with this code:
<dl xmlns="http://www.w3.org/1999/xhtml">
   <dt>since</dt><dd>v2.1.0</dd>
</dl>

Board members acknowledgment of the issue:
Tick the box in front of you name to indicate that you have looked at the suggestion.

  • Karin Bredenberg (Kommunalförbundet Sydarkivera, chair)
  • Anders Bo Nielsen (National Archives of Denmark)
  • Anja Paulič (National Archives of Slovenia)
  • Arne-Kristian Groven (National Archives of Norway)
  • Gregor Zavrsnik (Geoarh)
  • Janet Anderson (Highbury Research & Development Ltd.)
  • Maya Bangerter (Swiss Federal Archives)
  • Miguel Ferreira (KEEP Solutions)
  • Stephen Mackey (Penwern Limited)
  • Sven Schlarb (Austrian Institute of Technology)

Voting
(Decision making will be carried out on the basis of majority voting by all eligible members of the Board. In the case of a tied vote, decisions will be made at the discretion of the Chair)

Tick the box in front of you name to say yes to the suggestion.

  • Karin Bredenberg (Kommunalförbundet Sydarkivera, chair)
  • Anders Bo Nielsen (National Archives of Denmark)
  • Anja Paulič (National Archives of Slovenia)
  • Arne-Kristian Groven (National Archives of Norway)
  • Gregor Zavrsnik (Geoarh)
  • Janet Anderson (Highbury Research & Development Ltd.)
  • Maya Bangerter (Swiss Federal Archives)
  • Miguel Ferreira (KEEP Solutions)
  • Stephen Mackey (Penwern Limited)
  • Sven Schlarb (Austrian Institute of Technology)

@karinbredenberg
Copy link
Contributor

karinbredenberg commented Feb 14, 2024

7 DILCIS Board members have acknowledge the issue
7 DILCIS Board members agree with the solution

The suggestion of updated encoding of requirement addition will be part of the next release of the specifications.

Issues will be created in the relevant repositories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

5 participants