| 123 | |
| 124 | === Tips and tricks === |
| 125 | |
| 126 | ==== Placeholders ==== |
| 127 | |
| 128 | Several strings are placeholders that will be replaced by internal links during the documentation build process. |
| 129 | Those strings start and end with a `|` : |
| 130 | |
| 131 | [[Image(placeholders.png, 200px)]] |
| 132 | |
| 133 | There is no need to translate them. Please copy from source. |
| 134 | |
| 135 | To do it you can copy from source using the button provided: |
| 136 | |
| 137 | [[Image(transifex_copy_from_source.png, 400px)]] |
| 138 | |
| 139 | |
| 140 | If there is several of them you can select them then apply the copy from source function. |
| 141 | |
| 142 | [[Image(placeholders_copy_from_source.png, 800px)]] |
| 143 | |
| 144 | [[Image(placeholders_copy_from_source2.png, 600px)]] |
| 145 | |
| 146 | ==== Links ==== |
| 147 | |
| 148 | Since the documentation is build using Sphinx and RST files, the RST syntax needs to be preserved when translating. |
| 149 | |
| 150 | There is several kind of links. |
| 151 | |
| 152 | ===== Internal links ===== |
| 153 | |
| 154 | The internal link syntax is like that: |
| 155 | |
| 156 | {{{:doc:`link caption <../path/to/file>`}}} |
| 157 | |
| 158 | Please translate the link caption but preserve the rest of the link. |
| 159 | For example this link: |
| 160 | |
| 161 | {{{:doc:`Quickstart documentation <../quickstart/ETF_quickstart>`}}} |
| 162 | |
| 163 | can be translated in French like this: |
| 164 | |
| 165 | {{{:doc:`Guide de démarrage rapide <../quickstart/ETF_quickstart>`}}} |