Commit 4d31ffc3 authored by Michal Čihař's avatar Michal Čihař

Improve project and component documentation

Signed-off-by: default avatarMichal Čihař <michal@cihar.com>
parent a48fa118
......@@ -52,37 +52,11 @@ project (unless disabled in component configuration).
The project has only few attributes giving translators information about
project.
Commit message
++++++++++++++
The commit message on each commit Weblate does, it can use following format
strings in the message:
``%(language)s``
Language code
``%(language_name)s``
Language name
``%(component)s``
Component name
``%(project)s``
Project name
``%(total)s``
Total strings count
``%(fuzzy)s``
Fuzzy strings count
``%(fuzzy_percent)s``
Fuzzy strings percent
``%(translated)s``
Translated strings count
``%(translated_percent)s``
Translated strings percent
Adjusting interaction
+++++++++++++++++++++
There are also additional features which you can control, like automatic
pushing of changes (see also :ref:`push-changes`), merge or rebase
(see :ref:`merge-rebase`), git committer name or
pushing of changes (see also :ref:`push-changes`) or
maintaining of Translation-Team header.
.. _component:
......@@ -102,24 +76,29 @@ next release.
The component contains all important parameters for working with Git and
getting translations out of it:
Repo
Git repository used to pull changes.
Source code repository
VCS repository used to pull changes.
This can be either real Git URL or ``weblate://project/component``
indicating that Git repository should be shared with another component.
Push
Git URL used for pushing, this is completely optional and push support will
be disabled when this is empty.
Repoweb
indicating that the repository should be shared with another component.
Repository push URL
Repository URL used for pushing, this is completely optional and push
support will be disabled when this is empty.
Repository browser
URL of repository browser to display source files (location where messages
are used). When empty no such links will be generated.
For example on GitHub, you would use something like ``https://github.com/nijel/weblate-hello/blob/%(branch)s/%(file)s#L%(line)s``.
Branch
Which branch to checkout from the Git and where to look for translations.
Filemask
For example on GitHub, you would use something like
``https://github.com/nijel/weblate-hello/blob/%(branch)s/%(file)s#L%(line)s``.
Exported repository URL
URL where changes made by Weblate are exported. This is important when
:ref:`continuous-translation` is not used or when there is need to manually
merge changes.
Repository branch
Which branch to checkout from the VCS and where to look for translations.
File mask
Mask of files to translate including path. It should include one *
replacing language code. In case your Git repository contains more than one
replacing language code. In case your repository contains more than one
translation files (eg. more Gettext domains), you need to create separate
component for each. For example ``po/*.po`` or
``locale/*/LC_MESSAGES/django.po``.
......@@ -127,7 +106,9 @@ Monolingual base language file
Base file containing strings definition for :ref:`monolingual`.
Base file for new translations
Base file used to generate new translations, eg. ``.pot`` file with Gettext.
Report source bugs
File format
Translation file format, see also :ref:`formats`.
Source string bug report address
Email address used for reporting upstream bugs. This address will also receive
notification about any source string comments made in Weblate.
Locked
......@@ -136,10 +117,11 @@ Allow translation propagation
You can disable propagation of translations to this component from other
components within same project. This really depends on what you are
translating, sometimes it's desirable to have same string used.
Pre commit script
Pre-commit script
One of scripts defined in :setting:`PRE_COMMIT_SCRIPTS` which is executed
before commit.
Extra commit file
before commit. This can be used to generate some metadata about translation
or to generate binary form of a translation.
Additional commit file
Additional file to include in commit, usually this one is generated by pre
commit script described above.
Save translation history
......@@ -150,6 +132,51 @@ Autoaccept suggestions
Automatically accept voted suggestions, see :ref:`voting`.
Quality checks flags
Additional flags to pass to quality checks, see :ref:`custom-checks`.
Translation license
License of this translation.
License URL
URL where users can find full text of a license.
New language
How new language requests are handled.
Merge style
You can configure how the updates from upstream repository are handled.
This might not be supported for some VCS. See :ref:`merge-rebase` for
more details.
Commit message
Message used when committing translation, see :ref:`commit-message`.
Committer name
Name of commiter used on Weblate commits, the author will be always the
real translator. On some VCS this might be not supported.
Committer email
Email of commiter used on Weblate commits, the author will be always the
real translator. On some VCS this might be not supported.
.. _commit-message:
Commit message formatting
+++++++++++++++++++++++++
The commit message on each commit Weblate does, it can use following format
strings in the message:
``%(language)s``
Language code
``%(language_name)s``
Language name
``%(component)s``
Component name
``%(project)s``
Project name
``%(total)s``
Total strings count
``%(fuzzy)s``
Fuzzy strings count
``%(fuzzy_percent)s``
Fuzzy strings percent
``%(translated)s``
Translated strings count
``%(translated_percent)s``
Translated strings percent
.. seealso:: :ref:`faq-vcs`, :ref:`processing`
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment