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

Customise name-separator and list-separator #1927

Closed
alexreg opened this issue Sep 17, 2021 · 18 comments
Closed

Customise name-separator and list-separator #1927

alexreg opened this issue Sep 17, 2021 · 18 comments

Comments

@alexreg
Copy link

alexreg commented Sep 17, 2021

I (as do a sizeable minority, I believe) like to customise the name-separator and list-separator (using biber, e.g., --listsep='|' --namesep='|') rather then using the default and. Could this plugin perhaps add support for that?

Zotero version:
5.0.96.3

BBT version:
5.4.29

Suport log ID:
N9A7W2RU-euc

@alexreg alexreg added the export label Sep 17, 2021
@github-actions
Copy link

It looks like you did not upload an support log. The support log is important; it gives @retorquere your current BBT settings and a copy of the problematic reference as a test case so he can best replicate your problem. Without it, @retorquere is effectively blind. Support logs are useful for both analysis and for enhancement requests; in the case of export enhancements, @retorquere needs the copy of the references you have in mind.

If you did try to submit a support log, but the ID looked like D<number>, that is a Zotero debug report, which @retorquere cannot access. Please re-submit a BBT debug log by one of the methods below. BBT support log IDs end in -apse or -euc. Support logs that include sample references will end in -refs-apse or -refs-euc; these are the type @retorquere needs for export or citekey issues.

This request is much more likely than not to apply to you, too, even if you think it unlikely, and even if it does not, there's no harm in sending a debug log that turns out to be unnecessary. @retorquere will usually just end up saying "please send a debug log first". Let's just skip over the unnecesary delay this entails. Sending a debug log is very easy, depending on your situation, follow one of these procedures:

  1. If your issue relates to how BBT behaves around a specific reference(s), such as citekey generation or export, select at least one of the problematic reference(s), right-click it, and submit an BBT support log from that popup menu. If the problem is with export, please do include a sample of what you see exported, and what you expected to see exported for these references, either by pasting it in a comment here (if it is small) or attaching it as a .txt file (if it's large). These logs will have an ID that ends in -refs-apse or -refs-euc.

  2. If the issue does not relate to references and is of a more general nature, generate an support log by restarting Zotero with debugging enabled (Help -> Debug Output Logging -> Restart with logging enabled), reproducing your problem, and selecting Send Better BibTeX debug report... from the help menu.

Once done, you will see a support log ID in red. Please post that support log id in an issue comment here.

Thank you!

@retorquere
Copy link
Owner

retorquere commented Sep 17, 2021

I really need that log. It's just a few mouseclicks. I honestly don't know how I'd have the issue template or the bot phrase it more clearly without getting impolite.

@retorquere
Copy link
Owner

Out of curiosity, what do you do this instead of and?

@alexreg
Copy link
Author

alexreg commented Sep 17, 2021

@retorquere Sorry, didn't see the bit about them being needed for enhancements too, as it seemed counter-intuitive until I read your explanation. Maybe you can bold that bit of text in the first paragraph, for people like me who are liable to skim long messages (even if they're important)? :-)

I've updated my original post with the log ID now.

@alexreg
Copy link
Author

alexreg commented Sep 17, 2021

Out of curiosity, what do you do this instead of and?

@retorquere Basically for readability (in my personal opinion) and language-agnosticism.

@retorquere
Copy link
Owner

I'll get you a test build in a bit.

@retorquere
Copy link
Owner

@njbart do and's still have to be brace-protected when using these separators?

@alexreg
Copy link
Author

alexreg commented Sep 17, 2021

I'll get you a test build in a bit.

That's super, thanks.

Also, I know you addressed that question to @njbart, but I believe that there is no longer any need to brace-protect them in this case. At least, in my experience. Hopefully he can confirm though.

@njbart
Copy link
Contributor

njbart commented Sep 17, 2021

do and's still have to be brace-protected when using these separators?

Just to be sure, I checked with a test file including publisher = {Smith and Jones}, using biber --listsep='|' --namesep='|', and this does work as expected.

One thing that might cause problems further down the line, however, is that converting a bibfile containing such non-standard separators back to using the default and separators (e.g. using biber, with arguments such as biber --tool --namesep='|' --listsep='|' in.bib --output-file=out.bib) does not automatically result in the non-separator ands being wrapped in braces again.

Not sure whether anyone’s workflow will include such a step, but if so, it might be better to retain the braces.

@alexreg
Copy link
Author

alexreg commented Sep 17, 2021

@njbart I recommend submitting that as a bug on the biber repo. The maintainer is usually pretty quick to fix small things like this. :-)

retorquere added a commit that referenced this issue Sep 27, 2021
@github-actions
Copy link

🤖 this is your friendly neighborhood build bot announcing test build 5.4.29.1602 ("fixes #1927")

Install in Zotero by downloading test build 5.4.29.1602, opening the Zotero "Tools" menu, selecting "Add-ons", open the gear menu in the top right, and select "Install Add-on From File...".

@retorquere
Copy link
Owner

The options have been added as hidden preferences; search for separator.

@alexreg
Copy link
Author

alexreg commented Sep 27, 2021

Thanks very much @retorquere, that's great. It seems to work well, with one caveat: I had to redo my automatic export to get the change to take effect — simply "refreshing" the automatic export was not good enough.

Also, I noticed this minor UI issue on the Export dialog (keepUpdated, which seems to be a localisation key or something, instead of the usual description of the optioni). This just appeared with the test version.

@alexreg
Copy link
Author

alexreg commented Sep 27, 2021

Also, do I need to reinstall the main version (rather than test version) of this plugin to get updates in the future now?

@github-actions
Copy link

🤖 this is your friendly neighborhood build bot announcing test build 5.4.29.1606 ("Merge branch 'master' into gh-1927")

Install in Zotero by downloading test build 5.4.29.1606, opening the Zotero "Tools" menu, selecting "Add-ons", open the gear menu in the top right, and select "Install Add-on From File...".

@retorquere
Copy link
Owner

No, when a new version drops you'll be updated automatically.

@retorquere
Copy link
Owner

Build 1606 should fix the issue with keepUpdated and the auto-export refresh.

@alexreg
Copy link
Author

alexreg commented Sep 27, 2021

That's super, thanks.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants