BookStackApp / BookStack

A platform to create documentation/wiki content built with PHP & Laravel
https://www.bookstackapp.com/
MIT License
14.41k stars 1.82k forks source link

Separate English into UK/US #2781

Open escservices opened 3 years ago

escservices commented 3 years ago

Describe the feature you'd like I think it would be helpful if there was a lang option for en_US and en_UK. So far the only spelling difference I've noticed is favourite, spelled favorite in US. But I would imagine as the platform continues to add new features there'll probably be a lot more instances of this.

Describe the benefits this feature would bring to BookStack users Users in the US wouldn't have to create themes and manually translate UK to US spelling.

Additional context Also, favorites could have totally been called Bookmarks. BookStack, bookmarks, seems like a match made in heaven :D

Thanks for making Bookstack, definitely a big fan of the platform.

escservices commented 3 years ago

Actually, just noticed that even if I wanted to create a custom theme and create a translation via the Hacking BookStack documentation, it doesn't actually change it everywhere as it appears to be hardcoded in some areas.

ssddanbrown commented 3 years ago

Hi @escservices,

I think it would be helpful if there was a lang option for en_US and en_UK. So far the only spelling difference I've noticed is favourite, spelled favorite in US. But I would imagine as the platform continues to add new features there'll probably be a lot more instances of this.

There's also color vs colour, Currently using the US spelling there. We can split these out I suppose, didn't really feel like we'd need to but if you feel passionately enough to attempt using theme overrides instead then I guess it's maybe time.

Also, favorites could have totally been called Bookmarks. BookStack, bookmarks, seems like a match made in heaven :D

Yeah, This was discussed in #2063, Works well with the theme but too much room for confusion since it's commonly used by browsers.

Actually, just noticed that even if I wanted to create a custom theme and create a translation via the Hacking BookStack documentation, it doesn't actually change it everywhere as it appears to be hardcoded in some areas.

That should not be the case, but I totally could have left some text hardcoded. The only places that I can think of that would be hardcoded are the URL terms and text within the WYSIWYG editor. The API documentation is also EN only for now. If you've found bits outside of that feel free to raise them to be made translatable.

escservices commented 3 years ago

Thanks @ssddanbrown for the quick reply! That makes sense.

There's also color vs colour, Currently using the US spelling there. We can split these out I suppose, didn't really feel like we'd need to but if you feel passionately enough to attempt using theme overrides instead then I guess it's maybe time.

That's a good one too, it's not too visible though, I believe I've only seen colors on the settings pages, maybe it's in WYSIWYG editor and I missed it. With the favourite/unfavourite on almost every page I think a few of my users will point it out and ask me to change it (currently just over 100 users at the company). It's funny how something so simple sticks out so much when you're not used to the different spelling.

If the theme override method covered more of the UI, then it would probably be fine to delay splitting them for awhile until there are more instances of language differences in the end user parts of the UI.

The only areas I've noticed that weren't affected by the theme translation was the top left section on the homepage "My Most Viewed Favourites" and under the user dropdown "My Favourites". And the url path as you've mentioned. I'm guessing the URL paths probably can't be changed, but maybe those links could be?

Thanks again!

image

image

ssddanbrown commented 3 years ago

@escservices Those strings should be overridable via theme system, although they are in a different file compared to "Favourite/Unfavourite":

https://github.com/BookStackApp/BookStack/blob/fdabafffda615fd4ec9978ac5476d22fe7744a89/resources/lang/en/entities.php#L30-L31

Yeah, Won't be able to change the spelling in URL though.

escservices commented 3 years ago

@ssddanbrown It worked! Thanks for the help, I really appreciate it!