Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

language update #74

Merged
merged 2 commits into from
Oct 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,21 @@ deploy:
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" -nW
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/sw" -D language='sw' -nW
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='ar' -nW
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='es' -nW
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='fr' -nW
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='te' -nW
# -n Run in nit-picky mode. Currently, this generates warnings for all missing references.
# -W Turn warnings into errors that stop the build.
# for more details about the options see https://www.sphinx-doc.org/en/1.8/man/sphinx-build.html#options

allerr:
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html"
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/sw" -D language='sw'
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='ar'
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='es'
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='fr'
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/ar" -D language='te'

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,13 +215,17 @@ To add a new language, do it through the Transifex interface and then add a new

Don't panic! Unfortunately, Transifex doesn't protect the reST notation that Sphinx uses for things like formatting and links. It's possible that during translation, some of the syntax was broken.

Start up your Python virtual environment if it's not already with `source venv/bin/activate` and then try a build of the language that you're trying to update, for example:
Start up your Python virtual environment if it's not already with `source venv/bin/activate` and then run `make allerr`. This does the same thing as `make deploy` but removes the nit-picky mode so that it logs all errors and doesn't stop the build after hitting the first one.

You can also run the build for just one specific language, for example:

```
sphinx-build -b html -D language='sw' source "_build/html/sw/" -nW
sphinx-build -b html -D language='sw' source "_build/html/sw/"
```

The `-nW` (nitpicky) flag is important. You should see an output in your console such as:
![build errors logged to the terminal](https://raw.githubusercontent.com/OpenDroneMap/docs/publish/source/readme-img/sphinx-build_errors_in_terminal.png)

You should see output in your console such as:

```
Warning, treated as error:
Expand All @@ -234,7 +238,7 @@ Go to Transifex, go to the resource, and go to the string. The warning/error mes

![Transifex screen grab](https://raw.githubusercontent.com/OpenDroneMap/docs/publish/source/readme-img/reST_syntax_err_transifex.png)

Pull the language down (e.g. `tx pull -l sw`) and then try the build again. Unfortunately, if there is more than one error, you'll have to fix them one at a time.
Pull the language down (for example, `tx pull -l sw`) and then try the build again.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose an abbreviation of a Latin phrase isn't the best idea in communicating on translating docs in English.


### Questions?

Expand Down
11 changes: 11 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ Welcome to OpenDroneMap's documentation
|
|

The documentation is available in several languages. Some translations are incomplete and will still display in English. The below languages are at least 20 percent translated. You can help us translate those languages (and other languages!) via Transifex. There is a `getting started guide on GitHub <https://github.com/opendronemap/docs#translations>`_.

- `English <https://docs.opendronemap.org/>`_
- `French <https://docs.opendronemap.org/fr>`_
- `Spanish <https://docs.opendronemap.org/es>`_
- `Swahili <https://docs.opendronemap.org/sw>`_
- `Telugu <https://docs.opendronemap.org/te>`_

|
|

.. figure:: images/seedling.png
:alt: image of seedling
:align: right
Expand Down
Binary file modified source/locale/en/pot/.doctrees/arguments.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/contributing.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/environment.pickle
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/flying.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/gcp.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/geo.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/index.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/installation.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/large.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/map-accuracy.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/masks.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/multispectral.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/outputs.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/requesting-features.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/resources.doctree
Binary file not shown.
Binary file modified source/locale/en/pot/.doctrees/tutorials.doctree
Binary file not shown.
9 changes: 4 additions & 5 deletions source/locale/en/pot/arguments.pot
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: OpenDroneMap 2.0.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2020-10-05 12:56-0400\n"
"POT-Creation-Date: 2020-10-26 14:39-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand All @@ -17,17 +17,16 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"

#: ../../../arguments.rst:4
# 3c050a6e28a542979ddc0687deabc8e3
#: 3c050a6e28a542979ddc0687deabc8e3
msgid "Options and Flags"
msgstr ""

#: ../../../arguments.rst:6
# 22dcd4f93de143d4be348424b5141abe
#: 22dcd4f93de143d4be348424b5141abe
msgid "Arguments::"
msgstr ""

#: ../../../arguments.rst:387
# 3ce8631539bc46c5a0823cb6065ddf2d
#: 3ce8631539bc46c5a0823cb6065ddf2d
msgid "`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/using.rst>`_"
msgstr ""

65 changes: 32 additions & 33 deletions source/locale/en/pot/contributing.pot
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: OpenDroneMap 2.0.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2020-10-05 12:56-0400\n"
"POT-Creation-Date: 2020-10-26 14:39-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand All @@ -17,157 +17,156 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"

#: ../../../contributing.rst:4
# 33a2711c05144f9582994fb626017045
#: 33a2711c05144f9582994fb626017045
msgid "How To Contribute"
msgstr ""

#: ../../../contributing.rst:6
# fd9047989963484db99d88e41c6a763c
#: fd9047989963484db99d88e41c6a763c
msgid "OpenDroneMap relies on community contributions. You can contribute in many ways, even if you are not a programmer."
msgstr ""

#: ../../../contributing.rst:9
# d7a8cfb3ce1c4e789d9bc59089b7af33
#: d7a8cfb3ce1c4e789d9bc59089b7af33
msgid "Community Forum"
msgstr ""

#: ../../../contributing.rst:11
# 372bbf306f2e4a60a8915ed2441771d7
#: 372bbf306f2e4a60a8915ed2441771d7
msgid "If you are looking to get involved, are stuck on a problem, or want to reach out, `the forum <https://community.opendronemap.org/>`_ is a great place to start. You may find your questions already answered or else you can find other useful tips and resources. You can also contribute your open access datasets for others to explore. It is a good place go before submitting bug reports or getting in touch with developers before writing a new feature."
msgstr ""

#: ../../../contributing.rst:14
# 925012996add420ca56b7ff53828e745
#: 925012996add420ca56b7ff53828e745
msgid "Reporting Bugs"
msgstr ""

#: ../../../contributing.rst:16
# cfa595af5c7748dea7c279ce2b09160f
#: cfa595af5c7748dea7c279ce2b09160f
msgid "Bugs are tracked as Github issues. Please create an issue in the repository and tag it with the Bug tag."
msgstr ""

#: ../../../contributing.rst:18
# f79279e13ea24b5e8196ae34fb77bb8c
#: f79279e13ea24b5e8196ae34fb77bb8c
msgid "Explain the problem and include additional details to help maintainers reproduce the problem:"
msgstr ""

#: ../../../contributing.rst:20
# 3957ae606cb0425d8a8d6fcb1e639faf
#: 3957ae606cb0425d8a8d6fcb1e639faf
msgid "**Use a clear and descriptive title** for the issue to identify the problem."
msgstr ""

#: ../../../contributing.rst:21
# bdb253d1772f45e7a7ef73e96e4e2654
#: bdb253d1772f45e7a7ef73e96e4e2654
msgid "**Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you run ODM (Docker, Vagrant, etc), e.g. which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it.**"
msgstr ""

#: ../../../contributing.rst:22
# eebf5329d6344d08b8d6949880fca497
#: eebf5329d6344d08b8d6949880fca497
msgid "**Provide specific examples to demonstrate the steps.** Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use `Markdown code blocks <https://help.github.com/articles/markdown-basics/#multiple-lines>`_."
msgstr ""

#: ../../../contributing.rst:23
# c6dc25d3a3cc4b188e567e241d3f3a77
#: c6dc25d3a3cc4b188e567e241d3f3a77
msgid "**Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior."
msgstr ""

#: ../../../contributing.rst:24
# a4e3ccec200740a0854f45b8c9105728
#: a4e3ccec200740a0854f45b8c9105728
msgid "**Explain which behavior you expected to see instead and why.**"
msgstr ""

#: ../../../contributing.rst:25
# 541a50043a9b4241a4b659662b6e1d30
#: 541a50043a9b4241a4b659662b6e1d30
msgid "**Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use `this tool to record GIFs on macOS and Windows <http://www.cockos.com/licecap/>`_, and `this tool <https://github.com/colinkeenan/silentcast>`_ or `this one <https://github.com/GNOME/byzanz>`_ on Linux."
msgstr ""

#: ../../../contributing.rst:26
# 43f98a3d907e487d967f29497574f208
#: 43f98a3d907e487d967f29497574f208
msgid "**If the problem is related to performance,** please post your machine's specs (host and guest machine)."
msgstr ""

#: ../../../contributing.rst:27
# 95d28b70f6c745269f2e101c9ebd7872
#: 95d28b70f6c745269f2e101c9ebd7872
msgid "**If the problem wasn't triggered by a specific action,** describe what you were doing before the problem happened and share more information using the guidelines below."
msgstr ""

#: ../../../contributing.rst:29
# 7e3a9ff9bd6047cfbb353a9007c072de
#: 7e3a9ff9bd6047cfbb353a9007c072de
msgid "Include details about your configuration and environment:"
msgstr ""

#: ../../../contributing.rst:31
# d0b284a2065049f5a2c78f914fd4ee97
#: d0b284a2065049f5a2c78f914fd4ee97
msgid "**Which version of ODM are you using?** A stable release? a clone of master?"
msgstr ""

#: ../../../contributing.rst:32
# 2c6d40300ba9430a85a83dc23588debb
#: 2c6d40300ba9430a85a83dc23588debb
msgid "**What's the name and version of the OS you're using?**"
msgstr ""

#: ../../../contributing.rst:33
# 49f8184463b44d938e19609a806233ea
#: 49f8184463b44d938e19609a806233ea
msgid "**Are you running ODM in a virtual machine or Docker?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?"
msgstr ""

#: ../../../contributing.rst:36
# 3135c11e453247179f8c1c65d5700c63
#: 3135c11e453247179f8c1c65d5700c63
msgid "Template For Submitting Bug Reports"
msgstr ""

#: ../../../contributing.rst:69
# befb661ef483468296538486ee7c72a1
#: befb661ef483468296538486ee7c72a1
msgid "Pull Requests"
msgstr ""

#: ../../../contributing.rst:71
# 39056637eeed467b8451dd10998c0783
#: 39056637eeed467b8451dd10998c0783
msgid "Include screenshots and animated GIFs in your pull request whenever possible."
msgstr ""

#: ../../../contributing.rst:72
# b7dbdbac90e84d6284edfd22f4d2b53b
#: b7dbdbac90e84d6284edfd22f4d2b53b
msgid "Follow the PEP8 Python Style Guide."
msgstr ""

#: ../../../contributing.rst:73
# b679a0d7db6246c1a8c40720159e034b
#: b679a0d7db6246c1a8c40720159e034b
msgid "End files with a newline."
msgstr ""

#: ../../../contributing.rst:76
# dc6b120a67bf4f9684e5bb653290c7cb
#: dc6b120a67bf4f9684e5bb653290c7cb
msgid "Avoid platform-dependent code:"
msgstr ""

#: ../../../contributing.rst:75
# e198baeffa1f4a919d039b18e11ec7f8
#: e198baeffa1f4a919d039b18e11ec7f8
msgid "Use require('fs-plus').getHomeDirectory() to get the home directory."
msgstr ""

#: ../../../contributing.rst:76
# 5d00c0c8d3d24347bfaa26f0ebe1e063
#: 5d00c0c8d3d24347bfaa26f0ebe1e063
msgid "Use path.join() to concatenate filenames."
msgstr ""

#: ../../../contributing.rst:77
# 00cddf0eb7bf4e4bb9a469313a778b3a
#: 00cddf0eb7bf4e4bb9a469313a778b3a
msgid "Use os.tmpdir() rather than /tmp when you need to reference the temporary directory."
msgstr ""

#: ../../../contributing.rst:79
# 60e9e81967354752b39a01541d5b2ccf
#: 60e9e81967354752b39a01541d5b2ccf
msgid "Using a plain return when returning explicitly at the end of a function."
msgstr ""

#: ../../../contributing.rst:79
# fc372ffc32604e90890111d4287b33a0
#: fc372ffc32604e90890111d4287b33a0
msgid "Not return null, return undefined, null, or undefined"
msgstr ""

#: ../../../contributing.rst:81
# cbb4ef102fb34a88bc3ccb04d7ff203c
#: cbb4ef102fb34a88bc3ccb04d7ff203c
msgid "`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/contributing.rst>`_"
msgstr ""

21 changes: 10 additions & 11 deletions source/locale/en/pot/flying.pot
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: OpenDroneMap 2.0.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2020-10-05 12:56-0400\n"
"POT-Creation-Date: 2020-10-26 14:39-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand All @@ -17,47 +17,46 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"

#: ../../../flying.rst:2
# 846d8a3f9d9646e5a43911942183b8c8
#: 846d8a3f9d9646e5a43911942183b8c8
msgid "Flying Tips"
msgstr ""

#: ../../../flying.rst:4
# c96becee56f94efca8b3de336db9d844
#: c96becee56f94efca8b3de336db9d844
msgid "The `Humanitarian OpenStreetMap team <https://www.hotosm.org/>`_ has guidelines on `flying for UAV mapping <https://uav-guidelines.openaerialmap.org/>`_:"
msgstr ""

#: ../../../flying.rst:6
# 4a6f4c2edee741ddac135447436976f7
#: 4a6f4c2edee741ddac135447436976f7
msgid "`Choosing the right UAV <https://uav-guidelines.openaerialmap.org/pages/05-choosing-the-right-uav/>`_"
msgstr ""

#: ../../../flying.rst:8
# fe7f09d545684117aba61ff9860a51d2
#: fe7f09d545684117aba61ff9860a51d2
msgid "`Choosing the right sensor <https://uav-guidelines.openaerialmap.org/pages/06-choosing-the-sensor/>`_"
msgstr ""

#: ../../../flying.rst:10
# 6c7947d1197147df9d63e165d11924cb
#: 6c7947d1197147df9d63e165d11924cb
msgid "`Mission preparation <https://uav-guidelines.openaerialmap.org/pages/07-preparing-for-the-uav-mission/>`_"
msgstr ""

#: ../../../flying.rst:12
# 9b557a1da5cc46af807bcaaa6faee6dd
#: 9b557a1da5cc46af807bcaaa6faee6dd
msgid "The guidelines are intended for drone mapping projects on islands, but have general use for all drone mappers."
msgstr ""

#: ../../../flying.rst:14
# 44b1eacc4ff2499a8a4e74651b9443e1
#: 44b1eacc4ff2499a8a4e74651b9443e1
msgid "See also DroneDeploy's guide on `Making Successful Maps <https://support.dronedeploy.com/docs/making-successful-maps>`_, which provides great tips on mission planning."
msgstr ""

#: ../../../flying.rst:16
# 790dc47dea524f9589ab6de072d0febc
#: 790dc47dea524f9589ab6de072d0febc
msgid "Finally, lens distortion is a challenge in projects requiring accurate 3D data. See our section in these docs on `Camera Calibration <tutorials.html#calibrating-the-camera>`_."
msgstr ""

#: ../../../flying.rst:18
# 96453509d0ed4fcf97681fe2c9bb7385
#: 96453509d0ed4fcf97681fe2c9bb7385
msgid "`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/flying.rst>`_"
msgstr ""

Loading