mirror of
https://github.com/WeblateOrg/weblate.git
synced 2026-07-26 14:23:58 +08:00
f60e72d521
Help users find strings with comments they authored, including source comments, without changing existing comment search semantics.
381 lines
13 KiB
ReStructuredText
Vendored
381 lines
13 KiB
ReStructuredText
Vendored
Searching
|
|
=========
|
|
|
|
Search query syntax
|
|
+++++++++++++++++++
|
|
|
|
Advanced searches support boolean operations, parentheses, field-specific
|
|
lookup, field operators, exact match, date values, and regular expressions.
|
|
The available fields depend on what kind of object is being searched.
|
|
|
|
.. _search-boolean:
|
|
|
|
Boolean operators
|
|
-----------------
|
|
|
|
You can combine lookups using ``AND``, ``OR``, ``NOT`` and parentheses to
|
|
form complex queries. Boolean operators are case-insensitive, so ``and``,
|
|
``And`` and ``AND`` are equivalent.
|
|
|
|
The ``NOT`` operator has higher precedence than the ``AND`` operator; the
|
|
``AND`` operator has higher precedence than the ``OR`` operator. You can add
|
|
parenthesis to define a precedence of your own.
|
|
|
|
Omitting the operator will make the query behave like the ``AND`` operator was
|
|
used.
|
|
|
|
.. list-table:: Equivalent expressions
|
|
|
|
* - ``(state:translated AND source:hello) OR source:bar``
|
|
- Parenthesized expression to clearly show the precedence.
|
|
* - ``state:translated AND source:hello OR source:bar``
|
|
- The ``AND`` operator has higher precedence than the ``OR`` operator.
|
|
* - ``state:translated source:hello OR source:bar``
|
|
- Query using an implicit ``AND`` operator.
|
|
|
|
.. _search-operators:
|
|
|
|
Field operators
|
|
---------------
|
|
|
|
You can specify operators, ranges or partial lookups for date or numeric
|
|
searches:
|
|
|
|
``state:>=translated``
|
|
State is ``translated`` or better (``approved``).
|
|
``changed:[2019-03-01 to 2019-04-01]``
|
|
Changed between two given dates (inclusive).
|
|
``position:[10 to 100]``
|
|
Strings with position between 10 and 100 (inclusive).
|
|
|
|
.. _date-search:
|
|
|
|
Searching for DATETIME fields
|
|
-----------------------------
|
|
|
|
Timestamp searching supports multiple ways to specify the value. It supports
|
|
wide range of ways to specify date and time.
|
|
|
|
* ISO 8601 formatted like :samp:`2025-09-08T12:16:55.336146+00:00`.
|
|
* English written date and time like :samp:`July 4, 2013 PST`.
|
|
* English adverbs of time like :samp:`yesterday`, :samp:`last month`, and :samp:`2 days ago`.
|
|
|
|
Whenever only the date is specified, it is always used as inclusive and covers
|
|
that date. Specify the exact timestamp if you need to override this behavior.
|
|
|
|
Examples:
|
|
|
|
``changed:>=2019-03-01``
|
|
Changed on 1st March 2019 and later (inclusive).
|
|
``changed:>="2 weeks ago"``
|
|
Changed 2 weeks ago from the current date and time.
|
|
``changed:>=yesterday``
|
|
Changed starting yesterday.
|
|
``changed:2019``
|
|
Changed in the year 2019.
|
|
``changed:[2019-03-01 to 2019-04-01]``
|
|
Changed between two given dates (inclusive).
|
|
``changed:[20_days_ago to yesterday]``
|
|
Changed between two relative dates (inclusive).
|
|
|
|
Exact operators
|
|
---------------
|
|
|
|
You can do an exact match query on different string fields using ``=``
|
|
operator. For example, to search for all source strings exactly matching
|
|
``hello world``, use: ``source:="hello world"``. For searching single word
|
|
expressions, you can skip quotes. For example, to search for all source strings
|
|
matching ``hello``, you can use: ``source:=hello``.
|
|
|
|
Regular expressions
|
|
-------------------
|
|
|
|
Anywhere text is accepted you can also specify a regular expression as
|
|
``r"regexp"``.
|
|
|
|
For example, to search for all source strings which contain any digit between 2
|
|
and 5, use ``source:r"[2-5]"``.
|
|
|
|
.. hint::
|
|
|
|
The regular expressions are evaluated by the database backend and might use
|
|
different extensions, please consult the database documentation for
|
|
more details:
|
|
|
|
* `PostgreSQL Regular Expressions Details <https://www.postgresql.org/docs/current/functions-matching.html#POSIX-SYNTAX-DETAILS>`_
|
|
|
|
.. _search-strings:
|
|
|
|
Searching for strings
|
|
+++++++++++++++++++++
|
|
|
|
String search supports the shared query syntax above.
|
|
|
|
When no field is defined, the lookup happens on source, target, and context strings.
|
|
|
|
.. image:: /screenshots/search.webp
|
|
|
|
Simple search
|
|
-------------
|
|
|
|
Any phrase typed into the search box is split into words. Strings containing all
|
|
of them are shown. To look for an exact phrase, put "the searchphrase" into
|
|
quotes (both single (``'``) and double (``"``) quotes will work): ``"this is a quoted
|
|
string"`` or ``'another quoted string'``.
|
|
|
|
Fields
|
|
------
|
|
|
|
``source:TEXT``
|
|
Source string case-insensitive search.
|
|
``target:TEXT``
|
|
Target string case-insensitive search.
|
|
``context:TEXT``
|
|
Context string case-insensitive search.
|
|
``key:TEXT``
|
|
Key string case-insensitive search.
|
|
``note:TEXT``
|
|
Source string description case-insensitive search.
|
|
``location:TEXT``
|
|
Location string case-insensitive search.
|
|
``priority:NUMBER``
|
|
String priority.
|
|
``id:NUMBER``
|
|
String unique identifier.
|
|
``position:NUMBER``
|
|
String position in the translation file.
|
|
``added:DATETIME``
|
|
Timestamp for when the string was added to Weblate.
|
|
``state:TEXT``
|
|
Search for string states (``approved``, ``translated``, ``needs-editing``, ``needs-rewriting``, ``needs-checking``, ``empty``, ``read-only``).
|
|
|
|
This field also supports :ref:`search-operators`, so searching for completed strings can be performed as ``state:>=translated``, searching for strings needing translation as ``state:<translated``.
|
|
``source_state:TEXT``
|
|
Search for source string states, see above for more info.
|
|
``pending:BOOLEAN``
|
|
String pending for flushing to VCS.
|
|
``has:TEXT``
|
|
Search for string having attributes - ``plural``, ``context``, ``suggestion``, ``comment``, ``source-comment``, ``check``, ``dismissed-check``, ``translation``, ``variant``, ``screenshot``, ``flags``, ``explanation``, ``glossary``, ``note``, ``label``, ``location``.
|
|
``is:TEXT``
|
|
Filters string on a condition:
|
|
|
|
``read-only`` or ``readonly``
|
|
Read-only strings, same as ``state:read-only``.
|
|
``approved``
|
|
Approved strings, same as ``state:approved``.
|
|
``needs-editing`` or ``fuzzy``
|
|
Needing editing/checking/rewriting strings, same as ``state:needs-editing OR state:needs-rewriting OR state:needs-checking``.
|
|
``translated``
|
|
Translated strings, same as ``state:>translated``.
|
|
``untranslated``
|
|
Untranslated strings, same as ``state:<translated``.
|
|
``pending``
|
|
Pending strings not yet committed to the file (see :ref:`lazy-commit`).
|
|
``automatically-translated``
|
|
Strings that were translated automatically (see :ref:`auto-translation`).
|
|
``language:TEXT``
|
|
String target language.
|
|
``component:TEXT``
|
|
Component slug or name case-insensitive search, see :ref:`component-slug` and :ref:`component-name`.
|
|
``project:TEXT``
|
|
Project slug, see :ref:`project-slug`.
|
|
``path:TEXT``
|
|
Path to the object to limit searching inside component, category, project, or translation.
|
|
``changed_by:TEXT``
|
|
String was changed by author with given username.
|
|
Use ``changed_by:""`` to search for strings with at least one content change without a recorded author.
|
|
``changed:DATETIME``
|
|
String content was changed on date, supports :ref:`search-operators` and :ref:`date-search`.
|
|
``change_time:DATETIME``
|
|
String was changed on date, supports :ref:`search-operators` and :ref:`date-search`.
|
|
|
|
Unlike ``changed`` this includes event which don't change content and you
|
|
can apply custom action filtering using ``change_action``.
|
|
``change_action:TEXT``
|
|
Filters on change action, useful together with ``change_time``. Accepts
|
|
English name of the change action, either quoted and with spaces or
|
|
lowercase and spaces replaced by a hyphen. See :ref:`search-changes` for
|
|
examples.
|
|
|
|
When combining ``changed_by``, ``changed``, ``change_time``, and
|
|
``change_action`` filters, the filters apply to the same change event.
|
|
``source_changed:DATETIME``
|
|
Source string was last changed on date, supports :ref:`search-operators` and :ref:`date-search`.
|
|
``last_changed:DATETIME``
|
|
The string was last changed on date, supports :ref:`search-operators` and :ref:`date-search`.
|
|
``check:TEXT``
|
|
String has failing check, see :doc:`/user/checks` for check identifiers.
|
|
``dismissed_check:TEXT``
|
|
String has dismissed check, see :doc:`/user/checks` for check identifiers.
|
|
``comment:TEXT``
|
|
Search in unresolved user comments on the string.
|
|
``resolved_comment:TEXT``
|
|
Search in resolved comments.
|
|
``comment_author:TEXT``
|
|
Filter by comment author.
|
|
``source_comment:TEXT``
|
|
Search in unresolved source string comments.
|
|
``resolved_source_comment:TEXT``
|
|
Search in resolved source string comments.
|
|
``source_comment_author:TEXT``
|
|
Filter by source string comment author.
|
|
|
|
Source string comment filters match comments attached to the source string.
|
|
When searching across languages, matching target strings sharing that source
|
|
string can be included in the results.
|
|
``suggestion:TEXT``
|
|
Search in suggestions.
|
|
``suggestion_author:TEXT``
|
|
Filter by suggestion author.
|
|
``explanation:TEXT``
|
|
Search in explanations.
|
|
``label:TEXT``
|
|
Search in labels.
|
|
``screenshot:TEXT``
|
|
Search in screenshots.
|
|
``labels_count:NUMBER``
|
|
Filter by count of labels
|
|
|
|
.. _search-changes:
|
|
|
|
Searching for changes
|
|
---------------------
|
|
|
|
.. versionadded:: 4.4
|
|
|
|
Searching for history events can be done using ``change_action`` and
|
|
``change_time`` operators.
|
|
|
|
For example, searching for strings marked for edit in 2018 can be entered as
|
|
``change_time:2018 AND change_action:marked-for-edit`` or
|
|
``change_time:2018 AND change_action:"Marked for edit"``.
|
|
|
|
|
|
Predefined queries
|
|
------------------
|
|
|
|
You can select out of predefined queries on the search page, this allows you to quickly access the most frequent searches:
|
|
|
|
.. image:: /screenshots/query-dropdown.webp
|
|
|
|
Ordering the results
|
|
--------------------
|
|
|
|
There are many options to order the strings according to your needs:
|
|
|
|
.. image:: /screenshots/query-sort.webp
|
|
|
|
.. _search-screenshots:
|
|
|
|
Searching for screenshots
|
|
+++++++++++++++++++++++++
|
|
|
|
The screenshot listing in a component accepts advanced queries using boolean
|
|
operations, parentheses, or field specific lookup.
|
|
|
|
When no field is defined, the lookup happens on the screenshot name. Use
|
|
field-specific lookups to search repository paths, screenshot languages, or
|
|
assigned source strings.
|
|
|
|
Screenshot fields
|
|
-----------------
|
|
|
|
``name:TEXT``
|
|
Screenshot name case-insensitive search.
|
|
``path:TEXT``
|
|
Repository path to screenshot case-insensitive search.
|
|
``repository:TEXT``
|
|
Repository path to screenshot case-insensitive search, same as
|
|
``path:TEXT``.
|
|
``language:TEXT``
|
|
Screenshot language code or language name case-insensitive search.
|
|
``string:TEXT``
|
|
Assigned source string case-insensitive search.
|
|
``context:TEXT``
|
|
Assigned source string context case-insensitive search.
|
|
``location:TEXT``
|
|
Assigned source string location case-insensitive search.
|
|
``id:NUMBER``
|
|
Screenshot unique identifier.
|
|
``timestamp:DATETIME``
|
|
Timestamp for when the screenshot was added to Weblate.
|
|
``strings:NUMBER``
|
|
Number of assigned source strings.
|
|
``has:TEXT``
|
|
Search for screenshots having attributes:
|
|
|
|
``string``
|
|
Screenshot assigned to at least one source string.
|
|
``repository``
|
|
Screenshot with a repository path.
|
|
``path``
|
|
Screenshot with a repository path, same as ``repository``.
|
|
|
|
Screenshot search examples
|
|
--------------------------
|
|
|
|
``login``
|
|
Search for screenshots matching ``login`` in the screenshot name.
|
|
``name:login``
|
|
Search for screenshots with ``login`` in the screenshot name.
|
|
``language:cs``
|
|
Search for screenshots in languages matching ``cs``.
|
|
``string:"Save changes"``
|
|
Search for screenshots assigned to source strings matching
|
|
``Save changes``.
|
|
``has:string``
|
|
Search for screenshots assigned to at least one source string.
|
|
``NOT has:string``
|
|
Search for screenshots not assigned to any source string.
|
|
``repository:fastlane``
|
|
Search for screenshots with ``fastlane`` in the repository path.
|
|
``strings:>2``
|
|
Search for screenshots assigned to more than two source strings.
|
|
``has:repository AND NOT has:string``
|
|
Search for screenshots imported from the repository that still need source
|
|
string assignment.
|
|
|
|
Screenshot search supports the same :ref:`search-boolean`,
|
|
:ref:`search-operators`, :ref:`date-search`, exact match, and regular
|
|
expression syntax as string search.
|
|
|
|
.. _search-users:
|
|
|
|
Searching for users
|
|
+++++++++++++++++++
|
|
|
|
.. versionadded:: 4.18
|
|
|
|
The user browsing has similar search abilities:
|
|
|
|
``username:TEXT``
|
|
Search in usernames.
|
|
``full_name:TEXT``
|
|
Search in full names.
|
|
``language:TEXT``
|
|
User configured translation language (see :ref:`profile-translated-languages`).
|
|
``joined:DATETIME``
|
|
String content was changed on date, supports :ref:`search-operators`.
|
|
``translates:TEXT``
|
|
User has contributed to a given language.
|
|
|
|
You might want to limit contribution time by ``change_time``, for example ``change_time:>"90 days ago"``.
|
|
``contributes:TEXT``
|
|
User has contributed to a given project or component.
|
|
|
|
You might want to limit contribution time by ``change_time``, for example ``change_time:>"90 days ago"``.
|
|
``change_time:DATETIME``
|
|
Same as in :ref:`search-strings`.
|
|
``change_action:TEXT``
|
|
Same as in :ref:`search-strings`.
|
|
|
|
Additional lookups are available in the :ref:`management-interface`:
|
|
|
|
``is:bot``
|
|
Search for bots (used for project scoped tokens).
|
|
``is:active``
|
|
Search for active users.
|
|
``email:TEXT``
|
|
Search by e-mail.
|
|
``ip:TEXT``
|
|
Search by audit log IP address.
|
