IES4 icon indicating copy to clipboard operation
IES4 copied to clipboard

V4.3.0 rc1 model changes

Open afizzycola opened this issue 1 year ago • 7 comments

In order to make it easier to see the deltas between the v4.2 RDF and the proposed v4.3 changes, I have modified the .n3 file named Information Exchange Standard r4.2.0.n3. Once these changes have been reviewed and approved we will rename this file to ies4.n3 so that future changes are easily applied and reviewed against a single file which does not require renaming for each version bump.

NOTE: There are a bunch of breaking changes made in this version which we think impact the community in a minor way. Please review these with care and shout if there is something that impacts you severely.

afizzycola avatar Aug 23 '24 14:08 afizzycola

Minor request - could you split out the changelog from ies.md - I found it surprisingly painful just to find the list of changes for 4.3. and the user has to read through all prior changes before getting to the actual IES content.

Using a CHANGELOG.md would align with common practice - particularly if you could also reverse order so most recent update is at the top of the file.

je84315 avatar Aug 27 '24 12:08 je84315

Noticed a powertype relation which is the wrong way: ies:ClassOfMeasureValue ies:powertype ies:MeasureValue . Should be ies:MeasureValue ies:powertype ies:ClassOfMeasureValue .

afizzycola avatar Aug 27 '24 13:08 afizzycola

ies:pluriverse missing from RDF

afizzycola avatar Aug 29 '24 09:08 afizzycola

ies:pluriverse missing from RDF

addressed in https://github.com/dstl/IES4/pull/9/commits/6d45e93a7c1c6012c92f1dd59e67d83e6776c157

afizzycola avatar Sep 02 '24 09:09 afizzycola

Noticed a powertype relation which is the wrong way: ies:ClassOfMeasureValue ies:powertype ies:MeasureValue . Should be ies:MeasureValue ies:powertype ies:ClassOfMeasureValue .

Fixed in https://github.com/dstl/IES4/pull/9/commits/0a2243cf35363041f8523273663e28f00d822b23

afizzycola avatar Sep 02 '24 12:09 afizzycola

Minor request - could you split out the changelog from ies.md - I found it surprisingly painful just to find the list of changes for 4.3. and the user has to read through all prior changes before getting to the actual IES content.

Using a CHANGELOG.md would align with common practice - particularly if you could also reverse order so most recent update is at the top of the file.

This is a great idea and we probably should do this but at the moment we would have to rewrite our model to .md scripts to do this. I can bring this up with the EWG.

afizzycola avatar Sep 02 '24 12:09 afizzycola

The in-page text hyperlinks of ies.md don't resolve when viewed in github's in-browser markdown viewer (i.e. by clicking on the lists of in-doc hyperlinks in the link given). This is due to md formatting issues likely due to the markdown generator engine used to create ies.md not generating github compatible markdown.. However, these issues can be resolved. Here are the steps to do this:

  1. Change in-page links to be all lowercase and without the enclosing { and }. Ensure only three spaces before the *.

From this line do:

From this:
    * [All Events](#{D488BDAE-AAEA-4c4a-B866-ED79D154D547})
To this:
   * [All Events](#d488bdae-aaea-4c4a-b866-ed79d154d547)
  1. Change the html hyperlink tag id to be all lowercase and without the enclosing { and }.

From this line do:

From this:
### <a id="{D488BDAE-AAEA-4c4a-B866-ED79D154D547}"></a>All Events
To this:
### <a id="d488bdae-aaea-4c4a-b866-ed79d154d547"></a>All Events

I have tested this on the examples given but haven't written a script to do the changes (sorry, I've run out of time today). It's easily scriptable and would make navigating the in-page model hyperlinks in the browser so much better. A script would also allow this to be addressed every time the markdown generation is done.

ClimbingAl avatar Sep 02 '24 16:09 ClimbingAl

Heads up - you may have lost access to the repository due to some repo policy changes this end. Please let me know if this is the case and I'll get your access reinstated.

paulc-dstl avatar Dec 09 '24 14:12 paulc-dstl

The in-page text hyperlinks of ies.md don't resolve when viewed in github's in-browser markdown viewer (i.e. by clicking on the lists of in-doc hyperlinks in the link given). This is due to md formatting issues likely due to the markdown generator engine used to create ies.md not generating github compatible markdown.. However, these issues can be resolved. Here are the steps to do this:

  1. Change in-page links to be all lowercase and without the enclosing { and }. Ensure only three spaces before the *.

From this line do:

From this:
    * [All Events](#{D488BDAE-AAEA-4c4a-B866-ED79D154D547})
To this:
   * [All Events](#d488bdae-aaea-4c4a-b866-ed79d154d547)
  1. Change the html hyperlink tag id to be all lowercase and without the enclosing { and }.

From this line do:

From this:
### <a id="{D488BDAE-AAEA-4c4a-B866-ED79D154D547}"></a>All Events
To this:
### <a id="d488bdae-aaea-4c4a-b866-ed79d154d547"></a>All Events

I have tested this on the examples given but haven't written a script to do the changes (sorry, I've run out of time today). It's easily scriptable and would make navigating the in-page model hyperlinks in the browser so much better. A script would also allow this to be addressed every time the markdown generation is done.

Thanks for this @ClimbingAl, I am going to raise a separate PR related to this and update our output scripts to do as you have suggested. Thanks again

afizzycola avatar Dec 09 '24 15:12 afizzycola