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

Add sidebar to all Glossary pages #16942

Closed
4 tasks done
leon-win opened this issue Nov 13, 2023 · 1 comment · Fixed by #16943 or #16986
Closed
4 tasks done

Add sidebar to all Glossary pages #16942

leon-win opened this issue Nov 13, 2023 · 1 comment · Fixed by #16943 or #16986
Assignees
Labels
l10n-ja Issues related to Japanese content. l10n-ko Issues related to Korean content. l10n-pt-br Issues related to Brazilian Portuguese

Comments

@leon-win
Copy link
Member

leon-win commented Nov 13, 2023

What is the new suggestion?

I recently noticed that many Glossary pages were missing a sidebar with a list of terms.
Examples of pages that do not have a sidebar:
https://developer.mozilla.org/es/docs/Glossary/Abstraction
https://developer.mozilla.org/ja/docs/Glossary/Abstraction
https://developer.mozilla.org/ko/docs/Glossary/Accessible_name
https://developer.mozilla.org/pt-BR/docs/Glossary/Abstraction

I already fixed it for ru locale (#16863).
And I think it will be useful to do this in other locales:

Why is it important or useful?

Sidebar is useful for navigation in Glossary, so this change will improve user experience.

Other supporting information

Initial works was in #16848.

To add a sidebar we need to do the following on each page (using the Spanish locale as an example):

  1. add a {{GlossarySidebar}} macro at the beginning of the page
  2. remove {{MDNSidebar}} macro if present
  3. remove {{QuickLinksWithSubpages("/es/docs/Glossary")}} macro if present
  4. remove {{ListSubpagesForSidebar("/es/docs/Glossary", 1)}} macro if present
  5. replace such code blocks:
<section id="Quick_links">
 <ol>
  <li><a href="/es/docs/Glossary">Glossary</a>
   <ol>
    <li>{{Glossary("Accessibility")}}</li>
    <li>{{Glossary("ARIA")}}</li>
   </ol>
  </li>
 </ol>
</section>

with regular markup with the heading "See also":

## Véase también

- [Glosario de MDN Web Docs](/es/docs/Glossary)
  - {{Glossary("Accessibility")}}
  - {{Glossary("ARIA")}}
@yin1999 yin1999 added l10n-ja Issues related to Japanese content. l10n-ko Issues related to Korean content. l10n-pt-br Issues related to Brazilian Portuguese labels Nov 13, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 14, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
leon-win added a commit to leon-win/mdn_translated-content that referenced this issue Nov 15, 2023
josielrocha added a commit that referenced this issue Nov 19, 2023
* [pt-br]: add sidebar to Glossary index page, set short-title (#16942)

* [pt-br]: add sidebar to all Glossary pages (#16942)

* [pt-br] fix duplication {{GlossarySidebar}} macro on Glossary main page

Co-authored-by: Josiel Rocha <[email protected]>

---------

Co-authored-by: Josiel Rocha <[email protected]>
@leon-win
Copy link
Member Author

This issues has become closed, although in fact it has not yet been completed.
Perhaps this is due to the fact that I closed #16979. But I did this at the request of a @mfuji09 to break it into several parts (#17031, #17032, #17033, #17034, #17035, #17036).

Therefore, if anyone has the opportunity, please re-open this issue.

@yin1999 yin1999 reopened this Nov 20, 2023
hochan222 pushed a commit that referenced this issue Dec 11, 2023
[ko]: add sidebar to all Glossary pages (#16942)
@leon-win leon-win self-assigned this Jan 5, 2024
@leon-win leon-win closed this as completed Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
l10n-ja Issues related to Japanese content. l10n-ko Issues related to Korean content. l10n-pt-br Issues related to Brazilian Portuguese
Projects
None yet
2 participants