File: tags.rst

package info (click to toggle)
copyq 3.7.3-1~bpo9+1
  • links: PTS, VCS
  • area: main
  • in suites: stretch-backports
  • size: 10,480 kB
  • sloc: cpp: 51,894; sh: 734; python: 211; xml: 57; makefile: 34
file content (59 lines) | stat: -rw-r--r-- 1,636 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
Tags
====

Tags are small icons or short texts in upper right corner of an item
used to mark important or special items.

.. image:: images/tags.png

Tags can be configured in "Items" configuration tab. On Windows, "Item
Tags" plugin needs to be installed.

.. image:: images/tags-config.png

Configuration consists solely of table where each row contains matching
and styling rules for tags.

Style from the first row which matches tag text is applied on the tag.

Column in the table are following.

-  "Tag Name"

Text for the tag. This is used for matching if "Match" column is empty.
Expressions like ``\1``, ``\2`` etc. will be replaced with
captured texts from "Match" column.

-  "Match"

Regular expression for matching the tags.

E.g. ``.*`` (any tag), ``Important: .*`` (match prefix),
``\d\d\d\d-\d\d-\d\d.*`` (date time).

-  "Style Sheet"

Simple style sheet (http://doc.qt.io/qt-4.8/stylesheet-reference.html).

E.g. ``border: 1px solid white; border-radius: 3px; font-size: 7pt``.

-  "Color" - Text color.

-  "Icon" - Icon for tag. To show only icon without text you have to set
   "Match" and keep "Tag Name" field empty.

Tagging items can be accessed from context menu if appropriate commands
are added in Command dialog (generated commands are available in the
list under "Add" button).

.. image:: images/tags-add-command.png

Alternatively, tags are added to an item by setting
"application/x-copyq-tags" format. It can contain multiple tags
separated by comma. The tag text itself can be written as simple HTML.

Example:

::

    copyq write text/plain "Item with tag" application/x-copyq-tags "Some tag text"