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

Add @ident to <remarks> and <exemplum> #1713

Closed
martindholmes opened this issue Nov 18, 2017 · 13 comments
Closed

Add @ident to <remarks> and <exemplum> #1713

martindholmes opened this issue Nov 18, 2017 · 13 comments

Comments

@martindholmes
Copy link
Contributor

martindholmes commented Nov 18, 2017

Arising out of work on Stylesheets TEIC/Stylesheets#272, we need a way to identify <remarks> and <exemplum> instances so that we can process them with @mode. @ident is used for this on other elements and attributes, but there is an expectation of some kind of uniqueness there which may not be appropriate for these elements.

@sydb sydb changed the title Add @ident to <remarks> and <exemplum> Add @ident to <remarks> and <exemplum> Jan 16, 2018
@ebeshero
Copy link
Member

F2F discussion: We need some kind of identification mechanism: Should it be @ident or @xml:id or something else?

Do we want to have @mode on these, too?

@sydb
Copy link
Member

sydb commented Feb 24, 2018

Yes. (We do want <exemplum> and <remarks> to have @mode, too. The question is how should it get it — @ident and @mode are in different classes, and the membership of those classes mostly overlap.)

@ebeshero
Copy link
Member

Really, we want to add @mode and @ident.

@scstanley7
Copy link
Contributor

Implement this the same way as <valItem>

@sydb
Copy link
Member

sydb commented Feb 24, 2018

(I.e., member of att.combinable and gets @ident directly.)

@peterstadler peterstadler added this to the Guidelines 3.7.0 milestone Sep 16, 2019
@raffazizzi raffazizzi assigned raffazizzi and unassigned scstanley7 Jan 16, 2020
@raffazizzi
Copy link
Contributor

NB, unlike valItem where @ident is required, I've made it optional in order not to break all existing occurernces of <remarks>

@jamescummings
Copy link
Member

jamescummings commented Aug 22, 2020

Re-opening to question why <exemplum> did not get @ident and the other required attributes to make it identifiable in the same way as <remarks> has been? This would enable to the replacement of just one example from an elementSpec in a project ODD customisation. If it was decided that this should not be done it would be good to have a record of why.

@martindholmes
Copy link
Contributor Author

I think it got lost in the shuffle; remarks were more important because of potential issues with internationalization, and I think exemplum may just have been forgotten.

@sydb
Copy link
Member

sydb commented Aug 22, 2020

I cannot speak to <exemplum>, probably @martindholmes is right. But as to <remarks>, seems to me @ident should be required. After all, you can’t delete it if you can’t refer to it. (And yes, this means that all existing <remarks> (in Source/ and Exemplars/) will need to get an @ident assigned.)

Of course, I do not know that the Stylesheets currently know what to do with <remarks ident="duckR01" mode="delete"/> or some such. If they don’t do the right thing now, it will likely take us months to teach them.

P.S. Feel free to read “change” or “replace” instead of “delete”.

@jamescummings
Copy link
Member

jamescummings commented Aug 22, 2020

@sydb I'm less sure about whether @ident should be required generally. It might be that the TEI-C makes it required in the guidelines files but optional elsewhere. (i.e. through a schema constraint for the ODD for editing the TEI Guidelines) Forcing all projects to have an @ident on their own <remarks> seems overkill to me. (Though of course how many of them use it....)

That is less of a problem than half of this issue (remarks and exemplum) having just been not done. So re-opening for that, but if we want to tidy up ident req/opt then that could be done at the same time.

@sydb
Copy link
Member

sydb commented Aug 22, 2020

@jamescummings: I lean towards requiring them all, but agree that in the Guidelines are where it is important, and could certainly live with optional elsewhere.

And yes, getting <exemplum> into att.combinable and getting it its own @ident are the more important bits.

@ebeshero
Copy link
Member

ebeshero commented Jul 2, 2021

Presumably addressing this issue with adding <exemplum> to att.combinable would resolve #1703 , correct?

@martinascholger
Copy link
Member

Released with version 4.0.0

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

No branches or pull requests

8 participants