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

As an editor I want to easily insert certain common annotations into documents where appropriate, to save time #2326

Closed
goose-life opened this issue Jan 20, 2025 · 4 comments · Fixed by #2339
Assignees
Labels
proposal needed Needs a proposal or write-up
Milestone

Comments

@goose-life
Copy link
Contributor

There are certain editorial notes that a content team will use a bunch across their collection, and it's nice to keep the wording and punctuation consistent. e.g. {{*[Please note: Forms have not been reproduced; please see the original publication document as well as those of any amendments listed below.]}}

A content admin should be able to write these once with everything correct, and instruct the team on when to use what. This would cut down on the time taken to insert the notes as well as checking them.

@goose-life goose-life added the new label Jan 20, 2025
@goose-life
Copy link
Contributor Author

Proposal: Add admin-managed 'common notes' or 'quick text' per language

  • New model: CommonNote or QuickText:
    • text: CharField – the plain text of the note – including or excluding editorial note inline mark-up? square brackets?
    • language: FK
    • place? maybe not since we're doing this to keep things consistent
    • editorial note: Boolean – to opt in or out of {{*[ + ]}} being included? probably not needed for a small number of notes
  • Register it in admin so that a content admin can manage them
  • New option in the document toolbar, 'Insert > Common notes / Quick text', with a searchable dropdown, which shows notes in the document's language (and place? again, probably not)
    • When an option is selected the text is pasted wherever the cursor is, exactly the same as 'Insert > Insert annotation'

@goose-life goose-life removed the new label Jan 22, 2025
@longhotsummer longhotsummer added this to the 2025-Q1 milestone Jan 22, 2025
@longhotsummer
Copy link
Contributor

I think the text of the annotation should NOT include the {{* ... }} markup, but should include the [ ... ]. So that separates the editorial content of the note from the bluebell markup.

I don't think place is necessary. Can be added later.

The note needs a title, which will be shown in the dropdown menu.

I suggest keeping it under the "Insert > Insert annotation" menu. Include the new options at the end of that list. They're annotations, after all. That they're "quick text" shouldn't matter to the editor?

@longhotsummer longhotsummer added the proposal needed Needs a proposal or write-up label Jan 22, 2025
@goose-life
Copy link
Contributor Author

@longhotsummer this is pretty straightforward to implement, the only hiccup is the wrapping []s which are baked in at https://github.com/laws-africa/bluebell-monaco/blob/master/src/grammars.js#L38
I think I agree with you that we should separate the bluebell and the editorial markup, but we could deploy this today if we accept that they're going to be there and must be removed manually if they're not wanted (which I don't think is an issue we'll have internally at least). What do you think?

@longhotsummer
Copy link
Contributor

Ok, let's take the easy path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal needed Needs a proposal or write-up
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants