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

display of entry contents within a terminological record - differences between deployed and staging sites #208

Open
ReesePlews opened this issue Mar 27, 2024 · 30 comments
Assignees
Labels
interface_revision A revision to the interface or display - but not a bug

Comments

@ReesePlews
Copy link
Contributor

i am noticing some differences in the display of ENGLISH entry contents between both the deployed site ( https://isotc211.geolexica.org ) and the staging site ( https://www.geolexica.org/isotc211-staging/ ). i some cases both deployed and staging are incorrect. i am not sure when the deployed version became different but i would like to have them changed before we make the new release.

currently deployed site
image

staging site
image

deployed site after staging updates
image

the links after the Source Document and [SOURCE ... ] are the same. it is not a problem having both.
if there are any questions, please let me know. thank you.

@ReesePlews ReesePlews added the interface_revision A revision to the interface or display - but not a bug label Mar 27, 2024
@ReesePlews
Copy link
Contributor Author

please note this is only on the English (published) entry, not on the other languages, as they are displaying correctly.

@ronaldtse
Copy link
Member

@HassanAkbar could you please help fix this? Thanks!

@HassanAkbar
Copy link
Member

@ReesePlews This has been fixed and deployed on staging. Can you please test this and let me know if anything else needs to be done here?

@ReesePlews
Copy link
Contributor Author

@HassanAkbar thank you for working on this.

i am noticing some differences. for example in this record it seems ok:
image

but in this record it is different, the authoritative term-id (from the source standard) is appended to the content.
image

in this case, where the source reference has been modified, there is a lot of text being added to the entry:
image
in this image, at the bottom, the source reference is acceptable, but at the top of the entry i only wanted to have "Source Document" and then the link, not all of the additional text.

i am not sure why this is coming into the data. is it from column I in the spreadsheet? column I contains the source reference. there is no URL in column I so i am not sure where that is coming from.

if it takes too much time to work this out, we can remove the "SOURCE " from the top of the entry, and only keep it at the end of the entry. that would be acceptable to me at this time. please discuss with @ronaldtse . thank you

@ReesePlews
Copy link
Contributor Author

@HassanAkbar i was thinking a bit more about this issue.

i am not sure why there is a source reference at the top of the entry. lets make it easy and delete that at the top.

image

the bottom under the definition remains unchanged. thank you

@HassanAkbar
Copy link
Member

@ronaldtse The summary of issues mentioned are

  1. The clause is being appended to the source link and should be removed.
  2. The source from the top of the document should be removed.

What do you suggest?

@ronaldtse
Copy link
Member

There is a confusion here on what the "SOURCE" is. There are 2 types of sources:

  1. The standard that this term came from. This is the top "SOURCE".
  2. The language-specific register that this entry comes from. This is the "ORIGIN". E.g. "Glosario de terminos de ISO/TC211"

For English entries, there is only 1.

For other language entries, only 2.

Now we need to revisit the hierarchy of the page. At a high level we have the language-independent "concept", then under it there are language-specific "designations" or "terms".

The Concept has a SOURCE. The Designation has an ORIGIN.

Initially, there was a request to show the SOURCE at the top because it is the SOURCE of the "concept", to distinguish with the ORIGIN of the designations. For English, the ORIGIN is actually the SOURCE, that's why the English ORIGIN is identical to the Concept SOURCE.

This is the current state.

If we are talking about a future state, we should no longer have language-specific registers, so we don't need to distinguish ORIGIN anymore, because the MLGT is the origin of all Concepts and Designations.

@HassanAkbar
Copy link
Member

i am not sure why this is coming into the data. is it from column I in the spreadsheet? column I contains the source reference. there is no URL in column I so i am not sure where that is coming from.

@ReesePlews Yes this is not coming from the spreadsheet, we are fetching the url based on the reference i.e ISO 19130-1:2018, if it is valid.

@ReesePlews
Copy link
Contributor Author

regarding the comment from @ronaldtse,

There is a confusion here on what the "SOURCE" is. There are 2 types of sources:

  1. The standard that this term came from. This is the top "SOURCE".
  2. The language-specific register that this entry comes from. This is the "ORIGIN". E.g. "Glosario de terminos de ISO/TC211"

For English entries, there is only 1.

For other language entries, only 2

perhaps there are really 3 types of "source references"

a) the url link on the ISO website which is the public facing ISO identifier webpage of the document.
this is the link at the top of the entry. to the right of the Term ID. we should call this the document base source, or iso document base page.... or something.

b) the authoritative source reference for the english entry. this is shown at the end of the english terminological entry. the case with the MLGT spreadsheet, for some reason not all of the entries from "column I" have the term-number from the authoritative document. at this time we cannot worry about this. i like the link to the document base page, so that is why i suggested removing from a)

c) is the source you have working for the other languages. it can stay as is but it is not resolving correctly. i think the link is incorrect on each of them. its ok they dont link in the staging site, but it will need to be corrected when deployed.

hope this clears things up. if no, please let me know and i will prepare an image. thank you @HassanAkbar

@HassanAkbar
Copy link
Member

@ronaldtse @ReesePlews Thanks for the explanation, I now understand better what different type of sources are.

a) the url link on the ISO website which is the public facing ISO identifier webpage of the document.
this is the link at the top of the entry. to the right of the Term ID. we should call this the document base source, or iso document base page.... or something.

@ronaldtse What should this be changed to, on the site? Is there anything else that needs to be updated on the page?

c) is the source you have working for the other languages. it can stay as is but it is not resolving correctly. i think the link is incorrect on each of them. its ok they dont link in the staging site, but it will need to be corrected when deployed.

@ReesePlews I'm working on the fix and let you know once it is deployed on the staging.

@HassanAkbar
Copy link
Member

c) is the source you have working for the other languages. it can stay as is but it is not resolving correctly. i think the link is incorrect on each of them. its ok they dont link in the staging site, but it will need to be corrected when deployed

@ReesePlews this has been fixed on staging site.

@ronaldtse
Copy link
Member

@ReesePlews how about we call this the “Concept source”?

@ReesePlews
Copy link
Contributor Author

@HassanAkbar thank you for updating the link in c). i confirm that link is working well.

however, the links and format of b) are changed back to the incorrect styling format of a couple days (week?) ago.
please check this at your convenience. thank you.

@ReesePlews
Copy link
Contributor Author

@ReesePlews how about we call this the “Concept source”?

@ronaldtse not sure which one you are referring to, is it a? i am not sure if "concept source" and "authoritative source" are distinct enough to be clear for users. since we are including an active link to the iso document page in b) i did not think we needed to have it duplicated in a). would it be more clear to the user to delete a)?

@ReesePlews
Copy link
Contributor Author

@HassanAkbar

i checked the staging site ( https://geolexica-staging.github.io/concepts/2896/ ) and the math is also not working.

am i using the correct staging site link?

@HassanAkbar
Copy link
Member

@ReesePlews the latest staging link is -> https://www.geolexica.org/isotc211-staging,

( https://geolexica-staging.github.io/concepts/2896/ ) this is outdated and will not be updated.

@ReesePlews
Copy link
Contributor Author

@ronaldtse and @HassanAkbar

in the new staging site, is there any way we could remove the "(E)," from the source reference "col I" in the spreadsheet?

SOURCE: ISO/TS 19159-4:2022, (E), 3.30]

is this possible or do we need to reload the data?

@ronaldtse
Copy link
Member

@ReesePlews the spreadsheet contains over 13,000 entries with "(E)", so I'm not sure if you want to change the source spreadsheet / term repo:

image

We can certainly strip this from the SOURCE field in the parser.

@ronaldtse
Copy link
Member

I've created the task here:

@ReesePlews
Copy link
Contributor Author

thanks for commenting on this @ronaldtse. unfortunately these are from the original version of the repo and have continued to be added all the time. instead of removing from the spreadsheet and thus needing to reload, could they be removed by the parser when they are added to the entry display?

@ReesePlews
Copy link
Contributor Author

@ronaldtse a bit more thought on this...

i guess it comes down to which is easier, fixing during the display or updating the spreadsheet. i am not happy the main repo has these "(E)" notations but i have not made any action to remove them. in the future i want to remove them before the repo gets converted. since this is MLGT (a snap-shot product of the main repo) perhaps the best way is to just remove them before displaying and not go back to the spreadsheet.

@ReesePlews
Copy link
Contributor Author

@HassanAkbar thank you for updating the staging site. i notice the source in the upper area (concept area) of the entry has been removed. it looks very nice.

regarding the "(E)" in the source reference entries, i think in this PR #33 you had removed them. however i am still seeing them on the staging site today. can you check this at your convenience. thank you.

@ronaldtse
Copy link
Member

@HassanAkbar I believe you will need to run tc211-termbase once more to generate the concept YAMLs without the "(E)".

@ReesePlews
Copy link
Contributor Author

@HassanAkbar thank you for removing the "(E)" notation from the authoritative source references.

i notice however on the stating site, that the "SOURCE at the top as re-appeared" can we remove the source at the top to the right of TERM-ID? if you need an image i will prepare.

@HassanAkbar
Copy link
Member

@ronaldtse I've regenerated the concepts and deployed the new concepts to the staging site.

@ReesePlews The (E) should now be removed from the source entries.

@ronaldtse
Copy link
Member

@HassanAkbar but this should be removed?
Screenshot 2024-04-05 at 16 45 06

@ReesePlews
Copy link
Contributor Author

ReesePlews commented Apr 5, 2024

@ronaldtse @HassanAkbar yes, that SOURCE and the link in the circled should be deleted from the display.

@HassanAkbar
Copy link
Member

@ReesePlews @ronaldtse the source from the top has been removed on the staging site.

@ReesePlews
Copy link
Contributor Author

hello @HassanAkbar thank you for doing that.

in checking the stating site, ( https://www.geolexica.org/isotc211-staging/concepts/2896/ ) i confirm the link at the top has been removed, however on this URL i am still seeing the "(E)" in the authoritative source reference at the end of the entry. when you have time, can you check that again? thank you.

@ReesePlews
Copy link
Contributor Author

@HassanAkbar i can confirm that the "(E)" in the authoritative source references is now removed.

let me do more checking and i will report back here to you and @ronaldtse .
please keep the staging site active until i have finished my check.

i will report any issues here. thanks again for your work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
interface_revision A revision to the interface or display - but not a bug
Projects
None yet
Development

No branches or pull requests

3 participants