MISP
/
misp-book
mirror of https://github.com/MISP/misp-book
2
0
Fork 0
Code Issues Releases Wiki Activity

- More explicit examples 

- Some pointers where to get help and how to start
pull/87/head
Steve Clement 2018-01-18 18:14:57 +01:00
parent 9d88ddbd6b
commit 10d479d10a
1 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
translation/README.md
View File

@ -7,10 +7,11 @@ Please read the following CakePHP documentation about i18n & l10n: https://book.
## Add one .md per translation effort ## Add one .md per translation effort
Please add a file à la: ja_JP.md (Japanese_Japan) or it_CH.md (Italian_Switzerland), in which you briefly describe what the current status of your translation effort is and what has been translated and which parts might be gotchas. Please add a file à la: ja_JP.md (Japanese_Japan) or it_CH.md (Italian_Switzerland), in which you briefly describe what the current status of your translation effort is and what has been translated and which parts might be gotchas.
This would also be a good place to quickly explain what your language is about, like whether most technical terms are a translation from the original, an adaptation from the English word or perhaps you just mostly use English terms.
## Style ## Style
Please follow whatever is the purest and most intelligible form of written language. Please follow whatever is the purest and most intelligible form of written language in the native tongue being translated.
## Formatting ## Formatting
@ -23,9 +24,28 @@ It is important to use correct formatting. This is wrong:
You want to have ultimate flexibility and that line should look more like this: You want to have ultimate flexibility and that line should look more like this:
``` ```
<p><?php echo __('Are you sure you want to delete Proposal #%s?', $id);?></p> <p><?php echo __('Are you sure you want to delete Proposal #{id}?');?></p>
``` ```
In the above example we use an alternative notation of the format string in PHP. Using the above, the generated po-template file ([default.pot](https://github.com/MISP/MISP/blob/2.4/app/Locale/default.pot)) will have the name of the to-be-translated variable in the "msgid" part of the file. Which is easier to read then a non descriptive %s and allows the translator to have context on how the phrase is used in MISP.
In case you have HTML-Tags, move them out of the sentence:
```
<p><?php echo __('<h1>Are you sure you want to delete Proposal #%s?', $id);?></h1></p>
```
```
<p><?php echo __('%sAre you sure you want to delete Proposal #{id}?', '<h1>');?></h1></p>
```
## Issues
Some times it might be impossible to translate some phrases.
Or you notice a certain bad formatting, or segmentation of sentences.
In that case, please either open an [Issue on Github](https://github.com/MISP/MISP/issues)
## Quirks ## Quirks
Lines like this: Lines like this:
@ -58,7 +78,10 @@ echo $this->Form->input('sharing_group_id', array(
)); ));
``` ```
## Let us know! ## Let us know!
If you plan to do a translation or localization, please open a ticket on the issue system: https://github.com/MISP/MISP-book/issues Are you planning to do a translation or localization? Please open a ticket on the [issue system](https://github.com/MISP/MISP-book/issues). This will allow us and others to track what is being worked on. You can keep it very light, as all the details should be in your markdown in misp-book.
## Reach out to the community
Want to chat with other MISP contributors? Make sure to join our [MISP Gitter channel](https://gitter.im/MISP/MISP).