Style guide

Learn how to write clear Modloader Wiki articles, add illustrations and prepare pages for translation.

Choose the right kind of page

Most wiki pages are ordinary articles. Give the page a clear title, start with a short explanation and write the content in normal wikitext. Use headings, short paragraphs, lists and code formatting where they help readers. You do not need Translate markup or a PO file for a page that will stay in one language.

For a Modloader help article, use the same metadata and category conventions as the other guide pages. Add a picture when it helps explain the topic. A simple page can still use this consistent layout without being marked for translation. Compare Dependencies to see the layout in use. Open its source view to inspect the metadata and image markup.

Use Translate when the article should be maintained in several languages. Create one English source page at its normal title, such as Style guide. Do not create separate pages such as Style guide/de. Translate creates the language versions from the marked source page.

Use the Modloader article layout

For a translated article, place <languages /> at the top. Add the ShroudForge metadata comment below it, then place the article image. Keep the short description in the metadata aligned with the first paragraph readers see.

The metadata fields are title, description, language, picture and creator. Use en-GB for an English source page. The value after picture: must exactly match the uploaded file name.

Put the article text that should be translated between <translate> and </translate>. Keep the metadata, image and category outside that block. Use [[Category:guide:Shroudforge]] for general Modloader help, or a more specific guide category when one fits, such as [[Category:Guide:Wiki]] for wiki writing and translation guides. Do not type translation markers such as <!--T:1-->. Translate creates those markers when the page is prepared.

Add an illustration

Choose a clear image that supports the article. Use a stable name such as ShroudForge-Wiki-article-id.svg. SVG works well for diagrams and icons. PNG or JPG can be used for screenshots and photos. Use images that you have permission to publish.

Upload the image through Special:Upload. Check that the upload finishes and note the exact file name. In the article metadata, use that same name after picture:. Add the image with markup such as [[File:ShroudForge-Wiki-article-id.svg|thumb|left|600px]], then preview the page to check its size and placement.

Upload the image before saving the article so you can check the file name and thumbnail. If a file with that name already exists, choose a different name rather than replacing it unexpectedly.

Prepare a page for translation

Write and review the English page first. Keep headings and paragraphs focused on one idea so each unit is easy to translate. Keep product names, file names, links and code exact. Put every heading, paragraph, list item and caption that needs translation inside the <translate> block.

After saving the source, a translation administrator can review and mark it through Special:PageTranslation. The source language should be English (United Kingdom), shown as en-GB. Enable translation of the page title so each language can have a natural title.

Once marked, the page appears as a message group in Special:Translate. Translate the article there, or export that specific group for offline translation. Do not make a hand-written German page. Do not copy message IDs from another article.

Translate online or with a PO file

For online translation, choose the article group in Special:Translate and enter the translations there.

For offline work, export the article's message group as a Gettext PO file from Special:Translate or Special:ExportTranslations. Keep its group name, language code and message contexts unchanged. Import that PO file through Special:ImportTranslations, selecting the matching page group and language. Review the import preview before confirming it. PO imports require the translate-import right.

Check translation progress on Special:MessageGroupStats. The page list at Special:SpecialPages shows the wiki tools available to your account.

Update an existing article

Edit the English source page when the instructions change. Keep its metadata, picture and category aligned with the article. After changing translatable text, ask a translation administrator to update the page's translation markers. Translate will show which existing translations need review.

Quick checklist

• Use a clear title and explain the topic in the first paragraph.
• Use the standard metadata and the guide:Shroudforge category for Modloader help articles.
• Upload an illustration first and use the exact same filename in the metadata and image markup.
• Leave Translate markup out of simple pages that will not be translated.
• For multilingual pages, keep translatable text inside the Translate block and let the extension create message IDs.
• Use the correct page group and language when importing a PO file.