Skip to content

Conversation

@KooShnoo
Copy link

@KooShnoo KooShnoo commented Jan 10, 2026

Pull Request Checklist

Issue

https://otwarchive.atlassian.net/browse/AO3-7242

Purpose

As part of internationalization, move these four static help modals to translatable erb files:

  • who can comment on this work
  • comments moderated
  • registered users
  • work skins help

Testing Instructions

There are already full testing instructions in the Jira issue.

Credit

KooShnoo (he/him)

move static help modals to translatable erb files:
* who can comment on this work
* comments moderated
* registered users
* work skins help
@KooShnoo
Copy link
Author

oops, missed a format 😅
Is there a recommended style guide for line lengths and such?

@Bilka2 Bilka2 self-requested a review January 16, 2026 21:29
Copy link
Contributor

@Bilka2 Bilka2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this! For i18n you can find the standards in the wiki.

For coding style, we have some extra notes on the wiki and generally follow the rubocop corrections. You can run rubocop locally if you don't want to have to push to see rubocop's comments.

Comment on lines +3 to +4
<dt><%= t(".enable_all") %></dt>
<dd><%= t(".enable_all_description") %></dd>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow the same locale key format as #5530 and preferences_locale.html.erb:

Suggested change
<dt><%= t(".enable_all") %></dt>
<dd><%= t(".enable_all_description") %></dd>
<dt><%= t(".enable_all.header") %></dt>
<dd><%= t(".enable_all.description") %></dd>

(in all files for all dt/dd's here)

Comment on lines +3 to +5
<p><%= t(".description_html") %></p>

<p><%= t(".limitations_html") %></p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also do the var_bold: tag.strong ... for the bold text in these strings, similar to what you did for disable_anon_description_html

# Redirects for moved help files
get "/first_login_help", to: redirect("/help/first_login")
get "/help/comments-moderated.html", to: redirect("/help/moderated_commenting")
get "/help/registered-users.html", to: redirect("/help/restricted_works")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still a bunch of links to the old registered-users page, please update them to use link_to_help_modal with the new path instead


# Redirects for moved help files
get "/first_login_help", to: redirect("/help/first_login")
get "/help/comments-moderated.html", to: redirect("/help/moderated_commenting")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still a bunch of links to the old comments-moderated page, please update them to use link_to_help_modal with the new path instead

<dt class="skin">
<%= f.label :work_skin_id, t("works.skin.select") %>
<%= link_to_help "work-skins" %>
<%= link_to_help_modal(help_work_skins_path, t("works.skin.help_title")) %>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also convert other modals that use link_to_help "work-skins" to instead use link_to_help_modal

Comment on lines +1112 to +1114
make_skin_with_css_class_html: "%{create_a_work_skin_link} with the following content: <code>.bluetext {color: blue;}</code>"
select_skin: Select this skin when posting your work.
use_css_class_html: 'In the HTML of your text, you would then give the word this class: <code>%{code_snippet}</code>'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For both of these, please try whether you can extract the <code> from the locale file here into the view with tag.code, similar to how you did it with tag.strong for the <strong> tag

</ul>

<p>
<%= t(".refer_tutorial_faq_html", tutorial_link: link_to(t(".tutorial"), archive_faq_path("tutorial-creating-a-work-skin")), faq_link: link_to(t(".faq"), archive_faq_path("skins-and-archive-interface"))) %>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Translation prefers when the link variables/locale keys are close to what the link text is, so please adjust the tutorial and faq locale keys/variables

def restricted_commenting
end

def restricted_works
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if this was restricted_work, but it's a very weak preference

Comment on lines 637 to +642
first_login
preferences_locale
moderated_commenting
restricted_commenting
restricted_works
work_skins
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also order this alphabetically

Comment on lines +649 to +652
get "/help/comments-moderated.html", to: redirect("/help/moderated_commenting")
get "/help/registered-users.html", to: redirect("/help/restricted_works")
get "/help/who-can-comment-on-this-work.html", to: redirect("/help/restricted_commenting")
get "/help/work-skins.html", to: redirect("/help/work_skins")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could also use some ordering, alphabetical by new path

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants