Official PR Manual - A call for translators

[Spearhead]

The Project Reality manual is a great document for new players new to our games or old timers coming back. To make it easier for them we try to make it accessible in as many languages as possible and for this we need your help!

To make PR more accessible to those who are having a harder time with the English language we need translate the manual into more languages. If your spoken/written English is on a good level and you want to translate the manual into your native tongue, then go ahead and contact read further!

We build up our manual through GitBook. A easy to distribute and edit platform. It uses the Markdown syntax, a very easy to learn system to do formatting.

We store our manual on our GitHub. This makes it easier for community members to make their own translated versions and easier to update with each PR version.

STARTING A NEW TRANSLATION:

Beginner's knowledge of Git is helpful, but we'll try to give all necessary information here to get you started. At any stage feel free to ask questions in this thread or PM [R-DEV]Mineral.

In order for you to work on your version of the manual, you will need to create your own copy, a Git Fork. Simply go to our GitHub page and click Fork button in the top right corner.

This will now create a copy fork of our Manual on your GitHub profile for you to work on. You can also then invite other users to help you by inviting them to the fork repo.

While you can edit the files through the GitHub website directly, we recommend to do it in Gitbook editor,
Typora(decent markdown editor) or your favorite file editor (just make sure it ends up in UTF-8 format!, notepad++ is also recommended) on your computer desktop. This means you will need to get the GIT first on your pc. For this you will need to download and install Git and install your repo. Familiarize yourself with how GIT works!

Best method
Once you have your fork installed on your computer, we suggest you copy the 'en' folder and change the name to the 2 letter language code that you are translating into. Then you open this new folder and in each subfolder you will find README.md files. These are the chapters and therefore the files that will need translating.

You will also find the SUMMARY.md which is the page table. This one will also require translation of the titles. Note that there are many links (ex. {#subchapter-name}) in the files. These are used to link to chapters within the document. It's recommended not to change these names so all the links continue to work. Also don't translate and actual folder names. Also don't change any image names.

Please in the meantime let us know you are working on a translation so we can take a look and potentially help out.

(Optional)Using Gitbook Editor
Gitbook Editor is the official gitbook tool to use on your desktop. It also has GIT support so makes it much easier to work with. Once you have installed it we suggest to login with your github account. Then go to the tab Gitbook editor --> import and find the gitfolder you have. This will allow you to open this gitbook and start editing. The easiest way we find is to use the 'files' tab and translate entire files that way.

Once you want to push your changes to your git, go to the book tab and use the push and pull commands. You might have to give in your github credentials again.

Often you will have editor links or other items that you can't easily edit in the current view. Hence you might want to go to source code view by clicking on the question mark in the bottom right and turning on 'edit markdown'. This will allow you to more easily do translations.

(Optional)Using Typora
Typora is a free Markdown editor that's easy to use. So we'll assume you'll be using it for your offline translation work before you commit it to your fork on GitHub.

Simply in Typora go file--> open folder --> and open the folder with the 2 letter language code of your translation language. Then press the little circle button in the bottom left corner to get the file-list. There you will find all documents that need translating. The bottom left also has a '</>' button. This allows you to switch between the final text or the markdown sourcecode. We recommend translating in sourcecode to avoid issues with the layout. But you can always exit the source code mode to make sure it still looks fine. Image links and others won't work but don't worry about those. just leave those as they are.

Completion
Once you think your translation is completed let us know and request a pull request from your fork, this will merge your edits into our repo and makes your translation come live on the official manual page!

COMPLETED TRANSLATIONS:

• German: By Rotblut (Updated for v1.5)
• Brazilian-Portuguese: By Mordekay(Updated for v1.5)

HELP WITH IN PROGRESS TRANSLATIONS:
If you want to help with a translation make sure to contact those already started on a translation to get access to their Git fork. Or contact us and we'll help out.
You can see all current forks here.



OLD TRANSLATIONS:
Here is a list of translations of old manuals. They will all have a folder prepared on the Git to be started from. They need to updated to the new Markdown format as well be checked for changes between v1.3.1 and the current version. If you are willing to help you can do that by creating a Git Fork and editing within the language's folder. If you need any help contact [R-DEV]Mineral or post in this thread.

• French - Grey_Echo - v1.3.1 - READ HERE
• Spanish - BlackGus,Pirutoko & Others - v1.3.1 - READ HERE
• Italian - =ITW= and [EI] clans (contact BSR_Pheelz) - v1.3.1 - READ HERE
• Brazilian-Portuguese - SANGUE-RUIM - v1.3.1 READ HERE
• Hebrew - khtk1 - v1.3.1 READ HERE
• Chinese - Saga community (contact KingFish-v-) - v1.3.1 READ HERE
• Bulgarian - =BG=BladeNakamura - v1.3.1 READ HERE
• Finnish - K-Massive and Kovanaama - v1.3.1 - READ HERE
• Hungarian - IAmNotMatthew - v1.3.1 - READ HERE

[boilerrat]

Polish needs to be translated also.

[Peeta]

Ask L4gi about Finnish

[rampo]

I sure would love to help you translate finnish. if you'd need it taht is

[alberto_di_gio]

I can also be a volunteer for Turkish. Just let me know!

[daniellegraham]

i can do it for Chinese version. I have already translated the PR 0.9 CHANGELOG into Chinese in my community.
It is called =SAGA=.

[Spearhead]

Originally Posted by alberto_di_gio

I can also be a volunteer for Turkish. Just let me know!

If you want to help out I suggest you contact the person assigned to the language and ask him if he wants to team up for the task. It's easier to manage this if I have one person responsible for each language. Of course they may cooperate in any way they see fit.

[Gore]

You can also lie down and look up to heal yourself, the wrench can also repair light vehicles such as cars and trucks. These things need to be updated into the manual. I've also added some extra in the grappling hook part.

[Spearhead]

Originally Posted by GoreZiad

You can also lie down and look up to heal yourself, the wrench can also repair light vehicles such as cars and trucks. These things need to be updated into the manual. I've also added some extra in the grappling hook part.

No problem in adding that. The manual is never perfect and slight improvements are welcome as long as you say what you change or add.

[goguapsy]

I can do Portuguese, however, I need help... The manual is made in PDF right? I don't have it... at least I don't know how to use it... maybe someone can guide me to a program I can use to translate it? I'll happily do it.