mirror of
https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git
synced 2026-05-04 23:01:46 +08:00
331 lines
11 KiB
ReStructuredText
331 lines
11 KiB
ReStructuredText
Frequently Asked Questions
|
|
==========================
|
|
|
|
Configuration
|
|
+++++++++++++
|
|
|
|
.. _auto-workflow:
|
|
|
|
How to create automatic worflow?
|
|
--------------------------------
|
|
|
|
Weblate can handle all the translation things semi-automatically for you. If
|
|
you will give it push access to your repository, the translations can live
|
|
without interaction unless some merge conflict occurs.
|
|
|
|
1. Set up you git repository to tell Weblate whenever there is any change, see
|
|
:ref:`hooks` for information how to do it.
|
|
2. Set push URL at your :ref:`subproject` in Weblate, this will allow Weblate
|
|
to push changes to your repository.
|
|
3. Enable push on commit on your :ref:`project` in Weblate, this will make
|
|
Weblate push changes to your repository whenever they are committed at Weblate.
|
|
4. Optionally setup cron job for :djadmin:`commit_pending`.
|
|
|
|
.. seealso:: :ref:`continuous-translation`
|
|
|
|
How to access repositories over SSH?
|
|
------------------------------------
|
|
|
|
Please see :ref:`private` for information about setting up SSH keys.
|
|
|
|
.. _merge:
|
|
|
|
How to fix merge conflicts in translations?
|
|
-------------------------------------------
|
|
|
|
The easiest way is to solve all conflicts locally at your workstation - simply
|
|
add Weblate as remote repository, merge it into upstream and fix conflicts.
|
|
Once you push changes back, Weblate will be able to use merged version without
|
|
any other special actions.
|
|
|
|
.. code-block:: sh
|
|
|
|
# Add remote
|
|
git remote add weblate git://git.weblate.org/debian-handbook.git
|
|
|
|
# Update remotes
|
|
git remote update
|
|
|
|
# Merge Weblate changes
|
|
git merge weblate/master
|
|
|
|
# Resolve conflicts
|
|
edit ....
|
|
git add ...
|
|
...
|
|
git commit
|
|
|
|
# Push changes to upstream respository, Weblate will fetch merge from there
|
|
git push
|
|
|
|
.. seealso:: :ref:`git-export`
|
|
|
|
How do I translate several branches at once?
|
|
--------------------------------------------
|
|
|
|
Weblate supports pushing translation changes within one :ref:`project`. For
|
|
every :ref:`subproject` which has it enabled (the default behavior), the change
|
|
made is automatically propagated to others. This way the translations are kept
|
|
synchronized even if the branches themselves have already diverged quite a lot
|
|
and it is not possible to simply merge translation changes between them.
|
|
|
|
Once you merge changes from Weblate, you might have to merge these branches
|
|
(depending on your development workflow) discarding differences:
|
|
|
|
.. code-block:: sh
|
|
|
|
git merge -s ours origin/maintenance
|
|
|
|
.. _git-export:
|
|
|
|
How to export Git repository weblate uses?
|
|
------------------------------------------
|
|
|
|
There is nothing special about the repository, it lives under
|
|
:setting:`GIT_ROOT` directory and is named as `project/subproject/`. If you
|
|
have SSH access to this machine, you can use the repository directly.
|
|
|
|
For anonymous access you might want to run git server and let it serve the
|
|
repository to outside world.
|
|
|
|
What are options of pushing changes back upstream?
|
|
--------------------------------------------------
|
|
|
|
This heavily depends on your setup, Weblate is quite flexible in this area.
|
|
Here are examples of workflows used with Weblate:
|
|
|
|
- Weblate automatically pushes and merges changes (see :ref:`auto-workflow`)
|
|
- You tell manually Weblate to push (it needs push access to upstream repository)
|
|
- Somebody manually merges changes from Weblate git repository into upstream
|
|
repository
|
|
- Somebody rewrites history produced by Weblate (eg. by eliminating merge
|
|
commits), merges changes and tells Weblate to reset contet on upstream
|
|
repository.
|
|
|
|
Of course your are free to mix all of these as you wish.
|
|
|
|
How can I check if my Weblate is configured properly?
|
|
-----------------------------------------------------
|
|
|
|
Weblate includes set of configuration checks, which you can see in admin
|
|
interface, just follow :guilabel:`Performace report` link in admin interface or
|
|
directly open ``/admin/performance/`` URL.
|
|
|
|
.. _faq-site:
|
|
|
|
Why does registration contain example.com as domain?
|
|
----------------------------------------------------
|
|
|
|
Weblate uses Django sites framework and it defines site name inside the
|
|
database. Please open admin interface and edit default site name and domain
|
|
(you can do that directly at ``/admin/sites/site/1/`` URL under your Weblate
|
|
installation).
|
|
|
|
.. seealso:: https://docs.djangoproject.com/en/dev/ref/contrib/sites/
|
|
|
|
Usage
|
|
+++++
|
|
|
|
How do I review others translations?
|
|
------------------------------------
|
|
|
|
- You can subscribe to any changes made in :ref:`subscriptions` and then check
|
|
other contributions in email.
|
|
- There is review tool available at bottom of translation view, where you can
|
|
choose to browse translations made by others since given date.
|
|
|
|
How do I provide feedback on source string?
|
|
-------------------------------------------
|
|
|
|
On context tabs below translation, you can use :guilabel:`Source` tab to
|
|
provide feedback on source string or discuss it with other translators.
|
|
|
|
How can I use existing translations while translating?
|
|
------------------------------------------------------
|
|
|
|
Weblate provides you several ways to utilize existing translations while
|
|
translating:
|
|
|
|
- You can use import functionality to load compendium as translations,
|
|
suggestions or fuzzy translations. This is best approach for one time
|
|
translation using compedium or similar translation database.
|
|
- You can setup :ref:`tmserver` with all databases you have and let Weblate use
|
|
it. This is good for case when you want to use it for several times during
|
|
translating.
|
|
- Another option is to translate all related projects in single Weblate
|
|
instance, what will make it automatically pick up translation from other
|
|
projects as well.
|
|
|
|
.. seealso:: :ref:`machine-translation-setup`, :ref:`machine-translation`
|
|
|
|
Does Weblate update translation files besides translations?
|
|
-----------------------------------------------------------
|
|
|
|
Weblate tries to limit changes in translation files to minimum. For some file
|
|
formats it might unfortunately lead to reformatting the file. If you want to
|
|
keep the file formattted in your way, please use pre commit hook for that.
|
|
|
|
For monolingual files (see :ref:`formats`) Weblate might add new translation
|
|
units which are present in the :guilabel:`template` and not in actual
|
|
translations. It does not however perform any automatic cleanup of stale
|
|
strings as it might have unexpected outcome. If you want to do this, please
|
|
install pre commit hook which will handle the cleanup according to your needs.
|
|
|
|
Weblate also will not try to update bilingual files in any way, so if you need
|
|
:file:`po` files being updated from :file:`pot`, you need to do it on
|
|
your own.
|
|
|
|
.. seealso:: :ref:`processing`
|
|
|
|
|
|
Where do language definition come from and how can I add own?
|
|
-------------------------------------------------------------
|
|
|
|
Basic set of language definitions is included within Weblate and
|
|
Translate-toolkit. This covers more than 150 languages and includes information
|
|
about used plural forms or text direction.
|
|
|
|
You are free to define own language in administrative interface, you just need
|
|
to provide information about it.
|
|
|
|
Can Weblate highlight change in a fuzzy string?
|
|
-----------------------------------------------
|
|
|
|
Weblate supports this, however it needs the data to show the difference.
|
|
|
|
For Gettext PO files, you have to pass parameter ``--previous`` to
|
|
:command:`msgmerge` when updating PO files, for example:
|
|
|
|
.. code-block:: sh
|
|
|
|
msgmerge --previous -U po/cs.po po/phpmyadmin.pot
|
|
|
|
For monolingual translations, Weblate can find the previous string by ID, so it
|
|
shows the differences automatically.
|
|
|
|
Troubleshooting
|
|
+++++++++++++++
|
|
|
|
Requests sometimes fail with too many open files error
|
|
------------------------------------------------------
|
|
|
|
This happens sometimes when your Git repository grows too much and you have
|
|
more of them. Compressing the Git repositories will improve this situation.
|
|
|
|
The easiest way to do this is to run:
|
|
|
|
.. code-block:: sh
|
|
|
|
# Go to GIT_ROOT directory
|
|
cd weblate/repos
|
|
# Compress all Git repositories
|
|
for d in */* ; do
|
|
pushd $d
|
|
git gc
|
|
popd
|
|
done
|
|
|
|
.. seealso::
|
|
|
|
:setting:`GIT_ROOT`
|
|
|
|
.. _faq-ft-slow:
|
|
|
|
Fulltext search is too slow
|
|
---------------------------
|
|
|
|
Depending on various conditions (frequency of updates, server restarts and
|
|
other), fulltext index might get too fragmented over time. It is recommended to
|
|
rebuild it from scratch time to time:
|
|
|
|
.. code-block:: sh
|
|
|
|
./manage.py rebuild_index --clean
|
|
|
|
.. seealso:: :djadmin:`rebuild_index`
|
|
|
|
.. _faq-ft-lock:
|
|
|
|
I get "Lock Error" quite often while translating
|
|
------------------------------------------------
|
|
|
|
This is usually caused by concurrent updates to fulltext index. In case you are
|
|
running multi threaded server (eg. mod_wsgi), this happens quite often. For such
|
|
setup it is recommended to enable :setting:`OFFLOAD_INDEXING`.
|
|
|
|
.. seealso:: :ref:`fulltext`
|
|
|
|
.. _faq-ft-space:
|
|
|
|
Rebuilding index has failed with "No space left on device"
|
|
----------------------------------------------------------
|
|
|
|
Whoosh uses temporary directory to build indices. In case you have small /tmp
|
|
(eg. using ramdisk), this might fail. Change used temporary directory by passing
|
|
as ``TEMP`` variable:
|
|
|
|
.. code-block:: sh
|
|
|
|
TEMP=/path/to/big/temp ./manage.py rebuild_index --clean
|
|
|
|
.. seealso:: :djadmin:`rebuild_index`
|
|
|
|
Features
|
|
++++++++
|
|
|
|
.. _faq-vcs:
|
|
|
|
Does Weblate support other VCS than Git?
|
|
----------------------------------------
|
|
|
|
Weblate does not have native support for anything else than Git, however Git is
|
|
versatile system, which allows plugging in `remote helpers`_ for other VCS as well.
|
|
|
|
At this time, helpers for Bazaar and Mercurial (hg) are available within
|
|
`Git source code`_, they might be also included in your Git package. If this is
|
|
not the case, you can download them manually and put somewhere in your search path
|
|
(for example :file:`~/bin`). You also need to have installed appropriate version
|
|
control programs.
|
|
|
|
Once you have these installed, you can use such remotes to specifi repository in Weblate.
|
|
|
|
To clone ``gnuhello`` project from Launchpad with Bazaar use::
|
|
|
|
bzr::lp:gnuhello
|
|
|
|
For ``hello`` repository from selenic.com with Mercurial use::
|
|
|
|
hg::http://selenic.com/repo/hello
|
|
|
|
.. _remote helpers: http://git-scm.com/docs/git-remote-helpers
|
|
.. _Git source code: https://github.com/git/git/tree/master/contrib/remote-helpers
|
|
|
|
.. note::
|
|
|
|
For native support of other VCS, Weblate requires distributed VCS and could
|
|
be probably adjusted to work with anything else than Git, but somebody has
|
|
to implement this support.
|
|
|
|
How does Weblate credit translators?
|
|
------------------------------------
|
|
|
|
Every change made in Weblate is committed into VCS under translators name. This
|
|
way every single change has proper authorship and you can track it down using
|
|
standard VCS tools you use for code.
|
|
|
|
Additionally, when translation file format supports it, the file headers are
|
|
updated to include translator name.
|
|
|
|
Why does Weblate force to have show all po files in single tree?
|
|
----------------------------------------------------------------
|
|
|
|
Weblate was designed in a way that every po file is represented as single
|
|
subproject. This is beneficial for translators, that they know what they are
|
|
actually translating. If you feel your project should be translated as one,
|
|
consider merging these po files. It will make life easier even for translators
|
|
not using Weblate.
|
|
|
|
.. note::
|
|
|
|
In case there will be big demand for this feature, it might be implemented
|
|
in future versions, but it's definitely not a priority for now.
|
