Skip to content

C
converse.js
Commit 788b1243 authored by Michal Čihař's avatar Michal Čihař
Browse files
Options

Consistent formatting of seealso sections in docs 

Fixes #841
Signed-off-by: default avatarMichal Čihař <michal@cihar.com>
parent 05783ebc
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 340 additions and 123 deletions
docs/admin/access.rst
View file @ 788b1243
......@@ -115,7 +115,9 @@ To allow access to this project, you have to add the privilege to do so either
directly to given user or group of users in Django admin interface. Or using
user management on project page as described in :ref:`manage-acl`.
.. seealso:: https://docs.djangoproject.com/en/stable/topics/auth/default/#auth-admin
.. seealso::
`Managing users in the Django admin <https://docs.djangoproject.com/en/stable/topics/auth/default/#auth-admin>`_
Managing users and groups
-------------------------
......@@ -141,5 +143,7 @@ The user management is available in :guilabel:`Tools` menu of a project:
.. image:: ../images/manage-users.png
.. seealso:: :ref:`acl`
.. seealso::
:ref:`acl`
docs/admin/auth.rst
View file @ 788b1243
......@@ -84,7 +84,9 @@ You need to register application on GitHub and then tell Weblate all the secrets
SOCIAL_AUTH_GITHUB_SECRET = 'GitHub Client Secret'
SOCIAL_AUTH_GITHUB_SCOPE = ['user:email']
.. seealso:: http://psa.matiasaguirre.net/docs/backends/index.html
.. seealso::
`Python Social Auth backends <http://psa.matiasaguirre.net/docs/backends/index.html>`_
Google OAuth2
~~~~~~~~~~~~~
......@@ -169,7 +171,9 @@ Once you have the package installed, you can hook it to Django authentication:
'email': 'mail',
}
.. seealso:: http://pythonhosted.org/django-auth-ldap/
.. seealso::
`Django Authentication Using LDAP <http://pythonhosted.org/django-auth-ldap/>`_
CAS authentication
......@@ -230,4 +234,6 @@ cause problems, therefore it's suggested to put it:
user.email = attributes['email']
user.save()
.. seealso:: https://github.com/mingchen/django-cas-ng
.. seealso::
`Django CAS NG <https://github.com/mingchen/django-cas-ng>`_
docs/admin/config.rst
View file @ 788b1243
......@@ -25,7 +25,9 @@ ANONYMOUS_USER_NAME
User name of user for definining privileges of not logged in user.
.. seealso:: :ref:`privileges`
.. seealso::
:ref:`privileges`
.. setting:: AUTO_LOCK
......@@ -34,7 +36,9 @@ AUTO_LOCK
Enables automatic locking of translation when somebody is working on it.
.. seealso:: :ref:`locking`
.. seealso::
:ref:`locking`
.. setting:: AUTO_LOCK_TIME
......@@ -43,7 +47,9 @@ AUTO_LOCK_TIME
Time in seconds for how long the automatic lock for translation will be active.
.. seealso:: :ref:`locking`
.. seealso::
:ref:`locking`
.. setting:: AUTOFIX_LIST
......@@ -70,7 +76,9 @@ For example you can enable only few of them:
'weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis',
)
.. seealso:: :ref:`autofix`, :ref:`custom-autofix`
.. seealso::
:ref:`autofix`, :ref:`custom-autofix`
.. setting:: BACKGROUND_HOOKS
......@@ -122,7 +130,9 @@ For example you can enable only few of them:
'weblate.trans.checks.source.MultipleFailingCheck',
)
.. seealso:: :ref:`checks`, :ref:`custom-checks`
.. seealso::
:ref:`checks`, :ref:`custom-checks`
.. setting:: DATA_DIR
......@@ -159,7 +169,9 @@ DEFAULT_COMMITER_EMAIL
Default commiter email when creating translation component (see
:ref:`component`), defaults to ``noreply@weblate.org``.
.. seealso:: :setting:`DEFAULT_COMMITER_NAME`, :ref:`component`
.. seealso::
:setting:`DEFAULT_COMMITER_NAME`, :ref:`component`
.. setting:: DEFAULT_COMMITER_NAME
......@@ -171,7 +183,9 @@ DEFAULT_COMMITER_NAME
Default commiter name when creating translation component (see
:ref:`component`), defaults to ``Weblate``.
.. seealso:: :setting:`DEFAULT_COMMITER_EMAIL`, :ref:`component`
.. seealso::
:setting:`DEFAULT_COMMITER_EMAIL`, :ref:`component`
.. setting:: DEFAULT_TRANSLATION_PROPAGATION
......@@ -183,7 +197,9 @@ DEFAULT_TRANSLATION_PROPAGATION
Default setting for translation propagation (see :ref:`component`),
defaults to ``True``.
.. seealso:: :ref:`component`
.. seealso::
:ref:`component`
.. setting:: ENABLE_AVATARS
......@@ -197,7 +213,9 @@ The avatars are fetched and cached on the server, so there is no risk in
leaking private information or slowing down the user experiences with enabling
this.
.. seealso:: :ref:`production-cache-avatar`
.. seealso::
:ref:`production-cache-avatar`
.. setting:: ENABLE_HOOKS
......@@ -206,7 +224,9 @@ ENABLE_HOOKS
Whether to enable anonymous remote hooks.
.. seealso:: :ref:`hooks`
.. seealso::
:ref:`hooks`
.. setting:: ENABLE_HTTPS
......@@ -242,7 +262,9 @@ GITHUB_USERNAME
GitHub username that will be used to send pull requests for translation
updates.
.. seealso:: :ref:`github-push`
.. seealso::
:ref:`github-push`
.. setting:: GOOGLE_ANALYTICS_ID
......@@ -271,7 +293,9 @@ Delay creating VCS commits until this is necessary. This heavily reduces
number of commits generated by Weblate at expense of temporarily not being
able to merge some changes as they are not yet committed.
.. seealso:: :ref:`lazy-commit`
.. seealso::
:ref:`lazy-commit`
.. setting:: LOCK_TIME
......@@ -281,7 +305,9 @@ LOCK_TIME
Time in seconds for how long the translation will be locked for single
translator when locked manually.
.. seealso:: :ref:`locking`
.. seealso::
:ref:`locking`
.. setting:: LOGIN_REQUIRED_URLS
......@@ -343,7 +369,9 @@ List of enabled machine translation services to use.
'weblate.trans.machine.weblatetm.WeblateTranslation',
)
.. seealso:: :ref:`machine-translation-setup`, :ref:`machine-translation`
.. seealso::
:ref:`machine-translation-setup`, :ref:`machine-translation`
.. setting:: MT_APERTIUM_KEY
......@@ -352,7 +380,9 @@ MT_APERTIUM_KEY
API key for Apertium Web Service, you can register at http://api.apertium.org/register.jsp
.. seealso:: :ref:`apertium`, :ref:`machine-translation-setup`, :ref:`machine-translation`
.. seealso::
:ref:`apertium`, :ref:`machine-translation-setup`, :ref:`machine-translation`
.. setting:: MT_GOOGLE_KEY
......@@ -361,7 +391,9 @@ MT_GOOGLE_KEY
API key for Google Translate API, you can register at https://cloud.google.com/translate/docs
.. seealso:: :ref:`google-translate`, :ref:`machine-translation-setup`, :ref:`machine-translation`
.. seealso::
:ref:`google-translate`, :ref:`machine-translation-setup`, :ref:`machine-translation`
.. setting:: MT_MICROSOFT_ID
......@@ -370,7 +402,10 @@ MT_MICROSOFT_ID
Cliend ID for Microsoft Translator service.
.. seealso:: :ref:`ms-translate`, :ref:`machine-translation-setup`, :ref:`machine-translation`, https://datamarket.azure.com/developer/applications/
.. seealso::
:ref:`ms-translate`, :ref:`machine-translation-setup`, :ref:`machine-translation`,
`Azure datamarket <https://datamarket.azure.com/developer/applications/>`_
.. setting:: MT_MICROSOFT_SECRET
......@@ -379,7 +414,10 @@ MT_MICROSOFT_SECRET
Client secret for Microsoft Translator service.
.. seealso:: :ref:`ms-translate`, :ref:`machine-translation-setup`, :ref:`machine-translation`, https://datamarket.azure.com/developer/applications/
.. seealso::
:ref:`ms-translate`, :ref:`machine-translation-setup`, :ref:`machine-translation`,
`Azure datamarket <https://datamarket.azure.com/developer/applications/>`_
.. setting:: MT_MYMEMORY_EMAIL
......@@ -388,7 +426,10 @@ MT_MYMEMORY_EMAIL
MyMemory identification email, you can get 1000 requests per day with this.
.. seealso:: :ref:`mymemory`, :ref:`machine-translation-setup`, :ref:`machine-translation`, http://mymemory.translated.net/doc/spec.php
.. seealso::
:ref:`mymemory`, :ref:`machine-translation-setup`, :ref:`machine-translation`,
`MyMemory: API technical specifications <http://mymemory.translated.net/doc/spec.php>`_
.. setting:: MT_MYMEMORY_KEY
......@@ -397,7 +438,10 @@ MT_MYMEMORY_KEY
MyMemory access key for private translation memory, use together with :setting:`MT_MYMEMORY_USER`.
.. seealso:: :ref:`mymemory`, :ref:`machine-translation-setup`, :ref:`machine-translation`, http://mymemory.translated.net/doc/keygen.php
.. seealso::
:ref:`mymemory`, :ref:`machine-translation-setup`, :ref:`machine-translation`,
`MyMemory: API key generator <http://mymemory.translated.net/doc/keygen.php>`_
.. setting:: MT_MYMEMORY_USER
......@@ -406,7 +450,10 @@ MT_MYMEMORY_USER
MyMemory user id for private translation memory, use together with :setting:`MT_MYMEMORY_KEY`.
.. seealso:: :ref:`mymemory`, :ref:`machine-translation-setup`, :ref:`machine-translation`, http://mymemory.translated.net/doc/keygen.php
.. seealso::
:ref:`mymemory`, :ref:`machine-translation-setup`, :ref:`machine-translation`,
`MyMemory: API key generator <http://mymemory.translated.net/doc/keygen.php>`_
.. setting:: MT_TMSERVER
......@@ -415,7 +462,10 @@ MT_TMSERVER
URL where tmserver is running.
.. seealso:: :ref:`tmserver`, :ref:`machine-translation-setup`, :ref:`machine-translation`, http://docs.translatehouse.org/projects/translate-toolkit/en/latest/commands/tmserver.html
.. seealso::
:ref:`tmserver`, :ref:`machine-translation-setup`, :ref:`machine-translation`,
`tmserver, a Translation Memory service <http://docs.translatehouse.org/projects/translate-toolkit/en/latest/commands/tmserver.html>`_
.. setting:: NEARBY_MESSAGES
......@@ -438,7 +488,9 @@ While enabling this, don't forget scheduling runs of
This is recommended setup for production use.
.. seealso:: :ref:`fulltext`
.. seealso::
:ref:`fulltext`
.. setting:: PIWIK_SITE_ID
......@@ -447,7 +499,9 @@ PIWIK_SITE_ID
ID of a site in Piwik you want to track.
.. seealso:: :setting:`PIWIK_URL`
.. seealso::
:setting:`PIWIK_URL`
.. setting:: PIWIK_URL
......@@ -457,7 +511,9 @@ PIWIK_URL
URL of a Piwik installation you want to use to track Weblate users. For more
information about Piwik see <http://piwik.org/>.
.. seealso:: :setting:`PIWIK_SITE_ID`
.. seealso::
:setting:`PIWIK_SITE_ID`
.. setting:: POST_ADD_SCRIPTS
......@@ -474,7 +530,9 @@ Weblate comes with few example hook scripts which you might find useful:
:file:`examples/hook-update-linguas`
Updates LINGUAS file or ALL_LINGUAS in confiugure script.
.. seealso:: :ref:`processing`
.. seealso::
:ref:`processing`
.. setting:: POST_UPDATE_SCRIPTS
......@@ -486,7 +544,9 @@ POST_UPDATE_SCRIPTS
List of scripts which are allowed as post update scripts. The script needs to be
later enabled in the :ref:`component`.
.. seealso:: :ref:`processing`
.. seealso::
:ref:`processing`
.. setting:: PRE_COMMIT_SCRIPTS
......@@ -515,7 +575,9 @@ Weblate comes with few example hook scripts which you might find useful:
:file:`examples/hook-replace-single-quotes`
Replaces single quotes in a file.
.. seealso:: :ref:`processing`
.. seealso::
:ref:`processing`
.. setting:: POST_COMMIT_SCRIPTS
......@@ -527,7 +589,9 @@ POST_COMMIT_SCRIPTS
List of scripts which are allowed as post commit scripts. The script needs to be
later enabled in the :ref:`component`.
.. seealso:: :ref:`processing`
.. seealso::
:ref:`processing`
.. setting:: POST_PUSH_SCRIPTS
......@@ -539,7 +603,9 @@ POST_PUSH_SCRIPTS
List of scripts which are allowed as post push scripts. The script needs to be
later enabled in the :ref:`component`.
.. seealso:: :ref:`processing`
.. seealso::
:ref:`processing`
.. setting:: REGISTRATION_CAPTCHA
......@@ -566,7 +632,9 @@ SELF_ADVERTISEMENT
Enables self advertisement of Weblate in case there are no configured ads.
.. seealso:: :ref:`advertisement`
.. seealso::
:ref:`advertisement`
.. setting:: SIMPLIFY_LANGUAGES
......
docs/admin/continuous.rst
View file @ 788b1243
......@@ -89,7 +89,9 @@ You can also use generic :guilabel:`Webhook`, in that case the
:guilabel:`Payload URL` would have to be full path to the handler, for example
``https://hosted.weblate.org/hooks/github/``.
.. seealso:: :http:post:`/hooks/github/`, :ref:`hosted-push`
.. seealso::
:http:post:`/hooks/github/`, :ref:`hosted-push`
.. _bitbucket-setup:
......@@ -103,7 +105,9 @@ on your Weblate installation (for example
.. image:: ../images/bitbucket-settings.png
.. seealso:: :http:post:`/hooks/bitbucket/`, :ref:`hosted-push`
.. seealso::
:http:post:`/hooks/bitbucket/`, :ref:`hosted-push`
.. _gitlab-setup:
......@@ -114,7 +118,9 @@ Weblate has support for GitLab hooks, all you need to do is add project web hook
with destination to ``/hooks/gitlab/`` URL on your Weblate installation
(for example ``https://hosted.weblate.org/hooks/gitlab/``).
.. seealso:: :http:post:`/hooks/gitlab/`, :ref:`hosted-push`
.. seealso::
:http:post:`/hooks/gitlab/`, :ref:`hosted-push`
.. _push-changes:
......@@ -154,7 +160,9 @@ push translations to the repository, you can have them sent as a pull request in
You need to configure the :guilabel:`hub` command line tool and set :setting:`GITHUB_USERNAME` for this to work.
.. seealso:: :setting:`GITHUB_USERNAME`, :ref:`hub-setup` for configuration instructions
.. seealso::
:setting:`GITHUB_USERNAME`, :ref:`hub-setup` for configuration instructions
.. _hosted-push:
......@@ -188,7 +196,9 @@ Interacting with others
Weblate makes it easy to interact with others using its API.
.. seealso:: :ref:`api`
.. seealso::
:ref:`api`
.. _lazy-commit:
......
docs/admin/deployments.rst
View file @ 788b1243
......@@ -185,7 +185,9 @@ After installation on OpenShift Weblate is ready to use and preconfigured as fol
* Django site name and ALLOWED_HOSTS set to DNS name of your OpenShift application
* Email sender addresses set to no-reply@<OPENSHIFT_CLOUD_DOMAIN>, where <OPENSHIFT_CLOUD_DOMAIN> is the domain OpenShift runs under. In case of OpenShift Online it's rhcloud.com.
.. seealso:: :ref:`customize_config`
.. seealso::
:ref:`customize_config`
Retrieve Admin Password
~~~~~~~~~~~~~~~~~~~~~~~
......@@ -267,7 +269,9 @@ To reset a setting to its preconfigured value just delete the corresponding envi
rhc -aweblate env unset WEBLATE_ADMINS
.. seealso:: :ref:`config`
.. seealso::
:ref:`config`
Updating
++++++++
......
docs/admin/install.rst
View file @ 788b1243
This diff is collapsed.
docs/admin/machine.rst
View file @ 788b1243
......@@ -22,7 +22,9 @@ Special installation of :ref:`tmserver` run by Virtaal authors.
To enable this service, add ``trans.machine.tmserver.AmagamaTranslation`` to
:setting:`MACHINE_TRANSLATION_SERVICES`.
.. seealso:: http://docs.translatehouse.org/projects/virtaal/en/latest/amagama.html
.. seealso::
`Amagama Translation Memory server <http://docs.translatehouse.org/projects/virtaal/en/latest/amagama.html>`_
.. _apertium:
......@@ -39,7 +41,7 @@ To enable this service, add ``trans.machine.apertium.ApertiumTranslation`` to
.. seealso::
:setting:`MT_APERTIUM_KEY`, https://www.apertium.org/
:setting:`MT_APERTIUM_KEY`, `Apertium website <https://www.apertium.org/>`_
Glosbe
++++++
......@@ -55,7 +57,7 @@ To enable this service, add ``trans.machine.glosbe.GlosbeTranslation`` to
.. seealso::
https://glosbe.com/
`Glosbe website <https://glosbe.com/>`_
.. _google-translate:
......@@ -73,7 +75,7 @@ To enable this service, add ``trans.machine.google.GoogleTranslation`` to
.. seealso::
:setting:`MT_GOOGLE_KEY`,
https://cloud.google.com/translate/docs
`Google translate documentation <https://cloud.google.com/translate/docs>`_
Google Web Translate
++++++++++++++++++++
......@@ -88,14 +90,14 @@ To enable this service, add ``trans.machine.google.GoogleWebTranslation`` to
.. seealso::
https://translate.google.com/
`Google translate service <https://translate.google.com/>`_
.. _ms-translate:
Microsoft Translator
++++++++++++++++++++
Bing Translator
+++++++++++++++
Machine translation service provided by Microsoft.
Machine translation service provided by Microsoft, it's known as Microsoft Translator as well.
You need to register at Azure market and use Client ID and secret from there.
......@@ -105,8 +107,8 @@ To enable this service, add ``trans.machine.microsoft.MicrosoftTranslation`` to
.. seealso::
:setting:`MT_MICROSOFT_ID`, :setting:`MT_MICROSOFT_SECRET`,
http://www.bing.com/translator/,
https://datamarket.azure.com/developer/applications/
`Bing Translator <http://www.bing.com/translator/>`_,
`Azure datamarket <https://datamarket.azure.com/developer/applications/>`_
.. _mymemory:
......@@ -127,7 +129,7 @@ To enable this service, add ``trans.machine.mymemory.MyMemoryTranslation`` to
:setting:`MT_MYMEMORY_EMAIL`,
:setting:`MT_MYMEMORY_USER`,
:setting:`MT_MYMEMORY_KEY`,
http://mymemory.translated.net/
`MyMemory website <http://mymemory.translated.net/>`_
.. _tmserver:
......@@ -164,8 +166,8 @@ And configure Weblate to talk to it:
.. seealso::
:setting:`MT_TMSERVER`,
http://docs.translatehouse.org/projects/translate-toolkit/en/latest/commands/tmserver.html,
http://amagama.translatehouse.org/
`tmserver, a Translation Memory service <http://docs.translatehouse.org/projects/translate-toolkit/en/latest/commands/tmserver.html>`_,
`Amagama Translation Memory <http://amagama.translatehouse.org/>`_
Weblate
+++++++
......
docs/admin/management.rst
View file @ 788b1243
......@@ -56,7 +56,9 @@ Example:
./manage.py --user nijel --inconsistent --source phpmyadmin/master phpmyadmin 4-5 cs
.. seealso:: :ref:`auto-translation`
.. seealso::
:ref:`auto-translation`
changesite
----------
......@@ -68,7 +70,9 @@ changesite
You can use this to changes site name from command line with ``--set-name``
parameter. The ``--get-name`` prints currently configured site name.
.. seealso:: :ref:`production-site`
.. seealso::
:ref:`production-site`
checkgit <project|project/component>
------------------------------------
......@@ -107,7 +111,9 @@ This is most useful if executed periodically from cron or similar tool:
./manage.py commit_pending --all --age=48
.. seealso:: :ref:`production-cron`
.. seealso::
:ref:`production-cron`
cleanuptrans
------------
......@@ -116,7 +122,9 @@ cleanuptrans
Cleanups orphaned checks and translation suggestions.
.. seealso:: :ref:`production-cron`
.. seealso::
:ref:`production-cron`
createadmin
-----------
......@@ -298,7 +306,9 @@ some maintenance on underlaying repository.
You can either define which project or component to update (eg.
``weblate/master``) or use ``--all`` to update all existing components.
.. seealso:: :djadmin:`unlock_translation`
.. seealso::
:djadmin:`unlock_translation`
pushgit <project|project/component>
-----------------------------------
......@@ -325,7 +335,9 @@ With ``--optimize`` the index will not be processed again, only it's content
will be optimized (removing stale entries and merging possibly split index
files).
.. seealso:: :ref:`fulltext`
.. seealso::
:ref:`fulltext`
update_index
------------
......@@ -337,7 +349,9 @@ Updates index for fulltext search when :setting:`OFFLOAD_INDEXING` is enabled.
It is recommended to run this frequently (eg. every 5 minutes) to have index
uptodate.
.. seealso:: :ref:`fulltext`, :ref:`production-cron`, :ref:`production-indexing`
.. seealso::
:ref:`fulltext`, :ref:`production-cron`, :ref:`production-indexing`
unlock_translation <project|project/component>
----------------------------------------------
......@@ -350,7 +364,9 @@ some maintenance on underlaying repository.
You can either define which project or component to update (eg.
``weblate/master``) or use ``--all`` to update all existing components.
.. seealso:: :djadmin:`lock_translation`
.. seealso::
:djadmin:`lock_translation`
setupgroups
-----------
......@@ -363,7 +379,9 @@ to default group.
The option ``--no-privs-update`` disables update of existing groups (only adds
new ones).
.. seealso:: :ref:`privileges`
.. seealso::
:ref:`privileges`
setuplang
---------
......
docs/admin/projects.rst
View file @ 788b1243
......@@ -58,7 +58,9 @@ components. Usually you create one project for one piece of software or book
.. image:: ../images/add-project.png
.. seealso:: :ref:`project`
.. seealso::
:ref:`project`
.. _bilingual:
......@@ -70,7 +72,9 @@ Once you have added a project, you can add translation compontents to it
.. image:: ../images/add-component.png
.. seealso:: :ref:`component`
.. seealso::
:ref:`component`
.. _monolingual:
......@@ -83,7 +87,9 @@ English) (see :ref:`component` for information on individual parameters):
.. image:: ../images/add-component-mono.png
.. seealso:: :ref:`component`
.. seealso::
:ref:`component`
.. _project:
......@@ -285,7 +291,9 @@ strings in the message:
``%(translated_percent)s``
Translated strings percent
.. seealso:: :ref:`faq-vcs`, :ref:`processing`
.. seealso::
:ref:`faq-vcs`, :ref:`processing`
.. _import-speed:
......@@ -345,7 +353,9 @@ at once. This can be achieved using :djadmin:`import_project`.
First you need to create project which will contain all components and then
it's just a matter of running :djadmin:`import_project`.
.. seealso:: :ref:`manage`
.. seealso::
:ref:`manage`
.. _vcs-repos:
......@@ -439,7 +449,10 @@ or by enforcing it in VCS configuration, for example:
jobs. The VCS configuration has to be set for the user which is running
Weblate.
.. seealso:: http://curl.haxx.se/docs/manpage.html, http://git-scm.com/docs/git-config
.. seealso::
`curl manpage <http://curl.haxx.se/docs/manpage.html>`_,
`git config documentation <http://git-scm.com/docs/git-config>`_
.. _fulltext:
......@@ -459,4 +472,6 @@ which items need to be reindexed and you need to schedule background process
(:djadmin:`update_index`) to update index. This leads to faster response of the
site and less fragmented index with cost that it might be slightly outdated.
.. seealso:: :djadmin:`update_index`, :setting:`OFFLOAD_INDEXING`, :ref:`faq-ft-slow`, :ref:`faq-ft-lock`, :ref:`faq-ft-space`
.. seealso::
:djadmin:`update_index`, :setting:`OFFLOAD_INDEXING`, :ref:`faq-ft-slow`, :ref:`faq-ft-lock`, :ref:`faq-ft-space`
docs/api.rst
View file @ 788b1243
......@@ -207,4 +207,6 @@ Changes in translations are exported in RSS feeds.
Retrieves RSS feed with recent changes for Weblate instance.
.. seealso:: https://en.wikipedia.org/wiki/RSS
.. seealso::
`RSS on wikipedia <https://en.wikipedia.org/wiki/RSS>`_
docs/changes.rst
View file @ 788b1243
......@@ -44,6 +44,7 @@ Released on ? 2015.
* Improved support for translating PHP files
* Added XLIFF export for dictionary.
* Added XLIFF and Gettext PO export for all translations.
* Documentation improvements.
weblate 2.4
-----------
......
docs/faq.rst
View file @ 788b1243
......@@ -21,7 +21,9 @@ without interaction unless some merge conflict occurs.
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`
.. seealso::
:ref:`continuous-translation`
How to access repositories over SSH?
------------------------------------
......@@ -67,7 +69,9 @@ actions.
# Push changes to upstream respository, Weblate will fetch merge from there
git push
.. seealso:: :ref:`git-export`
.. seealso::
:ref:`git-export`
How do I translate several branches at once?
--------------------------------------------
......@@ -128,7 +132,9 @@ Why does registration contain example.com as domain?
Weblate uses Django sites framework and it defines site name inside the
database.
.. seealso:: :ref:`production-site`
.. seealso::
:ref:`production-site`
Why are all commits committed by Weblate <noreply@weblate.org>?
---------------------------------------------------------------
......@@ -139,7 +145,9 @@ You can also change it in the administration at any time.
The author of every commit (when underlaying VCS supports it) is still recorded
correctly as an user who has made the translation.
.. seealso:: :ref:`component`
.. seealso::
:ref:`component`
Why do I get warning about not reflected changes on database migration?
-----------------------------------------------------------------------
......@@ -184,7 +192,9 @@ translating:
instance, what will make it automatically pick up translation from other
projects as well.
.. seealso:: :ref:`machine-translation-setup`, :ref:`machine-translation`
.. seealso::
:ref:`machine-translation-setup`, :ref:`machine-translation`
Does Weblate update translation files besides translations?
-----------------------------------------------------------
......@@ -203,7 +213,9 @@ 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`
.. seealso::
:ref:`processing`
Where do language definition come from and how can I add own?
......@@ -305,7 +317,9 @@ better to rebuild it from scratch:
./manage.py rebuild_index --clean
.. seealso:: :djadmin:`rebuild_index`
.. seealso::
:djadmin:`rebuild_index`
.. _faq-ft-lock:
......@@ -316,7 +330,9 @@ 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`
.. seealso::
:ref:`fulltext`
.. _faq-ft-space:
......@@ -331,7 +347,9 @@ as ``TEMP`` variable:
TEMP=/path/to/big/temp ./manage.py rebuild_index --clean
.. seealso:: :djadmin:`rebuild_index`
.. seealso::
:djadmin:`rebuild_index`
Database operations fail with "too many SQL variables"
......@@ -341,7 +359,9 @@ This can happen with SQLite database as it is not powerful enough for some
relations used within Weblate. The only way to fix this is to use some more
capable database, see :ref:`production-database` for more information.
.. seealso:: :ref:`production-database`, `Django's databases <https://docs.djangoproject.com/en/stable/ref/databases/>`_
.. seealso::
:ref:`production-database`, `Django's databases <https://docs.djangoproject.com/en/stable/ref/databases/>`_
Features
++++++++
......
docs/formats.rst
View file @ 788b1243
......@@ -7,7 +7,9 @@ Weblate supports any translation format understood by Translate-toolkit,
however each format being slightly different, there might be some issues with
not well tested formats.
.. seealso:: `Supported formats in translate-toolkit`_
.. seealso::
`Supported formats in translate-toolkit`_
.. note::
......@@ -349,6 +351,8 @@ Others
As already mentioned, all Translate-toolkit formats are supported, but they
did not (yet) receive deeper testing.
.. seealso:: `Supported formats in translate-toolkit`_
.. seealso::
`Supported formats in translate-toolkit`_
.. _Supported formats in translate-toolkit: http://docs.translatehouse.org/projects/translate-toolkit/en/latest/formats/index.html
docs/user/checks.rst
View file @ 788b1243
......@@ -11,7 +11,9 @@ errors in translated strings. This can be quite powerful feature to prevent
common mistakes in translations, however use it with caution as it can cause
silent corruption as well.
.. seealso:: :setting:`AUTOFIX_LIST`
.. seealso::
:setting:`AUTOFIX_LIST`
.. _checks:
......@@ -22,7 +24,9 @@ Weblate does wide range of quality checks on messages. The following section
describes them in more detail. The checks take account also special rules for
different languages, so if you think the result is wrong, please report a bug.
.. seealso:: :setting:`CHECK_LIST`, :ref:`custom-checks`
.. seealso::
:setting:`CHECK_LIST`, :ref:`custom-checks`
Translation checks
++++++++++++++++++
......@@ -140,7 +144,9 @@ real ellipsis (``…``) not for three dots (``...``).
Ellipsis is usually rendered nicer than three dots, so it's good to keep it
when the original string was using that as well.
.. seealso:: https://en.wikipedia.org/wiki/Ellipsis
.. seealso::
`Ellipsis on wikipedia <https://en.wikipedia.org/wiki/Ellipsis>`_
.. _check-max-length:
......@@ -181,6 +187,7 @@ Omitting format string from translation usually cause severe problems, so you
should really keep the format string matching the original one.
.. seealso::
`Python string formatting <https://docs.python.org/2.7/library/stdtypes.html#string-formatting>`_,
`Python brace format <https://docs.python.org/3.3/library/string.html#string-formatting>`_,
`PHP format strings <https://php.net/manual/en/function.sprintf.php>`_,
......@@ -245,7 +252,9 @@ Translation contains extra zero-width space (<U+200B>) character.
This character is usually inserted by mistake, though it might have legitimate
use. Some programs might have problems when this character is used.
.. seealso:: https://en.wikipedia.org/wiki/Zero-width_space
.. seealso::
`Zero width space on wikipedia <https://en.wikipedia.org/wiki/Zero-width_space>`_
.. _check-xml-tags:
......@@ -289,7 +298,9 @@ The string uses three dots (``...``) instead of an ellipsis character (``…``).
Using Unicode character is in most cases better approach and looks better when
rendered.
.. seealso:: https://en.wikipedia.org/wiki/Ellipsis
.. seealso::
`Ellipsis on wikipedia <https://en.wikipedia.org/wiki/Ellipsis>`_
.. _check-multiple-failures:
......
docs/user/files.rst
View file @ 788b1243
......@@ -30,7 +30,9 @@ Weblate accepts any file format it understands on upload, but it is still
recommeded to use same file format as is used for translation, otherwise some
features might not be translated properly.
.. seealso:: :ref:`formats`
.. seealso::
:ref:`formats`
The uploaded file is merged to current translation, overwriting existing
entries by default (this can be changed in the upload dialog).
......
docs/user/translating.rst
View file @ 788b1243
......@@ -176,7 +176,9 @@ machine translation tools.
All machine translations are available on single tab on translation page.
.. seealso:: :ref:`machine-translation-setup`
.. seealso::
:ref:`machine-translation-setup`
.. _auto-translation:
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7