Skip to content

Document language/internationalization variables and functions - #541

Merged
nonprofittechy merged 3 commits into
mainfrom
copilot/add-internationalization-documentation-page
Sep 9, 2025
Merged

Document language/internationalization variables and functions#541
nonprofittechy merged 3 commits into
mainfrom
copilot/add-internationalization-documentation-page

Conversation

Copilot AI commented Sep 9, 2025

Copy link
Copy Markdown
Contributor

This PR completes the documentation of AssemblyLine's language/internationalization system by adding comprehensive coverage of variables and functions defined in language.py and al_language.yml.

Changes Made

Added Assembly Line language system variables to magic_variables.md:

  • enable_al_language - Controls whether Assembly Line language system is active
  • al_user_default_language - Default language code when user hasn't selected one
  • al_interview_languages - List of supported language codes for the interview
  • al_user_language - Currently selected language for the user
  • al_change_language (event) - Event triggered when user switches languages

Enhanced translation.md documentation:

  • Added comprehensive section explaining the al_change_language event
  • Documented how the event works internally and when it's triggered
  • Provided example of how to add custom logic during language switches
  • Improved cross-references to the special variables page

Improved cross-references between documentation pages:

  • Added links between translation.md and magic_variables.md
  • Clear distinction between general localization variables (AL_DEFAULT_LANGUAGE) and Assembly Line-specific ones
  • Better organization of language-related documentation

Before/After

Previously, the Assembly Line language variables were only documented in the translation guide. Now they're properly categorized in the special variables reference alongside other runtime variables, making them easier to discover and understand in context.

The al_change_language event was only briefly mentioned before - now it has comprehensive documentation explaining its purpose, behavior, and how developers can extend it.

Updated Magic Variables

Al Change Language Event

All language/internationalization variables and functions from the AssemblyLine framework are now comprehensively documented with proper cross-references between related pages.

Fixes #173.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits September 9, 2025 13:49
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
Copilot AI changed the title [WIP] Add a page to document language/internationalization variables and functions we define Document language/internationalization variables and functions Sep 9, 2025
Copilot AI requested a review from nonprofittechy September 9, 2025 13:54
@nonprofittechy
nonprofittechy marked this pull request as ready for review September 9, 2025 14:02
@nonprofittechy
nonprofittechy merged commit e14eb81 into main Sep 9, 2025
2 checks passed
@nonprofittechy
nonprofittechy deleted the copilot/add-internationalization-documentation-page branch September 9, 2025 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a page to document language/internationalization variables and functions we define

2 participants