diff --git a/docs/LOOT Readme.html b/docs/LOOT Readme.html index ff4050b2..ef2c2379 100644 --- a/docs/LOOT Readme.html +++ b/docs/LOOT Readme.html @@ -311,13 +311,15 @@ Clicking on a plugin in the list will display the editing panel, where its load

Contributing To LOOT

-

User contribution of additions and corrections to LOOT's masterlists are vital to the upkeep of LOOT. Please let us know what you know! +

LOOT is very much a community project, and contributions from its users are vital to its upkeep. The best way to contribute is to make changes yourself at GitHub! It's the fastest way to get changes you want applied, and you'll get your name automatically immortalised in our credits. -

General discussion and the submission of questions, suggestions and metadata takes place in LOOT's official threads for Oblivion, Skyrim, Fallout 3 and Fallout: New Vegas. These are linked to at the bottom of LOOT's homepage. +

Otherwise, general discussion takes place in LOOT's official forum threads. These are linked to at the bottom of LOOT's homepage. + +

If you want to submit metadata, the easiest way to do so is to add the metadata to your own LOOT install (either during sorting or in the Metadata Editor), and use the Copy Metadata As Text feature to easily get it in a form that you can then edit into a masterlist on GitHub or post in the official forum threads.

Information on dirty plugins is very welcome, but for such information to be useful we require at least the filename and the CRC of the dirty plugin. The CRC may be calculated using Wrye Bash or 7-zip, with other sources being unverified as correct. In the case of 7-zip, the CRC checksum for data is the one required. In addition to the CRC, the number of records removed (the ITM count) and/or undeleted (the UDR count) are also welcome. -

If you wish to submit metadata, the easiest way to do so is to add the metadata to your own LOOT install (either during sorting or in the Metadata Editor), and use the Copy Metadata As Text feature to easily get it in a form that you can then post in the official forum threads. +

Translating LOOT

@@ -327,30 +329,18 @@ Clicking on a plugin in the list will display the editing panel, where its load
  • Masterlist messages can be translated, but translations must be submitted to the masterlist maintainers for addition.
  • The languages LOOT supports is hardcoded, so LOOT must be updated to include new translations. -

    Translations can be submitted for inclusion into LOOT in the relevant issue tracker entry, by posting it in one of LOOT's official threads (see Contributing To LOOT), or by contacting one of the LOOT team directly (see Project Members). +

    Translations are best submitted through GitHub's forking system. You will need to fork the LOOT source code repository. All file paths given below are relative to the base folder of that repository.

    To translate LOOT's installer:

      -
    1. Download the installer script. -
    2. Open the downloaded installer script in a text editor of your choice. +
    3. Open the installer script at src/installer.nsi in a text editor of your choice.
    4. The English strings are located in the section with the heading English Strings. Copy and paste this section into a new text file, and translate the quoted strings, replacing the English text. For the lines beginning VIAddVersionKey, only translate the second quoted string.
    5. Save the text file containing your translated strings.
    To translate the LOOT application:
    1. Download and install the latest version of Poedit. -
    2. Download LOOT's translation template file. -
    3. If you are updating an existing translation, download the relevant translation file for the language you're interested in: - -
    4. Open Poedit and select File->Preferences, then in the Editor tab ensure that the checkbox for the Automatically compile .mo file on save setting is checked. Click OK to close the preferences window. -
    5. If you are starting a new translation, select File->New catalogue from POT file... and choose the template file you downloaded. In the Catalog properties dialog, just click OK without changing anything. -
    6. If you are updating a previous translation, open the translation file you downloaded in Poedit, then select Catalogue->Update from POT file... and choose the template file you downloaded. Click OK in the Update summary dialog. +
    7. If you are starting a new translation, select File->New catalogue from POT file... and choose the template file at resources/l10n/template.pot. In the Catalog properties dialog, just click OK without changing anything. +
    8. If you are updating a previous translation, open in Poedit the loot.po translation file in the relevant subdirectory of resources/l10n, then select Catalogue->Update from POT file... and choose the template file you downloaded. Click OK in the Update summary dialog.
    9. Edit the translation file to add or update translations of the programs' text. Strings that were added since the last translation are displayed in bold and dark blue, and strings you have edited the translations of are marked with a star to the left of their source text in the main list.

      Some languages may use different words or phrases for different contexts where only one word or phrase may be used for all contexts in English. While no contextual information is supplied to translators by default, it can be added on request. To request the addition of contextual information to a text string, contact WrinklyNinja, quoting the structure that contains the string for which you are requesting contextual information.

      Some strings to be translated may contain special characters. Different types of special character that may be encountered are: @@ -361,12 +351,12 @@ To translate the LOOT application:

    10. Words containing an ampersand &. If a string contains a word that begins with or includes an ampersand, the string is for a menu item and the ampersand is a symbol placed before a specific letter and used to show which keyboard key can be used to select that menu item. The ampersand can be moved to be placed before a more appropriate letter in the translated text.
    11. Formatting placeholders. Placeholders are used so that LOOT can substitute text or numbers that are generated at runtime into pre-made strings. They appear as a number surrounded by percentage signs, eg. %1%. If formatting placeholders are used in the untranslated string, they must all be present in the translated string, or LOOT will crash when it tries to display the translated string. Placeholders can be moved around so that the sentence makes grammatical sense in the target language. -
    12. Save the translation file with the filename loot.po in a location of your choosing. This will also create a loot.mo file in the same location. +
    13. Save the translation file with the filename loot.po in a location of your choosing.

    Credits

    -

    LOOT is developed by a team on GitHub. An up-to-date list of team members past and present may be viewed on the project wiki. Unless otherwise noted, project members can be contacted on the Bethesda Softworks Forums or on The Nexus Forums via the private messaging system. +

    LOOT is developed by a team on GitHub, with contributions from users. A full list of GitHub contributors may be found here. An up-to-date list of team members may be viewed on the project wiki. Unless otherwise noted, team members can be contacted on the Bethesda Softworks Forums or on The Nexus Forums via the private messaging system.

    LOOT's masterlists were largely converted from BOSS's masterlists, and so credit is due to the very large number of sources and people who have contributed to them.

    In addition, the following are credited with application-related support: