PaperCheck appears to be inconsistent with instructions

[jdswinbank]

ManuscriptInstructions.pdf tells us that we can add new \ssindex keywords at will (trying to be consistent with existing entries, and:

By the time the next ADASS conference comes around, your new entry will have been extracted from the proceedings and added to the new version of the cumulative index file

Sounds great!

Unfortunately, PaperCheck.py disagrees: it thinks I need to do something more to declare my new keywords:

---------------- Summary ----------------------------------------
Some problems were found with this paper, as follows:
Found ssindex{} entries that are not in subjectKeywords.txt/newKeywords.txt:
        not-a-useful-keyword

I'm confused as to whether I'm actually supposed to do something else before submitting my paper with this new keyword.

[bennahugo]

Thanks for the fix I will merge that with the 2021 branch - I already had to change the location, but yours look like a cleaner solution

As far as this is documented in the README it mentions to add the subjects needed - the index.py script will find existing matches

[jdswinbank]

I can't find anywhere in the readme that tells me I need to add new keywords to newKeywords.txt before make check will pass...

[bennahugo]

Hi John I think it is enough to suggest subject keywords. The editing group will add them into the vocabulary list in the final submission.

…

On Fri, 15 Oct 2021, 16:30 John Swinbank, ***@***.***> wrote: I can't find anywhere in the readme that tells me I need to add new keywords to newKeywords.txt before make check will pass... — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#9 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4RE6VH7GQ7XBYI4S5JEVLUHA3HNANCNFSM5GB5OXXA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[jdswinbank]

Hey @bennahugo — sorry for the confusion; I think I'm being unclear, and it's possible I'm misreading the instructions! Let me try to be as explicit as possible and see if that helps.

The instructions tell me:

1. I can just add new %ssindex entries to my manuscript, and (as you suggest) the editing group will sweep them into the vocabulary list for the future.
2. I should run make check before submitting my manuscript.

So the problem I'm experiencing is that if I add a new %ssindex entry then run make check, the check fails because my new entry is not found in newKeywords.txt. There seem to me to be two possibilities here:

1. This is a documentation bug: the readme, ManuscriptInstructions.pdf, etc, should explain that I need to add entries to newKeywords.txt as I add them to the LaTeX source (and presumably include newKeywords.txt in my tarball when I upload it).
2. This is a test bug: make check should not fail if an \ssindex command in LaTeX doesn't correspond to an entry in one of the text files.

I'm not sure which of the above applies — I guess that's your call — but either way it seems like a bug.

Does that make sense?!

[bennahugo]

Hi John Thanks this needs to be clarified in the documentation. If you have new keywords to add then please add them in the commented out subject words in your tex file. We will take them into consideration for the publication and add them to the running list. Please ignore the error in this case - as long as the rest of the checks pass you can proceed with submission. Thanks,

…

On Sun, 17 Oct 2021, 13:07 John Swinbank, ***@***.***> wrote: Hey @bennahugo <https://github.com/bennahugo> — sorry for the confusion; I think I'm being unclear, and it's possible I'm misreading the instructions! Let me try to be as explicit as possible and see if that helps. The instructions tell me: 1. I can just add new %ssindex entries to my manuscript, and (as you suggest) the editing group will sweep them into the vocabulary list for the future. 2. I should run make check before submitting my manuscript. So the problem I'm experiencing is that if I add a new %ssindex entry then run make check, the check fails because my new entry is not found in newKeywords.txt. There seem to me to be two possibilities here: 1. This is a documentation bug: the readme, ManuscriptInstructions.pdf, etc, should explain that I need to add entries to newKeywords.txt as I add them to the LaTeX source (and presumably include newKeywords.txt in my tarball when I upload it). 2. This is a test bug: make check should not fail if an \ssindex command in LaTeX doesn't correspond to an entry in one of the text files. I'm not sure which of the above applies — I guess that's your call — but either way it seems like a bug. Does that make sense?! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#9 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4RE6Q6KFIYJFPZSYP5VWTUHKVAFANCNFSM5GB5OXXA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.