What is the topic of the page?
- MediaWiki internationalisation and localisation (i18n and L10n)
Does the page fit into to a defined content type?
- It wants to be a landing page but is including tons of information that is more like a reference for developers
What information is included on the page?
- Technical aspects of MediaWiki's internationalisation and localisation (i18n and L10n) system and philosophy
- "How to get things localized": tidbits about translatewiki.net and links to Localisation overview and other guides. How to find the messages you want to localize.
- "How to stay updated about i18n stuff": link to mailing list. Seems odd at its current location.
- "Conceptual overview of language objects": structure of messages, Localisation file format
- "How to work with messages": do's and don'ts of interacting with message keys and parameters. Buried link to "VERY IMPORTANT API DOC":Manual:Messages API. "This is an important documentation page, and you should read it before you write code that uses messages." Buried link in translatewiki section to https://www.mediawiki.org/wiki/Localisation#Message_documentation
- "Understanding things from translators' POV and how to make your messages nice for them": how to document your messages and provide i18n hints (?) to help with translation. Some things are "suggested guidelines, not standard in MediaWiki development" -- which makes me wonder where is there a list of the things that *are* standard and that developers *must* do or follow? Much of the "Internationalisation hints" section reads like an unordered list of points of confusion that have arisen between the users of the translation system (translators) and developers. It sounds important to clearly articulate (within the API documentation?) how some of these code decisions / developer behaviors ultimately impact the translators -- rather than just having this large list of "hints".
- Interacting with translators (how to handle support requests on translatewiki)
- Conceptual overview of how localization works (Note: this section and below feels like what used to be the old contents of the page, and everything above is organic growth over time / cruft)
- System details about messages and caching implementation
- Reference list of "things that can be translated"
- Information about the old translation system
Who is the audience (or audiences) of the page? Is the content of the page suitable for that audience?
- MediaWiki developers who want to translate elements of MediaWiki, extensions and skins
Are there any duplicate pages or overlapping content that needs to be merged or marked as obsolete?
- The "Overview of the localisation system" should be its own doc that provides a more gentle introduction to how things work, without all of the technical / system architecture details. There may be other overviews, too; see "links" section below.
- The sections on "Message sources", "caching", "code structure" and "language objects" should be an explanatory document that has some diagrams to help developers create a mental model of the architecture.
- The sections about "Using messages" (and all the other types of actions you do with them) and how to interact with / work effectively with translators should be separate user guides, with key hints and guidelines integrated into the API documentation so that developers are more likely to see them and follow the best practices when they're writing code.
How is the page linked to related pages? What categories does the page belong to? Is it part of a clearly defined collection of pages? Check Special:PrefixIndex for subpages.
i18n template includes links to: Localisation (this page); System message; Messages API; Language; translatewiki.net; Writing systems; Directionality
TODO (more to review, but all the following docs have overlap with some of the content on the Localisation landing page):
- Important links that are somewhat buried in body text:
"How to get things localized":
- Overview of the localisation system (an introduction that is buried at the bottom of the page)
- What can be localised (a section of reference content that is linked at the top but buried at the bottom of the page)
"How to work with messages": Buried link to "VERY IMPORTANT API DOC":Manual:Messages API. "This is an important documentation page, and you should read it before you write code that uses messages." But apparently you should also read the stuff on this page because it has important tips. Are they also represented in the Messages API documentation? Let's go find out! (later). Buried link in translatewiki section to https://www.mediawiki.org/wiki/Localisation#Message_documentation
"How to stay informed about i18n stuff"
- some content at the top in the translatewiki section, more buried below in the "internationalisation" section ("These are the main places where you can find the assistance of experienced and knowledgeable people regarding i18n: The support page of translatewiki.net. The #translatewiki connect IRC channel. Please do ask there!")
To review: translatewiki:Translating:Localisation for developers. - is this yet another localisation landing page? how does its content differ from what's here?
To review: translatewiki:Translating:MediaWiki