Add Gls and Glspl for capitalized terms
#121
Conversation
|
Hello @killercup, I think this is a good start. If you are willing to improve on this PR, I'll be glad to help you along with it. Otherwise I'll use your commit as a starting point for the feature. I will leave a review |
|
Thanks! I'd love to help out but I'm not sure how much time I have to work on this, I mainly just needed this right now and now need to continue writing. If you want to work on this right now, don't stop :) Otherwise I can maybe pick it up over the weekend |
That's alright, I can focus on other things and leave this to you if you're willing. If not, I'll pick it up at some point. |
|
Thanks for the feedback! Had some time and I think I managed to apply all of it.
|
Key `ref` now generates `ref:pl`, `Ref`, and `Ref:pl`. This changes `__get_entry_with_key` to not panic but return `none`, so we can retry with the lowercase key. All call-sites have been updates but it's not very pretty.
killercup
force-pushed
the
feature/capitalize
branch
from
8849751 to
4a88f76
Compare
Thank you, I will take a look! It might take a while, but don't worry |
| @@ -41,6 +41,7 @@ | |||
| #let __glossary_is_empty = "glossary_is_empty" | |||
| #let __entry_has_neither_short_nor_long = "entry_has_neither_short_nor_long" | |||
| #let __make_glossary_not_called = "make_glossary_not_called" | |||
| #let __capitalize_called_with_content_type = "__capitalize_called_with_content_type" | |||
There was a problem hiding this comment.
| #let __capitalize_called_with_content_type = "__capitalize_called_with_content_type" | |
| #let __capitalize_called_with_content_type = "capitalize_called_with_content_type" |
| // | ||
| // # Panics | ||
| // If the key is not found, it will raise a `key_not_found` error | ||
| // The entry of the term or `none` |
There was a problem hiding this comment.
revert
| // The entry of the term or `none` | |
| // The entry of the term | |
| // | |
| // # Panics | |
| // If the key is not found, it will raise a `key_not_found` error |
| @@ -115,7 +125,7 @@ | |||
| if key in entries { | |||
| return entries.at(key) | |||
| } else { | |||
| panic(__error_message(key, __key_not_found)) | |||
| return none | |||
There was a problem hiding this comment.
revert
| return none | |
| panic(__error_message(key, __key_not_found)) |
| if entry == none { | ||
| panic(__error_message(key, __key_not_found)) | ||
| } |
| @@ -303,6 +335,9 @@ | |||
| // The link and the entry label | |||
| #let agls(key, suffix: none, long: none, update: true) = context { | |||
| let entry = __get_entry_with_key(here(), key) | |||
| if entry == none { | |||
| panic(__error_message(key, __key_not_found)) | |||
| } | |||
| let default-plural-suffix = "s" | ||
| let entry = __get_entry_with_key(here(), key) | ||
| if entry == none { | ||
| panic(__error_message(key, __key_not_found)) | ||
| } |
| if entry == none { | ||
| panic(__error_message(key, __key_not_found)) | ||
| } | ||
|
|
| let _key = str(key) | ||
| if __get_entry_with_key(position, _key) != none { | ||
| return gls(_key, suffix: r.citation.supplement, update: update) | ||
| } | ||
| let lower_case_key = lower(_key.first()) + _key.slice(1) | ||
| if __get_entry_with_key(position, lower_case_key) != none { | ||
| return gls(lower_case_key, suffix: r.citation.supplement, update: update, capitalize: true) | ||
| } |
There was a problem hiding this comment.
| let _key = str(key) | |
| if __get_entry_with_key(position, _key) != none { | |
| return gls(_key, suffix: r.citation.supplement, update: update) | |
| } | |
| let lower_case_key = lower(_key.first()) + _key.slice(1) | |
| if __get_entry_with_key(position, lower_case_key) != none { | |
| return gls(lower_case_key, suffix: r.citation.supplement, update: update, capitalize: true) | |
| } | |
| if is-upper(key) { | |
| // Capitalized ref | |
| return Gls(lower(key), update: update) | |
| } else { | |
| return gls(key, update: update) | |
| } |
|
|
||
| panic(__error_message(key, __key_not_found)) |
| @@ -807,6 +879,19 @@ | |||
| kind: __glossarium_figure, | |||
| supplement: "", | |||
| )[]#label(entry.key + ":pl") | |||
| // Same as above, but for capitalized form, e.g., "@Term" | |||
| #if upper(entry.key.first()) != entry.key.first() { | |||
There was a problem hiding this comment.
Use is-upper
| #if upper(entry.key.first()) != entry.key.first() { | |
| #if not is-upper(entry.key) { |
| let singular_key = str(key).slice(0, -3) | ||
| if __get_entry_with_key(position, singular_key) != none { | ||
| return glspl(singular_key, update: update) | ||
| } | ||
| let lower_case_key = lower(singular_key.first()) + singular_key.slice(1) | ||
| if __get_entry_with_key(position, lower_case_key) != none { | ||
| return glspl(lower_case_key, update: update, capitalize: true) | ||
| } |
There was a problem hiding this comment.
Define above refrule
#let is-upper(key) = upper(key).first() == key.first()| let singular_key = str(key).slice(0, -3) | |
| if __get_entry_with_key(position, singular_key) != none { | |
| return glspl(singular_key, update: update) | |
| } | |
| let lower_case_key = lower(singular_key.first()) + singular_key.slice(1) | |
| if __get_entry_with_key(position, lower_case_key) != none { | |
| return glspl(lower_case_key, update: update, capitalize: true) | |
| } | |
| if is-upper(key.slice(0, -3)) { | |
| // Capitalized ref | |
| return Glspl(lower(key).slice(0, -3), update: update) | |
| } else { | |
| return glspl(key.slice(0, -3), update: update) | |
| } |
There was a problem hiding this comment.
Thanks! I love what you've done. It works out pretty well. Just a few nitpicks. I see you were unsure about your solution for __get_entry. I think what I suggest in my comments is better overall. Feel free to take it as it is, or make changes.
I believe only a final review should be necessary to merge this @killercup!
Very simple implementation, just always uppercases the first letter.
Fixes #48